annotate man/rmail.texi @ 73353:ae1dd9c6ba18

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