1 .. _email_clients: 1 .. _email_clients:
2 2
3 Email clients info for Linux 3 Email clients info for Linux
4 ============================ 4 ============================
5 5
6 Git 6 Git
7 --- 7 ---
8 8
9 These days most developers use ``git send-emai 9 These days most developers use ``git send-email`` instead of regular
10 email clients. The man page for this is quite 10 email clients. The man page for this is quite good. On the receiving
11 end, maintainers use ``git am`` to apply the p 11 end, maintainers use ``git am`` to apply the patches.
12 12
13 If you are new to ``git`` then send your first 13 If you are new to ``git`` then send your first patch to yourself. Save it
14 as raw text including all the headers. Run `` 14 as raw text including all the headers. Run ``git am raw_email.txt`` and
15 then review the changelog with ``git log``. W 15 then review the changelog with ``git log``. When that works then send
16 the patch to the appropriate mailing list(s). 16 the patch to the appropriate mailing list(s).
17 17
18 General Preferences 18 General Preferences
19 ------------------- 19 -------------------
20 20
21 Patches for the Linux kernel are submitted via 21 Patches for the Linux kernel are submitted via email, preferably as
22 inline text in the body of the email. Some ma 22 inline text in the body of the email. Some maintainers accept
23 attachments, but then the attachments should h 23 attachments, but then the attachments should have content-type
24 ``text/plain``. However, attachments are gene 24 ``text/plain``. However, attachments are generally frowned upon because
25 it makes quoting portions of the patch more di 25 it makes quoting portions of the patch more difficult in the patch
26 review process. 26 review process.
27 27
28 It's also strongly recommended that you use pl <<
29 for patches and other emails alike. https://us <<
30 for information on how to configure your prefe <<
31 listing recommended email clients should you n <<
32 <<
33 Email clients that are used for Linux kernel p 28 Email clients that are used for Linux kernel patches should send the
34 patch text untouched. For example, they shoul 29 patch text untouched. For example, they should not modify or delete tabs
35 or spaces, even at the beginning or end of lin 30 or spaces, even at the beginning or end of lines.
36 31
37 Don't send patches with ``format=flowed``. Th 32 Don't send patches with ``format=flowed``. This can cause unexpected
38 and unwanted line breaks. 33 and unwanted line breaks.
39 34
40 Don't let your email client do automatic word 35 Don't let your email client do automatic word wrapping for you.
41 This can also corrupt your patch. 36 This can also corrupt your patch.
42 37
43 Email clients should not modify the character 38 Email clients should not modify the character set encoding of the text.
44 Emailed patches should be in ASCII or UTF-8 en 39 Emailed patches should be in ASCII or UTF-8 encoding only.
45 If you configure your email client to send ema 40 If you configure your email client to send emails with UTF-8 encoding,
46 you avoid some possible charset problems. 41 you avoid some possible charset problems.
47 42
48 Email clients should generate and maintain "Re 43 Email clients should generate and maintain "References:" or "In-Reply-To:"
49 headers so that mail threading is not broken. 44 headers so that mail threading is not broken.
50 45
51 Copy-and-paste (or cut-and-paste) usually does 46 Copy-and-paste (or cut-and-paste) usually does not work for patches
52 because tabs are converted to spaces. Using x 47 because tabs are converted to spaces. Using xclipboard, xclip, and/or
53 xcutsel may work, but it's best to test this f 48 xcutsel may work, but it's best to test this for yourself or just avoid
54 copy-and-paste. 49 copy-and-paste.
55 50
56 Don't use PGP/GPG signatures in mail that cont 51 Don't use PGP/GPG signatures in mail that contains patches.
57 This breaks many scripts that read and apply t 52 This breaks many scripts that read and apply the patches.
58 (This should be fixable.) 53 (This should be fixable.)
59 54
60 It's a good idea to send a patch to yourself, 55 It's a good idea to send a patch to yourself, save the received message,
61 and successfully apply it with 'patch' before 56 and successfully apply it with 'patch' before sending patches to Linux
62 mailing lists. 57 mailing lists.
63 58
64 59
65 Some email client (MUA) hints 60 Some email client (MUA) hints
66 ----------------------------- 61 -----------------------------
67 62
68 Here are some specific MUA configuration hints 63 Here are some specific MUA configuration hints for editing and sending
69 patches for the Linux kernel. These are not m 64 patches for the Linux kernel. These are not meant to be complete
70 software package configuration summaries. 65 software package configuration summaries.
71 66
72 67
73 Legend: 68 Legend:
74 69
75 - TUI = text-based user interface 70 - TUI = text-based user interface
76 - GUI = graphical user interface 71 - GUI = graphical user interface
77 72
78 Alpine (TUI) 73 Alpine (TUI)
79 ************ 74 ************
80 75
81 Config options: 76 Config options:
82 77
83 In the :menuselection:`Sending Preferences` se 78 In the :menuselection:`Sending Preferences` section:
84 79
85 - :menuselection:`Do Not Send Flowed Text` mus 80 - :menuselection:`Do Not Send Flowed Text` must be ``enabled``
86 - :menuselection:`Strip Whitespace Before Send 81 - :menuselection:`Strip Whitespace Before Sending` must be ``disabled``
87 82
88 When composing the message, the cursor should 83 When composing the message, the cursor should be placed where the patch
89 should appear, and then pressing :kbd:`CTRL-R` 84 should appear, and then pressing :kbd:`CTRL-R` let you specify the patch file
90 to insert into the message. 85 to insert into the message.
91 86
92 Claws Mail (GUI) 87 Claws Mail (GUI)
93 **************** 88 ****************
94 89
95 Works. Some people use this successfully for p 90 Works. Some people use this successfully for patches.
96 91
97 To insert a patch use :menuselection:`Message- 92 To insert a patch use :menuselection:`Message-->Insert File` (:kbd:`CTRL-I`)
98 or an external editor. 93 or an external editor.
99 94
100 If the inserted patch has to be edited in the 95 If the inserted patch has to be edited in the Claws composition window
101 "Auto wrapping" in 96 "Auto wrapping" in
102 :menuselection:`Configuration-->Preferences--> 97 :menuselection:`Configuration-->Preferences-->Compose-->Wrapping` should be
103 disabled. 98 disabled.
104 99
105 Evolution (GUI) 100 Evolution (GUI)
106 *************** 101 ***************
107 102
108 Some people use this successfully for patches. 103 Some people use this successfully for patches.
109 104
110 When composing mail select: Preformat 105 When composing mail select: Preformat
111 from :menuselection:`Format-->Paragraph Styl 106 from :menuselection:`Format-->Paragraph Style-->Preformatted` (:kbd:`CTRL-7`)
112 or the toolbar 107 or the toolbar
113 108
114 Then use: 109 Then use:
115 :menuselection:`Insert-->Text File...` (:kbd:` 110 :menuselection:`Insert-->Text File...` (:kbd:`ALT-N x`)
116 to insert the patch. 111 to insert the patch.
117 112
118 You can also ``diff -Nru old.c new.c | xclip`` 113 You can also ``diff -Nru old.c new.c | xclip``, select
119 :menuselection:`Preformat`, then paste with th 114 :menuselection:`Preformat`, then paste with the middle button.
120 115
121 Kmail (GUI) 116 Kmail (GUI)
122 *********** 117 ***********
123 118
124 Some people use Kmail successfully for patches 119 Some people use Kmail successfully for patches.
125 120
126 The default setting of not composing in HTML i 121 The default setting of not composing in HTML is appropriate; do not
127 enable it. 122 enable it.
128 123
129 When composing an email, under options, unchec 124 When composing an email, under options, uncheck "word wrap". The only
130 disadvantage is any text you type in the email 125 disadvantage is any text you type in the email will not be word-wrapped
131 so you will have to manually word wrap text be 126 so you will have to manually word wrap text before the patch. The easiest
132 way around this is to compose your email with 127 way around this is to compose your email with word wrap enabled, then save
133 it as a draft. Once you pull it up again from 128 it as a draft. Once you pull it up again from your drafts it is now hard
134 word-wrapped and you can uncheck "word wrap" w 129 word-wrapped and you can uncheck "word wrap" without losing the existing
135 wrapping. 130 wrapping.
136 131
137 At the bottom of your email, put the commonly- 132 At the bottom of your email, put the commonly-used patch delimiter before
138 inserting your patch: three hyphens (``---``) 133 inserting your patch: three hyphens (``---``).
139 134
140 Then from the :menuselection:`Message` menu it 135 Then from the :menuselection:`Message` menu item, select
141 :menuselection:`insert file` and choose your p 136 :menuselection:`insert file` and choose your patch.
142 As an added bonus you can customise the messag 137 As an added bonus you can customise the message creation toolbar menu
143 and put the :menuselection:`insert file` icon 138 and put the :menuselection:`insert file` icon there.
144 139
145 Make the composer window wide enough so that n 140 Make the composer window wide enough so that no lines wrap. As of
146 KMail 1.13.5 (KDE 4.5.4), KMail will apply wor 141 KMail 1.13.5 (KDE 4.5.4), KMail will apply word wrapping when sending
147 the email if the lines wrap in the composer wi 142 the email if the lines wrap in the composer window. Having word wrapping
148 disabled in the Options menu isn't enough. Thu 143 disabled in the Options menu isn't enough. Thus, if your patch has very
149 long lines, you must make the composer window 144 long lines, you must make the composer window very wide before sending
150 the email. See: https://bugs.kde.org/show_bug. 145 the email. See: https://bugs.kde.org/show_bug.cgi?id=174034
151 146
152 You can safely GPG sign attachments, but inlin 147 You can safely GPG sign attachments, but inlined text is preferred for
153 patches so do not GPG sign them. Signing patc 148 patches so do not GPG sign them. Signing patches that have been inserted
154 as inlined text will make them tricky to extra 149 as inlined text will make them tricky to extract from their 7-bit encoding.
155 150
156 If you absolutely must send patches as attachm 151 If you absolutely must send patches as attachments instead of inlining
157 them as text, right click on the attachment an 152 them as text, right click on the attachment and select :menuselection:`properties`,
158 and highlight :menuselection:`Suggest automati 153 and highlight :menuselection:`Suggest automatic display` to make the attachment
159 inlined to make it more viewable. 154 inlined to make it more viewable.
160 155
161 When saving patches that are sent as inlined t 156 When saving patches that are sent as inlined text, select the email that
162 contains the patch from the message list pane, 157 contains the patch from the message list pane, right click and select
163 :menuselection:`save as`. You can use the who 158 :menuselection:`save as`. You can use the whole email unmodified as a patch
164 if it was properly composed. Emails are saved 159 if it was properly composed. Emails are saved as read-write for user only so
165 you will have to chmod them to make them group 160 you will have to chmod them to make them group and world readable if you copy
166 them elsewhere. 161 them elsewhere.
167 162
168 Lotus Notes (GUI) 163 Lotus Notes (GUI)
169 ***************** 164 *****************
170 165
171 Run away from it. 166 Run away from it.
172 167
173 IBM Verse (Web GUI) 168 IBM Verse (Web GUI)
174 ******************* 169 *******************
175 170
176 See Lotus Notes. 171 See Lotus Notes.
177 172
178 Mutt (TUI) 173 Mutt (TUI)
179 ********** 174 **********
180 175
181 Plenty of Linux developers use ``mutt``, so it 176 Plenty of Linux developers use ``mutt``, so it must work pretty well.
182 177
183 Mutt doesn't come with an editor, so whatever 178 Mutt doesn't come with an editor, so whatever editor you use should be
184 used in a way that there are no automatic line 179 used in a way that there are no automatic linebreaks. Most editors have
185 an :menuselection:`insert file` option that in 180 an :menuselection:`insert file` option that inserts the contents of a file
186 unaltered. 181 unaltered.
187 182
188 To use ``vim`` with mutt:: 183 To use ``vim`` with mutt::
189 184
190 set editor="vi" 185 set editor="vi"
191 186
192 If using xclip, type the command:: 187 If using xclip, type the command::
193 188
194 :set paste 189 :set paste
195 190
196 before middle button or shift-insert or use:: 191 before middle button or shift-insert or use::
197 192
198 :r filename 193 :r filename
199 194
200 if you want to include the patch inline. 195 if you want to include the patch inline.
201 (a)ttach works fine without ``set paste``. 196 (a)ttach works fine without ``set paste``.
202 197
203 You can also generate patches with ``git forma 198 You can also generate patches with ``git format-patch`` and then use Mutt
204 to send them:: 199 to send them::
205 200
206 $ mutt -H 0001-some-bug-fix.patch 201 $ mutt -H 0001-some-bug-fix.patch
207 202
208 Config options: 203 Config options:
209 204
210 It should work with default settings. 205 It should work with default settings.
211 However, it's a good idea to set the ``send_ch 206 However, it's a good idea to set the ``send_charset`` to::
212 207
213 set send_charset="us-ascii:utf-8" 208 set send_charset="us-ascii:utf-8"
214 209
215 Mutt is highly customizable. Here is a minimum 210 Mutt is highly customizable. Here is a minimum configuration to start
216 using Mutt to send patches through Gmail:: 211 using Mutt to send patches through Gmail::
217 212
218 # .muttrc 213 # .muttrc
219 # ================ IMAP ================== !! 214 # ================ IMAP ====================
220 set imap_user = 'yourusername@gmail.com' 215 set imap_user = 'yourusername@gmail.com'
221 set imap_pass = 'yourpassword' 216 set imap_pass = 'yourpassword'
222 set spoolfile = imaps://imap.gmail.com/INBOX 217 set spoolfile = imaps://imap.gmail.com/INBOX
223 set folder = imaps://imap.gmail.com/ 218 set folder = imaps://imap.gmail.com/
224 set record="imaps://imap.gmail.com/[Gmail]/S 219 set record="imaps://imap.gmail.com/[Gmail]/Sent Mail"
225 set postponed="imaps://imap.gmail.com/[Gmail 220 set postponed="imaps://imap.gmail.com/[Gmail]/Drafts"
226 set mbox="imaps://imap.gmail.com/[Gmail]/All 221 set mbox="imaps://imap.gmail.com/[Gmail]/All Mail"
227 222
228 # ================ SMTP ================== 223 # ================ SMTP ====================
229 set smtp_url = "smtp://username@smtp.gmail.c 224 set smtp_url = "smtp://username@smtp.gmail.com:587/"
230 set smtp_pass = $imap_pass 225 set smtp_pass = $imap_pass
231 set ssl_force_tls = yes # Require encrypted 226 set ssl_force_tls = yes # Require encrypted connection
232 227
233 # ================ Composition =========== 228 # ================ Composition ====================
234 set editor = `echo \$EDITOR` 229 set editor = `echo \$EDITOR`
235 set edit_headers = yes # See the headers wh 230 set edit_headers = yes # See the headers when editing
236 set charset = UTF-8 # value of $LANG; al 231 set charset = UTF-8 # value of $LANG; also fallback for send_charset
237 # Sender, email address, and sign-off line m 232 # Sender, email address, and sign-off line must match
238 unset use_domain # because joe@localh 233 unset use_domain # because joe@localhost is just embarrassing
239 set realname = "YOUR NAME" 234 set realname = "YOUR NAME"
240 set from = "username@gmail.com" 235 set from = "username@gmail.com"
241 set use_from = yes 236 set use_from = yes
242 237
243 The Mutt docs have lots more information: 238 The Mutt docs have lots more information:
244 239
245 https://gitlab.com/muttmua/mutt/-/wikis/Us !! 240 http://dev.mutt.org/trac/wiki/UseCases/Gmail
246 241
247 http://www.mutt.org/doc/manual/ !! 242 http://dev.mutt.org/doc/manual.html
248 243
249 Pine (TUI) 244 Pine (TUI)
250 ********** 245 **********
251 246
252 Pine has had some whitespace truncation issues 247 Pine has had some whitespace truncation issues in the past, but these
253 should all be fixed now. 248 should all be fixed now.
254 249
255 Use alpine (pine's successor) if you can. 250 Use alpine (pine's successor) if you can.
256 251
257 Config options: 252 Config options:
258 253
259 - ``quell-flowed-text`` is needed for recent v 254 - ``quell-flowed-text`` is needed for recent versions
260 - the ``no-strip-whitespace-before-send`` opti 255 - the ``no-strip-whitespace-before-send`` option is needed
261 256
262 257
263 Sylpheed (GUI) 258 Sylpheed (GUI)
264 ************** 259 **************
265 260
266 - Works well for inlining text (or using attac 261 - Works well for inlining text (or using attachments).
267 - Allows use of an external editor. 262 - Allows use of an external editor.
268 - Is slow on large folders. 263 - Is slow on large folders.
269 - Won't do TLS SMTP auth over a non-SSL connec 264 - Won't do TLS SMTP auth over a non-SSL connection.
270 - Has a helpful ruler bar in the compose windo 265 - Has a helpful ruler bar in the compose window.
271 - Adding addresses to address book doesn't und 266 - Adding addresses to address book doesn't understand the display name
272 properly. 267 properly.
273 268
274 Thunderbird (GUI) 269 Thunderbird (GUI)
275 ***************** 270 *****************
276 271
277 Thunderbird is an Outlook clone that likes to 272 Thunderbird is an Outlook clone that likes to mangle text, but there are ways
278 to coerce it into behaving. 273 to coerce it into behaving.
279 274
280 After doing the modifications, this includes i <<
281 you need to restart Thunderbird. <<
282 <<
283 - Allow use of an external editor: 275 - Allow use of an external editor:
284 !! 276 The easiest thing to do with Thunderbird and patches is to use an
285 The easiest thing to do with Thunderbird and !! 277 "external editor" extension and then just use your favorite ``$EDITOR``
286 which open your favorite external editor. !! 278 for reading/merging patches into the body text. To do this, download
287 !! 279 and install the extension, then add a button for it using
288 Here are some example extensions which are c !! 280 :menuselection:`View-->Toolbars-->Customize...` and finally just click on it
289 !! 281 when in the :menuselection:`Compose` dialog.
290 - "External Editor Revived" !! 282
291 !! 283 Please note that "external editor" requires that your editor must not
292 https://github.com/Frederick888/external-e !! 284 fork, or in other words, the editor must not return before closing.
293 !! 285 You may have to pass additional flags or change the settings of your
294 https://addons.thunderbird.net/en-GB/thund !! 286 editor. Most notably if you are using gvim then you must pass the -f
295 !! 287 option to gvim by putting ``/usr/bin/gvim -f`` (if the binary is in
296 It requires installing a "native messaging !! 288 ``/usr/bin``) to the text editor field in :menuselection:`external editor`
297 Please read the wiki which can be found he !! 289 settings. If you are using some other editor then please read its manual
298 https://github.com/Frederick888/external-e !! 290 to find out how to do this.
299 <<
300 - "External Editor" <<
301 <<
302 https://github.com/exteditor/exteditor <<
303 <<
304 To do this, download and install the exten <<
305 :menuselection:`compose` window, add a but <<
306 :menuselection:`View-->Toolbars-->Customiz <<
307 then just click on the new button when you <<
308 <<
309 Please note that "External Editor" require <<
310 fork, or in other words, the editor must n <<
311 You may have to pass additional flags or c <<
312 editor. Most notably if you are using gvim <<
313 option to gvim by putting ``/usr/bin/gvim <<
314 ``/usr/bin``) to the text editor field in <<
315 settings. If you are using some other edit <<
316 to find out how to do this. <<
317 291
318 To beat some sense out of the internal editor, 292 To beat some sense out of the internal editor, do this:
319 293
320 - Edit your Thunderbird config settings so tha !! 294 - Edit your Thunderbird config settings so that it won't use ``format=flowed``.
321 Go to your main window and find the button f !! 295 Go to :menuselection:`edit-->preferences-->advanced-->config editor` to bring up
322 :menuselection:`Main Menu-->Preferences-->Ge !! 296 the thunderbird's registry editor.
323 to bring up the thunderbird's registry edito <<
324 297
325 - Set ``mailnews.send_plaintext_flowed`` to !! 298 - Set ``mailnews.send_plaintext_flowed`` to ``false``
326 299
327 - Set ``mailnews.wraplength`` from ``72`` to !! 300 - Set ``mailnews.wraplength`` from ``72`` to ``0``
328 301
329 - Don't write HTML messages! Go to the main wi !! 302 - :menuselection:`View-->Message Body As-->Plain Text`
330 :menuselection:`Main Menu-->Account Settings <<
331 There you can disable the option "Compose me <<
332 303
333 - Open messages only as plain text! Go to the !! 304 - :menuselection:`View-->Character Encoding-->Unicode (UTF-8)`
334 :menuselection:`Main Menu-->View-->Message B <<
335 305
336 TkRat (GUI) 306 TkRat (GUI)
337 *********** 307 ***********
338 308
339 Works. Use "Insert file..." or external edito 309 Works. Use "Insert file..." or external editor.
340 310
341 Gmail (Web GUI) 311 Gmail (Web GUI)
342 *************** 312 ***************
343 313
344 Does not work for sending patches. 314 Does not work for sending patches.
345 315
346 Gmail web client converts tabs to spaces autom 316 Gmail web client converts tabs to spaces automatically.
347 317
348 At the same time it wraps lines every 78 chars 318 At the same time it wraps lines every 78 chars with CRLF style line breaks
349 although tab2space problem can be solved with 319 although tab2space problem can be solved with external editor.
350 320
351 Another problem is that Gmail will base64-enco 321 Another problem is that Gmail will base64-encode any message that has a
352 non-ASCII character. That includes things like 322 non-ASCII character. That includes things like European names.
353 <<
354 HacKerMaiL (TUI) <<
355 **************** <<
356 <<
357 HacKerMaiL (hkml) is a public-inbox based simp <<
358 doesn't require subscription of mailing lists. <<
359 by the DAMON maintainer and aims to support si <<
360 DAMON and general kernel subsystems. Refer to <<
361 (https://github.com/sjp38/hackermail/blob/mast <<
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.