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 insert file and 141 :menuselection:`insert file` and choose your p !! 136 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 properties, and 158 and highlight :menuselection:`Suggest automati !! 153 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. There is no option currently to save the email 165 you will have to chmod them to make them group !! 160 when you are actually viewing it in its own window -- there has been a request 166 them elsewhere. !! 161 filed at kmail's bugzilla and hopefully this will be addressed. Emails are >> 162 saved as read-write for user only so you will have to chmod them to make them >> 163 group and world readable if you copy them elsewhere. 167 164 168 Lotus Notes (GUI) 165 Lotus Notes (GUI) 169 ***************** 166 ***************** 170 167 171 Run away from it. 168 Run away from it. 172 169 173 IBM Verse (Web GUI) 170 IBM Verse (Web GUI) 174 ******************* 171 ******************* 175 172 176 See Lotus Notes. 173 See Lotus Notes. 177 174 178 Mutt (TUI) 175 Mutt (TUI) 179 ********** 176 ********** 180 177 181 Plenty of Linux developers use ``mutt``, so it 178 Plenty of Linux developers use ``mutt``, so it must work pretty well. 182 179 183 Mutt doesn't come with an editor, so whatever 180 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 181 used in a way that there are no automatic linebreaks. Most editors have 185 an :menuselection:`insert file` option that in 182 an :menuselection:`insert file` option that inserts the contents of a file 186 unaltered. 183 unaltered. 187 184 188 To use ``vim`` with mutt:: 185 To use ``vim`` with mutt:: 189 186 190 set editor="vi" 187 set editor="vi" 191 188 192 If using xclip, type the command:: 189 If using xclip, type the command:: 193 190 194 :set paste 191 :set paste 195 192 196 before middle button or shift-insert or use:: 193 before middle button or shift-insert or use:: 197 194 198 :r filename 195 :r filename 199 196 200 if you want to include the patch inline. 197 if you want to include the patch inline. 201 (a)ttach works fine without ``set paste``. 198 (a)ttach works fine without ``set paste``. 202 199 203 You can also generate patches with ``git forma 200 You can also generate patches with ``git format-patch`` and then use Mutt 204 to send them:: 201 to send them:: 205 202 206 $ mutt -H 0001-some-bug-fix.patch 203 $ mutt -H 0001-some-bug-fix.patch 207 204 208 Config options: 205 Config options: 209 206 210 It should work with default settings. 207 It should work with default settings. 211 However, it's a good idea to set the ``send_ch 208 However, it's a good idea to set the ``send_charset`` to:: 212 209 213 set send_charset="us-ascii:utf-8" 210 set send_charset="us-ascii:utf-8" 214 211 215 Mutt is highly customizable. Here is a minimum 212 Mutt is highly customizable. Here is a minimum configuration to start 216 using Mutt to send patches through Gmail:: 213 using Mutt to send patches through Gmail:: 217 214 218 # .muttrc 215 # .muttrc 219 # ================ IMAP ================== !! 216 # ================ IMAP ==================== 220 set imap_user = 'yourusername@gmail.com' 217 set imap_user = 'yourusername@gmail.com' 221 set imap_pass = 'yourpassword' 218 set imap_pass = 'yourpassword' 222 set spoolfile = imaps://imap.gmail.com/INBOX 219 set spoolfile = imaps://imap.gmail.com/INBOX 223 set folder = imaps://imap.gmail.com/ 220 set folder = imaps://imap.gmail.com/ 224 set record="imaps://imap.gmail.com/[Gmail]/S 221 set record="imaps://imap.gmail.com/[Gmail]/Sent Mail" 225 set postponed="imaps://imap.gmail.com/[Gmail 222 set postponed="imaps://imap.gmail.com/[Gmail]/Drafts" 226 set mbox="imaps://imap.gmail.com/[Gmail]/All 223 set mbox="imaps://imap.gmail.com/[Gmail]/All Mail" 227 224 228 # ================ SMTP ================== 225 # ================ SMTP ==================== 229 set smtp_url = "smtp://username@smtp.gmail.c 226 set smtp_url = "smtp://username@smtp.gmail.com:587/" 230 set smtp_pass = $imap_pass 227 set smtp_pass = $imap_pass 231 set ssl_force_tls = yes # Require encrypted 228 set ssl_force_tls = yes # Require encrypted connection 232 229 233 # ================ Composition =========== 230 # ================ Composition ==================== 234 set editor = `echo \$EDITOR` 231 set editor = `echo \$EDITOR` 235 set edit_headers = yes # See the headers wh 232 set edit_headers = yes # See the headers when editing 236 set charset = UTF-8 # value of $LANG; al 233 set charset = UTF-8 # value of $LANG; also fallback for send_charset 237 # Sender, email address, and sign-off line m 234 # Sender, email address, and sign-off line must match 238 unset use_domain # because joe@localh 235 unset use_domain # because joe@localhost is just embarrassing 239 set realname = "YOUR NAME" 236 set realname = "YOUR NAME" 240 set from = "username@gmail.com" 237 set from = "username@gmail.com" 241 set use_from = yes 238 set use_from = yes 242 239 243 The Mutt docs have lots more information: 240 The Mutt docs have lots more information: 244 241 245 https://gitlab.com/muttmua/mutt/-/wikis/Us !! 242 http://dev.mutt.org/trac/wiki/UseCases/Gmail 246 243 247 http://www.mutt.org/doc/manual/ !! 244 http://dev.mutt.org/doc/manual.html 248 245 249 Pine (TUI) 246 Pine (TUI) 250 ********** 247 ********** 251 248 252 Pine has had some whitespace truncation issues 249 Pine has had some whitespace truncation issues in the past, but these 253 should all be fixed now. 250 should all be fixed now. 254 251 255 Use alpine (pine's successor) if you can. 252 Use alpine (pine's successor) if you can. 256 253 257 Config options: 254 Config options: 258 255 259 - ``quell-flowed-text`` is needed for recent v 256 - ``quell-flowed-text`` is needed for recent versions 260 - the ``no-strip-whitespace-before-send`` opti 257 - the ``no-strip-whitespace-before-send`` option is needed 261 258 262 259 263 Sylpheed (GUI) 260 Sylpheed (GUI) 264 ************** 261 ************** 265 262 266 - Works well for inlining text (or using attac 263 - Works well for inlining text (or using attachments). 267 - Allows use of an external editor. 264 - Allows use of an external editor. 268 - Is slow on large folders. 265 - Is slow on large folders. 269 - Won't do TLS SMTP auth over a non-SSL connec 266 - Won't do TLS SMTP auth over a non-SSL connection. 270 - Has a helpful ruler bar in the compose windo 267 - Has a helpful ruler bar in the compose window. 271 - Adding addresses to address book doesn't und 268 - Adding addresses to address book doesn't understand the display name 272 properly. 269 properly. 273 270 274 Thunderbird (GUI) 271 Thunderbird (GUI) 275 ***************** 272 ***************** 276 273 277 Thunderbird is an Outlook clone that likes to 274 Thunderbird is an Outlook clone that likes to mangle text, but there are ways 278 to coerce it into behaving. 275 to coerce it into behaving. 279 276 280 After doing the modifications, this includes i << 281 you need to restart Thunderbird. << 282 << 283 - Allow use of an external editor: 277 - Allow use of an external editor: 284 !! 278 The easiest thing to do with Thunderbird and patches is to use an 285 The easiest thing to do with Thunderbird and !! 279 "external editor" extension and then just use your favorite ``$EDITOR`` 286 which open your favorite external editor. !! 280 for reading/merging patches into the body text. To do this, download 287 !! 281 and install the extension, then add a button for it using 288 Here are some example extensions which are c !! 282 :menuselection:`View-->Toolbars-->Customize...` and finally just click on it 289 !! 283 when in the :menuselection:`Compose` dialog. 290 - "External Editor Revived" !! 284 291 !! 285 Please note that "external editor" requires that your editor must not 292 https://github.com/Frederick888/external-e !! 286 fork, or in other words, the editor must not return before closing. 293 !! 287 You may have to pass additional flags or change the settings of your 294 https://addons.thunderbird.net/en-GB/thund !! 288 editor. Most notably if you are using gvim then you must pass the -f 295 !! 289 option to gvim by putting ``/usr/bin/gvim -f`` (if the binary is in 296 It requires installing a "native messaging !! 290 ``/usr/bin``) to the text editor field in :menuselection:`external editor` 297 Please read the wiki which can be found he !! 291 settings. If you are using some other editor then please read its manual 298 https://github.com/Frederick888/external-e !! 292 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 293 318 To beat some sense out of the internal editor, 294 To beat some sense out of the internal editor, do this: 319 295 320 - Edit your Thunderbird config settings so tha !! 296 - Edit your Thunderbird config settings so that it won't use ``format=flowed``. 321 Go to your main window and find the button f !! 297 Go to :menuselection:`edit-->preferences-->advanced-->config editor` to bring up 322 :menuselection:`Main Menu-->Preferences-->Ge !! 298 the thunderbird's registry editor. 323 to bring up the thunderbird's registry edito << 324 299 325 - Set ``mailnews.send_plaintext_flowed`` to !! 300 - Set ``mailnews.send_plaintext_flowed`` to ``false`` 326 301 327 - Set ``mailnews.wraplength`` from ``72`` to !! 302 - Set ``mailnews.wraplength`` from ``72`` to ``0`` 328 303 329 - Don't write HTML messages! Go to the main wi !! 304 - :menuselection:`View-->Message Body As-->Plain Text` 330 :menuselection:`Main Menu-->Account Settings << 331 There you can disable the option "Compose me << 332 305 333 - Open messages only as plain text! Go to the !! 306 - :menuselection:`View-->Character Encoding-->Unicode (UTF-8)` 334 :menuselection:`Main Menu-->View-->Message B << 335 307 336 TkRat (GUI) 308 TkRat (GUI) 337 *********** 309 *********** 338 310 339 Works. Use "Insert file..." or external edito 311 Works. Use "Insert file..." or external editor. 340 312 341 Gmail (Web GUI) 313 Gmail (Web GUI) 342 *************** 314 *************** 343 315 344 Does not work for sending patches. 316 Does not work for sending patches. 345 317 346 Gmail web client converts tabs to spaces autom 318 Gmail web client converts tabs to spaces automatically. 347 319 348 At the same time it wraps lines every 78 chars 320 At the same time it wraps lines every 78 chars with CRLF style line breaks 349 although tab2space problem can be solved with 321 although tab2space problem can be solved with external editor. 350 322 351 Another problem is that Gmail will base64-enco 323 Another problem is that Gmail will base64-encode any message that has a 352 non-ASCII character. That includes things like 324 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.