diff options
| author | Richard M. Stallman | 2009-02-17 18:15:59 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2009-02-17 18:15:59 +0000 |
| commit | 5f50b807bb1633ec0896682615950e6368fecbaf (patch) | |
| tree | 3ad3dee7d438c8f1be313daed35b9c2fd0a742b6 | |
| parent | 57d2296ade3299c9f018e058aaf26c06e9b121b7 (diff) | |
| download | emacs-5f50b807bb1633ec0896682615950e6368fecbaf.tar.gz emacs-5f50b807bb1633ec0896682615950e6368fecbaf.zip | |
Update for mbox format.
Various small fixes, as well as the following.
(Out of Rmail): Node deleted.
(Rmail): Update menu.
(Rmail Files): Comment out set-rmail-inbox-list.
Document rmail-inbox-list instead.
(Rmail Output): Substantial changes since C-o is now
rmail-output-as-seen and o is rmail-output.
(Rmail Attributes): Delete `stored', add `retried'.
(Rmail Display): Editing headers works in all cases.
| -rw-r--r-- | doc/emacs/rmail.texi | 142 |
1 files changed, 51 insertions, 91 deletions
diff --git a/doc/emacs/rmail.texi b/doc/emacs/rmail.texi index 1d07f1cc2c1..0a863acb09c 100644 --- a/doc/emacs/rmail.texi +++ b/doc/emacs/rmail.texi | |||
| @@ -32,7 +32,6 @@ to run commands for managing mail. | |||
| 32 | * Coding: Rmail Coding. How Rmail handles decoding character sets. | 32 | * Coding: Rmail Coding. How Rmail handles decoding character sets. |
| 33 | * Editing: Rmail Editing. Editing message text and headers in Rmail. | 33 | * Editing: Rmail Editing. Editing message text and headers in Rmail. |
| 34 | * Digest: Rmail Digest. Extracting the messages from a digest message. | 34 | * Digest: Rmail Digest. Extracting the messages from a digest message. |
| 35 | * Out of Rmail:: Converting an Rmail file to mailbox format. | ||
| 36 | * Rot13: Rmail Rot13. Reading messages encoded in the rot13 code. | 35 | * Rot13: Rmail Rot13. Reading messages encoded in the rot13 code. |
| 37 | * Movemail:: More details of fetching new mail. | 36 | * Movemail:: More details of fetching new mail. |
| 38 | * Remote Mailboxes:: Retrieving Mail from Remote Mailboxes. | 37 | * Remote Mailboxes:: Retrieving Mail from Remote Mailboxes. |
| @@ -52,7 +51,7 @@ Rmail file, merges new mail in from your inboxes, displays the first | |||
| 52 | message you haven't read yet, and lets you begin reading. The variable | 51 | message you haven't read yet, and lets you begin reading. The variable |
| 53 | @code{rmail-file-name} specifies the name of the primary Rmail file. | 52 | @code{rmail-file-name} specifies the name of the primary Rmail file. |
| 54 | 53 | ||
| 55 | Rmail uses narrowing to hide all but one message in the Rmail file. | 54 | Rmail displays only one message in the Rmail file at a time. |
| 56 | The message that is shown is called the @dfn{current message}. Rmail | 55 | The message that is shown is called the @dfn{current message}. Rmail |
| 57 | mode's special commands can do such things as delete the current | 56 | mode's special commands can do such things as delete the current |
| 58 | message, copy it into another file, send a reply, or move to another | 57 | message, copy it into another file, send a reply, or move to another |
| @@ -370,7 +369,7 @@ exist, and Rmail will use it again the next time it gets new mail from | |||
| 370 | that inbox. | 369 | that inbox. |
| 371 | 370 | ||
| 372 | If Rmail is unable to convert the data in | 371 | If Rmail is unable to convert the data in |
| 373 | @file{~/.newmail-@var{inboxname}} into Babyl format, it renames the file | 372 | @file{~/.newmail-@var{inboxname}} into mbox format, it renames the file |
| 374 | to @file{~/RMAILOSE.@var{n}} (@var{n} is an integer chosen to make the | 373 | to @file{~/RMAILOSE.@var{n}} (@var{n} is an integer chosen to make the |
| 375 | name unique) so that Rmail will not have trouble with the data again. | 374 | name unique) so that Rmail will not have trouble with the data again. |
| 376 | You should look at the file, find whatever message confuses Rmail | 375 | You should look at the file, find whatever message confuses Rmail |
| @@ -410,11 +409,13 @@ in Rmail mode. You can use @kbd{M-x rmail-input} even when not in | |||
| 410 | Rmail, but it is easier to type @kbd{C-u M-x rmail}, which does the | 409 | Rmail, but it is easier to type @kbd{C-u M-x rmail}, which does the |
| 411 | same thing. | 410 | same thing. |
| 412 | 411 | ||
| 413 | The file you read with @kbd{i} should normally be a valid Rmail file. | 412 | The file you read with @kbd{i} should normally be a valid mbox file. |
| 414 | If it is not, Rmail tries to decompose it into a stream of messages in | 413 | If it is not, Rmail tries to convert its text to mbox format, and |
| 415 | various known formats. If it succeeds, it converts the whole file to an | 414 | visits the converted text in the buffer. If you save the buffer, that |
| 416 | Rmail file. If you specify a file name that doesn't exist, @kbd{i} | 415 | converts the file. |
| 417 | initializes a new buffer for creating a new Rmail file. | 416 | |
| 417 | If you specify a file name that doesn't exist, @kbd{i} initializes a | ||
| 418 | new buffer for creating a new Rmail file. | ||
| 418 | 419 | ||
| 419 | @vindex rmail-secondary-file-directory | 420 | @vindex rmail-secondary-file-directory |
| 420 | @vindex rmail-secondary-file-regexp | 421 | @vindex rmail-secondary-file-regexp |
| @@ -427,6 +428,7 @@ second says which files in that directory to offer (all those that | |||
| 427 | match the regular expression). These variables also apply to choosing | 428 | match the regular expression). These variables also apply to choosing |
| 428 | a file for output (@pxref{Rmail Output}). | 429 | a file for output (@pxref{Rmail Output}). |
| 429 | 430 | ||
| 431 | @ignore | ||
| 430 | @findex set-rmail-inbox-list | 432 | @findex set-rmail-inbox-list |
| 431 | Each Rmail file can contain a list of inbox file names; you can specify | 433 | Each Rmail file can contain a list of inbox file names; you can specify |
| 432 | this list with @kbd{M-x set-rmail-inbox-list @key{RET} @var{files} | 434 | this list with @kbd{M-x set-rmail-inbox-list @key{RET} @var{files} |
| @@ -434,9 +436,13 @@ this list with @kbd{M-x set-rmail-inbox-list @key{RET} @var{files} | |||
| 434 | by commas. It can also be empty, which specifies that this file should | 436 | by commas. It can also be empty, which specifies that this file should |
| 435 | have no inboxes. Once you specify a list of inboxes in an Rmail file, | 437 | have no inboxes. Once you specify a list of inboxes in an Rmail file, |
| 436 | the Rmail file remembers it permanently until you specify a different list. | 438 | the Rmail file remembers it permanently until you specify a different list. |
| 439 | @end ignore | ||
| 437 | 440 | ||
| 438 | As a special exception, if your primary Rmail file does not specify any | 441 | @vindex rmail-inbox-list |
| 439 | inbox files, it uses your standard system inbox. | 442 | The inbox files to use are specified by the variable |
| 443 | @code{rmail-inbox-list}, which is buffer-local in Rmail mode. As a | ||
| 444 | special exception, if you have specified no inbox files for your | ||
| 445 | primary Rmail file, it uses your standard system inbox. | ||
| 440 | 446 | ||
| 441 | @kindex g @r{(Rmail)} | 447 | @kindex g @r{(Rmail)} |
| 442 | @findex rmail-get-new-mail | 448 | @findex rmail-get-new-mail |
| @@ -458,12 +464,12 @@ therefore, a general way of merging one file of messages into another. | |||
| 458 | 464 | ||
| 459 | @table @kbd | 465 | @table @kbd |
| 460 | @item o @var{file} @key{RET} | 466 | @item o @var{file} @key{RET} |
| 461 | Append a copy of the current message to the file @var{file}, using Rmail | 467 | Append a full copy of the current message to the file @var{file} |
| 462 | file format by default (@code{rmail-output-to-rmail-file}). | 468 | (@code{rmail-output}). |
| 463 | 469 | ||
| 464 | @item C-o @var{file} @key{RET} | 470 | @item C-o @var{file} @key{RET} |
| 465 | Append a copy of the current message to the file @var{file}, using | 471 | Append a copy of the current message, as displayed, to the file |
| 466 | system inbox file format by default (@code{rmail-output}). | 472 | @var{file} (@code{rmail-output-as-seen}). |
| 467 | 473 | ||
| 468 | @item w @var{file} @key{RET} | 474 | @item w @var{file} @key{RET} |
| 469 | Output just the message body to the file @var{file}, taking the default | 475 | Output just the message body to the file @var{file}, taking the default |
| @@ -471,25 +477,21 @@ file name from the message @samp{Subject} header. | |||
| 471 | @end table | 477 | @end table |
| 472 | 478 | ||
| 473 | @kindex o @r{(Rmail)} | 479 | @kindex o @r{(Rmail)} |
| 474 | @findex rmail-output-to-rmail-file | 480 | @findex rmail-output-as-seen |
| 475 | @kindex C-o @r{(Rmail)} | 481 | @kindex C-o @r{(Rmail)} |
| 476 | @findex rmail-output | 482 | @findex rmail-output |
| 477 | The commands @kbd{o} and @kbd{C-o} copy the current message into a | 483 | The commands @kbd{o} and @kbd{C-o} copy the current message into a |
| 478 | specified file. This file may be an Rmail file or it may be in system | 484 | specified file, adding it at the end. The two commands differ mainly |
| 479 | inbox format; the output commands ascertain the file's format and write | 485 | in how much to copy: @kbd{o} copies the full message headers, even if |
| 480 | the copied message in that format. | 486 | they are not all visible, while @kbd{C-o} copies exactly the headers |
| 481 | 487 | currently displayed and no more. @xref{Rmail Display}. In addition, | |
| 482 | The @kbd{o} and @kbd{C-o} commands differ in two ways: each has its | 488 | @kbd{o} converts the message to Babyl format (used by Rmail in Emacs |
| 483 | own separate default file name, and each specifies a choice of format to | 489 | version 22 and before) if the file is in Babyl format; @kbd{C-o} |
| 484 | use when the file does not already exist. The @kbd{o} command uses | 490 | cannot output to Babyl files at all. |
| 485 | Rmail format when it creates a new file, while @kbd{C-o} uses system | 491 | |
| 486 | inbox format for a new file. The default file name for @kbd{o} is the | 492 | If the output file is currently visited in an Emacs buffer, the |
| 487 | file name used last with @kbd{o}, and the default file name for | 493 | output commands append the message to that buffer. It is up to you to |
| 488 | @kbd{C-o} is the file name used last with @kbd{C-o}. | 494 | save the buffer eventually in its file. |
| 489 | |||
| 490 | If the output file is an Rmail file currently visited in an Emacs buffer, | ||
| 491 | the output commands copy the message into that buffer. It is up to you | ||
| 492 | to save the buffer eventually in its file. | ||
| 493 | 495 | ||
| 494 | @kindex w @r{(Rmail)} | 496 | @kindex w @r{(Rmail)} |
| 495 | @findex rmail-output-body-to-file | 497 | @findex rmail-output-body-to-file |
| @@ -514,17 +516,12 @@ match the regular expression). | |||
| 514 | @vindex rmail-delete-after-output | 516 | @vindex rmail-delete-after-output |
| 515 | Copying a message with @kbd{o} or @kbd{C-o} gives the original copy | 517 | Copying a message with @kbd{o} or @kbd{C-o} gives the original copy |
| 516 | of the message the @samp{filed} attribute, so that @samp{filed} | 518 | of the message the @samp{filed} attribute, so that @samp{filed} |
| 517 | appears in the mode line when such a message is current. @kbd{w} | 519 | appears in the mode line when such a message is current. |
| 518 | gives it the @samp{stored} attribute. If you like to keep just a | 520 | |
| 519 | single copy of every mail message, set the variable | 521 | If you like to keep just a single copy of every mail message, set |
| 520 | @code{rmail-delete-after-output} to @code{t}; then the @kbd{o}, | 522 | the variable @code{rmail-delete-after-output} to @code{t}; then the |
| 521 | @kbd{C-o} and @kbd{w} commands delete the original message after | 523 | @kbd{o}, @kbd{C-o} and @kbd{w} commands delete the original message |
| 522 | copying it. (You can undelete the original afterward if you wish.) | 524 | after copying it. (You can undelete it afterward if you wish.) |
| 523 | |||
| 524 | Copying messages into files in system inbox format uses the header | ||
| 525 | fields that are displayed in Rmail at the time. Thus, if you use the | ||
| 526 | @kbd{t} command to view the entire header and then copy the message, the | ||
| 527 | entire header is copied. @xref{Rmail Display}. | ||
| 528 | 525 | ||
| 529 | @vindex rmail-output-file-alist | 526 | @vindex rmail-output-file-alist |
| 530 | The variable @code{rmail-output-file-alist} lets you specify | 527 | The variable @code{rmail-output-file-alist} lets you specify |
| @@ -633,8 +630,6 @@ removed by undeletion commands (@pxref{Rmail Deletion}). | |||
| 633 | @item filed | 630 | @item filed |
| 634 | Means the message has been copied to some other file. Assigned by the | 631 | Means the message has been copied to some other file. Assigned by the |
| 635 | @kbd{o} and @kbd{C-o} file output commands (@pxref{Rmail Output}). | 632 | @kbd{o} and @kbd{C-o} file output commands (@pxref{Rmail Output}). |
| 636 | @item stored | ||
| 637 | Assigned by the @kbd{w} file output command (@pxref{Rmail Output}). | ||
| 638 | @item answered | 633 | @item answered |
| 639 | Means you have mailed an answer to the message. Assigned by the @kbd{r} | 634 | Means you have mailed an answer to the message. Assigned by the @kbd{r} |
| 640 | command (@code{rmail-reply}). @xref{Rmail Reply}. | 635 | command (@code{rmail-reply}). @xref{Rmail Reply}. |
| @@ -647,6 +642,9 @@ Means you have edited the text of the message within Rmail. | |||
| 647 | @item resent | 642 | @item resent |
| 648 | Means you have resent the message. Assigned by the command @kbd{M-x | 643 | Means you have resent the message. Assigned by the command @kbd{M-x |
| 649 | rmail-resend}. @xref{Rmail Reply}. | 644 | rmail-resend}. @xref{Rmail Reply}. |
| 645 | @item retried | ||
| 646 | Means you have retried a failed outgoing message. Assigned by the | ||
| 647 | command @kbd{M-x rmail-retry-failure}. @xref{Rmail Reply}. | ||
| 650 | @end table | 648 | @end table |
| 651 | 649 | ||
| 652 | All other labels are assigned or removed only by users, and have no | 650 | All other labels are assigned or removed only by users, and have no |
| @@ -761,7 +759,7 @@ if you provide a numeric argument.) | |||
| 761 | 759 | ||
| 762 | @kindex m @r{(Rmail)} | 760 | @kindex m @r{(Rmail)} |
| 763 | @findex rmail-mail | 761 | @findex rmail-mail |
| 764 | The @kbd{m} (@code{rmail-mail}) command is used to start editing an | 762 | Use the @kbd{m} (@code{rmail-mail}) command to start editing an |
| 765 | outgoing message that is not a reply. It leaves the header fields empty. | 763 | outgoing message that is not a reply. It leaves the header fields empty. |
| 766 | Its only difference from @kbd{C-x 4 m} is that it makes the Rmail buffer | 764 | Its only difference from @kbd{C-x 4 m} is that it makes the Rmail buffer |
| 767 | accessible for @kbd{C-c C-y}, just as @kbd{r} does. Thus, @kbd{m} can be | 765 | accessible for @kbd{C-c C-y}, just as @kbd{r} does. Thus, @kbd{m} can be |
| @@ -1038,12 +1036,6 @@ again, which shows only the interesting headers according to the | |||
| 1038 | current values of those variable. Selecting the message again also | 1036 | current values of those variable. Selecting the message again also |
| 1039 | reformats it if necessary. | 1037 | reformats it if necessary. |
| 1040 | 1038 | ||
| 1041 | One consequence of this is that if you edit the reformatted header | ||
| 1042 | (using @kbd{e}; @pxref{Rmail Editing}), subsequent use of @kbd{t} will | ||
| 1043 | discard your edits. On the other hand, if you use @kbd{e} after | ||
| 1044 | @kbd{t}, to edit the original (unreformatted) header, those changes are | ||
| 1045 | permanent. | ||
| 1046 | |||
| 1047 | When the @kbd{t} command has a prefix argument, a positive argument | 1039 | When the @kbd{t} command has a prefix argument, a positive argument |
| 1048 | means to show the reformatted header, and a zero or negative argument | 1040 | means to show the reformatted header, and a zero or negative argument |
| 1049 | means to show the full header. | 1041 | means to show the full header. |
| @@ -1123,18 +1115,17 @@ Rmail mode into Rmail Edit mode, another major mode which is nearly the | |||
| 1123 | same as Text mode. The mode line indicates this change. | 1115 | same as Text mode. The mode line indicates this change. |
| 1124 | 1116 | ||
| 1125 | In Rmail Edit mode, letters insert themselves as usual and the Rmail | 1117 | In Rmail Edit mode, letters insert themselves as usual and the Rmail |
| 1126 | commands are not available. When you are finished editing the message and | 1118 | commands are not available. You can edit message body and header |
| 1127 | are ready to go back to Rmail, type @kbd{C-c C-c}, which switches back to | 1119 | fields. When you are finished editing the message, type @kbd{C-c C-c} |
| 1128 | Rmail mode. Alternatively, you can return to Rmail mode but cancel all the | 1120 | to switch back to Rmail mode. Alternatively, you can return to Rmail |
| 1129 | editing that you have done, by typing @kbd{C-c C-]}. | 1121 | mode but cancel all the editing that you have done, by typing @kbd{C-c |
| 1122 | C-]}. | ||
| 1130 | 1123 | ||
| 1131 | @vindex rmail-edit-mode-hook | 1124 | @vindex rmail-edit-mode-hook |
| 1132 | Entering Rmail Edit mode runs the hook @code{text-mode-hook}; then it | 1125 | Entering Rmail Edit mode runs the hook @code{text-mode-hook}; then |
| 1133 | runs the hook @code{rmail-edit-mode-hook} (@pxref{Hooks}). It adds the | 1126 | it runs the hook @code{rmail-edit-mode-hook} (@pxref{Hooks}). |
| 1134 | attribute @samp{edited} to the message. It also displays the full | 1127 | Returning to ordinary Rmail mode adds the attribute @samp{edited} to |
| 1135 | headers of the message, so that you can edit the headers as well as the | 1128 | the message, if you have made any changes in it. |
| 1136 | body of the message, and your changes in the headers will be | ||
| 1137 | permanent. | ||
| 1138 | 1129 | ||
| 1139 | @node Rmail Digest | 1130 | @node Rmail Digest |
| 1140 | @section Digest Messages | 1131 | @section Digest Messages |
| @@ -1159,37 +1150,6 @@ undigestify-rmail-message}. This extracts the submessages as separate | |||
| 1159 | Rmail messages, and inserts them following the digest. The digest | 1150 | Rmail messages, and inserts them following the digest. The digest |
| 1160 | message itself is flagged as deleted. | 1151 | message itself is flagged as deleted. |
| 1161 | 1152 | ||
| 1162 | @node Out of Rmail | ||
| 1163 | @section Converting an Rmail File to Inbox Format | ||
| 1164 | @cindex Babyl format to Inbox format | ||
| 1165 | @cindex converting Rmail file to mailbox format | ||
| 1166 | |||
| 1167 | @findex unrmail | ||
| 1168 | The command @kbd{M-x unrmail} converts a file in Rmail format to inbox | ||
| 1169 | format (also known as the system mailbox, or mbox, format), so that | ||
| 1170 | you can use it with other mail-editing tools. You must specify two | ||
| 1171 | arguments, the name of the Rmail file and the name to use for the | ||
| 1172 | converted file. @kbd{M-x unrmail} does not alter the Rmail file itself. | ||
| 1173 | |||
| 1174 | @pindex b2m | ||
| 1175 | @kbd{M-x unrmail} is useful if you can run Emacs on the machine | ||
| 1176 | where the Rmail file resides, or can access the Rmail file remotely | ||
| 1177 | (@pxref{Remote Files}) from a machine where Emacs is installed. If | ||
| 1178 | accessing Rmail files from Emacs is impossible, you can use the | ||
| 1179 | @command{b2m} program instead. @command{b2m} is part of the Emacs | ||
| 1180 | distribution, it is installed into the same directory as the | ||
| 1181 | @command{emacs} executable, and its source is available in the Emacs | ||
| 1182 | source distribution (in the @file{lib-src} directory), so that you could | ||
| 1183 | copy the source to the target machine and compile it there. (In the | ||
| 1184 | same directory, there is also a version written in Perl, @file{b2m.pl}.) | ||
| 1185 | |||
| 1186 | To convert a file @file{@var{babyl-file}} into @file{@var{mbox-file}}, | ||
| 1187 | invoke @command{b2m} like this: | ||
| 1188 | |||
| 1189 | @example | ||
| 1190 | b2m < @var{babyl-file} > @var{mbox-file} | ||
| 1191 | @end example | ||
| 1192 | |||
| 1193 | @node Rmail Rot13 | 1153 | @node Rmail Rot13 |
| 1194 | @section Reading Rot13 Messages | 1154 | @section Reading Rot13 Messages |
| 1195 | @cindex rot13 code | 1155 | @cindex rot13 code |