| blob | 828cd6e72e7091a2b5b0a878ddeaaf35c71a6b68 |
1 ;;; rmail.el --- main code of "RMAIL" mail reader for Emacs
3 ;; Copyright (C) 1985-1988, 1993-1998, 2000-2012
4 ;; Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: mail
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
28 ;; Souped up by shane@mit-ajax based on ideas of rlk@athena.mit.edu
29 ;; New features include attribute and keyword support, message
30 ;; selection by dispatch table, summary by attributes and keywords,
31 ;; expunging by dispatch table, sticky options for file commands.
33 ;; Extended by Bob Weiner of Motorola
34 ;; New features include: rmail and rmail-summary buffers remain
35 ;; synchronized and key bindings basically operate the same way in both
36 ;; buffers, summary by topic or by regular expression, rmail-reply-prefix
37 ;; variable, and a bury rmail buffer (wipe) command.
38 ;;
52 ;;; Attribute indexes
87 "An array that provides a mapping between an attribute index,
100 "The current header display style choice, one of
104 "Mail reader for Emacs."
108 "Rmail retrieval options."
113 "Rmail files."
118 "Rmail header options."
123 "Rmail reply options."
128 "Rmail summary options."
134 "Output message to a file."
140 "Rmail editing."
144 ;;;###autoload
146 "Name of user's primary mail file."
151 ;;;###autoload
158 ;;;###autoload
162 ;; SVR4 and recent BSD are said to use this.
163 ;; Rather than trying to know precisely which systems use it,
164 ;; let's assume this dir is never used for anything else.
166 ;; Many GNU/Linux systems use this name.
170 "Name of directory used by system mailer for delivering new mail.
171 Its name should end with a slash."
176 ;;;###autoload(custom-initialize-delay 'rmail-spool-directory nil)
179 "If non-nil, the file name of the `movemail' program."
187 "Password to use when reading mail from a remote server.
188 This setting is ignored for mailboxes whose URL already contains a password."
198 "Non-nil if a password is required when reading mail from a remote server."
204 "List of flags to pass to movemail.
205 Most commonly used to specify `-g' to enable GSS-API authentication
206 or `-k' to enable Kerberos authentication."
213 "Regular expression matching incorrect-password POP or IMAP server error
214 messages.
215 If you get an incorrect-password error that this expression does not match,
221 "Non-nil means leave incoming mail in the user's inbox--don't delete it."
226 "List of directories to search for movemail (in addition to `exec-path')."
235 "Determine what flavor of movemail PROG is.
236 We do this by executing it with `--version' and analyzing its output."
242 ;; Should not happen...
243 nil
251 ;; FIXME:
255 "Determine the file name of the `movemail' program and return its flavor.
256 If `rmail-movemail-program' is non-nil, use it.
257 Otherwise, look for `movemail' in the directories in
258 `rmail-movemail-search-path', those in `exec-path', and `exec-directory'."
265 ;; Previously, this didn't have to work on Windows, because
266 ;; rmail-insert-inbox-text before r1.439 fell back to using
267 ;; (expand-file-name "movemail" exec-directory) and just
268 ;; assuming it would work.
269 ;; http://lists.gnu.org/archive/html/bug-gnu-emacs/2008-02/msg00087.html
282 "The movemail variant currently in use. Known variants are:
284 `emacs' Means any implementation, compatible with the native Emacs one.
285 This is the default;
286 `mailutils' Means GNU mailutils implementation, capable of handling full
289 ;;;###autoload
291 "Return t if the current movemail variant is any of VARIANTS.
292 Currently known variants are 'emacs and 'mailutils."
294 ;; Autodetect
298 ;; Call for effect, to set rmail-movemail-program (if not set by the
299 ;; user), and rmail-movemail-variant-in-use. Used by various functions.
300 ;; I'm not sure if M-x rmail is the only entry point to this package.
301 ;; If so, this can be moved there.
304 ;;;###autoload
306 "Regexp matching user mail addresses.
307 If non-nil, this variable is used to identify the correspondent
308 when receiving new mail. If it matches the address of the sender,
309 the recipient is taken as correspondent of a mail.
310 If nil \(default value\), your `user-login-name' and `user-mail-address'
311 are used to exclude yourself as correspondent.
313 Usually you don't have to set this variable, except if you collect mails
314 sent by you under different user names.
315 Then it should be a regexp matching your mail addresses.
317 Setting this variable has an effect only before reading a mail."
322 ;;;###autoload
326 ;; Prior to 24.1, this used to contain "\\`info-".
327 ;;;###autoload
329 "Regexp specifying part of the default value of `mail-dont-reply-to-names'.
330 This is used when the user does not set `mail-dont-reply-to-names'
332 ;;;###autoload
336 ;;;###autoload
356 "Regexp to match header fields that Rmail should normally hide.
357 \(See also `rmail-nonignored-headers', which overrides this regexp.)
358 This variable is used for reformatting the message header,
359 which normally happens once for each message,
360 when you view the message for the first time in Rmail.
361 To make a change in this variable take effect
362 for a message that you have already viewed,
368 "Regexp to match X header fields that Rmail should show.
369 This regexp overrides `rmail-ignored-headers'; if both this regexp
370 and that one match a certain header field, Rmail shows the field.
371 If this is nil, ignore all header fields in `rmail-ignored-headers'.
373 This variable is used for reformatting the message header,
374 which normally happens once for each message,
375 when you view the message for the first time in Rmail.
376 To make a change in this variable take effect
377 for a message that you have already viewed,
382 ;;;###autoload
384 "Regexp to match Header fields that Rmail should display.
385 If nil, display all header fields except those matched by
386 `rmail-ignored-headers'."
390 ;;;###autoload
391 (defcustom rmail-retry-ignored-headers (purecopy "^x-authentication-warning:\\|^x-detected-operating-system:\\|^x-spam[-a-z]*:\\|content-type:\\|content-transfer-encoding:\\|mime-version:\\|message-id:")
392 "Headers that should be stripped when retrying a failed message."
397 ;;;###autoload
399 "Regexp to match Header fields that Rmail should normally highlight.
400 A value of nil means don't highlight. Uses the face `rmail-highlight'."
406 "Face to use for highlighting the most important header fields.
407 The variable `rmail-highlighted-headers' specifies which headers."
411 ;; This was removed in Emacs 23.1 with no notification, an unnecessary
412 ;; incompatible change.
414 "Face used by Rmail for highlighting headers."
415 ;; Note that nil doesn't actually mean use the default face, it
416 ;; means use either bold or highlight. It's not worth fixing this
417 ;; now that this is obsolete.
419 face)
422 "customize the face `rmail-highlight' instead."
427 "Face to use for highlighting the header names.
428 The variable `rmail-font-lock-keywords' specifies which headers
429 get highlighted."
434 "Non-nil means automatically delete a message that is copied to a file."
438 ;;;###autoload
440 "List of files that are inboxes for your primary mail file `rmail-file-name'.
441 If this is nil, uses the environment variable MAIL. If that is
442 unset, uses a file named by the function `user-login-name' in the
443 directory `rmail-spool-directory' (whose value depends on the
445 ;; Don't use backquote here, because we don't want to need it at load time.
446 ;; (That must be an old comment - it's dumped these days.)
456 "Non-nil means Rmail makes a new frame for composing outgoing mail.
457 This is handy if you want to preserve the window configuration of
458 the frame where you have the RMAIL buffer displayed."
462 ;;;###autoload
464 "Directory for additional secondary Rmail files."
467 ;;;###autoload
469 "Regexp for which files are secondary Rmail files."
474 "Whether and how to ask for confirmation before expunging deleted messages.
475 The value, if non-nil is a function to call with a question (string)
476 as argument, to ask the user that question."
484 ;;;###autoload
491 ;;;###autoload
493 "List of functions to call when Rmail displays a message."
502 "List of functions to call when Rmail deletes a message.
503 When the hooks are called, the message has been marked deleted but is
506 ;; These may be altered by site-init.el to match the format of mmdf files
507 ;; delimiting used on a given host (delim1 and delim2 from the config
508 ;; files).
515 ;; FIXME Post-mbox, this is now unused.
516 ;; In Emacs-22, this was called:
517 ;; i) the very first time a message was shown.
518 ;; ii) when toggling the headers to the normal state, every time.
519 ;; It's not clear what it should do now, since there is nothing that
520 ;; records when a message is shown for the first time (unseen is not
521 ;; necessarily the same thing).
522 ;; See http://lists.gnu.org/archive/html/emacs-devel/2009-03/msg00013.html
524 "If non-nil, a filter function for new messages in RMAIL.
525 Called with region narrowed to the message, including headers,
526 before obeying `rmail-ignored-headers'."
531 "it is not used (try `rmail-show-message-hook')."
535 "List of directives specifying how to automatically file messages.
536 Whenever Rmail shows a message in the folder that `rmail-file-name'
537 specifies, it calls `rmail-auto-file' to maybe file the message in
538 another folder according to this list. Messages that are already
539 marked as `filed', or are in different folders, are left alone.
541 Each element of the list is of the form:
543 (FOLDERNAME FIELD REGEXP [ FIELD REGEXP ] ... )
545 FOLDERNAME is the name of a folder in which to put the message.
546 If FOLDERNAME is nil then Rmail deletes the message, and moves on to
548 but does not move to the next.
550 FIELD is the name of a header field in the message, such as
554 REGEXP is a regular expression to match (case-sensitively) against
555 the preceding specified FIELD.
557 There may be any number of FIELD/REGEXP pairs.
558 All pairs must match for a directive to apply to a message.
559 For a given message, Rmail applies only the first matching directive.
561 Examples:
564 "
572 ;; Some mailers use "Re(2):" or "Re^2:" or "Re: Re:" or "Re[2]:".
573 ;; This pattern should catch all the common variants.
574 ;; rms: I deleted the change to delete tags in square brackets
575 ;; because they mess up RT tags.
580 "If non-nil, Rmail always displays the summary buffer."
583 \f
588 "The RMAIL buffer related to the current buffer.
589 In an RMAIL buffer, this holds the RMAIL buffer itself.
601 ;; Message counters and markers. Deleted flags.
604 "Integer specifying the message currently being displayed in this folder.
605 Counts messages from 1 to `rmail-total-messages'. A value of 0
610 "Integer specifying the total number of messages in this folder.
615 "Vector of markers specifying the start and end of each message.
620 "A string of length `rmail-total-messages' plus one.
626 "In an Rmail buffer, a vector whose Nth element is a list (N).
627 When expunging renumbers messages, these lists are modified
634 ;; These are used by autoloaded rmail-summary.
639 "In an Rmail buffer, vector of (newline-terminated) strings.
643 ;; Rmail buffer swapping variables.
654 \f
655 ;; `Sticky' default variables.
657 ;; Last individual label specified to a or k.
660 ;; Last set of values specified to C-M-n, C-M-p, C-M-s or C-M-l.
666 ;; Note that rmail-output-read-file-name modifies this.
677 ;; Mule and MIME related variables.
679 ;;;###autoload
681 "Coding system used in RMAIL file.
686 "If non-nil, RMAIL automatically displays decoded MIME messages.
687 For this to work, the feature specified by `rmail-mime-feature' must
688 be available."
694 "If non-nil, use `rmail-insert-mime-forwarded-message-function' to forward."
700 "Function of no argument called to show a decoded MIME message.
701 This function is called when `rmail-enable-mime' is non-nil.
704 ;;;###autoload
706 "Function to insert a message in MIME format so it can be forwarded.
707 This function is called if `rmail-enable-mime' and
708 `rmail-enable-mime-composing' are non-nil.
709 It is called with one argument FORWARD-BUFFER, which is a
710 buffer containing the message to forward. The current buffer
714 "Function to insert a message in MIME format so it can be resent.
715 This function is called by `rmail-resend' if `rmail-enable-mime' is non-nil.
716 It is called with one argument FORWARD-BUFFER, which is a
717 buffer containing the message to forward. The current buffer
720 ;; FIXME one might want to pass a LIMIT, as per
721 ;; rmail-search-mime-header-function.
723 "Function to check if a regexp matches a MIME message.
724 This function is called by `rmail-search-message' if
725 `rmail-enable-mime' is non-nil. It is called (with point at the
726 start of the message) with two arguments MSG and REGEXP, where
730 "Function to check if a regexp matches a header of MIME message.
731 This function is called by `rmail-message-regexp-p-1' if
732 `rmail-enable-mime' is non-nil. It is called (with point at the
733 start of the header) with three arguments MSG, REGEXP, and LIMIT,
734 where MSG is the message number, REGEXP is the regular
738 "Feature to require for MIME support in Rmail.
739 When starting Rmail, if `rmail-enable-mime' is non-nil, this
740 feature is loaded with `require'. The default value is `rmailmm'.
742 The library should set the variable `rmail-show-mime-function'
743 to an appropriate value, and optionally also set
744 `rmail-search-mime-message-function',
745 `rmail-search-mime-header-function',
746 `rmail-insert-mime-forwarded-message-function', and
753 "Regexp to match MIME-charset specification in a header of message.
756 \f
764 "From "
766 ;; Many things can happen to an RFC 822 mailbox before it is put into
767 ;; a `From' line. The leading phrase can be stripped, e.g.
768 ;; `Joe <@w.x:joe@y.z>' -> `<@w.x:joe@y.z>'. The <> can be stripped, e.g.
769 ;; `<@x.y:joe@y.z>' -> `@x.y:joe@y.z'. Everything starting with a CRLF
770 ;; can be removed, e.g.
771 ;; From: joe@y.z (Joe K
772 ;; User)
773 ;; can yield `From joe@y.z (Joe K Fri Mar 22 08:11:15 1996', and
774 ;; From: Joe User
775 ;; <joe@y.z>
776 ;; can yield `From Joe User Fri Mar 22 08:11:15 1996'.
777 ;; The mailbox can be removed or be replaced by white space, e.g.
778 ;; From: "Joe User"{space}{tab}
779 ;; <joe@y.z>
780 ;; can yield `From {space}{tab} Fri Mar 22 08:11:15 1996',
781 ;; where {space} and {tab} represent the Ascii space and tab characters.
782 ;; We want to match the results of any of these manglings.
783 ;; The following regexp rejects names whose first characters are
784 ;; obviously bogus, but after that anything goes.
787 ;; The time the message was sent.
793 ;; Perhaps a time zone, specified by an abbreviation, or by a
794 ;; numeric offset.
795 time-zone-regexp
797 ;; The year.
800 ;; On some systems the time zone can appear after the year, too.
801 time-zone-regexp
803 ;; Old uucp cruft.
807 "Regexp matching the delimiter of messages in UNIX mail format
808 \(UNIX From lines), minus the initial ^. Note that if you change
809 this expression, you must change the code in `rmail-nuke-pinhead-header'
812 ;; FIXME the rmail-header-name headers ought to be customizable.
813 ;; It seems a bit arbitrary, for example, that all of the Date: line
814 ;; gets highlighted.
816 ;; These are all matched case-insensitively.
824 ;; FIXME Mail-Followup-To should probably be here too.
829 ;; Use MATCH-ANCHORED to effectively anchor the regexp left side.
830 `(,cite-chars
842 ;; Rmail does not expect horizontal splitting. (Bug#2282)
844 "Like `pop-to-buffer', but with `split-width-threshold' set to nil."
848 ;; Perform BODY in the summary buffer
849 ;; in such a way that its cursor is properly updated in its own window.
858 ;; rmail-total-messages is a buffer-local var
859 ;; in the rmail buffer.
860 ;; This way we make it available for the body
861 ;; even tho the rmail buffer is not current.
869 \f
870 ;;;; *** Rmail Mode ***
873 "Require `rmail-mime-feature' if that is non-nil.
874 Signal an error and set `rmail-mime-feature' to nil if the feature
875 isn't provided."
881 'rmail
883 through `rmail-enable-mime' being non-nil, the required feature
884 `%s' (the value of `rmail-mime-feature')
885 is not available in the current session.
886 So, MIME support is turned off for the moment."
887 rmail-mime-feature)
892 ;;;###autoload
894 "Read and edit incoming mail.
895 Moves messages into file named by `rmail-file-name' and edits that
896 file in RMAIL Mode.
899 May be called with file name as argument; then performs rmail editing on
900 that file, but does not copy any new mail into the file.
901 Interactively, if you supply a prefix argument, then you
902 have a chance to specify a file name with the minibuffer.
904 If `rmail-display-summary' is non-nil, make a summary for this RMAIL file."
909 ;; Use find-buffer-visiting, not get-file-buffer, for those users
910 ;; who have find-file-visit-truename set to t.
912 run-mail-hook mail-buf msg-shown)
913 ;; Determine if an existing mail file has been changed behind the
914 ;; scene...
916 ;; The mail file has been changed. Revisit it and reset the
917 ;; message state variables when in rmail mode.
924 ;; The mail file is either unchanged or not visited. Visit it.
927 ;; Force no-conversion by default, since that's what
928 ;; pre-mbox Rmail did with BABYL files (via
929 ;; auto-coding-regexp-alist).
933 ;; Ensure that the collection and view buffers are in sync and
934 ;; ensure that a message is not being edited.
941 ;; Ensure that the Rmail file is in mbox format, the buffer is in
942 ;; Rmail mode and has been scanned to find all the messages
943 ;; (setting the global message variables in the process).
950 ;; Show the first unread message and process summary mode.
952 ;; Only get new mail when there is not a file name argument.
965 "Determine if the file needs to be converted to mbox format."
968 ;; Detect previous Babyl format files.
971 ;; The file is Babyl version 5. Use unrmail to convert
972 ;; it.
975 ;; Losing babyl file made by old version of Rmail. Fix the
976 ;; babyl file header and use unrmail to convert to mbox
977 ;; format.
987 "Report that the buffer is not in the mbox file format.
988 MSGNUM, if present, indicates the malformed message."
994 "Convert the mail file from Babyl version 5 to mbox.
995 This function also reinitializes local variables used by Rmail."
1009 ;; Rmail buffers need to be saved with Unix EOLs, or else
1010 ;; the format will not be recognized.
1024 "Return a suitable coding system to use for the current mail message.
1025 The buffer is expected to be narrowed to just the header of the message."
1031 \f
1032 ;;; Set up Rmail mode keymaps
1043 ;; If you change this, change the rmail-resend menu-item's :keys.
1069 ;; I find I can't live without the default M-r command -- rms.
1070 ;; (define-key rmail-mode-map "\er" 'rmail-search-backwards)
1096 \f
1103 nil)
1106 nil)
1213 map)
1216 ;; Rmail toolbar
1220 map rmail-mode-map)
1222 map rmail-mode-map)
1224 map rmail-mode-map)
1226 map rmail-mode-map)
1228 map rmail-mode-map)
1230 map rmail-mode-map)
1232 map rmail-mode-map)
1234 map rmail-mode-map)
1236 map rmail-mode-map)
1238 map rmail-mode-map)
1240 map rmail-mode-map)
1242 map rmail-mode-map)
1243 map))
1246 \f
1247 ;; Rmail mode is suitable only for specially formatted data.
1255 ;;;###autoload
1258 All normal editing commands are turned off.
1259 Instead, these commands are available:
1275 \\[rmail-undelete-previous-message] Undelete message. Tries current message, then earlier messages
1276 till a deleted message is found.
1277 \\[rmail-edit-current-message] Edit the current message. \\[rmail-cease-edit] to return to Rmail.
1290 \\[rmail-output-body-to-file] Save message body to a file. Default filename comes from Subject line.
1295 (label defaults to last one specified).
1296 Standard labels: filed, unseen, answered, forwarded, deleted.
1334 ;; No need to auto save RMAIL files in normal circumstances
1335 ;; because they contain no info except attribute changes
1336 ;; and deletion of messages.
1337 ;; The one exception is when messages are copied into another mbox buffer.
1338 ;; rmail-output enables auto save when you do that.
1343 ;; Functions to support buffer swapping:
1350 "Return a reusable buffer suitable for viewing messages.
1351 Create the buffer if necessary."
1352 ;; We want to reuse any existing view buffer, so as not to create an
1353 ;; endless number of them. But we must avoid clashes if we visit
1354 ;; two different rmail files with the same basename (Bug#4593).
1357 rmail-view-buffer
1365 newbuf)))
1368 "Swap text between current buffer and `rmail-view-buffer'.
1369 This function preserves the current buffer's modified flag, and also
1370 sets the current buffer's `buffer-file-coding-system' to that of
1371 `rmail-view-buffer'."
1378 buffer-file-coding-system)))
1387 "Return non-nil if the message collection is in `rmail-view-buffer'."
1388 ;; This is analogous to tar-data-swapped-p in tar-mode.el.
1389 rmail-buffer-swapped)
1392 ;; Bring the actual Rmail messages back into the main buffer.
1398 "Determine if the Rmail buffer is showing a message.
1399 If so restore the actual mbox message collection."
1406 "Warn if important modifications would change Rmail file's format."
1409 ;; If it's already modified, don't warn again.
1424 ;; Turn off the hook on the view buffer, so we can kill it, then kill it.
1434 ;; Set up the permanent locals associated with an Rmail file.
1447 ;; Note that this does not erase the buffer. Should it?
1448 ;; It depends on how this is called. If somehow called with the
1449 ;; rmail buffers swapped, it would erase the message collection.
1452 ;; Force C-x C-s write Unix EOLs.
1462 ;; Provide default set of inboxes for primary mail file ~/RMAIL.
1470 ;; FIXME expand-file-name?
1475 ;; Set up the non-permanent locals associated with Rmail mode.
1477 ;; Turn off undo. We turn it back on in rmail-edit.
1479 ;; Don't let a local variables list in a message cause confusion.
1482 ;; Don't turn off auto-saving based on the size of the buffer
1483 ;; because that code does not understand buffer-swapping.
1491 t t nil nil
1507 \f
1508 ;; Handle M-x revert-buffer done in an rmail-mode buffer.
1513 ;; See similar code in `rmail'.
1514 ;; FIXME needs updating?
1517 ;; Call our caller again, but this time it does the default thing.
1519 ;; If the user said "yes", and we changed something,
1520 ;; reparse the messages.
1523 ;; Convert all or part to Babyl file if possible.
1525 ;; We have read the file as raw-text, so the buffer is set to
1526 ;; unibyte. Make it multibyte if necessary.
1536 "Expunge and save RMAIL file."
1540 ;; No need to swap buffers: rmail-write-region-annotate takes care of it.
1541 ;; (rmail-swap-buffers-maybe)
1547 "Quit out of RMAIL.
1548 Hook `rmail-quit-hook' is run after expunging."
1555 ;; Don't switch to the summary buffer even if it was recently visible.
1566 "Bury current Rmail buffer and its summary buffer."
1568 ;; This let var was called rmail-buffer, but that interfered
1569 ;; with the buffer-local var used in summary buffers.
1577 \f
1579 "Create a duplicated copy of the current message.
1580 The duplicate copy goes into the Rmail file just after the original."
1581 ;; If we are in a summary buffer, switch to the Rmail buffer.
1582 ;; FIXME simpler to swap the contents, not the buffers?
1604 \f
1605 ;;;###autoload
1607 "Run Rmail on file FILENAME."
1611 ;; This used to scan subdirectories recursively, but someone pointed out
1612 ;; that if the user wants that, person can put all the files in one dir.
1613 ;; And the recursive scan was slow. So I took it out.
1614 ;; rms, Sep 1996.
1616 "Return list of file in dir START that match `rmail-secondary-file-regexp'."
1618 ;; Don't sort here.
1621 ;; Sort here instead of in directory-files
1622 ;; because this list is usually much shorter.
1627 name)
1647 item)
1648 rmail-secondary-file-directory)))))
1652 menu))
1654 ;; This command is always "disabled" when it appears in a menu.
1664 files
1669 files
1677 \f
1678 ;;;; *** Rmail input ***
1686 ;; RLK feature not added in this version:
1687 ;; argument specifies inbox file or files in various ways.
1689 ;; In Babyl, the Mail: header in the preamble overrode rmail-inbox-list.
1690 ;; Mbox does not have this feature.
1692 "Move any new mail from this Rmail file's inbox files.
1693 The buffer-local variable `rmail-inbox-list' specifies the list
1694 of inbox files. By default, this is nil, except for your primary
1695 Rmail file `rmail-file-name'. In this case, when you first visit
1696 the Rmail file it is initialized using either
1698 or the function `user-login-name' and the directory
1699 `rmail-spool-directory' (whose value depends on the operating system).
1701 The command `set-rmail-inbox-list' sets `rmail-inbox-list' to the
1702 value you specify.
1704 You can also specify the file to get new mail from just for one
1705 instance of this command. In this case, the file of new mail is
1706 not changed or deleted. Noninteractively, you can pass the inbox
1707 file name as an argument. Interactively, a prefix argument
1708 causes us to read a file name and use that file as the inbox.
1710 If the variable `rmail-preserve-inbox' is non-nil, new mail will
1711 always be left in inbox files rather than deleted.
1713 Before doing anything, this runs `rmail-before-get-new-mail-hook'.
1714 Just before returning, it runs `rmail-after-get-new-mail-hook',
1715 whether or not there is new mail.
1717 If there is new mail, it runs `rmail-get-new-mail-hook', saves
1718 the updated file, and shows the first unseen message (which might
1719 not be a new one). It returns non-nil if it got any new messages."
1724 ;; If the disk file has been changed from under us,
1725 ;; revert to it before we get new mail.
1733 ;; Get rid of all undo records for this buffer.
1738 found)
1741 ;; This loops if any members of the inbox list have the same
1742 ;; basename (see "name conflict" below).
1745 ;; If buffer has not changed yet, and has not been
1746 ;; saved yet, don't replace the old backup file now.
1750 ;; Don't make undo records while getting mail.
1752 delete-files success files file-last-names)
1753 ;; Pull files off all-files onto files as long as there is
1754 ;; no name conflict. A conflict happens when two inbox
1755 ;; file names have the same last component.
1756 ;; The reason this careful handling is necessary seems
1757 ;; to be that rmail-insert-inbox-text uses .newmail-BASENAME.
1760 file-last-names)))
1762 file-last-names
1765 ;; Put them back in their original order.
1768 ;; Make sure we end with a blank line unless there are
1769 ;; no messages, as required by mbox format (Bug#9974).
1775 found))))
1776 ;; Move to the first new message unless we have other unseen
1777 ;; messages before it.
1780 found)
1781 ;; Don't leave the buffer screwed up if we get a disk-full error.
1788 "Return t if new messages are detected without error, nil otherwise."
1793 rmail-use-spam-filter))
1795 result success suffix)
1797 ;; Read in the contents of the inbox files, renaming them as
1798 ;; necessary, and adding to the list of files to delete
1799 ;; eventually.
1803 ;; Scan the new text and convert each message to
1804 ;; Rmail/mbox format.
1810 success t)
1811 ;; Try to delete the garbage just inserted.
1813 ;; If we could not convert the file's inboxes, rename the
1814 ;; files we tried to read so we won't over and over again.
1823 ;; Determine if there are messages.
1825 ;; There are. Process them.
1830 ;; Delete the old files, now that the Rmail file is saved.
1833 ;; First, try deleting.
1837 ;; If we can't delete it, truncate it.
1850 ;; Establish the return value.
1852 result))))
1855 "Parse the supplied URL. Return (list MAILBOX-NAME REMOTE PASSWORD GOT-PASSWORD)
1856 WHERE MAILBOX-NAME is the name of the mailbox suitable as argument to the
1857 actual version of `movemail', REMOTE is non-nil if MAILBOX-NAME refers to
1858 a remote mailbox, PASSWORD is the password if it should be
1859 supplied as a separate argument to `movemail' or nil otherwise, GOT-PASSWORD
1860 is non-nil if the user has supplied the password interactively.
1861 "
1876 ;; The password is embedded. Strip it out since movemail
1877 ;; does not really like it, in spite of the movemail spec.
1883 t
1885 got-password)
1890 got-password))))
1908 "Replace newly read mail in Babyl format with equivalent mbox format.
1910 FROM-FILE is the Babyl file from which the new mail should be read."
1912 size)
1920 size)))
1923 "If newly read mail from FILE is in Babyl format, convert it to mbox format.
1925 SIZE is the original size of the newly read mail.
1926 Value is the size of the newly read mail after conversion."
1927 ;; Detect previous Babyl format files.
1930 new-file)
1932 ;; The new mail is in Babyl version 5 format. Use unrmail
1933 ;; to convert it.
1936 ;; New mail is in Babyl format made by old version of
1937 ;; Rmail. Fix the babyl file header and use unrmail to
1938 ;; convert it.
1948 size))
1951 ;; Detect a locked file now, so that we avoid moving mail
1952 ;; out of the real inbox file. (That could scare people.)
1958 ;; Handle remote mailbox names specially; don't expand as filenames
1959 ;; in case the userid contains a directory separator.
1972 ;; Generate name to move to from inbox name,
1973 ;; in case of multiple inboxes that need moving.
1977 ;; cannot have colons in file name
1979 file)))
1980 ;; Use the directory of this rmail file
1981 ;; because it's a nuisance to use the homedir
1982 ;; if that is on a full disk and this rmail
1983 ;; file isn't.
1986 ;; Always use movemail to rename the file,
1987 ;; since there can be mailboxes in various directories.
1989 ;; On some systems, /usr/spool/mail/foo is a directory
1990 ;; and the actual inbox is /usr/spool/mail/foo/foo.
1993 file))))
2002 ;; Set TOFILE if have not already done so, and
2003 ;; rename or copy the file FILE to TOFILE if and as appropriate.
2008 nil)
2018 nil)
2021 rmail-movemail-flags)
2026 ;; No output => movemail won
2027 nil
2038 ;; If we just read the password, most likely it is
2039 ;; wrong. Otherwise, see if there is a specific
2040 ;; reason to think that the problem is a wrong passwd.
2043 nil t))
2046 ;; If using Mailutils, remove initial error code
2047 ;; abbreviation
2058 nil)))))
2060 ;; At this point, TOFILE contains the name to read:
2061 ;; Either the alternate name (if we renamed)
2062 ;; or the actual inbox (if not renaming).
2065 size)
2068 ;; If new mail is in Babyl format, convert it to mbox.
2070 tofile
2073 ;; Make sure the read-in mbox data properly ends with a
2074 ;; blank line unless it is of size 0.
2082 delete-files))
2084 ;; Decode the region specified by FROM and TO by CODING.
2085 ;; If CODING is nil or an invalid coding system, decode by `undecided'.
2089 ;; Use -dos decoding, to remove ^M characters left from base64 or
2090 ;; rogue qp-encoded text.
2093 ;; Don't reveal the fact we used -dos decoding, as users generally
2094 ;; will not expect the RMAIL buffer to use DOS EOL format.
2107 "Ensure a message ends in a blank line.
2108 Call with point at the end of the message."
2115 "Validate the RFC2822 format for the new messages.
2116 Point should be at the first new message.
2117 An error is signaled if the new messages are not RFC2822
2118 compliant.
2119 Unless an Rmail attribute header already exists, add it to the
2120 new messages. Return the number of new messages."
2128 limit stop)
2129 ;; Detect an empty inbox file.
2131 ;; Scan the new messages to establish a count and to ensure that
2132 ;; an attribute header is present.
2135 ;; Determine if a new attribute header needs to be
2136 ;; added to the message.
2146 ;; Move to the next message.
2153 count))))
2154 \f
2156 "Subroutine of `rmail-get-header'.
2157 Narrow to header, call `mail-fetch-field' to find header NAME."
2165 "Return the value of message header NAME, nil if it has none.
2166 MSGNUM specifies the message number to get it from.
2167 If MSGNUM is nil, use the current message."
2171 "Subroutine of `rmail-set-header'.
2172 Narrow to header, set header NAME to VALUE, replacing existing if present.
2173 VALUE nil means to remove NAME altogether."
2190 "Set message header NAME to VALUE in message number MSGNUM.
2191 If MSGNUM is nil, use the current message. NAME and VALUE are strings.
2192 VALUE may also be nil, meaning to remove the header."
2195 ;; Ensure header changes get saved.
2196 ;; (Note replacing a header with an identical copy modifies.)
2198 ;; However: don't save in mbox format over a Babyl file
2199 ;; merely because of this.
2201 \f
2202 ;;;; *** Rmail Attributes and Keywords ***
2205 "Return the message attributes in a comma separated string.
2206 MSG specifies the message number to get it from.
2207 If MSG is nil, use the current message."
2210 result temp)
2217 result
2222 result)))
2225 "Return the message keywords in a comma separated string.
2226 MSG, if non-nil, identifies the message number to use.
2227 If nil, that means the current message."
2231 "Return a string with the labels (attributes and keywords) of msg MSG.
2232 It is put in comma-separated form.
2233 MSG, if non-nil, identifies the message number to use.
2234 If nil, that means the current message."
2237 ;; Combine the message attributes and keywords
2238 ;; into a comma-separated list.
2244 ;; FIXME ? old rmail did not have spaces in the comma-separated lists.
2251 "Update the current messages's attributes and keywords in mode line."
2255 rmail-current-message rmail-total-messages blurb))))
2258 "Return the character value for ATTR.
2259 ATTR is a (numeric) index, an offset into the mbox attribute
2260 header value. STATE is one of nil, t, or a character value."
2267 "Subroutine of `rmail-set-attribute'.
2268 Set Rmail attribute ATTR to STATE in `rmail-attribute-header',
2269 creating the header if necessary. Returns non-nil if a
2270 significant attribute change was made."
2274 altered)
2277 ;; If this message already records attributes, just change the
2278 ;; value for this one.
2280 ;; Position point at this attribute, adding attributes if necessary.
2287 ;; Change this attribute.
2292 ;; Otherwise add a header line to record the attributes and set
2293 ;; all but this one to no.
2299 altered))
2302 "Turn an attribute of a message on or off according to STATE.
2303 STATE is either nil or the character (numeric) value associated
2304 with the state (nil represents off and non-nil represents on).
2305 ATTR is either the index number of the attribute, or a string,
2306 both from `rmail-attr-array'. MSGNUM is message number to
2307 change; nil means current message."
2317 ;; Ask for confirmation before setting any attribute except `unseen'
2318 ;; if it would force a format change.
2324 ;; The "deleted" attribute is also stored in a special vector so
2325 ;; update that too.
2332 ;; Don't save in mbox format over a Babyl file
2333 ;; merely because of a change in `unseen' attribute.
2336 ;; Otherwise, if we modified the file text via the view buffer,
2337 ;; mark the main buffer modified too.
2341 "Return non-nil if message number MSG has attributes matching regexp ATTRS."
2346 "Return non-nil if message number MSGNUM has the unseen attribute."
2349 ;; FIXME rmail-get-labels does some formatting (eg leading space, `;'
2350 ;; between attributes and labels), so this might not do what you want.
2351 ;; Eg see rmail-sort-by-labels. rmail-get-labels could have an
2352 ;; optional `noformat' argument.
2354 "Return non-nil if message number MSG has labels matching regexp LABELS."
2356 \f
2357 ;;;; *** Rmail Message Selection And Support ***
2360 "Return the end position for message number N."
2364 "Return the start position for message number N."
2368 "Call FUNCTION on ARGS while narrowed to message MSGNUM.
2369 Point is at the start of the message.
2370 This returns what the call to FUNCTION returns.
2371 If MSGNUM is nil, use the current message."
2378 ;; All access to the rmail-buffer's local variables is now finished...
2380 ;; ... so it is ok to go to a different buffer.
2389 ;; Unused (save for commented out code in rmailedit.el).
2391 "Call FUNCTION with point at start of internal data of current message.
2392 Assumes that bounds were previously narrowed to display the message in Rmail.
2393 The bounds are widened enough to move point where desired, then narrowed
2394 again afterward.
2396 FUNCTION may not change the visible text of the message, but it may
2397 change the invisible header text."
2405 ;; Note: we don't use save-restriction because that does not work right
2406 ;; if changes are made outside the saved restriction
2407 ;; before that restriction is restored.
2410 \f
2411 ;; Manage the message vectors and counters.
2427 rmail-message-vector
2428 rmail-current-message
2429 rmail-total-messages))
2433 "Count the number of new messages.
2434 The buffer should be narrowed to include only the new messages.
2435 Output a helpful message unless NOMSG is non-nil."
2442 ;; Put at the end of messages-head
2443 ;; the entry for message N+1, which marks
2444 ;; the end of message N. (N = number of messages).
2460 ;; Fill in the new elements of rmail-msgref-vector.
2479 ;; Determine how many messages follow point.
2482 ;; Put at the end of messages-head
2483 ;; the entry for message N+1, which marks
2484 ;; the end of message N. (N = number of messages).
2495 ;; Make an element 0 in rmail-message-vector and rmail-deleted-vector
2496 ;; which will never be used.
2517 "Collect the message deletion flags for each message.
2518 MESSAGE-END is the buffer position corresponding to the end of
2519 the message. Point is at the beginning of the message."
2520 ;; NOTE: This piece of code will be executed on a per-message basis.
2521 ;; In the face of thousands of messages, it has to be as fast as
2522 ;; possible, hence some brute force constant use is employed in
2523 ;; addition to inlining.
2528 ?D
2532 "Collect the start positions of messages in list `messages-head'.
2533 Return the number of messages after the one containing SPOT-TO-FIND."
2535 messages-after-spot)
2546 ;; Show progress after every 20 messages or so.
2549 ;; Handle the first message, maybe.
2558 messages-after-spot))
2559 \f
2560 ;; Display a message.
2562 ;;;; *** Rmail Message Formatting and Header Manipulation ***
2564 ;; This is used outside of rmail.
2566 "Return nil if the current message is showing full headers."
2568 rmail-buffer)
2572 "Toggle between showing full and normal message headers.
2573 With optional integer ARG, show the normal message header if ARG
2574 is greater than zero; otherwise, show it in full."
2583 "Show current message starting from the beginning."
2587 rmail-view-buffer
2588 rmail-buffer)
2589 rmail-header-style)))
2593 "Show bottom of current message."
2599 rmail-view-buffer
2600 rmail-buffer)
2601 rmail-header-style)))
2606 Ask the user whether to add that list name to `mail-mailing-lists'."
2607 ;; FIXME s-r not needed? Use rmail-get-header?
2608 ;; We have not narrowed to the headers at ths point?
2619 ;; taken from rmailsum.el
2631 addr))
2634 addr)))
2639 "Display the entire mailbox file."
2643 \f
2648 ;; Eg we deleted all the messages, so remove the old N/M mark.
2655 "Show message number N (prefix argument), counting from start of file.
2656 If summary buffer is currently displayed, update current message there also.
2657 N defaults to the current message."
2661 ;; FIXME: Why do we swap the raw data back in?
2671 ;; If there is a summary buffer, try to move to this message
2672 ;; in that buffer. But don't complain if this message is
2673 ;; not mentioned in the summary. Don't do this at all if we
2674 ;; were called on behalf of cursor motion in the summary
2675 ;; buffer.
2686 "Return t if the region contains a text message, nil otherwise."
2690 ;; The message is text if either there is no content type header
2691 ;; (a default of "text/plain; charset=US-ASCII" is assumed) or
2692 ;; the base content type is either text or message.
2697 "Message size at which to show progress messages for displaying it."
2703 "Show message MSG (default: current message) using `rmail-view-buffer'.
2704 Return text to display in the minibuffer if MSG is out of
2705 range (displaying a reasonable choice as well), nil otherwise.
2706 The current mail message becomes the message displayed."
2709 blurb beg end body-start coding-system character-coding
2710 is-text-message header-style)
2716 rmail-current-message 1
2720 rmail-current-message rmail-total-messages
2725 ;; Mark the message as seen, but preserve buffer modified flag.
2730 ;; bracket the message in the mail
2731 ;; buffer and determine the coding system the transfer encoding.
2740 ;; We give the view buffer a buffer-local value of
2741 ;; rmail-header-style based on the binding in effect when
2742 ;; this function is called; `rmail-toggle-headers' can
2743 ;; inspect this value to determine how to toggle.
2746 rmail-show-mime-function
2763 ;; Decode the message body into an empty view buffer using a
2764 ;; unibyte temporary buffer where the character decoding takes
2765 ;; place.
2769 ;; Do it directly since that is fast.
2771 ;; Can this be done directly, skipping the temp buffer?
2777 ;; See bug#5441.
2789 coding-system view-buf)))
2791 ;; Prepare the separator (blank line) before the body.
2794 ;; Unquote quoted From lines
2800 ;; Copy the headers to the front of the message view buffer.
2802 ;; Decode any RFC2047 encoded message headers.
2810 ;; highlight the message, activate any URL like text and add
2811 ;; special highlighting for and quoted material.
2815 ;(rmail-activate-urls)
2816 ;(rmail-process-quoted-material)
2817 )
2818 ;; Update the mode-line with message status information and swap
2819 ;; the view buffer/mail buffer contents.
2826 blurb))
2829 "Copy displayed header fields to the message viewer buffer.
2830 BEG and END marks the start and end positions of the message in
2831 the mbox buffer. If the optional argument IGNORED-HEADERS is
2832 non-nil, ignore all header fields whose names match that regexp.
2833 Otherwise, if `rmail-displayed-headers' is non-nil, copy only
2834 those header fields whose names match that regexp. Otherwise,
2835 copy all header fields whose names do not match
2836 `rmail-ignored-headers' (unless they also match
2837 `rmail-nonignored-headers'). Moves point in the message viewer
2838 buffer to the end of the headers."
2840 lim)
2845 ;; Put point right after the From header line.
2852 ;; Handle the case where all headers should be copied.
2855 ;; rmail-show-message-1 expects this function to leave point
2856 ;; at the end of the headers.
2862 ;; Handle the case where the headers matching the displayed
2863 ;; headers regexp should be copied.
2873 ;; Handle the ignored headers.
2888 "Decode the body of the current message using coding system CODING.
2889 This is useful with mail messages that have malformed or missing
2890 charset= headers.
2892 This function assumes that the current message is already decoded
2893 and displayed in the RMAIL buffer, but the coding system used to
2894 decode it was incorrect. It then decodes the message again,
2895 using the coding system CODING."
2905 body-start x-coding-header old-coding)
2912 ;; Narrow to headers
2920 ;; Make sure the new coding system uses the same EOL
2921 ;; conversion, to prevent ^M characters from popping up
2922 ;; all over the place.
2930 ;; Rewrite the coding-system header.
2942 "Highlight the headers specified by `rmail-highlighted-headers'.
2943 Uses the face specified by `rmail-highlight-face'."
2951 ;; When rmail-highlight-face is removed, just
2952 ;; use 'rmail-highlight here.
2956 ;; List of overlays to reuse.
2962 overlay)
2965 ;; Back up over newline, then trailing spaces or tabs
2970 ;; Reuse an overlay we already have.
2976 ;; Make a new overlay and add it to
2977 ;; rmail-overlay-list.
2984 "Automatically move a message into another sfolder based on criteria.
2985 This moves messages according to `rmail-automatic-folder-directives'.
2986 It only does something in the folder that `rmail-file-name' specifies.
2987 The function `rmail-show-message' calls this whenever it shows a message.
2988 This leaves a message alone if it already has the `filed' attribute."
2993 ;; Do nothing if the message has already been filed or if there
2994 ;; are no messages.
2995 nil
2996 ;; Find out some basics (common fields)
3009 from)
3011 to)
3015 ;; FIXME - shouldn't this ignore case?
3018 ;; If there are no directives left, then it was a complete match.
3027 \f
3028 ;; Simple message motion commands.
3031 "Show following message whether deleted or not.
3032 With prefix arg N, moves forward N messages, or backward if N is negative."
3039 "Show previous message whether deleted or not.
3040 With prefix arg N, moves backward N messages, or forward if N is negative."
3045 "Show following non-deleted message.
3046 With prefix arg N, moves forward N non-deleted messages,
3047 or backward if N is negative.
3049 Returns t if a new message is being shown, nil otherwise."
3065 t)
3070 nil)))
3073 "Show previous non-deleted message.
3074 With prefix argument N, moves backward N non-deleted messages,
3075 or forward if N is negative."
3080 "Show first message in file."
3086 "Show last message in file."
3092 "Move to an error locus (probably grep hit) in an Rmail buffer.
3093 MSG-POS is a marker pointing at the error message in the grep buffer.
3094 BAD-MARKER is a marker that ought to point at where to move to,
3095 but probably is garbage."
3102 line-text
3103 pos
3104 msgnum msgbeg msgend
3105 header-field
3106 line-number-within)
3108 ;; Look at the whole Rmail file.
3114 ;; Find the line that the error message points at.
3119 ;; Find the text at the start of the line,
3120 ;; before the first = sign.
3121 ;; This text has a good chance of being also in the
3122 ;; decoded message.
3127 ;; Find which message this position is in,
3128 ;; and the limits of that message.
3133 ;; Find which header this locus is in,
3134 ;; or if it's in the message body,
3135 ;; and the line-based position within that.
3150 ;; Display the right message.
3153 ;; Move to the right position within the displayed message.
3154 ;; Or at least try. The decoded message's lines may not
3155 ;; correspond to the lines in the inbox file.
3165 ;; If the decoded message doesn't have enough lines,
3166 ;; go to the beginning rather than the end.
3168 ;; Otherwise, go to the right column.
3173 "Return message number POS (or point) is in."
3179 rmail-view-buffer
3188 \f
3189 ;; Searching in Rmail file.
3192 "Return non-nil, if for message number MSG, regexp REGEXP matches."
3193 ;; This is adequate because its only caller, rmail-search,
3194 ;; unswaps the buffers.
3197 rmail-search-mime-message-function)
3203 "Show message containing next match for REGEXP (but not the current msg).
3204 Prefix argument gives repeat count; negative argument means search
3205 backwards (through earlier messages).
3206 Interactively, empty argument means use same regexp used last time."
3211 regexp)
3228 regexp)
3234 found)
3240 ;; Check messages one by one, advancing message number up or
3241 ;; down but searching forward through each message.
3253 ;; Search forward (if this is a normal search) or backward
3254 ;; (if this is a reverse search) through this message to
3255 ;; position point. This search may fail because REGEXP
3256 ;; was found in the hidden portion of this message. In
3257 ;; that case, move point to the beginning of visible
3258 ;; portion.
3267 regexp))
3274 "Show message containing previous match for REGEXP.
3275 Prefix argument gives repeat count; negative argument means search
3276 forward (through later messages).
3277 Interactively, empty argument means use same regexp used last time."
3282 regexp)
3297 \f
3298 ;; Scan for attributes, and compare subjects.
3301 "Return message number of first message which has `unseen' attribute."
3304 found)
3311 found))
3314 "Return the simplified subject of message MSGNUM (or current message).
3315 Simplifying the subject means stripping leading and trailing whitespace,
3316 and typical reply prefixes such as Re:."
3325 ;; If Subject is long, mailers will break it into several lines at
3326 ;; arbitrary places, so normalize whitespace by replacing every
3327 ;; run of whitespace characters with a single space.
3329 subject))
3332 "Return a regular expression matching the current simplified subject.
3333 The idea is to match it against simplified subjects of other messages."
3336 ;; Hide commas so it will work ok if parsed as a comma-separated list
3337 ;; of regexps.
3343 "Go to the next mail message having the same subject header.
3344 With prefix argument N, do this N times.
3345 If N is negative, go backwards instead."
3350 found)
3370 "Go to the previous mail message having the same subject header.
3371 With prefix argument N, do this N times.
3372 If N is negative, go forwards instead."
3375 \f
3376 ;;;; *** Rmail Message Deletion Commands ***
3379 "Return non-nil if message number N is deleted (in `rmail-deleted-vector')."
3383 "Set the deleted state of message number N (in `rmail-deleted-vector').
3384 STATE non-nil means mark as deleted."
3388 "Delete this message and stay on it."
3394 "Back up to deleted message, select it, and undelete it."
3412 "Delete this message and move to next nondeleted one.
3414 With prefix argument, delete and move backward.
3416 Returns t if a new message is displayed after the delete, or nil otherwise."
3428 "Delete this message and move to previous nondeleted one.
3432 \f
3433 ;; Expunging.
3435 ;; Compute the message number a given message would have after expunging.
3436 ;; The present number of the message is OLDNUM.
3437 ;; DELETEDVEC should be rmail-deleted-vector.
3438 ;; The value is nil for a message that would be deleted.
3441 nil
3448 newnum)))
3451 "Return t if expunge is needed and desirable.
3452 If `rmail-confirm-expunge' is non-nil, ask user to confirm."
3459 t)))
3462 "Actually erase all deleted messages in the file."
3467 ;; Discard all undo records for this buffer.
3475 0
3482 ;; Don't make any undo records for the expunging.
3491 new-summary
3500 rmail-current-message nil
3501 rmail-message-vector nil
3502 rmail-deleted-vector nil
3503 rmail-summary-vector nil)
3519 new-summary))
3522 new-msgref))
3530 rmail-total-messages counter
3535 win t)))
3545 ;; The DONT-SHOW argument is new in 23. Does not seem very important.
3547 "Erase deleted messages from Rmail file and summary buffer.
3548 This always shows a message (so as not to leave the Rmail buffer
3549 unswapped), and always updates any summary (so that it remains
3550 consistent with the Rmail buffer). If DONT-SHOW is non-nil, it
3551 does not pop any summary buffer."
3558 ;; We always update the summary buffer, so that the contents
3559 ;; remain consistent with the rmail buffer.
3560 ;; The only difference is, in the dont-show case, we use a
3561 ;; cut-down version of rmail-select-summary that does not pop
3562 ;; the summary buffer. It's only used by rmail-quit, which is
3563 ;; just going to bury any summary immediately after. If we made
3564 ;; rmail-quit bury the summary first, dont-show could be removed.
3565 ;; But the expunge might not be confirmed...
3573 ;; We always show a message, because (rmail-only-expunge t)
3574 ;; leaves the rmail buffer unswapped.
3575 ;; If we expunged the current message, a new one is current now,
3576 ;; so show it. If we weren't showing a message, show it.
3579 ;; We can just show the same message that was being shown before.
3583 \f
3584 ;;;; *** Rmail Mailing Commands ***
3587 "Yank into the current buffer the current message of Rmail buffer BUFFER.
3588 If BUFFER is swapped with its message viewer buffer, yank out of BUFFER.
3589 If BUFFER is not swapped, yank out of its message viewer buffer."
3594 ;; If they yank the text of BUFFER, the encoding of BUFFER is a
3595 ;; better default for the reply message than the default value of
3596 ;; buffer-file-coding-system.
3598 buffer-file-coding-system)
3603 buffer-file-coding-system))))))
3606 replybuffer sendactions same-window
3607 other-headers)
3612 yank-action)
3614 ;; The function used here must behave like insert-buffer wrt
3615 ;; point and mark (see doc of sc-cite-original).
3624 other-headers))
3632 switch-function yank-action sendactions
3635 ;; This is not a standard frame parameter; nothing except
3636 ;; sendmail.el looks at it.
3641 "Try to return to Rmail from the mail window.
3642 If optional argument NEWBUF is specified, it is the Rmail buffer
3643 to switch to."
3645 ;; If there is only one visible frame with no special handling,
3646 ;; consider deleting the mail window to return to Rmail.
3659 mail-bury-selects-summary
3661 rmail-summary-buffer
3664 rmail-summary-buffer))))
3666 ;; If the Rmail buffer is not in the next window, switch
3667 ;; directly to the Rmail buffer specified by NEWBUF.
3670 ;; If the Rmail buffer is in the next window, switch to
3671 ;; the summary buffer if `mail-bury-selects-summary' is
3672 ;; non-nil. Otherwise just delete this window.
3677 ;; If the frame was probably made for this buffer, the user
3678 ;; probably wants to delete it now.
3681 ;; The previous frame is where normally they have the Rmail buffer
3682 ;; displayed.
3686 "Send mail in another window.
3688 original message into it."
3692 ;; FIXME should complain if there is nothing to continue.
3694 "Continue composing outgoing message previously being composed."
3699 "Reply to the current message.
3700 Normally include CC: to all other recipients of original message;
3701 prefix argument means ignore them. While composing the reply,
3707 resent-to resent-cc resent-reply-to
3710 rmail-current-message
3717 from)
3723 ;; Bug#512. It's inappropriate to reply to these addresses.
3724 ;;; resent-cc (and (not just-sender)
3725 ;;; (mail-fetch-field "resent-cc" nil t))
3726 ;;; resent-to (or (mail-fetch-field "resent-to" nil t) "")
3727 ;;; resent-subject (mail-fetch-field "resent-subject")
3728 ;;; resent-date (mail-fetch-field "resent-date")
3729 ;;; resent-message-id (mail-fetch-field "resent-message-id")
3730 )
3733 ;; If this header field is present, use it instead of the
3734 ;; To and CC fields.
3738 ;; Merge the resent-to and resent-cc into the to and cc.
3739 ;; Bug#512. It's inappropriate to reply to these addresses.
3740 ;;; (if (and resent-to (not (equal resent-to "")))
3741 ;;; (if (not (equal to ""))
3742 ;;; (setq to (concat to ", " resent-to))
3743 ;;; (setq to resent-to)))
3744 ;;; (if (and resent-cc (not (equal resent-cc "")))
3745 ;;; (if (not (equal cc ""))
3746 ;;; (setq cc (concat cc ", " resent-cc))
3747 ;;; (setq cc resent-cc)))
3748 ;; Add `Re: ' to subject if not there already.
3755 subject))))
3757 nil
3758 ;; Using mail-strip-quoted-names is undesirable with newer mailers
3759 ;; since they can handle the names unstripped.
3760 ;; I don't know whether there are other mailers that still
3761 ;; need the names to be stripped.
3762 ;;; (mail-strip-quoted-names reply-to)
3763 ;; Remove unwanted names from reply-to, since Mail-Followup-To
3764 ;; header causes all the names in it to wind up in reply-to, not
3765 ;; in cc. But if what's left is an empty list, use the original.
3768 subject
3771 nil
3772 ;; `mail-dont-reply-to' doesn't need `mail-strip-quoted-names'.
3777 rmail-buffer
3779 rmail-buffer
3782 rmail-answered-attr-index))
3783 nil
3789 message-id)))))))
3790 \f
3792 "Give BUFFER's message number in MSGNUM-LIST the attribute ATTRIBUTE.
3793 This is use in the send-actions for message buffers.
3794 MSGNUM-LIST is a list of the form (MSGNUM)
3795 which is an element of rmail-msgref-vector."
3803 message-id
3804 nil))
3814 tem))
3815 message-id))
3816 ;; missing From, or Message-ID is sufficiently informative
3817 message-id
3819 ;; Copy TEM, discarding text properties.
3823 ;; Use prin1 to fake RFC822 quoting
3827 field)))))
3830 ;; These strings both match all non-ASCII characters.
3833 ;; "Unix Loser <Foo@bar.edu>" => "Unix Loser"
3834 from)
3837 ;; "<Bugs@bar.edu>" (Losing Unix) => "Losing Unix"
3838 from)))
3841 ;; Trim whitespace which above regexp match allows
3851 ;; "<AA259@bar.edu> (message from Unix Loser on 1-Apr-89)"
3853 field))))
3855 ;; If we can't kludge it simply, do it correctly
3858 \f
3860 "Forward the current message to another user.
3862 see the documentation of `rmail-resend'."
3879 nil nil subject nil nil rmail-buffer
3881 forward-buffer
3884 rmail-forwarded-attr-index))
3885 ;; If only one window, use it for the mail buffer.
3886 ;; Otherwise, use another window for the mail buffer
3887 ;; so that the Rmail buffer remains visible
3888 ;; and sending the mail will get back to it.
3890 ;; The mail buffer is now current.
3892 ;; Insert after header separator--before signature if any.
3896 rmail-insert-mime-forwarded-message-function)
3899 forward-buffer)
3900 ;; rmail-insert-mime-forwarded-message-function
3901 ;; works by inserting MML tags into forward-buffer.
3902 ;; The MUA will need to convert it to MIME before
3903 ;; sending. mail-encode-mml tells them to do that.
3904 ;; message.el does that automagically.
3908 ;; Quote lines with `- ' if they start with `-'.
3926 \f
3928 "Resend current message to ADDRESSES.
3929 ADDRESSES should be a single address, a string consisting of several
3930 addresses separated by commas, or a list of addresses.
3932 Optional FROM is the address to resend the message from, and
3933 defaults from the value of `user-mail-address'.
3934 Optional COMMENT is a string to insert as a comment in the resent message.
3935 Optional ALIAS-FILE is alternate aliases file to be used by sendmail,
3936 typically for purposes of moderating a list."
3951 ;;>> Copy message into temp buffer
3953 rmail-insert-mime-resent-message-function)
3957 ;; Delete any Sender field, since that's not specifiable.
3958 ; Only delete Sender fields in the actual header.
3960 ; Using "while" here rather than "if" because some buggy mail
3961 ; software may have inserted multiple Sender fields.
3969 ; Go back to the beginning of the buffer so the Resent- fields
3970 ; are inserted there.
3972 ;;>> Insert resent-from:
3975 ;;>> Insert resent-to: and bcc if need be.
3980 address
3983 ;; Expand abbrevs in the recipients.
4002 ;;>> Set up comment, if any.
4005 after)
4013 ;; Don't expand aliases in the destination fields
4014 ;; of the original message.
4020 \f
4038 ;; This is a cut-down version of rmail-clear-headers from Emacs 22.
4039 ;; It doesn't have the same functionality, hence the name change.
4041 "Delete any mail headers matching REGEXP.
4042 The message should be narrowed to just the headers."
4047 ;; This code from Emacs 22 doesn't seem right, since r-n-h is
4048 ;; just for display.
4049 ;;; (if (looking-at rmail-nonignored-headers)
4050 ;;; (forward-line 1)
4060 "Edit a mail message which is based on the contents of the current message.
4061 For a message rejected by the mail system, extract the interesting headers and
4062 the body of the original message.
4063 If the failed message is a MIME multipart message, it is searched for a
4064 body part with a header which matches the variable `mail-mime-unsent-header'.
4065 Otherwise, the variable `mail-unsent-separator' should match the string that
4066 delimits the returned original message.
4067 The variable `rmail-retry-ignored-headers' is a regular expression
4068 specifying headers which should not be copied into the new message."
4080 bounce-start bounce-end bounce-indent resending
4088 content-type))
4089 ;; Handle a MIME multipart bounce message.
4102 ;; Non-MIME bounce.
4106 ;; Support a style of failure message in which the original
4107 ;; message is indented, and included within lines saying
4108 ;; `Start of returned message' and `End of returned message'.
4117 ;; One message contained a few random lines before
4118 ;; the old message header. The first line of the
4119 ;; message started with two hyphens. A blank line
4120 ;; followed these random lines. The same line
4121 ;; beginning with two hyphens was possibly marking
4122 ;; the end of the message.
4137 ;; We have found the message that bounced, within the current message.
4138 ;; Now start sending new message; default header fields from original.
4139 ;; Turn off the usual actions for initializing the message body
4140 ;; because we want to get only the text from the failure message.
4144 rmail-this-buffer
4146 rmail-retried-attr-index)))
4147 ;; Insert original text as initial text of new draft message.
4148 ;; Bind inhibit-read-only since the header delimiter
4149 ;; of the previous message was probably read-only.
4151 eoh)
4154 bounce-start bounce-end)
4172 \f
4174 "Non-nil if in an RMAIL buffer and an associated summary buffer exists.
4175 In fact, the non-nil value returned is the summary buffer itself."
4177 rmail-summary-buffer))
4180 "t if in RMAIL buffer and an associated summary buffer is displayed."
4184 "Non-nil means Rmail should show the summary when it changes.
4185 This has an effect only if a summary buffer exists."
4190 "Non-nil means specify the height for an Rmail summary window."
4194 ;; Put the summary buffer back on the screen, if user wants that.
4197 window)
4198 ;; If requested, make sure the summary is displayed.
4200 rmail-redisplay-summary
4202 ;; It's already in some frame; show that one.
4208 ;; If requested, set the height of the summary window.
4210 rmail-summary-window-size
4212 ;; Don't try to change the size if just one window in frame.
4219 \f
4220 ;;;; *** Rmail Local Fontification ***
4223 ;; This function's symbol is bound to font-lock-fontify-buffer-function.
4225 ;; If we're already showing a message, fontify it now.
4227 ;; Prevent Font Lock mode from kicking in.
4231 ;; This function's symbol is bound to font-lock-fontify-unbuffer-function.
4234 before-change-functions after-change-functions
4235 buffer-file-name buffer-file-truename)
4245 ;; Fontify the current message if it is not already fontified.
4249 before-change-functions after-change-functions
4250 buffer-file-name buffer-file-truename)
4257 \f
4258 ;;; Speedbar support for RMAIL files.
4262 "Regexp matching Rmail folder names to be displayed in Speedbar.
4263 Enabling this permits Speedbar to display your folders for easy
4264 browsing, and moving of messages."
4276 "Install those variables used by speedbar to enhance rmail."
4278 nil
4287 ;; Mouse-3.
4295 ;; Make sure our special speedbar major mode is loaded
4301 "Create buttons for BUFFER containing rmail messages.
4302 Click on the address under Reply to: to reply to this person.
4303 Under Folders: Click a name to read it, or on the <M> to move the
4304 current message into that RMAIL folder."
4312 nil
4317 nil
4327 default-directory)
4328 nil rmail-speedbar-match-folder-regexp)))
4337 "Execute an rmail command specified by TEXT.
4338 The command used is TOKEN. INDENT is not used."
4343 "Load in the rmail file TEXT.
4344 TOKEN and INDENT are not used."
4350 "If the current line is a folder, move current message to it."
4360 "From button TEXT, copy current message to the rmail file specified by TOKEN.
4361 TEXT and INDENT are not used."
4364 ;; expand-file-name is needed due to the unhelpful way in which
4365 ;; rmail-output expands non-absolute filenames against rmail-default-file.
4366 ;; What is the point of that, anyway?
4368 \f
4369 ;; Functions for setting, getting and encoding the POP password.
4370 ;; The password is encoded to prevent it from being easily accessible
4371 ;; to "prying eyes." Obviously, this encoding isn't "real security,"
4372 ;; nor is it meant to be.
4374 ;;;###autoload
4376 "Set PASSWORD to be used for retrieving mail from a POP or IMAP server."
4385 "Get the password for retrieving mail from a POP or IMAP server. If none
4386 has been set, then prompt the user for one."
4391 "IMAP password: "
4401 "Encode STRING with integer MASK, by taking the exclusive OR of the
4402 lowest byte in the mask with the first character of string, the
4403 second-lowest-byte with the second character of the string, etc.,
4404 restarting at the lowest byte of the mask whenever it runs out.
4405 Returns the encoded string. Calling the function again with an
4406 encoded string (and the same mask) will decode the string."
4419 ;; Should this have a key-binding, or be in a menu?
4420 ;; There doesn't really seem to be an appropriate menu.
4421 ;; Eg the edit command is not in a menu either.
4423 "Decrypt OpenPGP armors in current message."
4426 ;; Save the current buffer here for cleanliness, in case we
4427 ;; change it in one of the calls to `epa-decrypt-region'.
4433 ;; In case the encrypted data is inside a mime attachment,
4434 ;; show it. This is a kludge; to be clean, it should not
4435 ;; modify the buffer, but I don't see how to do that.
4442 ;; Now find all armored messages in the buffer
4443 ;; and decrypt them one by one.
4447 armor-start armor-end after-end)
4450 nil t))
4455 ;; Because epa--find-coding-system-for-mime-charset not autoloaded.
4458 ;; Use the charset specified in the armor.
4465 ;; Advance over this armor.
4469 ;; Decrypt it, maybe in place, maybe making new buffer.
4471 armor-start armor-end
4472 ;; Call back this function to prepare the output.
4480 decrypts)))
4496 nil t))
4500 \f
4501 ;;;; Desktop support
4504 desktop-buffer-name
4505 desktop-buffer-misc)
4506 "Restore an rmail buffer specified in a desktop file."
4512 rmail-buffer))
4515 nil)))
4520 ;; We use this to record the encoding of the current message before
4521 ;; saving the message collection.
4524 ;; Used in `write-region-annotate-functions' to write rmail files.
4534 nil))
4536 ;; Used to restore the encoding of the buffer where we show the
4537 ;; current message, after we save the message collection. This is
4538 ;; needed because rmail-write-region-annotate switches buffers behind
4539 ;; save-file's back, with the side effect that last-coding-system-used
4540 ;; is assigned to buffer-file-coding-system of the wrong buffer.
4549 \f
4550 ;;; Start of automatically extracted autoloads.
4551 \f
4552 ;;;### (autoloads (rmail-edit-current-message) "rmailedit" "rmailedit.el"
4553 ;;;;;; "78b8b7d5c679935c118d595d473d7c5e")
4554 ;;; Generated autoloads from rmailedit.el
4557 Edit the contents of this message.
4561 ;;;***
4562 \f
4563 ;;;### (autoloads (rmail-next-labeled-message rmail-previous-labeled-message
4564 ;;;;;; rmail-read-label rmail-kill-label rmail-add-label) "rmailkwd"
4565 ;;;;;; "rmailkwd.el" "4ae5660d86d49e524f4a6bcbc6d9a984")
4566 ;;; Generated autoloads from rmailkwd.el
4569 Add LABEL to labels associated with current RMAIL message.
4570 Completes (see `rmail-read-label') over known labels when reading.
4571 LABEL may be a symbol or string. Only one label is allowed.
4576 Remove LABEL from labels associated with current RMAIL message.
4577 Completes (see `rmail-read-label') over known labels when reading.
4578 LABEL may be a symbol or string. Only one label is allowed.
4583 Read a label with completion, prompting with PROMPT.
4584 Completions are chosen from `rmail-label-obarray'. The default
4585 is `rmail-last-label', if that is non-nil. Updates `rmail-last-label'
4586 according to the choice made, and returns a symbol.
4591 Show previous message with one of the labels LABELS.
4592 LABELS should be a comma-separated list of label names.
4593 If LABELS is empty, the last set of labels specified is used.
4594 With prefix argument N moves backward N messages with these labels.
4599 Show next message with one of the labels LABELS.
4600 LABELS should be a comma-separated list of label names.
4601 If LABELS is empty, the last set of labels specified is used.
4602 With prefix argument N moves forward N messages with these labels.
4606 ;;;***
4607 \f
4608 ;;;### (autoloads (rmail-mime) "rmailmm" "rmailmm.el" "0c18b83f914803d1216e1a9df7ea5275")
4609 ;;; Generated autoloads from rmailmm.el
4612 Toggle the display of a MIME message.
4614 The actual behavior depends on the value of `rmail-enable-mime'.
4616 If `rmail-enable-mime' is non-nil (the default), this command toggles
4617 the display of a MIME message between decoded presentation form and
4618 raw data. With optional prefix argument ARG, it toggles the display only
4619 of the MIME entity at point, if there is one. The optional argument
4620 STATE forces a particular display state, rather than toggling.
4621 `raw' forces raw mode, any other non-nil value forces decoded mode.
4624 buffer holding a decoded copy of the message. Inline content-types are
4625 handled according to `rmail-mime-media-type-handlers-alist'.
4626 By default, this displays text and multipart messages, and offers to
4627 download attachments as specified by `rmail-mime-attachment-dirs-alist'.
4628 The arguments ARG and STATE have no effect in this case.
4632 ;;;***
4633 \f
4634 ;;;### (autoloads (set-rmail-inbox-list) "rmailmsc" "rmailmsc.el"
4635 ;;;;;; "e2212ea15561d60365ffa1f7a5902939")
4636 ;;; Generated autoloads from rmailmsc.el
4639 Set the inbox list of the current RMAIL file to FILE-NAME.
4640 You can specify one file name, or several names separated by commas.
4641 If FILE-NAME is empty, remove any existing inbox list.
4643 This applies only to the current session.
4647 ;;;***
4648 \f
4649 ;;;### (autoloads (rmail-sort-by-labels rmail-sort-by-lines rmail-sort-by-correspondent
4650 ;;;;;; rmail-sort-by-recipient rmail-sort-by-author rmail-sort-by-subject
4651 ;;;;;; rmail-sort-by-date) "rmailsort" "rmailsort.el" "38da5f17d4ed0dcd2b09c158642cef63")
4652 ;;; Generated autoloads from rmailsort.el
4656 If prefix argument REVERSE is non-nil, sorts in reverse order.
4663 non-nil, sorts in reverse order.
4668 Sort messages of current Rmail buffer by author.
4670 If prefix argument REVERSE is non-nil, sorts in reverse order.
4675 Sort messages of current Rmail buffer by recipient.
4677 If prefix argument REVERSE is non-nil, sorts in reverse order.
4682 Sort messages of current Rmail buffer by other correspondent.
4685 excluded by `mail-dont-reply-to-names'. If prefix argument
4686 REVERSE is non-nil, sorts in reverse order.
4691 Sort messages of current Rmail buffer by the number of lines.
4692 If prefix argument REVERSE is non-nil, sorts in reverse order.
4697 Sort messages of current Rmail buffer by labels.
4698 LABELS is a comma-separated list of labels. The order of these
4699 labels specifies the order of messages: messages with the first
4700 label come first, messages with the second label come second, and
4701 so on. Messages that have none of these labels come last.
4702 If prefix argument REVERSE is non-nil, sorts in reverse order.
4706 ;;;***
4707 \f
4708 ;;;### (autoloads (rmail-summary-by-senders rmail-summary-by-topic
4709 ;;;;;; rmail-summary-by-regexp rmail-summary-by-recipients rmail-summary-by-labels
4710 ;;;;;; rmail-summary) "rmailsum" "rmailsum.el" "bef21a376bd5bd59792a20dd86e6ec34")
4711 ;;; Generated autoloads from rmailsum.el
4714 Display a summary of all messages, one line per message.
4719 Display a summary of all messages with one or more LABELS.
4720 LABELS should be a string containing the desired labels, separated by commas.
4725 Display a summary of all messages with the given RECIPIENTS.
4726 Normally checks the To, From and Cc fields of headers;
4727 but if PRIMARY-ONLY is non-nil (prefix arg given),
4728 only look in the To and From fields.
4729 RECIPIENTS is a string of regexps separated by commas.
4734 Display a summary of all messages according to regexp REGEXP.
4735 If the regular expression is found in the header of the message
4736 \(including in the date and other lines, as well as the subject line),
4737 Emacs will list the message in the summary.
4742 Display a summary of all messages with the given SUBJECT.
4743 Normally checks just the Subject field of headers; but with prefix
4744 argument WHOLE-MESSAGE is non-nil, looks in the whole message.
4745 SUBJECT is a string of regexps separated by commas.
4751 SENDERS is a string of regexps separated by commas.
4755 ;;;***
4756 \f
4757 ;;;### (autoloads (unforward-rmail-message undigestify-rmail-message)
4758 ;;;;;; "undigest" "undigest.el" "9f270a2571bbbbfabc27498a8d4089c7")
4759 ;;; Generated autoloads from undigest.el
4762 Break up a digest message into its constituent messages.
4763 Leaves original message, deleted, before the undigestified messages.
4768 Extract a forwarded message from the containing message.
4769 This puts the forwarded message into a separate rmail message following
4770 the containing message. This command is only useful when messages are
4771 forwarded with `rmail-enable-mime-composing' set to nil.
4775 ;;;***
4776 \f
4777 ;;; End of automatically extracted autoloads.
4782 ;;; rmail.el ends here