Blame view
Documentation/email-clients.txt
10.8 KB
06ad63671 Documentation/ema... |
1 |
.. _email_clients: |
a6cd6bf9f doc: about email ... |
2 |
Email clients info for Linux |
06ad63671 Documentation/ema... |
3 |
============================ |
a6cd6bf9f doc: about email ... |
4 |
|
7d19e91b5 Documentation: ad... |
5 |
Git |
06ad63671 Documentation/ema... |
6 7 8 |
--- These days most developers use ``git send-email`` instead of regular |
7d19e91b5 Documentation: ad... |
9 |
email clients. The man page for this is quite good. On the receiving |
06ad63671 Documentation/ema... |
10 |
end, maintainers use ``git am`` to apply the patches. |
7d19e91b5 Documentation: ad... |
11 |
|
06ad63671 Documentation/ema... |
12 13 14 |
If you are new to ``git`` then send your first patch to yourself. Save it as raw text including all the headers. Run ``git am raw_email.txt`` and then review the changelog with ``git log``. When that works then send |
7d19e91b5 Documentation: ad... |
15 |
the patch to the appropriate mailing list(s). |
a6cd6bf9f doc: about email ... |
16 |
General Preferences |
06ad63671 Documentation/ema... |
17 |
------------------- |
a6cd6bf9f doc: about email ... |
18 19 20 |
Patches for the Linux kernel are submitted via email, preferably as inline text in the body of the email. Some maintainers accept attachments, but then the attachments should have content-type |
06ad63671 Documentation/ema... |
21 |
``text/plain``. However, attachments are generally frowned upon because |
a6cd6bf9f doc: about email ... |
22 23 24 25 26 27 |
it makes quoting portions of the patch more difficult in the patch review process. Email clients that are used for Linux kernel patches should send the patch text untouched. For example, they should not modify or delete tabs or spaces, even at the beginning or end of lines. |
06ad63671 Documentation/ema... |
28 |
Don't send patches with ``format=flowed``. This can cause unexpected |
a6cd6bf9f doc: about email ... |
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
and unwanted line breaks. Don't let your email client do automatic word wrapping for you. This can also corrupt your patch. Email clients should not modify the character set encoding of the text. Emailed patches should be in ASCII or UTF-8 encoding only. If you configure your email client to send emails with UTF-8 encoding, you avoid some possible charset problems. Email clients should generate and maintain References: or In-Reply-To: headers so that mail threading is not broken. Copy-and-paste (or cut-and-paste) usually does not work for patches because tabs are converted to spaces. Using xclipboard, xclip, and/or xcutsel may work, but it's best to test this for yourself or just avoid copy-and-paste. Don't use PGP/GPG signatures in mail that contains patches. This breaks many scripts that read and apply the patches. (This should be fixable.) It's a good idea to send a patch to yourself, save the received message, and successfully apply it with 'patch' before sending patches to Linux mailing lists. Some email client (MUA) hints |
06ad63671 Documentation/ema... |
57 |
----------------------------- |
a6cd6bf9f doc: about email ... |
58 59 60 |
Here are some specific MUA configuration hints for editing and sending patches for the Linux kernel. These are not meant to be complete software package configuration summaries. |
06ad63671 Documentation/ema... |
61 |
|
a6cd6bf9f doc: about email ... |
62 |
Legend: |
a6cd6bf9f doc: about email ... |
63 |
|
06ad63671 Documentation/ema... |
64 65 |
- TUI = text-based user interface - GUI = graphical user interface |
a6cd6bf9f doc: about email ... |
66 |
Alpine (TUI) |
06ad63671 Documentation/ema... |
67 |
************ |
a6cd6bf9f doc: about email ... |
68 69 |
Config options: |
a6cd6bf9f doc: about email ... |
70 |
|
06ad63671 Documentation/ema... |
71 72 73 74 |
In the :menuselection:`Sending Preferences` section: - :menuselection:`Do Not Send Flowed Text` must be ``enabled`` - :menuselection:`Strip Whitespace Before Sending` must be ``disabled`` |
a6cd6bf9f doc: about email ... |
75 76 |
When composing the message, the cursor should be placed where the patch |
06ad63671 Documentation/ema... |
77 |
should appear, and then pressing :kbd:`CTRL-R` let you specify the patch file |
a6cd6bf9f doc: about email ... |
78 |
to insert into the message. |
04a3302b5 Documentation/ema... |
79 |
Claws Mail (GUI) |
06ad63671 Documentation/ema... |
80 |
**************** |
04a3302b5 Documentation/ema... |
81 82 |
Works. Some people use this successfully for patches. |
06ad63671 Documentation/ema... |
83 84 |
To insert a patch use :menuselection:`Message-->Insert` File (:kbd:`CTRL-I`) or an external editor. |
04a3302b5 Documentation/ema... |
85 86 |
If the inserted patch has to be edited in the Claws composition window |
06ad63671 Documentation/ema... |
87 88 |
"Auto wrapping" in :menuselection:`Configuration-->Preferences-->Compose-->Wrapping` should be |
04a3302b5 Documentation/ema... |
89 |
disabled. |
a6cd6bf9f doc: about email ... |
90 |
Evolution (GUI) |
06ad63671 Documentation/ema... |
91 |
*************** |
a6cd6bf9f doc: about email ... |
92 93 94 95 |
Some people use this successfully for patches. When composing mail select: Preformat |
06ad63671 Documentation/ema... |
96 |
from :menuselection:`Format-->Paragraph Style-->Preformatted` (:kbd:`CTRL-7`) |
a6cd6bf9f doc: about email ... |
97 98 99 |
or the toolbar Then use: |
06ad63671 Documentation/ema... |
100 |
:menuselection:`Insert-->Text File...` (:kbd:`ALT-N x`) |
a6cd6bf9f doc: about email ... |
101 |
to insert the patch. |
06ad63671 Documentation/ema... |
102 103 |
You can also ``diff -Nru old.c new.c | xclip``, select :menuselection:`Preformat`, then paste with the middle button. |
a6cd6bf9f doc: about email ... |
104 |
|
a6cd6bf9f doc: about email ... |
105 |
Kmail (GUI) |
06ad63671 Documentation/ema... |
106 |
*********** |
a6cd6bf9f doc: about email ... |
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
Some people use Kmail successfully for patches. The default setting of not composing in HTML is appropriate; do not enable it. When composing an email, under options, uncheck "word wrap". The only disadvantage is any text you type in the email will not be word-wrapped so you will have to manually word wrap text before the patch. The easiest way around this is to compose your email with word wrap enabled, then save it as a draft. Once you pull it up again from your drafts it is now hard word-wrapped and you can uncheck "word wrap" without losing the existing wrapping. At the bottom of your email, put the commonly-used patch delimiter before |
06ad63671 Documentation/ema... |
122 |
inserting your patch: three hyphens (``---``). |
a6cd6bf9f doc: about email ... |
123 |
|
06ad63671 Documentation/ema... |
124 125 |
Then from the :menuselection:`Message` menu item, select insert file and choose your patch. |
a6cd6bf9f doc: about email ... |
126 |
As an added bonus you can customise the message creation toolbar menu |
06ad63671 Documentation/ema... |
127 |
and put the :menuselection:`insert file` icon there. |
a6cd6bf9f doc: about email ... |
128 |
|
d9a6ed1fa doc: fix some typos |
129 |
Make the composer window wide enough so that no lines wrap. As of |
5d3687d7f Documentation/ema... |
130 131 132 133 134 |
KMail 1.13.5 (KDE 4.5.4), KMail will apply word wrapping when sending the email if the lines wrap in the composer window. Having word wrapping disabled in the Options menu isn't enough. Thus, if your patch has very long lines, you must make the composer window very wide before sending the email. See: https://bugs.kde.org/show_bug.cgi?id=174034 |
a6cd6bf9f doc: about email ... |
135 136 137 138 139 140 |
You can safely GPG sign attachments, but inlined text is preferred for patches so do not GPG sign them. Signing patches that have been inserted as inlined text will make them tricky to extract from their 7-bit encoding. If you absolutely must send patches as attachments instead of inlining them as text, right click on the attachment and select properties, and |
06ad63671 Documentation/ema... |
141 142 |
highlight :menuselection:`Suggest automatic display` to make the attachment inlined to make it more viewable. |
a6cd6bf9f doc: about email ... |
143 144 145 |
When saving patches that are sent as inlined text, select the email that contains the patch from the message list pane, right click and select |
06ad63671 Documentation/ema... |
146 147 148 149 150 |
:menuselection:`save as`. You can use the whole email unmodified as a patch if it was properly composed. There is no option currently to save the email when you are actually viewing it in its own window -- there has been a request filed at kmail's bugzilla and hopefully this will be addressed. Emails are saved as read-write for user only so you will have to chmod them to make them |
a6cd6bf9f doc: about email ... |
151 |
group and world readable if you copy them elsewhere. |
a6cd6bf9f doc: about email ... |
152 |
Lotus Notes (GUI) |
06ad63671 Documentation/ema... |
153 |
***************** |
a6cd6bf9f doc: about email ... |
154 155 |
Run away from it. |
a6cd6bf9f doc: about email ... |
156 |
Mutt (TUI) |
06ad63671 Documentation/ema... |
157 |
********** |
a6cd6bf9f doc: about email ... |
158 |
|
06ad63671 Documentation/ema... |
159 |
Plenty of Linux developers use ``mutt``, so it must work pretty well. |
a6cd6bf9f doc: about email ... |
160 161 162 |
Mutt doesn't come with an editor, so whatever editor you use should be used in a way that there are no automatic linebreaks. Most editors have |
06ad63671 Documentation/ema... |
163 164 165 166 |
an :menuselection:`insert file` option that inserts the contents of a file unaltered. To use ``vim`` with mutt:: |
a6cd6bf9f doc: about email ... |
167 |
|
a6cd6bf9f doc: about email ... |
168 |
set editor="vi" |
06ad63671 Documentation/ema... |
169 |
If using xclip, type the command:: |
a6cd6bf9f doc: about email ... |
170 |
:set paste |
06ad63671 Documentation/ema... |
171 172 |
before middle button or shift-insert or use:: |
a6cd6bf9f doc: about email ... |
173 174 175 |
:r filename if you want to include the patch inline. |
06ad63671 Documentation/ema... |
176 177 178 179 |
(a)ttach works fine without ``set paste``. You can also generate patches with ``git format-patch`` and then use Mutt to send them:: |
a6cd6bf9f doc: about email ... |
180 |
|
803cfe263 Documentation: Ad... |
181 |
$ mutt -H 0001-some-bug-fix.patch |
a6cd6bf9f doc: about email ... |
182 |
Config options: |
06ad63671 Documentation/ema... |
183 |
|
a6cd6bf9f doc: about email ... |
184 |
It should work with default settings. |
06ad63671 Documentation/ema... |
185 |
However, it's a good idea to set the ``send_charset`` to:: |
a6cd6bf9f doc: about email ... |
186 |
set send_charset="us-ascii:utf-8" |
91633a6dc Documentation: Ad... |
187 |
Mutt is highly customizable. Here is a minimum configuration to start |
06ad63671 Documentation/ema... |
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 |
using Mutt to send patches through Gmail:: # .muttrc # ================ IMAP ==================== set imap_user = 'yourusername@gmail.com' set imap_pass = 'yourpassword' set spoolfile = imaps://imap.gmail.com/INBOX set folder = imaps://imap.gmail.com/ set record="imaps://imap.gmail.com/[Gmail]/Sent Mail" set postponed="imaps://imap.gmail.com/[Gmail]/Drafts" set mbox="imaps://imap.gmail.com/[Gmail]/All Mail" # ================ SMTP ==================== set smtp_url = "smtp://username@smtp.gmail.com:587/" set smtp_pass = $imap_pass set ssl_force_tls = yes # Require encrypted connection # ================ Composition ==================== set editor = `echo \$EDITOR` set edit_headers = yes # See the headers when editing set charset = UTF-8 # value of $LANG; also fallback for send_charset # Sender, email address, and sign-off line must match unset use_domain # because joe@localhost is just embarrassing set realname = "YOUR NAME" set from = "username@gmail.com" set use_from = yes |
91633a6dc Documentation: Ad... |
214 215 |
The Mutt docs have lots more information: |
06ad63671 Documentation/ema... |
216 |
|
91633a6dc Documentation: Ad... |
217 |
http://dev.mutt.org/trac/wiki/UseCases/Gmail |
06ad63671 Documentation/ema... |
218 |
|
91633a6dc Documentation: Ad... |
219 |
http://dev.mutt.org/doc/manual.html |
a6cd6bf9f doc: about email ... |
220 |
Pine (TUI) |
06ad63671 Documentation/ema... |
221 |
********** |
a6cd6bf9f doc: about email ... |
222 223 224 225 226 227 228 |
Pine has had some whitespace truncation issues in the past, but these should all be fixed now. Use alpine (pine's successor) if you can. Config options: |
06ad63671 Documentation/ema... |
229 230 231 |
- ``quell-flowed-text`` is needed for recent versions - the ``no-strip-whitespace-before-send`` option is needed |
a6cd6bf9f doc: about email ... |
232 |
|
a6cd6bf9f doc: about email ... |
233 |
Sylpheed (GUI) |
06ad63671 Documentation/ema... |
234 |
************** |
a6cd6bf9f doc: about email ... |
235 236 237 |
- Works well for inlining text (or using attachments). - Allows use of an external editor. |
a6cd6bf9f doc: about email ... |
238 239 240 241 242 |
- Is slow on large folders. - Won't do TLS SMTP auth over a non-SSL connection. - Has a helpful ruler bar in the compose window. - Adding addresses to address book doesn't understand the display name properly. |
a6cd6bf9f doc: about email ... |
243 |
Thunderbird (GUI) |
06ad63671 Documentation/ema... |
244 |
***************** |
a6cd6bf9f doc: about email ... |
245 |
|
e0e34e977 Documentation/ema... |
246 247 |
Thunderbird is an Outlook clone that likes to mangle text, but there are ways to coerce it into behaving. |
a6cd6bf9f doc: about email ... |
248 |
|
d50ca0786 Documentation/ema... |
249 |
- Allow use of an external editor: |
a6cd6bf9f doc: about email ... |
250 |
The easiest thing to do with Thunderbird and patches is to use an |
06ad63671 Documentation/ema... |
251 |
"external editor" extension and then just use your favorite ``$EDITOR`` |
a6cd6bf9f doc: about email ... |
252 253 |
for reading/merging patches into the body text. To do this, download and install the extension, then add a button for it using |
06ad63671 Documentation/ema... |
254 255 |
:menuselection:`View-->Toolbars-->Customize...` and finally just click on it when in the :menuselection:`Compose` dialog. |
a6cd6bf9f doc: about email ... |
256 |
|
d50ca0786 Documentation/ema... |
257 |
Please note that "external editor" requires that your editor must not |
a02b4fc29 Documentation/ema... |
258 |
fork, or in other words, the editor must not return before closing. |
d50ca0786 Documentation/ema... |
259 260 |
You may have to pass additional flags or change the settings of your editor. Most notably if you are using gvim then you must pass the -f |
06ad63671 Documentation/ema... |
261 262 263 264 |
option to gvim by putting ``/usr/bin/gvim -f`` (if the binary is in ``/usr/bin``) to the text editor field in :menuselection:`external editor` settings. If you are using some other editor then please read its manual to find out how to do this. |
d50ca0786 Documentation/ema... |
265 |
|
e0e34e977 Documentation/ema... |
266 |
To beat some sense out of the internal editor, do this: |
06ad63671 Documentation/ema... |
267 268 269 |
- Edit your Thunderbird config settings so that it won't use ``format=flowed``. Go to :menuselection:`edit-->preferences-->advanced-->config editor` to bring up the thunderbird's registry editor. |
e0e34e977 Documentation/ema... |
270 |
|
06ad63671 Documentation/ema... |
271 |
- Set ``mailnews.send_plaintext_flowed`` to ``false`` |
6989b5bb2 Documentation: em... |
272 |
|
06ad63671 Documentation/ema... |
273 |
- Set ``mailnews.wraplength`` from ``72`` to ``0`` |
6989b5bb2 Documentation: em... |
274 |
|
06ad63671 Documentation/ema... |
275 |
- :menuselection:`View-->Message Body As-->Plain Text` |
e0e34e977 Documentation/ema... |
276 |
|
06ad63671 Documentation/ema... |
277 |
- :menuselection:`View-->Character Encoding-->Unicode (UTF-8)` |
e0e34e977 Documentation/ema... |
278 |
|
a6cd6bf9f doc: about email ... |
279 |
TkRat (GUI) |
06ad63671 Documentation/ema... |
280 |
*********** |
a6cd6bf9f doc: about email ... |
281 282 |
Works. Use "Insert file..." or external editor. |
1b6bcdbe7 Documentation/ema... |
283 |
Gmail (Web GUI) |
06ad63671 Documentation/ema... |
284 |
*************** |
1b6bcdbe7 Documentation/ema... |
285 |
|
5ce9f07bf Documentation/ema... |
286 287 288 289 290 291 292 293 294 |
Does not work for sending patches. Gmail web client converts tabs to spaces automatically. At the same time it wraps lines every 78 chars with CRLF style line breaks although tab2space problem can be solved with external editor. Another problem is that Gmail will base64-encode any message that has a non-ASCII character. That includes things like European names. |