Commit | Line | Data |
---|---|---|
6bf7aab6 | 1 | @c This is part of the Emacs manual. |
b65d8176 | 2 | @c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 2001, 2002, |
8838673e GM |
3 | @c 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 |
4 | @c Free Software Foundation, Inc. | |
6bf7aab6 DL |
5 | @c See file emacs.texi for copying conditions. |
6 | @node Rmail, Dired, Sending Mail, Top | |
7 | @chapter Reading Mail with Rmail | |
8 | @cindex Rmail | |
9 | @cindex reading mail | |
10 | @findex rmail | |
11 | @findex rmail-mode | |
12 | @vindex rmail-mode-hook | |
13 | ||
9dd617a6 | 14 | Rmail is an Emacs subsystem for reading and disposing of mail that |
49b5c0e8 | 15 | you receive. Rmail stores mail messages in files called Rmail files. |
9d5de6f8 | 16 | Reading the messages in an Rmail file is done in a special major mode, |
49b5c0e8 | 17 | Rmail mode, which redefines most letters to run commands for managing mail. |
6bf7aab6 DL |
18 | @menu |
19 | * Basic: Rmail Basics. Basic concepts of Rmail, and simple use. | |
20 | * Scroll: Rmail Scrolling. Scrolling through a message. | |
21 | * Motion: Rmail Motion. Moving to another message. | |
22 | * Deletion: Rmail Deletion. Deleting and expunging messages. | |
23 | * Inbox: Rmail Inbox. How mail gets into the Rmail file. | |
24 | * Files: Rmail Files. Using multiple Rmail files. | |
8838673e | 25 | * Output: Rmail Output. Copying messages out to files. |
6bf7aab6 DL |
26 | * Labels: Rmail Labels. Classifying messages by labeling them. |
27 | * Attrs: Rmail Attributes. Certain standard labels, called attributes. | |
28 | * Reply: Rmail Reply. Sending replies to messages you are viewing. | |
29 | * Summary: Rmail Summary. Summaries show brief info on many messages. | |
30 | * Sort: Rmail Sorting. Sorting messages in Rmail. | |
31 | * Display: Rmail Display. How Rmail displays a message; customization. | |
358f71fd | 32 | * Coding: Rmail Coding. How Rmail handles decoding character sets. |
6bf7aab6 DL |
33 | * Editing: Rmail Editing. Editing message text and headers in Rmail. |
34 | * Digest: Rmail Digest. Extracting the messages from a digest message. | |
8838673e | 35 | * Rot13: Rmail Rot13. Reading messages encoded in the rot13 code. |
ea20444b | 36 | * Movemail:: More details of fetching new mail. |
79fc530e GM |
37 | * Remote Mailboxes:: Retrieving mail from remote mailboxes. |
38 | * Other Mailbox Formats:: Retrieving mail from local mailboxes in | |
39 | various formats. | |
6bf7aab6 DL |
40 | @end menu |
41 | ||
42 | @node Rmail Basics | |
43 | @section Basic Concepts of Rmail | |
44 | ||
45 | @cindex primary Rmail file | |
46 | @vindex rmail-file-name | |
47 | Using Rmail in the simplest fashion, you have one Rmail file | |
48 | @file{~/RMAIL} in which all of your mail is saved. It is called your | |
49 | @dfn{primary Rmail file}. The command @kbd{M-x rmail} reads your primary | |
50 | Rmail file, merges new mail in from your inboxes, displays the first | |
51 | message you haven't read yet, and lets you begin reading. The variable | |
52 | @code{rmail-file-name} specifies the name of the primary Rmail file. | |
53 | ||
5f50b807 | 54 | Rmail displays only one message in the Rmail file at a time. |
6bf7aab6 DL |
55 | The message that is shown is called the @dfn{current message}. Rmail |
56 | mode's special commands can do such things as delete the current | |
57 | message, copy it into another file, send a reply, or move to another | |
58 | message. You can also create multiple Rmail files and use Rmail to move | |
59 | messages between them. | |
60 | ||
61 | @cindex message number | |
62 | Within the Rmail file, messages are normally arranged sequentially in | |
04242bdc GM |
63 | order of receipt; you can specify other ways to sort them (@pxref{Rmail |
64 | Sorting}). Messages are identified by consecutive integers which are | |
65 | their @dfn{message numbers}. The number of the current message is | |
66 | displayed in Rmail's mode line, followed by the total number of messages | |
67 | in the file. You can move to a message by specifying its message number | |
68 | with the @kbd{j} key (@pxref{Rmail Motion}). | |
6bf7aab6 DL |
69 | |
70 | @kindex s @r{(Rmail)} | |
00aa62e5 | 71 | @findex rmail-expunge-and-save |
6bf7aab6 | 72 | Following the usual conventions of Emacs, changes in an Rmail file |
9dd617a6 | 73 | become permanent only when you save the file. You can save it with |
00aa62e5 RS |
74 | @kbd{s} (@code{rmail-expunge-and-save}), which also expunges deleted |
75 | messages from the file first (@pxref{Rmail Deletion}). To save the | |
76 | file without expunging, use @kbd{C-x C-s}. Rmail also saves the Rmail | |
77 | file after merging new mail from an inbox file (@pxref{Rmail Inbox}). | |
6bf7aab6 DL |
78 | |
79 | @kindex q @r{(Rmail)} | |
80 | @findex rmail-quit | |
81 | @kindex b @r{(Rmail)} | |
82 | @findex rmail-bury | |
32823124 LT |
83 | You can exit Rmail with @kbd{q} (@code{rmail-quit}); this expunges |
84 | and saves the Rmail file, then buries the Rmail buffer as well as its | |
d190d8c8 | 85 | summary buffer, if present (@pxref{Rmail Summary}). But there is no |
32823124 | 86 | need to ``exit'' formally. If you switch from Rmail to editing in |
9dd617a6 RS |
87 | other buffers, and never switch back, you have exited. Just make sure |
88 | to save the Rmail file eventually (like any other file you have | |
89 | changed). @kbd{C-x s} is a suitable way to do this (@pxref{Save | |
90 | Commands}). The Rmail command @kbd{b}, @code{rmail-bury}, buries the | |
91 | Rmail buffer and its summary buffer without expunging and saving the | |
92 | Rmail file. | |
6bf7aab6 DL |
93 | |
94 | @node Rmail Scrolling | |
95 | @section Scrolling Within a Message | |
96 | ||
97 | When Rmail displays a message that does not fit on the screen, you | |
177c0ea7 | 98 | must scroll through it to read the rest. You could do this with |
6bf7aab6 | 99 | @kbd{C-v}, @kbd{M-v} and @kbd{M-<}, but in Rmail scrolling is so |
9dd617a6 | 100 | frequent that it deserves to be easier. |
6bf7aab6 DL |
101 | |
102 | @table @kbd | |
103 | @item @key{SPC} | |
104 | Scroll forward (@code{scroll-up}). | |
105 | @item @key{DEL} | |
106 | Scroll backward (@code{scroll-down}). | |
107 | @item . | |
108 | Scroll to start of message (@code{rmail-beginning-of-message}). | |
a941a443 CY |
109 | @item / |
110 | Scroll to end of message (@code{rmail-end-of-message}). | |
6bf7aab6 DL |
111 | @end table |
112 | ||
113 | @kindex SPC @r{(Rmail)} | |
114 | @kindex DEL @r{(Rmail)} | |
115 | Since the most common thing to do while reading a message is to scroll | |
116 | through it by screenfuls, Rmail makes @key{SPC} and @key{DEL} synonyms of | |
117 | @kbd{C-v} (@code{scroll-up}) and @kbd{M-v} (@code{scroll-down}) | |
118 | ||
119 | @kindex . @r{(Rmail)} | |
a941a443 | 120 | @kindex / @r{(Rmail)} |
6bf7aab6 | 121 | @findex rmail-beginning-of-message |
a941a443 | 122 | @findex rmail-end-of-message |
6bf7aab6 DL |
123 | The command @kbd{.} (@code{rmail-beginning-of-message}) scrolls back to the |
124 | beginning of the selected message. This is not quite the same as @kbd{M-<}: | |
125 | for one thing, it does not set the mark; for another, it resets the buffer | |
04242bdc | 126 | boundaries of the current message if you have changed them. Similarly, |
a941a443 CY |
127 | the command @kbd{/} (@code{rmail-end-of-message}) scrolls forward to the end |
128 | of the selected message. | |
9d5de6f8 GM |
129 | @c The comment about buffer boundaries is still true in mbox Rmail, if |
130 | @c less likely to be relevant. | |
6bf7aab6 DL |
131 | |
132 | @node Rmail Motion | |
133 | @section Moving Among Messages | |
134 | ||
135 | The most basic thing to do with a message is to read it. The way to | |
136 | do this in Rmail is to make the message current. The usual practice is | |
137 | to move sequentially through the file, since this is the order of | |
138 | receipt of messages. When you enter Rmail, you are positioned at the | |
139 | first message that you have not yet made current (that is, the first one | |
140 | that has the @samp{unseen} attribute; @pxref{Rmail Attributes}). Move | |
b8f86df3 | 141 | forward to see the other new messages; move backward to re-examine old |
6bf7aab6 DL |
142 | messages. |
143 | ||
144 | @table @kbd | |
145 | @item n | |
146 | Move to the next nondeleted message, skipping any intervening deleted | |
147 | messages (@code{rmail-next-undeleted-message}). | |
148 | @item p | |
149 | Move to the previous nondeleted message | |
150 | (@code{rmail-previous-undeleted-message}). | |
151 | @item M-n | |
152 | Move to the next message, including deleted messages | |
153 | (@code{rmail-next-message}). | |
154 | @item M-p | |
155 | Move to the previous message, including deleted messages | |
156 | (@code{rmail-previous-message}). | |
505e70c3 GM |
157 | @item C-c C-n |
158 | Move to the next message with the same subject as the current one | |
159 | (@code{rmail-next-same-subject}). | |
160 | @item C-c C-p | |
161 | Move to the previous message with the same subject as the current one | |
162 | (@code{rmail-previous-same-subject}). | |
6bf7aab6 DL |
163 | @item j |
164 | Move to the first message. With argument @var{n}, move to | |
165 | message number @var{n} (@code{rmail-show-message}). | |
166 | @item > | |
167 | Move to the last message (@code{rmail-last-message}). | |
168 | @item < | |
169 | Move to the first message (@code{rmail-first-message}). | |
170 | ||
171 | @item M-s @var{regexp} @key{RET} | |
172 | Move to the next message containing a match for @var{regexp} | |
173 | (@code{rmail-search}). | |
174 | ||
175 | @item - M-s @var{regexp} @key{RET} | |
176 | Move to the previous message containing a match for @var{regexp}. | |
177 | @end table | |
178 | ||
179 | @kindex n @r{(Rmail)} | |
180 | @kindex p @r{(Rmail)} | |
181 | @kindex M-n @r{(Rmail)} | |
182 | @kindex M-p @r{(Rmail)} | |
183 | @findex rmail-next-undeleted-message | |
184 | @findex rmail-previous-undeleted-message | |
185 | @findex rmail-next-message | |
186 | @findex rmail-previous-message | |
187 | @kbd{n} and @kbd{p} are the usual way of moving among messages in | |
188 | Rmail. They move through the messages sequentially, but skip over | |
189 | deleted messages, which is usually what you want to do. Their command | |
190 | definitions are named @code{rmail-next-undeleted-message} and | |
191 | @code{rmail-previous-undeleted-message}. If you do not want to skip | |
192 | deleted messages---for example, if you want to move to a message to | |
193 | undelete it---use the variants @kbd{M-n} and @kbd{M-p} | |
194 | (@code{rmail-next-message} and @code{rmail-previous-message}). A | |
195 | numeric argument to any of these commands serves as a repeat | |
9dd617a6 | 196 | count. |
6bf7aab6 DL |
197 | |
198 | In Rmail, you can specify a numeric argument by typing just the | |
199 | digits. You don't need to type @kbd{C-u} first. | |
200 | ||
201 | @kindex M-s @r{(Rmail)} | |
202 | @findex rmail-search | |
203 | @cindex searching in Rmail | |
204 | The @kbd{M-s} (@code{rmail-search}) command is Rmail's version of | |
205 | search. The usual incremental search command @kbd{C-s} works in Rmail, | |
206 | but it searches only within the current message. The purpose of | |
207 | @kbd{M-s} is to search for another message. It reads a regular | |
208 | expression (@pxref{Regexps}) nonincrementally, then searches starting at | |
209 | the beginning of the following message for a match. It then selects | |
210 | that message. If @var{regexp} is empty, @kbd{M-s} reuses the regexp | |
211 | used the previous time. | |
212 | ||
213 | To search backward in the file for another message, give @kbd{M-s} a | |
9d5de6f8 GM |
214 | negative argument. In Rmail you can do this with @kbd{- M-s}. This |
215 | begins searching from the end of the previous message. | |
6bf7aab6 DL |
216 | |
217 | It is also possible to search for a message based on labels. | |
218 | @xref{Rmail Labels}. | |
219 | ||
505e70c3 GM |
220 | @kindex C-c C-n @r{(Rmail)} |
221 | @kindex C-c C-p @r{(Rmail)} | |
222 | @findex rmail-next-same-subject | |
223 | @findex rmail-previous-same-subject | |
224 | The @kbd{C-c C-n} (@code{rmail-next-same-subject}) command moves to | |
225 | the next message with the same subject as the current one. A prefix | |
226 | argument serves as a repeat count. With a negative argument, this | |
227 | command moves backward, acting like @kbd{C-c C-p} | |
749c6447 | 228 | (@code{rmail-previous-same-subject}). When comparing subjects, these |
04242bdc | 229 | commands ignore the prefixes typically added to the subjects of replies. |
505e70c3 | 230 | |
6bf7aab6 DL |
231 | @kindex j @r{(Rmail)} |
232 | @kindex > @r{(Rmail)} | |
233 | @kindex < @r{(Rmail)} | |
234 | @findex rmail-show-message | |
235 | @findex rmail-last-message | |
236 | @findex rmail-first-message | |
237 | To move to a message specified by absolute message number, use @kbd{j} | |
238 | (@code{rmail-show-message}) with the message number as argument. With | |
239 | no argument, @kbd{j} selects the first message. @kbd{<} | |
240 | (@code{rmail-first-message}) also selects the first message. @kbd{>} | |
241 | (@code{rmail-last-message}) selects the last message. | |
242 | ||
243 | @node Rmail Deletion | |
244 | @section Deleting Messages | |
245 | ||
246 | @cindex deletion (Rmail) | |
247 | When you no longer need to keep a message, you can @dfn{delete} it. This | |
248 | flags it as ignorable, and some Rmail commands pretend it is no longer | |
249 | present; but it still has its place in the Rmail file, and still has its | |
250 | message number. | |
251 | ||
252 | @cindex expunging (Rmail) | |
253 | @dfn{Expunging} the Rmail file actually removes the deleted messages. | |
04242bdc GM |
254 | The remaining messages are renumbered consecutively. |
255 | @c The following is neither true (there is also unforward, sorting, | |
256 | @c etc), nor especially interesting. | |
257 | @c Expunging is the only action that changes the message number of any | |
258 | @c message, except for undigestifying (@pxref{Rmail Digest}). | |
6bf7aab6 DL |
259 | |
260 | @table @kbd | |
261 | @item d | |
262 | Delete the current message, and move to the next nondeleted message | |
263 | (@code{rmail-delete-forward}). | |
264 | @item C-d | |
265 | Delete the current message, and move to the previous nondeleted | |
266 | message (@code{rmail-delete-backward}). | |
267 | @item u | |
9d5de6f8 GM |
268 | Undelete the current message, or move back to the previous deleted |
269 | message and undelete it (@code{rmail-undelete-previous-message}). | |
6bf7aab6 DL |
270 | @item x |
271 | Expunge the Rmail file (@code{rmail-expunge}). | |
272 | @end table | |
273 | ||
274 | @kindex d @r{(Rmail)} | |
275 | @kindex C-d @r{(Rmail)} | |
276 | @findex rmail-delete-forward | |
277 | @findex rmail-delete-backward | |
278 | There are two Rmail commands for deleting messages. Both delete the | |
279 | current message and select another message. @kbd{d} | |
280 | (@code{rmail-delete-forward}) moves to the following message, skipping | |
281 | messages already deleted, while @kbd{C-d} (@code{rmail-delete-backward}) | |
282 | moves to the previous nondeleted message. If there is no nondeleted | |
3d963b67 GM |
283 | message to move to in the specified direction, the message that was just |
284 | deleted remains current. @kbd{d} with a prefix argument is equivalent | |
285 | to @kbd{C-d}. Note that the Rmail summary versions of these commands | |
286 | behave slightly differently (@pxref{Rmail Summary Edit}). | |
6bf7aab6 | 287 | |
9d5de6f8 | 288 | @c mention other hooks, eg show message hook? |
6bf7aab6 | 289 | @vindex rmail-delete-message-hook |
b8f86df3 | 290 | Whenever Rmail deletes a message, it runs the hook |
6bf7aab6 DL |
291 | @code{rmail-delete-message-hook}. When the hook functions are invoked, |
292 | the message has been marked deleted, but it is still the current message | |
293 | in the Rmail buffer. | |
294 | ||
295 | @cindex undeletion (Rmail) | |
296 | @kindex x @r{(Rmail)} | |
297 | @findex rmail-expunge | |
298 | @kindex u @r{(Rmail)} | |
299 | @findex rmail-undelete-previous-message | |
300 | To make all the deleted messages finally vanish from the Rmail file, | |
301 | type @kbd{x} (@code{rmail-expunge}). Until you do this, you can still | |
302 | @dfn{undelete} the deleted messages. The undeletion command, @kbd{u} | |
303 | (@code{rmail-undelete-previous-message}), is designed to cancel the | |
304 | effect of a @kbd{d} command in most cases. It undeletes the current | |
305 | message if the current message is deleted. Otherwise it moves backward | |
306 | to previous messages until a deleted message is found, and undeletes | |
307 | that message. | |
308 | ||
309 | You can usually undo a @kbd{d} with a @kbd{u} because the @kbd{u} | |
310 | moves back to and undeletes the message that the @kbd{d} deleted. But | |
311 | this does not work when the @kbd{d} skips a few already-deleted messages | |
312 | that follow the message being deleted; then the @kbd{u} command | |
313 | undeletes the last of the messages that were skipped. There is no clean | |
314 | way to avoid this problem. However, by repeating the @kbd{u} command, | |
315 | you can eventually get back to the message that you intend to | |
316 | undelete. You can also select a particular deleted message with | |
317 | the @kbd{M-p} command, then type @kbd{u} to undelete it. | |
318 | ||
319 | A deleted message has the @samp{deleted} attribute, and as a result | |
320 | @samp{deleted} appears in the mode line when the current message is | |
321 | deleted. In fact, deleting or undeleting a message is nothing more than | |
322 | adding or removing this attribute. @xref{Rmail Attributes}. | |
323 | ||
324 | @node Rmail Inbox | |
325 | @section Rmail Files and Inboxes | |
326 | @cindex inbox file | |
327 | ||
1be48cfa RS |
328 | When you receive mail locally, the operating system places incoming |
329 | mail for you in a file that we call your @dfn{inbox}. When you start | |
330 | up Rmail, it runs a C program called @code{movemail} to copy the new | |
331 | messages from your local inbox into your primary Rmail file, which | |
332 | also contains other messages saved from previous Rmail sessions. It | |
333 | is in this file that you actually read the mail with Rmail. This | |
334 | operation is called @dfn{getting new mail}. You can get new mail at | |
335 | any time in Rmail by typing @kbd{g}. | |
6bf7aab6 DL |
336 | |
337 | @vindex rmail-primary-inbox-list | |
60a96371 | 338 | @cindex @env{MAIL} environment variable |
6bf7aab6 DL |
339 | The variable @code{rmail-primary-inbox-list} contains a list of the |
340 | files which are inboxes for your primary Rmail file. If you don't set | |
9d5de6f8 GM |
341 | this variable explicitly, Rmail uses the @env{MAIL} environment |
342 | variable, or, as a last resort, a default inbox based on | |
343 | @code{rmail-spool-directory}. The default inbox file depends on your | |
344 | operating system; often it is @file{/var/mail/@var{username}}, | |
345 | @file{/var/spool/mail/@var{username}}, or | |
346 | @file{/usr/spool/mail/@var{username}}. | |
6bf7aab6 | 347 | |
9d5de6f8 GM |
348 | You can specify the inbox file(s) for any Rmail file for the current |
349 | session with the command @code{set-rmail-inbox-list}; see @ref{Rmail | |
350 | Files}. | |
6bf7aab6 DL |
351 | |
352 | There are two reasons for having separate Rmail files and inboxes. | |
353 | ||
354 | @enumerate | |
355 | @item | |
356 | The inbox file format varies between operating systems and according to | |
357 | the other mail software in use. Only one part of Rmail needs to know | |
358 | about the alternatives, and it need only understand how to convert all | |
359 | of them to Rmail's own format. | |
360 | ||
361 | @item | |
362 | It is very cumbersome to access an inbox file without danger of losing | |
363 | mail, because it is necessary to interlock with mail delivery. | |
364 | Moreover, different operating systems use different interlocking | |
365 | techniques. The strategy of moving mail out of the inbox once and for | |
366 | all into a separate Rmail file avoids the need for interlocking in all | |
367 | the rest of Rmail, since only Rmail operates on the Rmail file. | |
368 | @end enumerate | |
369 | ||
9d5de6f8 GM |
370 | Rmail was originally written to use the Babyl format as its internal |
371 | format. Since then, we have recognized that the usual inbox format | |
372 | (@samp{mbox}) on Unix and GNU systems is adequate for the job, and so | |
373 | since Emacs 23 Rmail uses that as its internal format. The Rmail file | |
374 | is still separate from the inbox file, even though their format is the | |
375 | same. | |
6bf7aab6 | 376 | |
1be48cfa | 377 | @vindex rmail-preserve-inbox |
9dd617a6 RS |
378 | When getting new mail, Rmail first copies the new mail from the |
379 | inbox file to the Rmail file; then it saves the Rmail file; then it | |
380 | clears out the inbox file. This way, a system crash may cause | |
381 | duplication of mail between the inbox and the Rmail file, but cannot | |
382 | lose mail. If @code{rmail-preserve-inbox} is non-@code{nil}, then | |
383 | Rmail does not clear out the inbox file when it gets new mail. You | |
384 | may wish to set this, for example, on a portable computer you use to | |
385 | check your mail via POP while traveling, so that your mail will remain | |
386 | on the server and you can save it later on your workstation. | |
1be48cfa RS |
387 | |
388 | In some cases, Rmail copies the new mail from the inbox file | |
389 | indirectly. First it runs the @code{movemail} program to move the mail | |
390 | from the inbox to an intermediate file called | |
9d5de6f8 GM |
391 | @file{.newmail-@var{inboxname}}, in the same directory as the Rmail |
392 | file. Then Rmail merges the new mail from that file, saves the Rmail | |
393 | file, and only then deletes the intermediate file. If there is a crash | |
394 | at the wrong time, this file continues to exist, and Rmail will use it | |
395 | again the next time it gets new mail from that inbox. | |
1be48cfa RS |
396 | |
397 | If Rmail is unable to convert the data in | |
9d5de6f8 GM |
398 | @file{.newmail-@var{inboxname}} into mbox format, it renames the file to |
399 | @file{RMAILOSE.@var{n}} (@var{n} is an integer chosen to make the name | |
400 | unique) so that Rmail will not have trouble with the data again. You | |
401 | should look at the file, find whatever message confuses Rmail (probably | |
402 | one that includes the control-underscore character, octal code 037), and | |
403 | delete it. Then you can use @kbd{1 g} to get new mail from the | |
404 | corrected file. | |
1be48cfa | 405 | |
6bf7aab6 DL |
406 | @node Rmail Files |
407 | @section Multiple Rmail Files | |
408 | ||
409 | Rmail operates by default on your @dfn{primary Rmail file}, which is named | |
410 | @file{~/RMAIL} and receives your incoming mail from your system inbox file. | |
411 | But you can also have other Rmail files and edit them with Rmail. These | |
412 | files can receive mail through their own inboxes, or you can move messages | |
413 | into them with explicit Rmail commands (@pxref{Rmail Output}). | |
414 | ||
415 | @table @kbd | |
416 | @item i @var{file} @key{RET} | |
417 | Read @var{file} into Emacs and run Rmail on it (@code{rmail-input}). | |
418 | ||
419 | @item M-x set-rmail-inbox-list @key{RET} @var{files} @key{RET} | |
420 | Specify inbox file names for current Rmail file to get mail from. | |
421 | ||
422 | @item g | |
423 | Merge new mail from current Rmail file's inboxes | |
424 | (@code{rmail-get-new-mail}). | |
425 | ||
426 | @item C-u g @var{file} @key{RET} | |
427 | Merge new mail from inbox file @var{file}. | |
428 | @end table | |
429 | ||
430 | @kindex i @r{(Rmail)} | |
431 | @findex rmail-input | |
9dd617a6 | 432 | To run Rmail on a file other than your primary Rmail file, you can use |
6bf7aab6 DL |
433 | the @kbd{i} (@code{rmail-input}) command in Rmail. This visits the file |
434 | in Rmail mode. You can use @kbd{M-x rmail-input} even when not in | |
9dd617a6 RS |
435 | Rmail, but it is easier to type @kbd{C-u M-x rmail}, which does the |
436 | same thing. | |
6bf7aab6 | 437 | |
5f50b807 RS |
438 | The file you read with @kbd{i} should normally be a valid mbox file. |
439 | If it is not, Rmail tries to convert its text to mbox format, and | |
440 | visits the converted text in the buffer. If you save the buffer, that | |
441 | converts the file. | |
442 | ||
443 | If you specify a file name that doesn't exist, @kbd{i} initializes a | |
444 | new buffer for creating a new Rmail file. | |
6bf7aab6 DL |
445 | |
446 | @vindex rmail-secondary-file-directory | |
447 | @vindex rmail-secondary-file-regexp | |
9dd617a6 RS |
448 | You can also select an Rmail file from a menu. In the Classify menu, |
449 | choose the Input Rmail File item; then choose the Rmail file you want. | |
450 | The variables @code{rmail-secondary-file-directory} and | |
6bf7aab6 DL |
451 | @code{rmail-secondary-file-regexp} specify which files to offer in the |
452 | menu: the first variable says which directory to find them in; the | |
9d5de6f8 GM |
453 | second says which files in that directory to offer (all those that match |
454 | the regular expression). If no files match, you cannot select this menu | |
455 | item. These variables also apply to choosing a file for output | |
456 | (@pxref{Rmail Output}). | |
6bf7aab6 | 457 | |
5f50b807 | 458 | @ignore |
6bf7aab6 DL |
459 | @findex set-rmail-inbox-list |
460 | Each Rmail file can contain a list of inbox file names; you can specify | |
461 | this list with @kbd{M-x set-rmail-inbox-list @key{RET} @var{files} | |
462 | @key{RET}}. The argument can contain any number of file names, separated | |
463 | by commas. It can also be empty, which specifies that this file should | |
9dd617a6 RS |
464 | have no inboxes. Once you specify a list of inboxes in an Rmail file, |
465 | the Rmail file remembers it permanently until you specify a different list. | |
5f50b807 | 466 | @end ignore |
6bf7aab6 | 467 | |
5f50b807 RS |
468 | @vindex rmail-inbox-list |
469 | The inbox files to use are specified by the variable | |
470 | @code{rmail-inbox-list}, which is buffer-local in Rmail mode. As a | |
9d5de6f8 GM |
471 | special exception, if you have specified no inbox files for your primary |
472 | Rmail file, it uses the @env{MAIL} environment variable, or your | |
473 | standard system inbox. | |
6bf7aab6 DL |
474 | |
475 | @kindex g @r{(Rmail)} | |
476 | @findex rmail-get-new-mail | |
477 | The @kbd{g} command (@code{rmail-get-new-mail}) merges mail into the | |
9dd617a6 RS |
478 | current Rmail file from its inboxes. If the Rmail file has no |
479 | inboxes, @kbd{g} does nothing. The command @kbd{M-x rmail} also | |
480 | merges new mail into your primary Rmail file. | |
6bf7aab6 DL |
481 | |
482 | To merge mail from a file that is not the usual inbox, give the | |
483 | @kbd{g} key a numeric argument, as in @kbd{C-u g}. Then it reads a file | |
484 | name and merges mail from that file. The inbox file is not deleted or | |
485 | changed in any way when @kbd{g} with an argument is used. This is, | |
486 | therefore, a general way of merging one file of messages into another. | |
487 | ||
488 | @node Rmail Output | |
489 | @section Copying Messages Out to Files | |
490 | ||
491 | These commands copy messages from an Rmail file into another file. | |
492 | ||
493 | @table @kbd | |
494 | @item o @var{file} @key{RET} | |
5f50b807 RS |
495 | Append a full copy of the current message to the file @var{file} |
496 | (@code{rmail-output}). | |
6bf7aab6 DL |
497 | |
498 | @item C-o @var{file} @key{RET} | |
5f50b807 RS |
499 | Append a copy of the current message, as displayed, to the file |
500 | @var{file} (@code{rmail-output-as-seen}). | |
6bf7aab6 DL |
501 | |
502 | @item w @var{file} @key{RET} | |
503 | Output just the message body to the file @var{file}, taking the default | |
504 | file name from the message @samp{Subject} header. | |
505 | @end table | |
506 | ||
507 | @kindex o @r{(Rmail)} | |
5f50b807 | 508 | @findex rmail-output-as-seen |
6bf7aab6 DL |
509 | @kindex C-o @r{(Rmail)} |
510 | @findex rmail-output | |
511 | The commands @kbd{o} and @kbd{C-o} copy the current message into a | |
5f50b807 RS |
512 | specified file, adding it at the end. The two commands differ mainly |
513 | in how much to copy: @kbd{o} copies the full message headers, even if | |
514 | they are not all visible, while @kbd{C-o} copies exactly the headers | |
515 | currently displayed and no more. @xref{Rmail Display}. In addition, | |
516 | @kbd{o} converts the message to Babyl format (used by Rmail in Emacs | |
517 | version 22 and before) if the file is in Babyl format; @kbd{C-o} | |
518 | cannot output to Babyl files at all. | |
519 | ||
520 | If the output file is currently visited in an Emacs buffer, the | |
521 | output commands append the message to that buffer. It is up to you to | |
522 | save the buffer eventually in its file. | |
6bf7aab6 DL |
523 | |
524 | @kindex w @r{(Rmail)} | |
525 | @findex rmail-output-body-to-file | |
526 | Sometimes you may receive a message whose body holds the contents of a | |
527 | file. You can save the body to a file (excluding the message header) | |
528 | with the @kbd{w} command (@code{rmail-output-body-to-file}). Often | |
529 | these messages contain the intended file name in the @samp{Subject} | |
530 | field, so the @kbd{w} command uses the @samp{Subject} field as the | |
531 | default for the output file name. However, the file name is read using | |
532 | the minibuffer, so you can specify a different name if you wish. | |
533 | ||
534 | You can also output a message to an Rmail file chosen with a menu. | |
9dd617a6 RS |
535 | In the Classify menu, choose the Output Rmail File menu item; then |
536 | choose the Rmail file you want. This outputs the current message to | |
537 | that file, like the @kbd{o} command. The variables | |
538 | @code{rmail-secondary-file-directory} and | |
6bf7aab6 DL |
539 | @code{rmail-secondary-file-regexp} specify which files to offer in the |
540 | menu: the first variable says which directory to find them in; the | |
9dd617a6 | 541 | second says which files in that directory to offer (all those that |
9d5de6f8 GM |
542 | match the regular expression). If no files match, you cannot select |
543 | this menu item. | |
6bf7aab6 DL |
544 | |
545 | @vindex rmail-delete-after-output | |
32823124 LT |
546 | Copying a message with @kbd{o} or @kbd{C-o} gives the original copy |
547 | of the message the @samp{filed} attribute, so that @samp{filed} | |
5f50b807 RS |
548 | appears in the mode line when such a message is current. |
549 | ||
550 | If you like to keep just a single copy of every mail message, set | |
551 | the variable @code{rmail-delete-after-output} to @code{t}; then the | |
552 | @kbd{o}, @kbd{C-o} and @kbd{w} commands delete the original message | |
553 | after copying it. (You can undelete it afterward if you wish.) | |
6bf7aab6 DL |
554 | |
555 | @vindex rmail-output-file-alist | |
556 | The variable @code{rmail-output-file-alist} lets you specify | |
557 | intelligent defaults for the output file, based on the contents of the | |
558 | current message. The value should be a list whose elements have this | |
559 | form: | |
560 | ||
561 | @example | |
562 | (@var{regexp} . @var{name-exp}) | |
563 | @end example | |
564 | ||
565 | @noindent | |
566 | If there's a match for @var{regexp} in the current message, then the | |
567 | default file name for output is @var{name-exp}. If multiple elements | |
568 | match the message, the first matching element decides the default file | |
569 | name. The subexpression @var{name-exp} may be a string constant giving | |
570 | the file name to use, or more generally it may be any Lisp expression | |
571 | that returns a file name as a string. @code{rmail-output-file-alist} | |
572 | applies to both @kbd{o} and @kbd{C-o}. | |
573 | ||
574 | @node Rmail Labels | |
575 | @section Labels | |
576 | @cindex label (Rmail) | |
577 | @cindex attribute (Rmail) | |
578 | ||
579 | Each message can have various @dfn{labels} assigned to it as a means | |
580 | of classification. Each label has a name; different names are different | |
581 | labels. Any given label is either present or absent on a particular | |
582 | message. A few label names have standard meanings and are given to | |
583 | messages automatically by Rmail when appropriate; these special labels | |
584 | are called @dfn{attributes}. | |
4714476b | 585 | @ifnottex |
6bf7aab6 | 586 | (@xref{Rmail Attributes}.) |
4714476b | 587 | @end ifnottex |
6bf7aab6 DL |
588 | All other labels are assigned only by users. |
589 | ||
590 | @table @kbd | |
591 | @item a @var{label} @key{RET} | |
592 | Assign the label @var{label} to the current message (@code{rmail-add-label}). | |
593 | @item k @var{label} @key{RET} | |
594 | Remove the label @var{label} from the current message (@code{rmail-kill-label}). | |
595 | @item C-M-n @var{labels} @key{RET} | |
596 | Move to the next message that has one of the labels @var{labels} | |
597 | (@code{rmail-next-labeled-message}). | |
598 | @item C-M-p @var{labels} @key{RET} | |
599 | Move to the previous message that has one of the labels @var{labels} | |
600 | (@code{rmail-previous-labeled-message}). | |
32823124 LT |
601 | @item l @var{labels} @key{RET} |
602 | @itemx C-M-l @var{labels} @key{RET} | |
6bf7aab6 DL |
603 | Make a summary of all messages containing any of the labels @var{labels} |
604 | (@code{rmail-summary-by-labels}). | |
605 | @end table | |
606 | ||
607 | @kindex a @r{(Rmail)} | |
608 | @kindex k @r{(Rmail)} | |
609 | @findex rmail-add-label | |
610 | @findex rmail-kill-label | |
611 | The @kbd{a} (@code{rmail-add-label}) and @kbd{k} | |
612 | (@code{rmail-kill-label}) commands allow you to assign or remove any | |
613 | label on the current message. If the @var{label} argument is empty, it | |
614 | means to assign or remove the same label most recently assigned or | |
615 | removed. | |
616 | ||
617 | Once you have given messages labels to classify them as you wish, there | |
04242bdc | 618 | are three ways to use the labels: in moving, in summaries, and in sorting. |
6bf7aab6 DL |
619 | |
620 | @kindex C-M-n @r{(Rmail)} | |
621 | @kindex C-M-p @r{(Rmail)} | |
622 | @findex rmail-next-labeled-message | |
623 | @findex rmail-previous-labeled-message | |
624 | The command @kbd{C-M-n @var{labels} @key{RET}} | |
625 | (@code{rmail-next-labeled-message}) moves to the next message that has | |
626 | one of the labels @var{labels}. The argument @var{labels} specifies one | |
627 | or more label names, separated by commas. @kbd{C-M-p} | |
628 | (@code{rmail-previous-labeled-message}) is similar, but moves backwards | |
629 | to previous messages. A numeric argument to either command serves as a | |
630 | repeat count. | |
631 | ||
632 | The command @kbd{C-M-l @var{labels} @key{RET}} | |
633 | (@code{rmail-summary-by-labels}) displays a summary containing only the | |
634 | messages that have at least one of a specified set of labels. The | |
635 | argument @var{labels} is one or more label names, separated by commas. | |
9dd617a6 | 636 | @xref{Rmail Summary}, for information on summaries. |
6bf7aab6 DL |
637 | |
638 | If the @var{labels} argument to @kbd{C-M-n}, @kbd{C-M-p} or | |
639 | @kbd{C-M-l} is empty, it means to use the last set of labels specified | |
640 | for any of these commands. | |
641 | ||
04242bdc GM |
642 | @xref{Rmail Sorting}, for information on sorting messages with labels. |
643 | ||
6bf7aab6 DL |
644 | @node Rmail Attributes |
645 | @section Rmail Attributes | |
646 | ||
647 | Some labels such as @samp{deleted} and @samp{filed} have built-in | |
9dd617a6 RS |
648 | meanings, and Rmail assigns them to messages automatically at |
649 | appropriate times; these labels are called @dfn{attributes}. Here is | |
650 | a list of Rmail attributes: | |
6bf7aab6 DL |
651 | |
652 | @table @samp | |
653 | @item unseen | |
654 | Means the message has never been current. Assigned to messages when | |
655 | they come from an inbox file, and removed when a message is made | |
656 | current. When you start Rmail, it initially shows the first message | |
657 | that has this attribute. | |
658 | @item deleted | |
659 | Means the message is deleted. Assigned by deletion commands and | |
660 | removed by undeletion commands (@pxref{Rmail Deletion}). | |
661 | @item filed | |
662 | Means the message has been copied to some other file. Assigned by the | |
32823124 | 663 | @kbd{o} and @kbd{C-o} file output commands (@pxref{Rmail Output}). |
6bf7aab6 DL |
664 | @item answered |
665 | Means you have mailed an answer to the message. Assigned by the @kbd{r} | |
666 | command (@code{rmail-reply}). @xref{Rmail Reply}. | |
667 | @item forwarded | |
668 | Means you have forwarded the message. Assigned by the @kbd{f} command | |
669 | (@code{rmail-forward}). @xref{Rmail Reply}. | |
670 | @item edited | |
671 | Means you have edited the text of the message within Rmail. | |
672 | @xref{Rmail Editing}. | |
673 | @item resent | |
674 | Means you have resent the message. Assigned by the command @kbd{M-x | |
675 | rmail-resend}. @xref{Rmail Reply}. | |
5f50b807 RS |
676 | @item retried |
677 | Means you have retried a failed outgoing message. Assigned by the | |
678 | command @kbd{M-x rmail-retry-failure}. @xref{Rmail Reply}. | |
6bf7aab6 DL |
679 | @end table |
680 | ||
9dd617a6 | 681 | All other labels are assigned or removed only by users, and have no |
6bf7aab6 DL |
682 | standard meaning. |
683 | ||
684 | @node Rmail Reply | |
685 | @section Sending Replies | |
686 | ||
e73c2434 CY |
687 | Rmail has several commands to send outgoing mail. @xref{Sending |
688 | Mail}, for information on using Message mode, including certain | |
689 | features meant to work with Rmail. What this section documents are | |
690 | the special commands of Rmail for entering the mail buffer. Note that | |
691 | the usual keys for sending mail---@kbd{C-x m}, @kbd{C-x 4 m}, and | |
692 | @kbd{C-x 5 m}---also work normally in Rmail mode. | |
6bf7aab6 DL |
693 | |
694 | @table @kbd | |
695 | @item m | |
696 | Send a message (@code{rmail-mail}). | |
697 | @item c | |
698 | Continue editing the already started outgoing message (@code{rmail-continue}). | |
699 | @item r | |
700 | Send a reply to the current Rmail message (@code{rmail-reply}). | |
701 | @item f | |
702 | Forward the current message to other users (@code{rmail-forward}). | |
703 | @item C-u f | |
704 | Resend the current message to other users (@code{rmail-resend}). | |
705 | @item M-m | |
706 | Try sending a bounced message a second time (@code{rmail-retry-failure}). | |
707 | @end table | |
708 | ||
709 | @kindex r @r{(Rmail)} | |
710 | @findex rmail-reply | |
711 | @cindex reply to a message | |
9dd617a6 RS |
712 | The most common reason to send a message while in Rmail is to reply |
713 | to the message you are reading. To do this, type @kbd{r} | |
714 | (@code{rmail-reply}). This displays the @samp{*mail*} buffer in | |
715 | another window, much like @kbd{C-x 4 m}, but preinitializes the | |
716 | @samp{Subject}, @samp{To}, @samp{CC}, @samp{In-reply-to} and | |
717 | @samp{References} header fields based on the message you are replying | |
718 | to. The @samp{To} field starts out as the address of the person who | |
719 | sent the message you received, and the @samp{CC} field starts out with | |
720 | all the other recipients of that message. | |
6bf7aab6 DL |
721 | |
722 | @vindex rmail-dont-reply-to-names | |
3d963b67 GM |
723 | You can exclude certain recipients from being included automatically |
724 | in replies, using the variable @code{rmail-dont-reply-to-names}. Its | |
21b6bf3b GM |
725 | value should be a regular expression; any recipients that match are |
726 | excluded from the @samp{CC} field. They are also excluded from the | |
727 | @samp{To} field, unless this would leave the field empty. If this | |
728 | variable is nil, then the first time you compose a reply it is | |
729 | initialized to a default value that matches your own address, and any | |
730 | name starting with @samp{info-}. (Those names are excluded because | |
731 | there is a convention of using them for large mailing lists to broadcast | |
732 | announcements.) | |
6bf7aab6 DL |
733 | |
734 | To omit the @samp{CC} field completely for a particular reply, enter | |
735 | the reply command with a numeric argument: @kbd{C-u r} or @kbd{1 r}. | |
9dd617a6 | 736 | This means to reply only to the sender of the original message. |
6bf7aab6 DL |
737 | |
738 | Once the @samp{*mail*} buffer has been initialized, editing and | |
e73c2434 CY |
739 | sending the mail goes as usual (@pxref{Sending Mail}). You can edit |
740 | the presupplied header fields if they are not what you want. You can | |
741 | also use commands such as @kbd{C-c C-y}, which yanks in the message | |
742 | that you are replying to (@pxref{Mail Commands}). You can also switch | |
743 | to the Rmail buffer, select a different message there, switch back, | |
744 | and yank the new current message. | |
6bf7aab6 DL |
745 | |
746 | @kindex M-m @r{(Rmail)} | |
747 | @findex rmail-retry-failure | |
748 | @cindex retrying a failed message | |
749 | @vindex rmail-retry-ignored-headers | |
750 | Sometimes a message does not reach its destination. Mailers usually | |
751 | send the failed message back to you, enclosed in a @dfn{failure | |
752 | message}. The Rmail command @kbd{M-m} (@code{rmail-retry-failure}) | |
753 | prepares to send the same message a second time: it sets up a | |
754 | @samp{*mail*} buffer with the same text and header fields as before. If | |
755 | you type @kbd{C-c C-c} right away, you send the message again exactly | |
756 | the same as the first time. Alternatively, you can edit the text or | |
757 | headers and then send it. The variable | |
758 | @code{rmail-retry-ignored-headers}, in the same format as | |
759 | @code{rmail-ignored-headers} (@pxref{Rmail Display}), controls which | |
00aa62e5 | 760 | headers are stripped from the failed message when retrying it. |
6bf7aab6 DL |
761 | |
762 | @kindex f @r{(Rmail)} | |
763 | @findex rmail-forward | |
764 | @cindex forwarding a message | |
765 | Another frequent reason to send mail in Rmail is to @dfn{forward} the | |
766 | current message to other users. @kbd{f} (@code{rmail-forward}) makes | |
767 | this easy by preinitializing the @samp{*mail*} buffer with the current | |
768 | message as the text, and a subject designating a forwarded message. All | |
769 | you have to do is fill in the recipients and send. When you forward a | |
770 | message, recipients get a message which is ``from'' you, and which has | |
771 | the original message in its contents. | |
772 | ||
773 | @findex unforward-rmail-message | |
774 | Forwarding a message encloses it between two delimiter lines. It also | |
775 | modifies every line that starts with a dash, by inserting @w{@samp{- }} | |
776 | at the start of the line. When you receive a forwarded message, if it | |
777 | contains something besides ordinary text---for example, program source | |
778 | code---you might find it useful to undo that transformation. You can do | |
779 | this by selecting the forwarded message and typing @kbd{M-x | |
780 | unforward-rmail-message}. This command extracts the original forwarded | |
781 | message, deleting the inserted @w{@samp{- }} strings, and inserts it | |
782 | into the Rmail file as a separate message immediately following the | |
783 | current one. | |
784 | ||
785 | @findex rmail-resend | |
786 | @dfn{Resending} is an alternative similar to forwarding; the | |
787 | difference is that resending sends a message that is ``from'' the | |
788 | original sender, just as it reached you---with a few added header fields | |
04242bdc | 789 | (@samp{Resent-From} and @samp{Resent-To}) to indicate that it came via |
6bf7aab6 | 790 | you. To resend a message in Rmail, use @kbd{C-u f}. (@kbd{f} runs |
3d963b67 GM |
791 | @code{rmail-forward}, which invokes @code{rmail-resend} if you provide a |
792 | numeric argument.) | |
6bf7aab6 DL |
793 | |
794 | @kindex m @r{(Rmail)} | |
795 | @findex rmail-mail | |
5f50b807 | 796 | Use the @kbd{m} (@code{rmail-mail}) command to start editing an |
6bf7aab6 DL |
797 | outgoing message that is not a reply. It leaves the header fields empty. |
798 | Its only difference from @kbd{C-x 4 m} is that it makes the Rmail buffer | |
799 | accessible for @kbd{C-c C-y}, just as @kbd{r} does. Thus, @kbd{m} can be | |
800 | used to reply to or forward a message; it can do anything @kbd{r} or @kbd{f} | |
9dd617a6 | 801 | can do. |
6bf7aab6 DL |
802 | |
803 | @kindex c @r{(Rmail)} | |
804 | @findex rmail-continue | |
805 | The @kbd{c} (@code{rmail-continue}) command resumes editing the | |
806 | @samp{*mail*} buffer, to finish editing an outgoing message you were | |
9dd617a6 | 807 | already composing, or to alter a message you have sent. |
6bf7aab6 DL |
808 | |
809 | @vindex rmail-mail-new-frame | |
810 | If you set the variable @code{rmail-mail-new-frame} to a | |
811 | non-@code{nil} value, then all the Rmail commands to start sending a | |
812 | message create a new frame to edit it in. This frame is deleted when | |
00aa62e5 | 813 | you send the message, or when you use the @samp{Cancel} item in the |
6bf7aab6 DL |
814 | @samp{Mail} menu. |
815 | ||
816 | All the Rmail commands to send a message use the mail-composition | |
817 | method that you have chosen (@pxref{Mail Methods}). | |
818 | ||
819 | @node Rmail Summary | |
820 | @section Summaries | |
821 | @cindex summary (Rmail) | |
822 | ||
823 | A @dfn{summary} is a buffer containing one line per message to give | |
824 | you an overview of the mail in an Rmail file. Each line shows the | |
00aa62e5 RS |
825 | message number and date, the sender, the line count, the labels, and |
826 | the subject. Moving point in the summary buffer selects messages as | |
827 | you move to their summary lines. Almost all Rmail commands are valid | |
828 | in the summary buffer also; when used there, they apply to the message | |
829 | described by the current line of the summary. | |
6bf7aab6 DL |
830 | |
831 | A summary buffer applies to a single Rmail file only; if you are | |
832 | editing multiple Rmail files, each one can have its own summary buffer. | |
833 | The summary buffer name is made by appending @samp{-summary} to the | |
834 | Rmail buffer's name. Normally only one summary buffer is displayed at a | |
835 | time. | |
836 | ||
837 | @menu | |
8838673e GM |
838 | * Rmail Make Summary:: Making various sorts of summaries. |
839 | * Rmail Summary Edit:: Manipulating messages from the summary. | |
6bf7aab6 DL |
840 | @end menu |
841 | ||
842 | @node Rmail Make Summary | |
843 | @subsection Making Summaries | |
844 | ||
3d963b67 GM |
845 | Here are the commands to create a summary for the current Rmail |
846 | buffer. Once the Rmail buffer has a summary, changes in the Rmail | |
847 | buffer (such as deleting or expunging messages, and getting new mail) | |
6bf7aab6 DL |
848 | automatically update the summary. |
849 | ||
850 | @table @kbd | |
851 | @item h | |
852 | @itemx C-M-h | |
853 | Summarize all messages (@code{rmail-summary}). | |
854 | @item l @var{labels} @key{RET} | |
855 | @itemx C-M-l @var{labels} @key{RET} | |
856 | Summarize messages that have one or more of the specified labels | |
857 | (@code{rmail-summary-by-labels}). | |
858 | @item C-M-r @var{rcpts} @key{RET} | |
2340abde | 859 | Summarize messages that match the specified recipients |
6bf7aab6 DL |
860 | (@code{rmail-summary-by-recipients}). |
861 | @item C-M-t @var{topic} @key{RET} | |
862 | Summarize messages that have a match for the specified regexp | |
863 | @var{topic} in their subjects (@code{rmail-summary-by-topic}). | |
2340abde | 864 | @item C-M-s @var{regexp} @key{RET} |
3d963b67 GM |
865 | Summarize messages whose headers match the specified regular expression |
866 | @var{regexp} (@code{rmail-summary-by-regexp}). | |
2340abde GM |
867 | @item C-M-f @var{senders} @key{RET} |
868 | Summarize messages that match the specified senders. | |
869 | (@code{rmail-summary-by-senders}). | |
6bf7aab6 DL |
870 | @end table |
871 | ||
872 | @kindex h @r{(Rmail)} | |
873 | @findex rmail-summary | |
874 | The @kbd{h} or @kbd{C-M-h} (@code{rmail-summary}) command fills the summary buffer | |
3d963b67 | 875 | for the current Rmail buffer with a summary of all the messages in the buffer. |
6bf7aab6 DL |
876 | It then displays and selects the summary buffer in another window. |
877 | ||
878 | @kindex l @r{(Rmail)} | |
879 | @kindex C-M-l @r{(Rmail)} | |
880 | @findex rmail-summary-by-labels | |
881 | @kbd{C-M-l @var{labels} @key{RET}} (@code{rmail-summary-by-labels}) makes | |
882 | a partial summary mentioning only the messages that have one or more of the | |
883 | labels @var{labels}. @var{labels} should contain label names separated by | |
9dd617a6 | 884 | commas. |
6bf7aab6 DL |
885 | |
886 | @kindex C-M-r @r{(Rmail)} | |
887 | @findex rmail-summary-by-recipients | |
888 | @kbd{C-M-r @var{rcpts} @key{RET}} (@code{rmail-summary-by-recipients}) | |
3d963b67 | 889 | makes a partial summary mentioning only the messages that have one or |
2340abde GM |
890 | more recipients matching the regular expression @var{rcpts}. You can |
891 | use commas to separate multiple regular expressions. These are matched | |
3d963b67 GM |
892 | against the @samp{To}, @samp{From}, and @samp{CC} headers (with a prefix |
893 | argument, this header is not included). | |
6bf7aab6 DL |
894 | |
895 | @kindex C-M-t @r{(Rmail)} | |
896 | @findex rmail-summary-by-topic | |
897 | @kbd{C-M-t @var{topic} @key{RET}} (@code{rmail-summary-by-topic}) | |
898 | makes a partial summary mentioning only the messages whose subjects have | |
2340abde | 899 | a match for the regular expression @var{topic}. You can use commas to |
3d963b67 GM |
900 | separate multiple regular expressions. With a prefix argument, the |
901 | match is against the whole message, not just the subject. | |
6bf7aab6 | 902 | |
a99d2d64 EZ |
903 | @kindex C-M-s @r{(Rmail)} |
904 | @findex rmail-summary-by-regexp | |
b8f86df3 | 905 | @kbd{C-M-s @var{regexp} @key{RET}} (@code{rmail-summary-by-regexp}) |
3d963b67 | 906 | makes a partial summary that mentions only the messages whose headers |
a99d2d64 EZ |
907 | (including the date and the subject lines) match the regular |
908 | expression @var{regexp}. | |
909 | ||
2340abde GM |
910 | @kindex C-M-f @r{(Rmail)} |
911 | @findex rmail-summary-by-senders | |
912 | @kbd{C-M-f @var{senders} @key{RET}} (@code{rmail-summary-by-senders}) | |
913 | makes a partial summary that mentions only the messages whose @samp{From} | |
914 | fields match the regular expression @var{senders}. You can use commas to | |
915 | separate multiple regular expressions. | |
916 | ||
3d963b67 | 917 | Note that there is only one summary buffer for any Rmail buffer; |
9dd617a6 | 918 | making any kind of summary discards any previous summary. |
6bf7aab6 DL |
919 | |
920 | @vindex rmail-summary-window-size | |
921 | @vindex rmail-summary-line-count-flag | |
922 | The variable @code{rmail-summary-window-size} says how many lines to | |
923 | use for the summary window. The variable | |
924 | @code{rmail-summary-line-count-flag} controls whether the summary line | |
3d963b67 GM |
925 | for a message should include the line count of the message. Setting |
926 | this option to nil might speed up the generation of summaries. | |
6bf7aab6 DL |
927 | |
928 | @node Rmail Summary Edit | |
929 | @subsection Editing in Summaries | |
930 | ||
931 | You can use the Rmail summary buffer to do almost anything you can do | |
932 | in the Rmail buffer itself. In fact, once you have a summary buffer, | |
933 | there's no need to switch back to the Rmail buffer. | |
934 | ||
935 | You can select and display various messages in the Rmail buffer, from | |
936 | the summary buffer, just by moving point in the summary buffer to | |
937 | different lines. It doesn't matter what Emacs command you use to move | |
938 | point; whichever line point is on at the end of the command, that | |
939 | message is selected in the Rmail buffer. | |
940 | ||
941 | Almost all Rmail commands work in the summary buffer as well as in the | |
942 | Rmail buffer. Thus, @kbd{d} in the summary buffer deletes the current | |
36e2ae50 LT |
943 | message, @kbd{u} undeletes, and @kbd{x} expunges. (However, in the |
944 | summary buffer, a numeric argument to @kbd{d}, @kbd{C-d} and @kbd{u} | |
945 | serves as a repeat count. A negative argument reverses the meaning of | |
3d963b67 GM |
946 | @kbd{d} and @kbd{C-d}. Also, if there are no more undeleted messages in |
947 | the relevant direction, the delete commands go to the first or last | |
948 | message, rather than staying on the current message.) @kbd{o} and | |
949 | @kbd{C-o} output the current message to a FILE; @kbd{r} starts a reply | |
2340abde | 950 | to it; etc. You can scroll the current message while remaining in the |
3d963b67 | 951 | summary buffer using @key{SPC} and @key{DEL}. |
2340abde GM |
952 | @c rmail-summary-scroll-between-messages not mentioned. |
953 | ||
954 | @findex rmail-summary-undelete-many | |
955 | @kbd{M-u} (@code{rmail-summary-undelete-many}) undeletes all deleted | |
956 | messages in the summary. A prefix argument means to undelete that many | |
957 | of the previous deleted messages. | |
6bf7aab6 DL |
958 | |
959 | The Rmail commands to move between messages also work in the summary | |
960 | buffer, but with a twist: they move through the set of messages included | |
961 | in the summary. They also ensure the Rmail buffer appears on the screen | |
962 | (unlike cursor motion commands, which update the contents of the Rmail | |
963 | buffer but don't display it in a window unless it already appears). | |
964 | Here is a list of these commands: | |
965 | ||
966 | @table @kbd | |
967 | @item n | |
968 | Move to next line, skipping lines saying `deleted', and select its | |
2340abde | 969 | message (@code{rmail-summary-next-msg}). |
6bf7aab6 DL |
970 | @item p |
971 | Move to previous line, skipping lines saying `deleted', and select | |
2340abde | 972 | its message (@code{rmail-summary-previous-msg}). |
6bf7aab6 | 973 | @item M-n |
2340abde | 974 | Move to next line and select its message (@code{rmail-summary-next-all}). |
6bf7aab6 | 975 | @item M-p |
2340abde GM |
976 | Move to previous line and select its message |
977 | (@code{rmail-summary-previous-all}). | |
6bf7aab6 | 978 | @item > |
2340abde GM |
979 | Move to the last line, and select its message |
980 | (@code{rmail-summary-last-message}). | |
6bf7aab6 | 981 | @item < |
2340abde GM |
982 | Move to the first line, and select its message |
983 | (@code{rmail-summary-first-message}). | |
32823124 LT |
984 | @item j |
985 | @itemx @key{RET} | |
2340abde GM |
986 | Select the message on the current line (ensuring that the Rmail buffer |
987 | appears on the screen; @code{rmail-summary-goto-msg}). With argument | |
988 | @var{n}, select message number @var{n} and move to its line in the | |
989 | summary buffer; this signals an error if the message is not listed in | |
990 | the summary buffer. | |
6bf7aab6 DL |
991 | @item M-s @var{pattern} @key{RET} |
992 | Search through messages for @var{pattern} starting with the current | |
993 | message; select the message found, and move point in the summary buffer | |
2340abde GM |
994 | to that message's line (@code{rmail-summary-search}). A prefix argument |
995 | acts as a repeat count; a negative argument means search backward | |
996 | (equivalent to @code{rmail-summary-search-backward}.) | |
997 | @item C-M-n @var{labels} @key{RET} | |
998 | Move to the next message with at least one of the specified labels | |
999 | (@code{rmail-summary-next-labeled-message}). @var{labels} is a | |
1000 | comma-separated list of labels. A prefix argument acts as a repeat | |
1001 | count. | |
1002 | @item C-M-p @var{labels} @key{RET} | |
1003 | Move to the previous message with at least one of the specified labels | |
1004 | (@code{rmail-summary-previous-labeled-message}). | |
04242bdc GM |
1005 | @item C-c C-n @key{RET} |
1006 | Move to the next message with the same subject as the current message | |
1007 | (@code{rmail-summary-next-same-subject}). A prefix argument acts as a | |
1008 | repeat count. | |
1009 | @item C-c C-p @key{RET} | |
1010 | Move to the previous message with the same subject as the current message | |
1011 | (@code{rmail-summary-previous-same-subject}). | |
6bf7aab6 DL |
1012 | @end table |
1013 | ||
1014 | @vindex rmail-redisplay-summary | |
1015 | Deletion, undeletion, and getting new mail, and even selection of a | |
1016 | different message all update the summary buffer when you do them in the | |
1017 | Rmail buffer. If the variable @code{rmail-redisplay-summary} is | |
1018 | non-@code{nil}, these actions also bring the summary buffer back onto | |
1019 | the screen. | |
1020 | ||
1021 | @kindex Q @r{(Rmail summary)} | |
1022 | @findex rmail-summary-wipe | |
1023 | @kindex q @r{(Rmail summary)} | |
1024 | @findex rmail-summary-quit | |
3d963b67 GM |
1025 | @kindex b @r{(Rmail summary)} |
1026 | @findex rmail-summary-bury | |
6bf7aab6 DL |
1027 | When you are finished using the summary, type @kbd{Q} |
1028 | (@code{rmail-summary-wipe}) to delete the summary buffer's window. You | |
1029 | can also exit Rmail while in the summary: @kbd{q} | |
1030 | (@code{rmail-summary-quit}) deletes the summary window, then exits from | |
1031 | Rmail by saving the Rmail file and switching to another buffer. | |
3d963b67 GM |
1032 | Alternatively, @kbd{b} (@code{rmail-summary-bury}) simply buries the |
1033 | Rmail summary and buffer. | |
6bf7aab6 DL |
1034 | |
1035 | @node Rmail Sorting | |
1036 | @section Sorting the Rmail File | |
c1209b97 EZ |
1037 | @cindex sorting Rmail file |
1038 | @cindex Rmail file sorting | |
6bf7aab6 DL |
1039 | |
1040 | @table @kbd | |
c1209b97 | 1041 | @findex rmail-sort-by-date |
00cfe22c GM |
1042 | @item C-c C-s C-d |
1043 | @itemx M-x rmail-sort-by-date | |
1044 | Sort messages of current Rmail buffer by date. | |
6bf7aab6 | 1045 | |
c1209b97 | 1046 | @findex rmail-sort-by-subject |
00cfe22c GM |
1047 | @item C-c C-s C-s |
1048 | @itemx M-x rmail-sort-by-subject | |
1049 | Sort messages of current Rmail buffer by subject. | |
6bf7aab6 | 1050 | |
c1209b97 | 1051 | @findex rmail-sort-by-author |
00cfe22c GM |
1052 | @item C-c C-s C-a |
1053 | @itemx M-x rmail-sort-by-author | |
1054 | Sort messages of current Rmail buffer by author's name. | |
6bf7aab6 | 1055 | |
c1209b97 | 1056 | @findex rmail-sort-by-recipient |
00cfe22c GM |
1057 | @item C-c C-s C-r |
1058 | @itemx M-x rmail-sort-by-recipient | |
1059 | Sort messages of current Rmail buffer by recipient's names. | |
6bf7aab6 | 1060 | |
c1209b97 | 1061 | @findex rmail-sort-by-correspondent |
00cfe22c GM |
1062 | @item C-c C-s C-c |
1063 | @itemx M-x rmail-sort-by-correspondent | |
1064 | Sort messages of current Rmail buffer by the name of the other | |
6bf7aab6 DL |
1065 | correspondent. |
1066 | ||
c1209b97 | 1067 | @findex rmail-sort-by-lines |
00cfe22c GM |
1068 | @item C-c C-s C-l |
1069 | @itemx M-x rmail-sort-by-lines | |
1070 | Sort messages of current Rmail buffer by number of lines. | |
1071 | ||
1072 | @findex rmail-sort-by-labels | |
1073 | @item C-c C-s C-k @key{RET} @var{labels} @key{RET} | |
1074 | @itemx M-x rmail-sort-by-labels @key{RET} @var{labels} @key{RET} | |
1075 | Sort messages of current Rmail buffer by labels. The argument | |
6bf7aab6 DL |
1076 | @var{labels} should be a comma-separated list of labels. The order of |
1077 | these labels specifies the order of messages; messages with the first | |
1078 | label come first, messages with the second label come second, and so on. | |
00cfe22c | 1079 | Messages that have none of these labels come last. |
6bf7aab6 DL |
1080 | @end table |
1081 | ||
1082 | The Rmail sort commands perform a @emph{stable sort}: if there is no | |
1083 | reason to prefer either one of two messages, their order remains | |
1084 | unchanged. You can use this to sort by more than one criterion. For | |
1085 | example, if you use @code{rmail-sort-by-date} and then | |
1086 | @code{rmail-sort-by-author}, messages from the same author appear in | |
1087 | order by date. | |
1088 | ||
00cfe22c | 1089 | With a prefix argument, all these commands reverse the order of |
6bf7aab6 DL |
1090 | comparison. This means they sort messages from newest to oldest, from |
1091 | biggest to smallest, or in reverse alphabetical order. | |
1092 | ||
00cfe22c GM |
1093 | The same keys in the summary buffer run similar functions; for |
1094 | example, @kbd{C-c C-s C-l} runs @code{rmail-summary-sort-by-lines}. | |
1095 | Note that these commands always sort the whole Rmail buffer, even if the | |
1096 | summary is only showing a subset of messages. | |
1097 | ||
1098 | Note that you cannot undo a sort, so you may wish to save the Rmail | |
1099 | buffer before sorting it. | |
1100 | ||
6bf7aab6 DL |
1101 | @node Rmail Display |
1102 | @section Display of Messages | |
1103 | ||
1104 | Rmail reformats the header of each message before displaying it for | |
1105 | the first time. Reformatting hides uninteresting header fields to | |
1106 | reduce clutter. You can use the @kbd{t} command to show the entire | |
1107 | header or to repeat the header reformatting operation. | |
1108 | ||
1109 | @table @kbd | |
1110 | @item t | |
1111 | Toggle display of complete header (@code{rmail-toggle-header}). | |
1112 | @end table | |
1113 | ||
1114 | @vindex rmail-ignored-headers | |
9dd617a6 | 1115 | @vindex rmail-nonignored-headers |
6bf7aab6 DL |
1116 | Reformatting the header involves deleting most header fields, on the |
1117 | grounds that they are not interesting. The variable | |
1118 | @code{rmail-ignored-headers} holds a regular expression that specifies | |
9dd617a6 RS |
1119 | which header fields to hide in this way---if it matches the beginning |
1120 | of a header field, that whole field is hidden. However, the variable | |
1121 | @code{rmail-nonignored-headers} provides a further override: a header | |
1122 | matching that regular expression is shown even if it matches | |
1123 | @code{rmail-ignored-headers} too. | |
6bf7aab6 | 1124 | |
3d963b67 GM |
1125 | @vindex rmail-displayed-headers |
1126 | As an alternative to the previous two variables, you can set | |
1127 | @code{rmail-displayed-headers} instead. If non-@code{nil}, this should | |
1128 | be a regular expression specifying which headers to display. | |
1129 | ||
6bf7aab6 DL |
1130 | @kindex t @r{(Rmail)} |
1131 | @findex rmail-toggle-header | |
04242bdc GM |
1132 | To see the complete, original header, use the @kbd{t} command |
1133 | (@code{rmail-toggle-header}). This discards the reformatted headers of | |
1134 | the current message and displays it with the original header. Repeating | |
1135 | @kbd{t} reformats the message again, which shows only the interesting | |
1136 | headers according to the current values of the above variables. | |
1137 | Selecting the message again also reformats it if necessary. | |
6bf7aab6 | 1138 | |
6bf7aab6 DL |
1139 | When the @kbd{t} command has a prefix argument, a positive argument |
1140 | means to show the reformatted header, and a zero or negative argument | |
1141 | means to show the full header. | |
1142 | ||
1143 | @vindex rmail-highlighted-headers | |
3d963b67 GM |
1144 | Rmail highlights certain header fields that are especially |
1145 | interesting---by default, the @samp{From} and @samp{Subject} fields. | |
1146 | The variable @code{rmail-highlighted-headers} holds a regular expression | |
1147 | that specifies the header fields to highlight; if it matches the | |
1148 | beginning of a header field, that whole field is highlighted. To turn | |
1149 | off this feature, set @code{rmail-highlighted-headers} to @code{nil}. | |
1150 | Customize the face @code{rmail-highlight} to adjust the style of the | |
1151 | highlighting. | |
6bf7aab6 | 1152 | |
00cfe22c GM |
1153 | You can highlight and activate URLs in incoming messages using |
1154 | Goto Address mode: | |
1155 | ||
1156 | @c FIXME goto-addr.el commentary says to use goto-address instead. | |
1157 | @smallexample | |
1158 | (add-hook 'rmail-show-message-hook (lambda () (goto-address-mode 1))) | |
1159 | @end smallexample | |
1160 | ||
1161 | @noindent | |
1162 | Then you can browse these URLs by clicking on them with @kbd{Mouse-2} | |
1163 | (or @kbd{Mouse-1} quickly) or by moving to one and typing @kbd{C-c | |
1164 | @key{RET}}. @xref{Goto Address mode, Activating URLs, Activating URLs}. | |
358f71fd | 1165 | |
505e70c3 GM |
1166 | @cindex MIME messages (Rmail) |
1167 | @findex rmail-mime | |
1168 | @kindex v @r{(Rmail)} | |
1169 | The @kbd{v} (@code{rmail-mime}) command creates a temporary buffer | |
1170 | displaying the current MIME message. By default, it displays plain text | |
1171 | and multipart messages, and offers buttons to save attachments. | |
1172 | ||
358f71fd RS |
1173 | @node Rmail Coding |
1174 | @section Rmail and Coding Systems | |
6c21cdc0 | 1175 | |
eed0ee77 | 1176 | @cindex decoding mail messages (Rmail) |
76dd3692 | 1177 | Rmail automatically decodes messages which contain non-@acronym{ASCII} |
b8f86df3 EZ |
1178 | characters, just as Emacs does with files you visit and with subprocess |
1179 | output. Rmail uses the standard @samp{charset=@var{charset}} header in | |
1180 | the message, if any, to determine how the message was encoded by the | |
1181 | sender. It maps @var{charset} into the corresponding Emacs coding | |
1182 | system (@pxref{Coding Systems}), and uses that coding system to decode | |
95009a13 RS |
1183 | message text. If the message header doesn't have the @samp{charset} |
1184 | specification, or if @var{charset} is not recognized, | |
b8f86df3 EZ |
1185 | Rmail chooses the coding system with the usual Emacs heuristics and |
1186 | defaults (@pxref{Recognize Coding}). | |
eed0ee77 | 1187 | |
eed0ee77 | 1188 | @cindex fixing incorrectly decoded mail messages |
358f71fd RS |
1189 | Occasionally, a message is decoded incorrectly, either because Emacs |
1190 | guessed the wrong coding system in the absence of the @samp{charset} | |
1191 | specification, or because the specification was inaccurate. For | |
1192 | example, a misconfigured mailer could send a message with a | |
1193 | @samp{charset=iso-8859-1} header when the message is actually encoded | |
1194 | in @code{koi8-r}. When you see the message text garbled, or some of | |
1195 | its characters displayed as empty boxes, this may have happened. | |
eed0ee77 | 1196 | |
358f71fd RS |
1197 | @findex rmail-redecode-body |
1198 | You can correct the problem by decoding the message again using the | |
1199 | right coding system, if you can figure out or guess which one is | |
1200 | right. To do this, invoke the @kbd{M-x rmail-redecode-body} command. | |
763e01c4 EZ |
1201 | It reads the name of a coding system, and then redecodes the message |
1202 | using the coding system you specified. If you specified the right | |
358f71fd RS |
1203 | coding system, the result should be readable. |
1204 | ||
6bf7aab6 DL |
1205 | @node Rmail Editing |
1206 | @section Editing Within a Message | |
1207 | ||
00cfe22c | 1208 | Most of the usual Emacs keybindings are available in Rmail mode, though a |
6bf7aab6 DL |
1209 | few, such as @kbd{C-M-n} and @kbd{C-M-h}, are redefined by Rmail for |
1210 | other purposes. However, the Rmail buffer is normally read only, and | |
1211 | most of the letters are redefined as Rmail commands. If you want to | |
1212 | edit the text of a message, you must use the Rmail command @kbd{e}. | |
1213 | ||
1214 | @table @kbd | |
1215 | @item e | |
1216 | Edit the current message as ordinary text. | |
1217 | @end table | |
1218 | ||
1219 | @kindex e @r{(Rmail)} | |
1220 | @findex rmail-edit-current-message | |
1221 | The @kbd{e} command (@code{rmail-edit-current-message}) switches from | |
1222 | Rmail mode into Rmail Edit mode, another major mode which is nearly the | |
1223 | same as Text mode. The mode line indicates this change. | |
1224 | ||
1225 | In Rmail Edit mode, letters insert themselves as usual and the Rmail | |
00cfe22c | 1226 | commands are not available. You can edit the message body and header |
5f50b807 RS |
1227 | fields. When you are finished editing the message, type @kbd{C-c C-c} |
1228 | to switch back to Rmail mode. Alternatively, you can return to Rmail | |
00cfe22c | 1229 | mode but cancel any editing that you have done, by typing @kbd{C-c C-]}. |
6bf7aab6 DL |
1230 | |
1231 | @vindex rmail-edit-mode-hook | |
5f50b807 RS |
1232 | Entering Rmail Edit mode runs the hook @code{text-mode-hook}; then |
1233 | it runs the hook @code{rmail-edit-mode-hook} (@pxref{Hooks}). | |
1234 | Returning to ordinary Rmail mode adds the attribute @samp{edited} to | |
1235 | the message, if you have made any changes in it. | |
6bf7aab6 DL |
1236 | |
1237 | @node Rmail Digest | |
1238 | @section Digest Messages | |
1239 | @cindex digest message | |
1240 | @cindex undigestify | |
1241 | ||
1242 | A @dfn{digest message} is a message which exists to contain and carry | |
1243 | several other messages. Digests are used on some moderated mailing | |
1244 | lists; all the messages that arrive for the list during a period of time | |
1245 | such as one day are put inside a single digest which is then sent to the | |
1246 | subscribers. Transmitting the single digest uses much less computer | |
1247 | time than transmitting the individual messages even though the total | |
1248 | size is the same, because the per-message overhead in network mail | |
1249 | transmission is considerable. | |
1250 | ||
1251 | @findex undigestify-rmail-message | |
1252 | When you receive a digest message, the most convenient way to read it is | |
1253 | to @dfn{undigestify} it: to turn it back into many individual messages. | |
1254 | Then you can read and delete the individual messages as it suits you. | |
eca274b1 | 1255 | To do this, select the digest message and type the command @kbd{M-x |
6bf7aab6 DL |
1256 | undigestify-rmail-message}. This extracts the submessages as separate |
1257 | Rmail messages, and inserts them following the digest. The digest | |
1258 | message itself is flagged as deleted. | |
1259 | ||
6bf7aab6 DL |
1260 | @node Rmail Rot13 |
1261 | @section Reading Rot13 Messages | |
1262 | @cindex rot13 code | |
1263 | ||
1264 | Mailing list messages that might offend some readers are sometimes | |
1265 | encoded in a simple code called @dfn{rot13}---so named because it | |
1266 | rotates the alphabet by 13 letters. This code is not for secrecy, as it | |
1267 | provides none; rather, it enables those who might be offended to avoid | |
444246ca | 1268 | seeing the real text of the message. |
6bf7aab6 DL |
1269 | |
1270 | @findex rot13-other-window | |
444246ca | 1271 | To view a buffer which uses the rot13 code, use the command @kbd{M-x |
6bf7aab6 DL |
1272 | rot13-other-window}. This displays the current buffer in another window |
1273 | which applies the code when displaying the text. | |
1274 | ||
1275 | @node Movemail | |
ea20444b | 1276 | @section @code{movemail} program |
6bf7aab6 DL |
1277 | @cindex @code{movemail} program |
1278 | ||
00cfe22c GM |
1279 | Rmail uses the @code{movemail} program to move mail from your inbox to |
1280 | your Rmail file (@pxref{Rmail Inbox}). When loaded for the first time, | |
1281 | Rmail attempts to locate the @code{movemail} program and determine its | |
1282 | version. There are two versions of the @code{movemail} program: the | |
1283 | native one, shipped with GNU Emacs (the ``emacs version'') and the one | |
1284 | included in GNU mailutils (the ``mailutils version,'' | |
1285 | @pxref{movemail,,,mailutils,GNU mailutils}). They support the same | |
1286 | command line syntax and the same basic subset of options. However, the | |
1287 | Mailutils version offers additional features. | |
1288 | ||
1289 | The Emacs version of @code{movemail} is able to retrieve mail from the | |
1be48cfa RS |
1290 | usual UNIX mailbox formats and from remote mailboxes using the POP3 |
1291 | protocol. | |
1292 | ||
1293 | The Mailutils version is able to handle a wide set of mailbox | |
1294 | formats, such as plain UNIX mailboxes, @code{maildir} and @code{MH} | |
00cfe22c | 1295 | mailboxes, etc. It is able to access remote mailboxes using the POP3 or |
1be48cfa | 1296 | IMAP4 protocol, and can retrieve mail from them using a TLS encrypted |
00cfe22c | 1297 | channel. It also accepts mailbox arguments in @acronym{URL} form. |
1be48cfa | 1298 | The detailed description of mailbox @acronym{URL}s can be found in |
00cfe22c | 1299 | @ref{URL,,,mailutils,Mailbox URL Formats}. In short, a @acronym{URL} is: |
ea20444b EZ |
1300 | |
1301 | @smallexample | |
1302 | @var{proto}://[@var{user}[:@var{password}]@@]@var{host-or-file-name} | |
1303 | @end smallexample | |
1304 | ||
1305 | @noindent | |
1306 | where square brackets denote optional elements. | |
1307 | ||
1308 | @table @var | |
1309 | @item proto | |
1310 | Specifies the @dfn{mailbox protocol}, or @dfn{format} to | |
1311 | use. The exact semantics of the rest of @acronym{URL} elements depends | |
d1019816 | 1312 | on the actual value of @var{proto} (see below). |
ea20444b EZ |
1313 | |
1314 | @item user | |
1315 | User name to access the remote mailbox. | |
1316 | ||
1317 | @item password | |
1318 | User password to access the remote mailbox. | |
1319 | ||
1320 | @item host-or-file-name | |
1321 | Hostname of the remote server for remote mailboxes or file name of a | |
1322 | local mailbox. | |
1323 | @end table | |
1324 | ||
d1019816 | 1325 | @noindent |
ea20444b EZ |
1326 | @var{Proto} can be one of: |
1327 | ||
d1019816 | 1328 | @table @code |
ea20444b EZ |
1329 | @item mbox |
1330 | Usual UNIX mailbox format. In this case, neither @var{user} nor | |
1331 | @var{pass} are used, and @var{host-or-file-name} denotes the file name of | |
1332 | the mailbox file, e.g., @code{mbox://var/spool/mail/smith}. | |
1333 | ||
1334 | @item mh | |
1335 | A local mailbox in the @acronym{MH} format. @var{User} and | |
1336 | @var{pass} are not used. @var{Host-or-file-name} denotes the name of | |
1337 | @acronym{MH} folder, e.g., @code{mh://Mail/inbox}. | |
1338 | ||
1339 | @item maildir | |
1340 | A local mailbox in the @acronym{maildir} format. @var{User} and | |
1341 | @var{pass} are not used, and @var{host-or-file-name} denotes the name of | |
1342 | @code{maildir} mailbox, e.g., @code{maildir://mail/inbox}. | |
1343 | ||
1344 | @item file | |
1345 | Any local mailbox format. Its actual format is detected automatically | |
1346 | by @code{movemail}. | |
1347 | ||
1348 | @item pop | |
1349 | A remote mailbox to be accessed via POP3 protocol. @var{User} | |
1350 | specifies the remote user name to use, @var{pass} may be used to | |
1351 | specify the user password, @var{host-or-file-name} is the name or IP | |
1352 | address of the remote mail server to connect to; e.g., | |
1353 | @code{pop://smith:guessme@@remote.server.net}. | |
32823124 | 1354 | |
ea20444b EZ |
1355 | @item imap |
1356 | A remote mailbox to be accessed via IMAP4 protocol. @var{User} | |
1357 | specifies the remote user name to use, @var{pass} may be used to | |
1358 | specify the user password, @var{host-or-file-name} is the name or IP | |
1359 | address of the remote mail server to connect to; | |
1360 | e.g., @code{imap://smith:guessme@@remote.server.net}. | |
1361 | @end table | |
1362 | ||
1be48cfa RS |
1363 | Alternatively, you can specify the file name of the mailbox to use. |
1364 | This is equivalent to specifying the @samp{file} protocol: | |
ea20444b EZ |
1365 | |
1366 | @smallexample | |
1be48cfa | 1367 | /var/spool/mail/@var{user} @equiv{} file://var/spool/mail/@var{user} |
ea20444b EZ |
1368 | @end smallexample |
1369 | ||
1370 | @vindex rmail-movemail-program | |
1371 | @vindex rmail-movemail-search-path | |
1be48cfa RS |
1372 | The variable @code{rmail-movemail-program} controls which version of |
1373 | @code{movemail} to use. If that is a string, it specifies the | |
1374 | absolute file name of the @code{movemail} executable. If it is | |
1375 | @code{nil}, Rmail searches for @code{movemail} in the directories | |
1376 | listed in @code{rmail-movemail-search-path} and @code{exec-path}, then | |
1377 | in @code{exec-directory}. | |
32823124 | 1378 | |
ea20444b EZ |
1379 | @node Remote Mailboxes |
1380 | @section Retrieving Mail from Remote Mailboxes | |
1381 | @pindex movemail | |
1382 | ||
6bf7aab6 | 1383 | Some sites use a method called POP for accessing users' inbox data |
00cfe22c GM |
1384 | instead of storing the data in inbox files. By default, the @code{Emacs |
1385 | movemail} can work with POP (unless the Emacs @code{configure} script | |
1386 | was run with the option @samp{--without-pop}). | |
ea20444b | 1387 | |
00cfe22c GM |
1388 | Similarly, the Mailutils @code{movemail} by default supports POP, unless |
1389 | it was configured with the @samp{--disable-pop} option. | |
ea20444b EZ |
1390 | |
1391 | Both versions of @code{movemail} only work with POP3, not with older | |
6bf7aab6 DL |
1392 | versions of POP. |
1393 | ||
60a96371 | 1394 | @cindex @env{MAILHOST} environment variable |
ea20444b EZ |
1395 | @cindex POP mailboxes |
1396 | No matter which flavor of @code{movemail} you use, you can specify | |
00cfe22c | 1397 | a POP inbox by using a POP @dfn{URL} (@pxref{Movemail}). A POP |
ea20444b EZ |
1398 | @acronym{URL} is a ``file name'' of the form |
1399 | @samp{pop://@var{username}@@@var{hostname}}, where | |
1400 | @var{hostname} is the host name or IP address of the remote mail | |
1401 | server and @var{username} is the user name on that server. | |
1402 | Additionally, you may specify the password in the mailbox @acronym{URL}: | |
1403 | @samp{pop://@var{username}:@var{password}@@@var{hostname}}. In this | |
1404 | case, @var{password} takes preference over the one set by | |
00cfe22c GM |
1405 | @code{rmail-remote-password} (see below). This is especially useful |
1406 | if you have several remote mailboxes with different passwords. | |
1407 | ||
1408 | For backward compatibility, Rmail also supports an alternative way of | |
1409 | specifying remote POP mailboxes. Specifying an inbox name in the form | |
1410 | @samp{po:@var{username}:@var{hostname}} is equivalent to | |
1411 | @samp{pop://@var{username}@@@var{hostname}}. If you omit the | |
1412 | @var{:hostname} part, the @env{MAILHOST} environment variable specifies | |
1413 | the machine on which to look for the POP server. | |
1414 | ||
1415 | @c FIXME mention --with-hesiod "support Hesiod to get the POP server host"? | |
ea20444b EZ |
1416 | |
1417 | @cindex IMAP mailboxes | |
1418 | Another method for accessing remote mailboxes is IMAP. This method is | |
b2c09a2e | 1419 | supported only by the Mailutils @code{movemail}. To specify an IMAP |
ea20444b EZ |
1420 | mailbox in the inbox list, use the following mailbox @acronym{URL}: |
1421 | @samp{imap://@var{username}[:@var{password}]@@@var{hostname}}. The | |
32823124 | 1422 | @var{password} part is optional, as described above. |
ea20444b EZ |
1423 | |
1424 | @vindex rmail-remote-password | |
1425 | @vindex rmail-remote-password-required | |
ea20444b EZ |
1426 | Accessing a remote mailbox may require a password. Rmail uses the |
1427 | following algorithm to retrieve it: | |
1428 | ||
1429 | @enumerate | |
32823124 | 1430 | @item |
00cfe22c | 1431 | If a @var{password} is present in the mailbox URL (see above), it is |
38be61d5 | 1432 | used. |
32823124 | 1433 | @item |
00cfe22c GM |
1434 | If the variable @code{rmail-remote-password-required} is @code{nil}, |
1435 | Rmail assumes no password is required. | |
1436 | @item | |
38be61d5 EZ |
1437 | If the variable @code{rmail-remote-password} is non-@code{nil}, its |
1438 | value is used. | |
1439 | @item | |
00cfe22c | 1440 | Otherwise, Rmail will ask you for the password to use. |
ea20444b EZ |
1441 | @end enumerate |
1442 | ||
6bf7aab6 DL |
1443 | @vindex rmail-movemail-flags |
1444 | If you need to pass additional command-line flags to @code{movemail}, | |
1445 | set the variable @code{rmail-movemail-flags} a list of the flags you | |
1446 | wish to use. Do not use this variable to pass the @samp{-p} flag to | |
1447 | preserve your inbox contents; use @code{rmail-preserve-inbox} instead. | |
1448 | ||
1449 | @cindex Kerberos POP authentication | |
1450 | The @code{movemail} program installed at your site may support | |
00cfe22c GM |
1451 | Kerberos authentication (the Emacs @code{movemail} does so if Emacs was |
1452 | configured with the option @code{--with-kerberos} or | |
1453 | @code{--with-kerberos5}). If it is supported, it is used by default | |
1454 | whenever you attempt to retrieve POP mail when | |
1455 | @code{rmail-remote-password} and @code{rmail-remote-password-required} | |
1456 | are unset. | |
6bf7aab6 | 1457 | |
4946337d | 1458 | @cindex reverse order in POP inboxes |
6bf7aab6 DL |
1459 | Some POP servers store messages in reverse order. If your server does |
1460 | this, and you would rather read your mail in the order in which it was | |
1461 | received, you can tell @code{movemail} to reverse the order of | |
1462 | downloaded messages by adding the @samp{-r} flag to | |
1463 | @code{rmail-movemail-flags}. | |
ab5796a9 | 1464 | |
ea20444b | 1465 | @cindex TLS encryption (Rmail) |
b2c09a2e | 1466 | Mailutils @code{movemail} supports TLS encryption. If you wish to |
ea20444b EZ |
1467 | use it, add the @samp{--tls} flag to @code{rmail-movemail-flags}. |
1468 | ||
1469 | @node Other Mailbox Formats | |
1470 | @section Retrieving Mail from Local Mailboxes in Various Formats | |
1471 | ||
1472 | If your incoming mail is stored on a local machine in a format other | |
444246ca KB |
1473 | than UNIX mailbox, you will need the Mailutils @code{movemail} to |
1474 | retrieve it. @xref{Movemail}, for the detailed description of | |
1475 | @code{movemail} versions. For example, to access mail from a inbox in | |
1476 | @code{maildir} format located in @file{/var/spool/mail/in}, you would | |
1477 | include the following in the Rmail inbox list: | |
ea20444b EZ |
1478 | |
1479 | @smallexample | |
1480 | maildir://var/spool/mail/in | |
1481 | @end smallexample | |
1482 | ||
ab5796a9 MB |
1483 | @ignore |
1484 | arch-tag: 034965f6-38df-47a2-a9f1-b8bc8ab37e23 | |
1485 | @end ignore |