| blob | 8e38564b14a4aedcfa26e57a763d8e5de6e7c1ee |
1 ;;; rmail.el --- main code of "RMAIL" mail reader for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1988, 1993-1998, 2000-2015 Free Software
4 ;; Foundation, Inc.
6 ;; Maintainer: emacs-devel@gnu.org
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
108 "Non-nil if and only if the current message is a MIME."
113 "Mail reader for Emacs."
117 "Rmail retrieval options."
122 "Rmail files."
127 "Rmail header options."
132 "Rmail reply options."
137 "Rmail summary options."
143 "Output message to a file."
149 "Rmail editing."
153 ;;;###autoload
155 "Name of user's primary mail file."
160 ;;;###autoload
167 ;;;###autoload
171 ;; SVR4 and recent BSD are said to use this.
172 ;; Rather than trying to know precisely which systems use it,
173 ;; let's assume this dir is never used for anything else.
175 ;; Many GNU/Linux systems use this name.
179 "Name of directory used by system mailer for delivering new mail.
180 Its name should end with a slash."
185 ;;;###autoload(custom-initialize-delay 'rmail-spool-directory nil)
188 "If non-nil, the file name of the `movemail' program."
196 "Password to use when reading mail from a remote server.
197 This setting is ignored for mailboxes whose URL already contains a password."
207 "Non-nil if a password is required when reading mail from a remote server."
213 "List of flags to pass to movemail.
214 Most commonly used to specify `-g' to enable GSS-API authentication
215 or `-k' to enable Kerberos authentication."
222 "Regular expression matching incorrect-password POP or IMAP server error
223 messages.
224 If you get an incorrect-password error that this expression does not match,
230 "Non-nil means leave incoming mail in the user's inbox--don't delete it."
235 "List of directories to search for movemail (in addition to `exec-path')."
244 "Determine what flavor of movemail PROG is.
245 We do this by executing it with `--version' and analyzing its output."
251 ;; Should not happen...
252 nil
260 ;; FIXME:
264 "Determine the file name of the `movemail' program and return its flavor.
265 If `rmail-movemail-program' is non-nil, use it.
266 Otherwise, look for `movemail' in the directories in
267 `rmail-movemail-search-path', those in `exec-path', and `exec-directory'."
274 ;; Previously, this didn't have to work on Windows, because
275 ;; rmail-insert-inbox-text before r1.439 fell back to using
276 ;; (expand-file-name "movemail" exec-directory) and just
277 ;; assuming it would work.
278 ;; http://lists.gnu.org/archive/html/bug-gnu-emacs/2008-02/msg00087.html
291 "The movemail variant currently in use. Known variants are:
293 `emacs' Means any implementation, compatible with the native Emacs one.
294 This is the default;
295 `mailutils' Means GNU mailutils implementation, capable of handling full
298 ;;;###autoload
300 "Return t if the current movemail variant is any of VARIANTS.
301 Currently known variants are 'emacs and 'mailutils."
303 ;; Autodetect
307 ;; Call for effect, to set rmail-movemail-program (if not set by the
308 ;; user), and rmail-movemail-variant-in-use. Used by various functions.
309 ;; I'm not sure if M-x rmail is the only entry point to this package.
310 ;; If so, this can be moved there.
313 ;;;###autoload
315 "Regexp matching user mail addresses.
316 If non-nil, this variable is used to identify the correspondent
317 when receiving new mail. If it matches the address of the sender,
318 the recipient is taken as correspondent of a mail.
319 If nil \(default value), your `user-login-name' and `user-mail-address'
320 are used to exclude yourself as correspondent.
322 Usually you don't have to set this variable, except if you collect mails
323 sent by you under different user names.
324 Then it should be a regexp matching your mail addresses.
326 Setting this variable has an effect only before reading a mail."
331 ;;;###autoload
335 ;; Prior to 24.1, this used to contain "\\`info-".
336 ;;;###autoload
338 "Regexp specifying part of the default value of `mail-dont-reply-to-names'.
339 This is used when the user does not set `mail-dont-reply-to-names'
341 ;;;###autoload
345 ;;;###autoload
365 "Regexp to match header fields that Rmail should normally hide.
366 \(See also `rmail-nonignored-headers', which overrides this regexp.)
367 This variable is used for reformatting the message header,
368 which normally happens once for each message,
369 when you view the message for the first time in Rmail.
370 To make a change in this variable take effect
371 for a message that you have already viewed,
377 "Regexp to match X header fields that Rmail should show.
378 This regexp overrides `rmail-ignored-headers'; if both this regexp
379 and that one match a certain header field, Rmail shows the field.
380 If this is nil, ignore all header fields in `rmail-ignored-headers'.
382 This variable is used for reformatting the message header,
383 which normally happens once for each message,
384 when you view the message for the first time in Rmail.
385 To make a change in this variable take effect
386 for a message that you have already viewed,
391 ;;;###autoload
393 "Regexp to match Header fields that Rmail should display.
394 If nil, display all header fields except those matched by
395 `rmail-ignored-headers'."
399 ;;;###autoload
400 (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:")
401 "Headers that should be stripped when retrying a failed message."
406 ;;;###autoload
408 "Regexp to match Header fields that Rmail should normally highlight.
409 A value of nil means don't highlight. Uses the face `rmail-highlight'."
415 "Face to use for highlighting the most important header fields.
416 The variable `rmail-highlighted-headers' specifies which headers."
420 ;; This was removed in Emacs 23.1 with no notification, an unnecessary
421 ;; incompatible change.
423 "Face used by Rmail for highlighting headers."
424 ;; Note that nil doesn't actually mean use the default face, it
425 ;; means use either bold or highlight. It's not worth fixing this
426 ;; now that this is obsolete.
428 face)
431 "customize the face `rmail-highlight' instead."
436 "Face to use for highlighting the header names.
437 The variable `rmail-font-lock-keywords' specifies which headers
438 get highlighted."
443 "Non-nil means automatically delete a message that is copied to a file."
447 ;;;###autoload
449 "List of files that are inboxes for your primary mail file `rmail-file-name'.
450 If this is nil, uses the environment variable MAIL. If that is
451 unset, uses a file named by the function `user-login-name' in the
452 directory `rmail-spool-directory' (whose value depends on the
454 ;; Don't use backquote here, because we don't want to need it at load time.
455 ;; (That must be an old comment - it's dumped these days.)
465 "Non-nil means Rmail makes a new frame for composing outgoing mail.
466 This is handy if you want to preserve the window configuration of
467 the frame where you have the RMAIL buffer displayed."
471 ;;;###autoload
473 "Directory for additional secondary Rmail files."
476 ;;;###autoload
478 "Regexp for which files are secondary Rmail files."
483 "Whether and how to ask for confirmation before expunging deleted messages.
484 The value, if non-nil is a function to call with a question (string)
485 as argument, to ask the user that question."
493 ;;;###autoload
500 ;;;###autoload
502 "List of functions to call when Rmail displays a message."
511 "List of functions to call when Rmail deletes a message.
512 When the hooks are called, the message has been marked deleted but is
515 ;; These may be altered by site-init.el to match the format of mmdf files
516 ;; delimiting used on a given host (delim1 and delim2 from the config
517 ;; files).
524 ;; FIXME Post-mbox, this is now unused.
525 ;; In Emacs-22, this was called:
526 ;; i) the very first time a message was shown.
527 ;; ii) when toggling the headers to the normal state, every time.
528 ;; It's not clear what it should do now, since there is nothing that
529 ;; records when a message is shown for the first time (unseen is not
530 ;; necessarily the same thing).
531 ;; See http://lists.gnu.org/archive/html/emacs-devel/2009-03/msg00013.html
533 "If non-nil, a filter function for new messages in RMAIL.
534 Called with region narrowed to the message, including headers,
535 before obeying `rmail-ignored-headers'."
540 "it is not used (try `rmail-show-message-hook')."
544 "List of directives specifying how to automatically file messages.
545 Whenever Rmail shows a message in the folder that `rmail-file-name'
546 specifies, it calls `rmail-auto-file' to maybe file the message in
547 another folder according to this list. Messages that are already
548 marked as `filed', or are in different folders, are left alone.
550 Each element of the list is of the form:
552 (FOLDERNAME FIELD REGEXP [ FIELD REGEXP ] ... )
554 FOLDERNAME is the name of a folder in which to put the message.
555 If FOLDERNAME is nil then Rmail deletes the message, and moves on to
557 but does not move to the next.
559 FIELD is the name of a header field in the message, such as
563 REGEXP is a regular expression to match (case-sensitively) against
564 the preceding specified FIELD.
566 There may be any number of FIELD/REGEXP pairs.
567 All pairs must match for a directive to apply to a message.
568 For a given message, Rmail applies only the first matching directive.
570 Examples:
573 "
581 ;; Some mailers use "Re(2):" or "Re^2:" or "Re: Re:" or "Re[2]:".
582 ;; This pattern should catch all the common variants.
583 ;; rms: I deleted the change to delete tags in square brackets
584 ;; because they mess up RT tags.
589 "If non-nil, Rmail always displays the summary buffer."
592 \f
597 "The RMAIL buffer related to the current buffer.
598 In an RMAIL buffer, this holds the RMAIL buffer itself.
610 ;; Message counters and markers. Deleted flags.
613 "Integer specifying the message currently being displayed in this folder.
614 Counts messages from 1 to `rmail-total-messages'. A value of 0
619 "Integer specifying the total number of messages in this folder.
624 "Vector of markers specifying the start and end of each message.
629 "A string of length `rmail-total-messages' plus one.
635 "In an Rmail buffer, a vector whose Nth element is a list (N).
636 When expunging renumbers messages, these lists are modified
643 ;; These are used by autoloaded rmail-summary.
648 "In an Rmail buffer, vector of (newline-terminated) strings.
652 ;; Rmail buffer swapping variables.
663 \f
664 ;; `Sticky' default variables.
666 ;; Last individual label specified to a or k.
669 ;; Last set of values specified to C-M-n, C-M-p, C-M-s or C-M-l.
675 ;; Note that rmail-output-read-file-name modifies this.
686 ;; Mule and MIME related variables.
688 ;;;###autoload
690 "Coding system used in RMAIL file.
695 "Function of no args to try to determine coding system for a message."
701 "If non-nil, RMAIL automatically displays decoded MIME messages.
702 For this to work, the feature specified by `rmail-mime-feature' must
703 be available."
709 "If non-nil, use `rmail-insert-mime-forwarded-message-function' to forward."
715 "Function of no argument called to show a decoded MIME message.
716 This function is called when `rmail-enable-mime' is non-nil.
719 ;;;###autoload
721 "Function to insert a message in MIME format so it can be forwarded.
722 This function is called if `rmail-enable-mime' and
723 `rmail-enable-mime-composing' are non-nil.
724 It is called with one argument FORWARD-BUFFER, which is a
725 buffer containing the message to forward. The current buffer
729 "Function to insert a message in MIME format so it can be resent.
730 This function is called by `rmail-resend' if `rmail-enable-mime' is non-nil.
731 It is called with one argument FORWARD-BUFFER, which is a
732 buffer containing the message to forward. The current buffer
735 ;; FIXME one might want to pass a LIMIT, as per
736 ;; rmail-search-mime-header-function.
738 "Function to check if a regexp matches a MIME message.
739 This function is called by `rmail-search-message' if
740 `rmail-enable-mime' is non-nil. It is called (with point at the
741 start of the message) with two arguments MSG and REGEXP, where
745 "Function to check if a regexp matches a header of MIME message.
746 This function is called by `rmail-message-regexp-p-1' if
747 `rmail-enable-mime' is non-nil. It is called (with point at the
748 start of the header) with three arguments MSG, REGEXP, and LIMIT,
749 where MSG is the message number, REGEXP is the regular
753 "Feature to require for MIME support in Rmail.
754 When starting Rmail, if `rmail-enable-mime' is non-nil, this
755 feature is loaded with `require'. The default value is `rmailmm'.
757 The library should set the variable `rmail-show-mime-function'
758 to an appropriate value, and optionally also set
759 `rmail-search-mime-message-function',
760 `rmail-search-mime-header-function',
761 `rmail-insert-mime-forwarded-message-function', and
768 "Regexp to match MIME-charset specification in a header of message.
771 \f
779 "From "
781 ;; Many things can happen to an RFC 822 mailbox before it is put into
782 ;; a `From' line. The leading phrase can be stripped, e.g.
783 ;; `Joe <@w.x:joe@y.z>' -> `<@w.x:joe@y.z>'. The <> can be stripped, e.g.
784 ;; `<@x.y:joe@y.z>' -> `@x.y:joe@y.z'. Everything starting with a CRLF
785 ;; can be removed, e.g.
786 ;; From: joe@y.z (Joe K
787 ;; User)
788 ;; can yield `From joe@y.z (Joe K Fri Mar 22 08:11:15 1996', and
789 ;; From: Joe User
790 ;; <joe@y.z>
791 ;; can yield `From Joe User Fri Mar 22 08:11:15 1996'.
792 ;; The mailbox can be removed or be replaced by white space, e.g.
793 ;; From: "Joe User"{space}{tab}
794 ;; <joe@y.z>
795 ;; can yield `From {space}{tab} Fri Mar 22 08:11:15 1996',
796 ;; where {space} and {tab} represent the Ascii space and tab characters.
797 ;; We want to match the results of any of these manglings.
798 ;; The following regexp rejects names whose first characters are
799 ;; obviously bogus, but after that anything goes.
802 ;; The time the message was sent.
808 ;; Perhaps a time zone, specified by an abbreviation, or by a
809 ;; numeric offset.
810 time-zone-regexp
812 ;; The year.
815 ;; On some systems the time zone can appear after the year, too.
816 time-zone-regexp
818 ;; Old uucp cruft.
822 "Regexp matching the delimiter of messages in UNIX mail format
823 \(UNIX From lines), minus the initial ^. Note that if you change
824 this expression, you must change the code in `rmail-nuke-pinhead-header'
827 ;; FIXME the rmail-header-name headers ought to be customizable.
828 ;; It seems a bit arbitrary, for example, that all of the Date: line
829 ;; gets highlighted.
831 ;; These are all matched case-insensitively.
839 ;; FIXME Mail-Followup-To should probably be here too.
844 ;; Use MATCH-ANCHORED to effectively anchor the regexp left side.
845 `(,cite-chars
857 ;; Rmail does not expect horizontal splitting. (Bug#2282)
859 "Like `pop-to-buffer', but with `split-width-threshold' set to nil."
863 ;; Perform BODY in the summary buffer
864 ;; in such a way that its cursor is properly updated in its own window.
873 ;; rmail-total-messages is a buffer-local var
874 ;; in the rmail buffer.
875 ;; This way we make it available for the body
876 ;; even tho the rmail buffer is not current.
884 \f
885 ;;;; *** Rmail Mode ***
888 "Require `rmail-mime-feature' if that is non-nil.
889 Signal an error and set `rmail-mime-feature' to nil if the feature
890 isn't provided."
896 'rmail
898 through `rmail-enable-mime' being non-nil, the required feature
899 `%s' (the value of `rmail-mime-feature')
900 is not available in the current session.
901 So, MIME support is turned off for the moment."
902 rmail-mime-feature)
907 ;;;###autoload
909 "Read and edit incoming mail.
910 Moves messages into file named by `rmail-file-name' and edits that
911 file in RMAIL Mode.
914 May be called with file name as argument; then performs rmail editing on
915 that file, but does not copy any new mail into the file.
916 Interactively, if you supply a prefix argument, then you
917 have a chance to specify a file name with the minibuffer.
919 If `rmail-display-summary' is non-nil, make a summary for this RMAIL file."
924 ;; Use find-buffer-visiting, not get-file-buffer, for those users
925 ;; who have find-file-visit-truename set to t.
927 run-mail-hook mail-buf msg-shown)
928 ;; Determine if an existing mail file has been changed behind the
929 ;; scene...
931 ;; The mail file has been changed. Revisit it and reset the
932 ;; message state variables when in rmail mode.
939 ;; The mail file is either unchanged or not visited. Visit it.
942 ;; Force no-conversion by default, since that's what
943 ;; pre-mbox Rmail did with BABYL files (via
944 ;; auto-coding-regexp-alist).
948 ;; Ensure that the collection and view buffers are in sync and
949 ;; ensure that a message is not being edited.
956 ;; Ensure that the Rmail file is in mbox format, the buffer is in
957 ;; Rmail mode and has been scanned to find all the messages
958 ;; (setting the global message variables in the process).
965 ;; Show the first unread message and process summary mode.
967 ;; Only get new mail when there is not a file name argument.
980 "Determine if the file needs to be converted to mbox format."
983 ;; Detect previous Babyl format files.
986 ;; The file is Babyl version 5. Use unrmail to convert
987 ;; it.
990 ;; Losing babyl file made by old version of Rmail. Fix the
991 ;; babyl file header and use unrmail to convert to mbox
992 ;; format.
1002 "Report that the buffer is not in the mbox file format.
1003 MSGNUM, if present, indicates the malformed message."
1009 "Convert the mail file from Babyl version 5 to mbox.
1010 This function also reinitializes local variables used by Rmail."
1024 ;; Rmail buffers need to be saved with Unix EOLs, or else
1025 ;; the format will not be recognized.
1039 "Return a suitable coding system to use for the current mail message.
1040 The buffer is expected to be narrowed to just the header of the message."
1048 \f
1049 ;;; Set up Rmail mode keymaps
1060 ;; If you change this, change the rmail-resend menu-item's :keys.
1086 ;; I find I can't live without the default M-r command -- rms.
1087 ;; (define-key rmail-mode-map "\er" 'rmail-search-backwards)
1114 \f
1121 nil)
1124 nil)
1231 map)
1234 ;; Rmail toolbar
1238 map rmail-mode-map)
1240 map rmail-mode-map)
1242 map rmail-mode-map)
1244 map rmail-mode-map)
1246 map rmail-mode-map)
1248 map rmail-mode-map)
1250 map rmail-mode-map)
1252 map rmail-mode-map)
1254 map rmail-mode-map)
1256 map rmail-mode-map)
1258 map rmail-mode-map)
1260 map rmail-mode-map)
1261 map))
1264 \f
1265 ;; Rmail mode is suitable only for specially formatted data.
1273 ;;;###autoload
1276 All normal editing commands are turned off.
1277 Instead, these commands are available:
1293 \\[rmail-undelete-previous-message] Undelete message. Tries current message, then earlier messages
1294 till a deleted message is found.
1295 \\[rmail-edit-current-message] Edit the current message. \\[rmail-cease-edit] to return to Rmail.
1308 \\[rmail-output-body-to-file] Save message body to a file. Default filename comes from Subject line.
1313 (label defaults to last one specified).
1314 Standard labels: filed, unseen, answered, forwarded, deleted.
1352 ;; No need to auto save RMAIL files in normal circumstances
1353 ;; because they contain no info except attribute changes
1354 ;; and deletion of messages.
1355 ;; The one exception is when messages are copied into another mbox buffer.
1356 ;; rmail-output enables auto save when you do that.
1361 ;; Functions to support buffer swapping:
1368 "Return a reusable buffer suitable for viewing messages.
1369 Create the buffer if necessary."
1370 ;; We want to reuse any existing view buffer, so as not to create an
1371 ;; endless number of them. But we must avoid clashes if we visit
1372 ;; two different rmail files with the same basename (Bug#4593).
1375 rmail-view-buffer
1383 newbuf)))
1386 "Swap text between current buffer and `rmail-view-buffer'.
1387 This function preserves the current buffer's modified flag, and also
1388 sets the current buffer's `buffer-file-coding-system' to that of
1389 `rmail-view-buffer'."
1396 buffer-file-coding-system)))
1405 "Return non-nil if the message collection is in `rmail-view-buffer'."
1406 ;; This is analogous to tar-data-swapped-p in tar-mode.el.
1407 rmail-buffer-swapped)
1410 ;; Bring the actual Rmail messages back into the main buffer.
1416 "Determine if the Rmail buffer is showing a message.
1417 If so restore the actual mbox message collection."
1424 "Warn if important modifications would change Rmail file's format."
1427 ;; If it's already modified, don't warn again.
1442 ;; Turn off the hook on the view buffer, so we can kill it, then kill it.
1452 ;; Set up the permanent locals associated with an Rmail file.
1465 ;; Note that this does not erase the buffer. Should it?
1466 ;; It depends on how this is called. If somehow called with the
1467 ;; rmail buffers swapped, it would erase the message collection.
1470 ;; Force C-x C-s write Unix EOLs.
1480 ;; Provide default set of inboxes for primary mail file ~/RMAIL.
1488 ;; FIXME expand-file-name?
1493 ;; Set up the non-permanent locals associated with Rmail mode.
1495 ;; Turn off undo. We turn it back on in rmail-edit.
1497 ;; Don't let a local variables list in a message cause confusion.
1500 ;; Don't turn off auto-saving based on the size of the buffer
1501 ;; because that code does not understand buffer-swapping.
1509 t t nil nil
1526 \f
1527 ;; Handle M-x revert-buffer done in an rmail-mode buffer.
1532 ;; See similar code in `rmail'.
1533 ;; FIXME needs updating?
1536 ;; Call our caller again, but this time it does the default thing.
1538 ;; If the user said "yes", and we changed something,
1539 ;; reparse the messages.
1542 ;; Convert all or part to Babyl file if possible.
1544 ;; We have read the file as raw-text, so the buffer is set to
1545 ;; unibyte. Make it multibyte if necessary.
1555 "Expunge and save RMAIL file."
1559 ;; No need to swap buffers: rmail-write-region-annotate takes care of it.
1560 ;; (rmail-swap-buffers-maybe)
1566 "Quit out of RMAIL.
1567 Hook `rmail-quit-hook' is run after expunging."
1574 ;; Don't switch to the summary buffer even if it was recently visible.
1585 "Bury current Rmail buffer and its summary buffer."
1587 ;; This let var was called rmail-buffer, but that interfered
1588 ;; with the buffer-local var used in summary buffers.
1595 \f
1597 "Create a duplicated copy of the current message.
1598 The duplicate copy goes into the Rmail file just after the original."
1599 ;; If we are in a summary buffer, switch to the Rmail buffer.
1600 ;; FIXME simpler to swap the contents, not the buffers?
1622 \f
1623 ;;;###autoload
1625 "Run Rmail on file FILENAME."
1629 ;; This used to scan subdirectories recursively, but someone pointed out
1630 ;; that if the user wants that, person can put all the files in one dir.
1631 ;; And the recursive scan was slow. So I took it out.
1632 ;; rms, Sep 1996.
1634 "Return list of file in dir START that match `rmail-secondary-file-regexp'."
1636 ;; Don't sort here.
1639 ;; Sort here instead of in directory-files
1640 ;; because this list is usually much shorter.
1645 name)
1665 item)
1666 rmail-secondary-file-directory)))))
1670 menu))
1672 ;; This command is always "disabled" when it appears in a menu.
1682 files
1687 files
1695 \f
1696 ;;;; *** Rmail input ***
1704 ;; RLK feature not added in this version:
1705 ;; argument specifies inbox file or files in various ways.
1707 ;; In Babyl, the Mail: header in the preamble overrode rmail-inbox-list.
1708 ;; Mbox does not have this feature.
1710 "Move any new mail from this Rmail file's inbox files.
1711 The buffer-local variable `rmail-inbox-list' specifies the list
1712 of inbox files. By default, this is nil, except for your primary
1713 Rmail file `rmail-file-name'. In this case, when you first visit
1714 the Rmail file it is initialized using either
1716 or the function `user-login-name' and the directory
1717 `rmail-spool-directory' (whose value depends on the operating system).
1719 The command `set-rmail-inbox-list' sets `rmail-inbox-list' to the
1720 value you specify.
1722 You can also specify the file to get new mail from just for one
1723 instance of this command. In this case, the file of new mail is
1724 not changed or deleted. Noninteractively, you can pass the inbox
1725 file name as an argument. Interactively, a prefix argument
1726 causes us to read a file name and use that file as the inbox.
1728 If the variable `rmail-preserve-inbox' is non-nil, new mail will
1729 always be left in inbox files rather than deleted.
1731 Before doing anything, this runs `rmail-before-get-new-mail-hook'.
1732 Just before returning, it runs `rmail-after-get-new-mail-hook',
1733 whether or not there is new mail.
1735 If there is new mail, it runs `rmail-get-new-mail-hook', saves
1736 the updated file, and shows the first unseen message (which might
1737 not be a new one). It returns non-nil if it got any new messages."
1742 ;; If the disk file has been changed from under us,
1743 ;; revert to it before we get new mail.
1751 ;; Get rid of all undo records for this buffer.
1756 found)
1759 ;; This loops if any members of the inbox list have the same
1760 ;; basename (see "name conflict" below).
1763 ;; saved yet, don't replace the old backup file now.
1767 ;; Don't make undo records while getting mail.
1769 delete-files files file-last-names)
1770 ;; Pull files off all-files onto files as long as there is
1771 ;; no name conflict. A conflict happens when two inbox
1772 ;; file names have the same last component.
1773 ;; The reason this careful handling is necessary seems
1774 ;; to be that rmail-insert-inbox-text uses .newmail-BASENAME.
1777 file-last-names)))
1779 file-last-names
1782 ;; Put them back in their original order.
1785 ;; Make sure we end with a blank line unless there are
1786 ;; no messages, as required by mbox format (Bug#9974).
1792 found))))
1793 ;; Move to the first new message unless we have other unseen
1794 ;; messages before it.
1797 found)
1798 ;; Don't leave the buffer screwed up if we get a disk-full error.
1805 "Return t if new messages are detected without error, nil otherwise."
1810 rmail-use-spam-filter))
1812 result success suffix)
1814 ;; Read in the contents of the inbox files, renaming them as
1815 ;; necessary, and adding to the list of files to delete
1816 ;; eventually.
1820 ;; Scan the new text and convert each message to
1821 ;; Rmail/mbox format.
1827 success t)
1828 ;; Try to delete the garbage just inserted.
1830 ;; If we could not convert the file's inboxes, rename the
1831 ;; files we tried to read so we won't over and over again.
1840 ;; Determine if there are messages.
1842 ;; There are. Process them.
1847 ;; Delete the old files, now that the Rmail file is saved.
1850 ;; First, try deleting.
1854 ;; If we can't delete it, truncate it.
1867 ;; Establish the return value.
1869 result))))
1872 "Parse the supplied URL. Return (list MAILBOX-NAME REMOTE PASSWORD GOT-PASSWORD)
1873 WHERE MAILBOX-NAME is the name of the mailbox suitable as argument to the
1874 actual version of `movemail', REMOTE is non-nil if MAILBOX-NAME refers to
1875 a remote mailbox, PASSWORD is the password if it should be
1876 supplied as a separate argument to `movemail' or nil otherwise, GOT-PASSWORD
1877 is non-nil if the user has supplied the password interactively.
1878 "
1893 ;; The password is embedded. Strip it out since movemail
1894 ;; does not really like it, in spite of the movemail spec.
1900 t
1902 got-password)
1907 got-password))))
1911 ;; (proto "pop")
1912 ;; (user (match-string 1 file))
1913 ;; (host (match-string 3 file))
1914 )
1926 "Replace newly read mail in Babyl format with equivalent mbox format.
1928 FROM-FILE is the Babyl file from which the new mail should be read."
1930 size)
1938 size)))
1941 "If newly read mail from FILE is in Babyl format, convert it to mbox format.
1943 SIZE is the original size of the newly read mail.
1944 Value is the size of the newly read mail after conversion."
1945 ;; Detect previous Babyl format files.
1949 ;; The new mail is in Babyl version 5 format. Use unrmail
1950 ;; to convert it.
1953 ;; New mail is in Babyl format made by old version of
1954 ;; Rmail. Fix the babyl file header and use unrmail to
1955 ;; convert it.
1965 size))
1968 ;; Detect a locked file now, so that we avoid moving mail
1969 ;; out of the real inbox file. (That could scare people.)
1975 ;; Handle remote mailbox names specially; don't expand as filenames
1976 ;; in case the userid contains a directory separator.
1989 ;; Generate name to move to from inbox name,
1990 ;; in case of multiple inboxes that need moving.
1994 ;; cannot have colons in file name
1996 file)))
1997 ;; Use the directory of this rmail file
1998 ;; because it's a nuisance to use the homedir
1999 ;; if that is on a full disk and this rmail
2000 ;; file isn't.
2003 ;; Always use movemail to rename the file,
2004 ;; since there can be mailboxes in various directories.
2006 ;; On some systems, /usr/spool/mail/foo is a directory
2007 ;; and the actual inbox is /usr/spool/mail/foo/foo.
2010 file))))
2019 ;; Set TOFILE if have not already done so, and
2020 ;; rename or copy the file FILE to TOFILE if and as appropriate.
2025 nil)
2035 nil)
2038 rmail-movemail-flags)
2043 ;; No output => movemail won
2044 nil
2055 ;; If we just read the password, most likely it is
2056 ;; wrong. Otherwise, see if there is a specific
2057 ;; reason to think that the problem is a wrong passwd.
2060 nil t))
2063 ;; If using Mailutils, remove initial error code
2064 ;; abbreviation
2075 nil)))))
2077 ;; At this point, TOFILE contains the name to read:
2078 ;; Either the alternate name (if we renamed)
2079 ;; or the actual inbox (if not renaming).
2082 size)
2085 ;; If new mail is in Babyl format, convert it to mbox.
2087 tofile
2090 ;; Make sure the read-in mbox data properly ends with a
2091 ;; blank line unless it is of size 0.
2099 delete-files))
2101 ;; Decode the region specified by FROM and TO by CODING.
2102 ;; If CODING is nil or an invalid coding system, decode by `undecided'.
2106 ;; Use -dos decoding, to remove ^M characters left from base64 or
2107 ;; rogue qp-encoded text.
2110 ;; Don't reveal the fact we used -dos decoding, as users generally
2111 ;; will not expect the RMAIL buffer to use DOS EOL format.
2124 "Ensure a message ends in a blank line.
2125 Call with point at the end of the message."
2132 "Validate the RFC2822 format for the new messages.
2133 Point should be at the first new message.
2134 An error is signaled if the new messages are not RFC2822
2135 compliant.
2136 Unless an Rmail attribute header already exists, add it to the
2137 new messages. Return the number of new messages."
2145 stop)
2146 ;; Detect an empty inbox file.
2148 ;; Scan the new messages to establish a count and to ensure that
2149 ;; an attribute header is present.
2152 ;; Determine if a new attribute header needs to be
2153 ;; added to the message.
2163 ;; Move to the next message.
2170 count))))
2171 \f
2173 "Subroutine of `rmail-get-header'.
2174 Narrow to header, call `mail-fetch-field' to find header NAME."
2182 "Return the value of message header NAME, nil if it has none.
2183 MSGNUM specifies the message number to get it from.
2184 If MSGNUM is nil, use the current message."
2188 "Subroutine of `rmail-set-header'.
2189 Narrow to headers, set header NAME to VALUE, replacing existing if present.
2190 VALUE nil means to remove NAME altogether.
2192 Only changes the first instance of NAME. If VALUE is multi-line,
2193 continuation lines should already be indented. VALUE should not
2194 end in a newline."
2199 ;; cf mail-fetch-field.
2205 end)
2208 ;; Back up over newline.
2217 ;; Not already present: insert at end of headers.
2222 "Set message header NAME to VALUE in message number MSGNUM.
2223 If MSGNUM is nil, use the current message. NAME and VALUE are strings.
2224 VALUE may also be nil, meaning to remove the header."
2227 ;; Ensure header changes get saved.
2228 ;; (Note replacing a header with an identical copy modifies.)
2230 ;; However: don't save in mbox format over a Babyl file
2231 ;; merely because of this.
2233 \f
2234 ;;;; *** Rmail Attributes and Keywords ***
2237 "Return the message attributes in a comma separated string.
2238 MSG specifies the message number to get it from.
2239 If MSG is nil, use the current message."
2242 result temp)
2249 result
2254 result)))
2257 "Return the message keywords in a comma separated string.
2258 MSG, if non-nil, identifies the message number to use.
2259 If nil, that means the current message."
2263 "Return a string with the labels (attributes and keywords) of msg MSG.
2264 It is put in comma-separated form.
2265 MSG, if non-nil, identifies the message number to use.
2266 If nil, that means the current message."
2269 ;; Combine the message attributes and keywords
2270 ;; into a comma-separated list.
2276 ;; FIXME ? old rmail did not have spaces in the comma-separated lists.
2283 "Update the current messages's attributes and keywords in mode line."
2287 rmail-current-message rmail-total-messages blurb))))
2290 "Return the character value for ATTR.
2291 ATTR is a (numeric) index, an offset into the mbox attribute
2292 header value. STATE is one of nil, t, or a character value."
2299 "Subroutine of `rmail-set-attribute'.
2300 Set Rmail attribute ATTR to STATE in `rmail-attribute-header',
2301 creating the header if necessary. Returns non-nil if a
2302 significant attribute change was made."
2306 altered)
2309 ;; If this message already records attributes, just change the
2310 ;; value for this one.
2312 ;; Position point at this attribute, adding attributes if necessary.
2319 ;; Change this attribute.
2324 ;; Otherwise add a header line to record the attributes and set
2325 ;; all but this one to no.
2331 altered))
2334 "Turn an attribute of a message on or off according to STATE.
2335 STATE is either nil or the character (numeric) value associated
2336 with the state (nil represents off and non-nil represents on).
2337 ATTR is either the index number of the attribute, or a string,
2338 both from `rmail-attr-array'. MSGNUM is message number to
2339 change; nil means current message."
2349 ;; Ask for confirmation before setting any attribute except `unseen'
2350 ;; if it would force a format change.
2356 ;; The "deleted" attribute is also stored in a special vector so
2357 ;; update that too.
2364 ;; Don't save in mbox format over a Babyl file
2365 ;; merely because of a change in `unseen' attribute.
2368 ;; Otherwise, if we modified the file text via the view buffer,
2369 ;; mark the main buffer modified too.
2373 "Return non-nil if message number MSG has attributes matching regexp ATTRS."
2378 "Return non-nil if message number MSGNUM has the unseen attribute."
2381 ;; FIXME rmail-get-labels does some formatting (eg leading space, `;'
2382 ;; between attributes and labels), so this might not do what you want.
2383 ;; Eg see rmail-sort-by-labels. rmail-get-labels could have an
2384 ;; optional `noformat' argument.
2386 "Return non-nil if message number MSG has labels matching regexp LABELS."
2388 \f
2389 ;;;; *** Rmail Message Selection And Support ***
2392 "Return the end position for message number N."
2396 "Return the start position for message number N."
2400 "Call FUNCTION on ARGS while narrowed to message MSGNUM.
2401 Point is at the start of the message.
2402 This returns what the call to FUNCTION returns.
2403 If MSGNUM is nil, use the current message."
2410 ;; All access to the rmail-buffer's local variables is now finished...
2412 ;; ... so it is ok to go to a different buffer.
2421 ;; Unused (save for commented out code in rmailedit.el).
2423 "Call FUNCTION with point at start of internal data of current message.
2424 Assumes that bounds were previously narrowed to display the message in Rmail.
2425 The bounds are widened enough to move point where desired, then narrowed
2426 again afterward.
2428 FUNCTION may not change the visible text of the message, but it may
2429 change the invisible header text."
2437 ;; Note: we don't use save-restriction because that does not work right
2438 ;; if changes are made outside the saved restriction
2439 ;; before that restriction is restored.
2442 \f
2443 ;; Manage the message vectors and counters.
2459 rmail-message-vector
2460 rmail-current-message
2461 rmail-total-messages))
2465 "Count the number of new messages.
2466 The buffer should be narrowed to include only the new messages.
2467 Output a helpful message unless NOMSG is non-nil."
2474 ;; Put at the end of messages-head
2475 ;; the entry for message N+1, which marks
2476 ;; the end of message N. (N = number of messages).
2492 ;; Fill in the new elements of rmail-msgref-vector.
2511 ;; Determine how many messages follow point.
2514 ;; Put at the end of messages-head
2515 ;; the entry for message N+1, which marks
2516 ;; the end of message N. (N = number of messages).
2527 ;; Make an element 0 in rmail-message-vector and rmail-deleted-vector
2528 ;; which will never be used.
2549 "Collect the message deletion flags for each message.
2550 MESSAGE-END is the buffer position corresponding to the end of
2551 the message. Point is at the beginning of the message."
2552 ;; NOTE: This piece of code will be executed on a per-message basis.
2553 ;; In the face of thousands of messages, it has to be as fast as
2554 ;; possible, hence some brute force constant use is employed in
2555 ;; addition to inlining.
2560 ?D
2564 "Collect the start positions of messages in list `messages-head'.
2565 Return the number of messages after the one containing SPOT-TO-FIND."
2567 messages-after-spot)
2578 ;; Show progress after every 20 messages or so.
2581 ;; Handle the first message, maybe.
2590 messages-after-spot))
2591 \f
2592 ;; Display a message.
2594 ;;;; *** Rmail Message Formatting and Header Manipulation ***
2596 ;; This is used outside of rmail.
2598 "Return nil if the current message is showing full headers."
2600 rmail-buffer)
2604 "Toggle between showing full and normal message headers.
2605 With optional integer ARG, show the normal message header if ARG
2606 is greater than zero; otherwise, show it in full."
2615 "Show current message starting from the beginning."
2619 rmail-view-buffer
2620 rmail-buffer)
2621 rmail-header-style)))
2625 "Show bottom of current message."
2631 rmail-view-buffer
2632 rmail-buffer)
2633 rmail-header-style)))
2638 Ask the user whether to add that list name to `mail-mailing-lists'."
2639 ;; FIXME s-r not needed? Use rmail-get-header?
2640 ;; We have not narrowed to the headers at ths point?
2651 ;; taken from rmailsum.el
2663 addr))
2666 addr)))
2671 "Display the entire mailbox file."
2675 \f
2680 ;; Eg we deleted all the messages, so remove the old N/M mark.
2687 "Show message number N (prefix argument), counting from start of file.
2688 If summary buffer is currently displayed, update current message there also.
2689 N defaults to the current message."
2693 ;; FIXME: Why do we swap the raw data back in?
2703 ;; If there is a summary buffer, try to move to this message
2704 ;; in that buffer. But don't complain if this message is
2705 ;; not mentioned in the summary. Don't do this at all if we
2706 ;; were called on behalf of cursor motion in the summary
2707 ;; buffer.
2718 "Return t if the region contains a text message, nil otherwise."
2722 ;; The message is text if either there is no content type header
2723 ;; (a default of "text/plain; charset=US-ASCII" is assumed) or
2724 ;; the base content type is either text or message.
2729 "Message size at which to show progress messages for displaying it."
2734 ;; FIXME?
2735 ;; rmail-show-mime-function does not unquote >From lines. Should it?
2737 "The mbox format that your system uses.
2738 There is no way to determine this, so you should set the appropriate value.
2740 The choices are:
2743 The `mboxo' format is ambiguous, in that one cannot know whether
2746 It is not critical to set this to the correct value; it only affects
2749 See also `unrmail-mbox-format'."
2756 "Show message MSG (default: current message) using `rmail-view-buffer'.
2757 Return text to display in the minibuffer if MSG is out of
2758 range (displaying a reasonable choice as well), nil otherwise.
2759 The current mail message becomes the message displayed."
2762 blurb beg end body-start coding-system character-coding
2763 is-text-message header-style
2764 showing-message)
2770 rmail-current-message 1
2774 rmail-current-message rmail-total-messages
2779 ;; Mark the message as seen, but preserve buffer modified flag.
2784 ;; bracket the message in the mail
2785 ;; buffer and determine the coding system the transfer encoding.
2795 ;; We give the view buffer a buffer-local value of
2796 ;; rmail-header-style based on the binding in effect when
2797 ;; this function is called; `rmail-toggle-headers' can
2798 ;; inspect this value to determine how to toggle.
2801 rmail-show-mime-function
2821 ;; Decode the message body into an empty view buffer using a
2822 ;; unibyte temporary buffer where the character decoding takes
2823 ;; place.
2827 ;; Do it directly since that is fast.
2829 ;; Can this be done directly, skipping the temp buffer?
2835 ;; See bug#5441.
2847 coding-system view-buf)))
2849 ;; Prepare the separator (blank line) before the body.
2852 ;; Unquote quoted From lines.
2854 "^>+From "
2856 case-fold-search)
2862 ;; Copy the headers to the front of the message view buffer.
2864 ;; Decode any RFC2047 encoded message headers.
2872 ;; highlight the message, activate any URL like text and add
2873 ;; special highlighting for and quoted material.
2877 ;(rmail-activate-urls)
2878 ;(rmail-process-quoted-material)
2879 )
2880 ;; Update the mode-line with message status information and swap
2881 ;; the view buffer/mail buffer contents.
2888 blurb))
2891 "Copy displayed header fields to the message viewer buffer.
2892 BEG and END marks the start and end positions of the message in
2893 the mbox buffer. If the optional argument IGNORED-HEADERS is
2894 non-nil, ignore all header fields whose names match that regexp.
2895 Otherwise, if `rmail-displayed-headers' is non-nil, copy only
2896 those header fields whose names match that regexp. Otherwise,
2897 copy all header fields whose names do not match
2898 `rmail-ignored-headers' (unless they also match
2899 `rmail-nonignored-headers'). Moves point in the message viewer
2900 buffer to the end of the headers."
2902 lim)
2907 ;; Put point right after the From header line.
2914 ;; Handle the case where all headers should be copied.
2917 ;; rmail-show-message-1 expects this function to leave point
2918 ;; at the end of the headers.
2924 ;; Handle the case where the headers matching the displayed
2925 ;; headers regexp should be copied.
2935 ;; Handle the ignored headers.
2951 "Decode the body of the current message using coding system CODING.
2952 This is useful with mail messages that have malformed or missing
2953 charset= headers.
2955 This function assumes that the current message is already decoded
2956 and displayed in the RMAIL buffer, but the coding system used to
2957 decode it was incorrect. It then decodes the message again,
2958 using the coding system CODING."
2968 body-start x-coding-header old-coding)
2975 ;; Narrow to headers
2983 ;; Make sure the new coding system uses the same EOL
2984 ;; conversion, to prevent ^M characters from popping up
2985 ;; all over the place.
2993 ;; Rewrite the coding-system header.
3005 "Highlight the headers specified by `rmail-highlighted-headers'.
3006 Uses the face specified by `rmail-highlight-face'."
3014 ;; When rmail-highlight-face is removed, just
3015 ;; use 'rmail-highlight here.
3019 ;; List of overlays to reuse.
3025 overlay)
3028 ;; Back up over newline, then trailing spaces or tabs
3033 ;; Reuse an overlay we already have.
3039 ;; Make a new overlay and add it to
3040 ;; rmail-overlay-list.
3047 "Automatically move a message into another sfolder based on criteria.
3048 This moves messages according to `rmail-automatic-folder-directives'.
3049 It only does something in the folder that `rmail-file-name' specifies.
3050 The function `rmail-show-message' calls this whenever it shows a message.
3051 This leaves a message alone if it already has the `filed' attribute."
3056 ;; Do nothing if the message has already been filed or if there
3057 ;; are no messages.
3058 nil
3059 ;; Find out some basics (common fields)
3072 from)
3074 to)
3078 ;; FIXME - shouldn't this ignore case?
3081 ;; If there are no directives left, then it was a complete match.
3090 \f
3091 ;; Simple message motion commands.
3094 "Show following message whether deleted or not.
3095 With prefix arg N, moves forward N messages, or backward if N is negative."
3102 "Show previous message whether deleted or not.
3103 With prefix arg N, moves backward N messages, or forward if N is negative."
3108 "Show following non-deleted message.
3109 With prefix arg N, moves forward N non-deleted messages,
3110 or backward if N is negative.
3112 Returns t if a new message is being shown, nil otherwise."
3128 t)
3133 nil)))
3136 "Show previous non-deleted message.
3137 With prefix argument N, moves backward N non-deleted messages,
3138 or forward if N is negative."
3143 "Show first message in file."
3149 "Show last message in file."
3155 "Move to an error locus (probably grep hit) in an Rmail buffer.
3156 MSG-POS is a marker pointing at the error message in the grep buffer.
3157 BAD-MARKER is a marker that ought to point at where to move to,
3158 but probably is garbage."
3165 line-text
3166 pos
3167 msgnum msgbeg msgend
3168 header-field
3169 line-number-within)
3171 ;; Look at the whole Rmail file.
3177 ;; Find the line that the error message points at.
3182 ;; Find the text at the start of the line,
3183 ;; before the first = sign.
3184 ;; This text has a good chance of being also in the
3185 ;; decoded message.
3190 ;; Find which message this position is in,
3191 ;; and the limits of that message.
3196 ;; Find which header this locus is in,
3197 ;; or if it's in the message body,
3198 ;; and the line-based position within that.
3213 ;; Display the right message.
3216 ;; Move to the right position within the displayed message.
3217 ;; Or at least try. The decoded message's lines may not
3218 ;; correspond to the lines in the inbox file.
3228 ;; If the decoded message doesn't have enough lines,
3229 ;; go to the beginning rather than the end.
3231 ;; Otherwise, go to the right column.
3236 "Return message number POS (or point) is in."
3242 rmail-view-buffer
3251 \f
3252 ;; Searching in Rmail file.
3255 "Return non-nil, if for message number MSG, regexp REGEXP matches."
3256 ;; This is adequate because its only caller, rmail-search,
3257 ;; unswaps the buffers.
3260 rmail-search-mime-message-function)
3266 "Show message containing next match for REGEXP (but not the current msg).
3267 Prefix argument gives repeat count; negative argument means search
3268 backwards (through earlier messages).
3269 Interactively, empty argument means use same regexp used last time."
3274 regexp)
3291 regexp)
3297 found)
3303 ;; Check messages one by one, advancing message number up or
3304 ;; down but searching forward through each message.
3316 ;; Search forward (if this is a normal search) or backward
3317 ;; (if this is a reverse search) through this message to
3318 ;; position point. This search may fail because REGEXP
3319 ;; was found in the hidden portion of this message. In
3320 ;; that case, move point to the beginning of visible
3321 ;; portion.
3330 regexp))
3337 "Show message containing previous match for REGEXP.
3338 Prefix argument gives repeat count; negative argument means search
3339 forward (through later messages).
3340 Interactively, empty argument means use same regexp used last time."
3345 regexp)
3360 \f
3361 ;; Scan for attributes, and compare subjects.
3364 "Return message number of first message which has `unseen' attribute."
3367 found)
3374 found))
3377 "Return the simplified subject of message MSGNUM (or current message).
3378 Simplifying the subject means stripping leading and trailing whitespace,
3379 and typical reply prefixes such as Re:."
3388 ;; If Subject is long, mailers will break it into several lines at
3389 ;; arbitrary places, so normalize whitespace by replacing every
3390 ;; run of whitespace characters with a single space.
3392 subject))
3395 "Return a regular expression matching the current simplified subject.
3396 The idea is to match it against simplified subjects of other messages."
3399 ;; Hide commas so it will work ok if parsed as a comma-separated list
3400 ;; of regexps.
3406 "Go to the next mail message having the same subject header.
3407 With prefix argument N, do this N times.
3408 If N is negative, go backwards instead."
3413 found)
3433 "Go to the previous mail message having the same subject header.
3434 With prefix argument N, do this N times.
3435 If N is negative, go forwards instead."
3438 \f
3439 ;;;; *** Rmail Message Deletion Commands ***
3442 "Return non-nil if message number N is deleted (in `rmail-deleted-vector')."
3446 "Set the deleted state of message number N (in `rmail-deleted-vector').
3447 STATE non-nil means mark as deleted."
3451 "Delete this message and stay on it."
3461 "Back up to deleted message, select it, and undelete it."
3480 "Delete this message and move to next nondeleted one.
3482 Optional argument COUNT (interactively, prefix argument) is a repeat count;
3483 negative argument means move backwards instead of forwards.
3485 Returns t if a new message is displayed after the delete, or nil otherwise."
3500 value))
3503 "Delete this message and move to previous nondeleted one.
3505 Optional argument COUNT (interactively, prefix argument) is a repeat count;
3506 negative argument means move forwards instead of backwards.
3508 Returns t if a new message is displayed after the delete, or nil otherwise."
3513 \f
3514 ;; Expunging.
3516 ;; Compute the message number a given message would have after expunging.
3517 ;; The present number of the message is OLDNUM.
3518 ;; DELETEDVEC should be rmail-deleted-vector.
3519 ;; The value is nil for a message that would be deleted.
3522 nil
3529 newnum)))
3532 "Return t if expunge is needed and desirable.
3533 If `rmail-confirm-expunge' is non-nil, ask user to confirm."
3540 t)))
3543 "Actually erase all deleted messages in the file."
3548 ;; Discard all undo records for this buffer.
3556 0
3563 ;; Don't make any undo records for the expunging.
3572 new-summary
3581 rmail-current-message nil
3582 rmail-message-vector nil
3583 rmail-deleted-vector nil
3584 rmail-summary-vector nil)
3600 new-summary))
3603 new-msgref))
3611 rmail-total-messages counter
3616 win t)))
3626 ;; The DONT-SHOW argument is new in 23. Does not seem very important.
3628 "Erase deleted messages from Rmail file and summary buffer.
3629 This always shows a message (so as not to leave the Rmail buffer
3630 unswapped), and always updates any summary (so that it remains
3631 consistent with the Rmail buffer). If DONT-SHOW is non-nil, it
3632 does not pop any summary buffer."
3639 ;; We always update the summary buffer, so that the contents
3640 ;; remain consistent with the rmail buffer.
3641 ;; The only difference is, in the dont-show case, we use a
3642 ;; cut-down version of rmail-select-summary that does not pop
3643 ;; the summary buffer. It's only used by rmail-quit, which is
3644 ;; just going to bury any summary immediately after. If we made
3645 ;; rmail-quit bury the summary first, dont-show could be removed.
3646 ;; But the expunge might not be confirmed...
3654 ;; We always show a message, because (rmail-only-expunge t)
3655 ;; leaves the rmail buffer unswapped.
3656 ;; If we expunged the current message, a new one is current now,
3657 ;; so show it. If we weren't showing a message, show it.
3660 ;; We can just show the same message that was being shown before.
3664 \f
3665 ;;;; *** Rmail Mailing Commands ***
3668 "Yank into the current buffer the current message of Rmail buffer BUFFER.
3669 If BUFFER is swapped with its message viewer buffer, yank out of BUFFER.
3670 If BUFFER is not swapped, yank out of its message viewer buffer."
3675 ;; If they yank the text of BUFFER, the encoding of BUFFER is a
3676 ;; better default for the reply message than the default value of
3677 ;; buffer-file-coding-system.
3679 buffer-file-coding-system)
3684 buffer-file-coding-system))))))
3687 replybuffer sendactions same-window
3688 other-headers)
3693 yank-action)
3695 ;; The function used here must behave like insert-buffer wrt
3696 ;; point and mark (see doc of sc-cite-original).
3705 other-headers))
3713 switch-function yank-action sendactions
3716 ;; This is not a standard frame parameter; nothing except
3717 ;; sendmail.el looks at it.
3722 "Try to return to Rmail from the mail window.
3723 If optional argument NEWBUF is specified, it is the Rmail buffer
3724 to switch to."
3726 ;; If there is only one visible frame with no special handling,
3727 ;; consider deleting the mail window to return to Rmail.
3740 mail-bury-selects-summary
3742 rmail-summary-buffer
3745 rmail-summary-buffer))))
3747 ;; If the Rmail buffer is not in the next window, switch
3748 ;; directly to the Rmail buffer specified by NEWBUF.
3751 ;; If the Rmail buffer is in the next window, switch to
3752 ;; the summary buffer if `mail-bury-selects-summary' is
3753 ;; non-nil. Otherwise just delete this window.
3758 ;; If the frame was probably made for this buffer, the user
3759 ;; probably wants to delete it now.
3762 ;; The previous frame is where normally they have the Rmail buffer
3763 ;; displayed.
3767 "Send mail in another window.
3769 original message into it."
3773 ;; FIXME should complain if there is nothing to continue.
3775 "Continue composing outgoing message previously being composed."
3780 "Reply to the current message.
3781 Normally include CC: to all other recipients of original message;
3782 prefix argument means ignore them. While composing the reply,
3788 ;; resent-to resent-cc resent-reply-to
3791 rmail-current-message
3798 from)
3803 ;; Bug#512. It's inappropriate to reply to these addresses.
3804 ;;resent-reply-to (mail-fetch-field "resent-reply-to" nil t)
3805 ;;resent-cc (and (not just-sender)
3806 ;; (mail-fetch-field "resent-cc" nil t))
3807 ;;resent-to (or (mail-fetch-field "resent-to" nil t) "")
3808 ;;resent-subject (mail-fetch-field "resent-subject")
3809 ;;resent-date (mail-fetch-field "resent-date")
3810 ;;resent-message-id (mail-fetch-field "resent-message-id")
3811 )
3814 ;; If this header field is present, use it instead of the
3815 ;; To and CC fields.
3819 ;; Merge the resent-to and resent-cc into the to and cc.
3820 ;; Bug#512. It's inappropriate to reply to these addresses.
3821 ;;(if (and resent-to (not (equal resent-to "")))
3822 ;; (setq to (if (not (equal to ""))
3823 ;; (concat to ", " resent-to)
3824 ;; resent-to)))
3825 ;;(if (and resent-cc (not (equal resent-cc "")))
3826 ;; (setq cc (if (not (equal cc ""))
3827 ;; (concat cc ", " resent-cc)
3828 ;; resent-cc)))
3829 ;; Add `Re: ' to subject if not there already.
3832 subject
3837 subject))))
3839 nil
3840 ;; Using mail-strip-quoted-names is undesirable with newer mailers
3841 ;; since they can handle the names unstripped.
3842 ;; I don't know whether there are other mailers that still
3843 ;; need the names to be stripped.
3844 ;;; (mail-strip-quoted-names reply-to)
3845 ;; Remove unwanted names from reply-to, since Mail-Followup-To
3846 ;; header causes all the names in it to wind up in reply-to, not
3847 ;; in cc. But if what's left is an empty list, use the original.
3850 subject
3853 nil
3854 ;; `mail-dont-reply-to' doesn't need `mail-strip-quoted-names'.
3859 rmail-buffer
3861 rmail-buffer
3864 rmail-answered-attr-index))
3865 nil
3871 message-id)))))))
3872 \f
3874 "Give BUFFER's message number in MSGNUM-LIST the attribute ATTRIBUTE.
3875 This is use in the send-actions for message buffers.
3876 MSGNUM-LIST is a list of the form (MSGNUM)
3877 which is an element of rmail-msgref-vector."
3885 message-id
3886 nil))
3896 tem))
3897 message-id))
3898 ;; missing From, or Message-ID is sufficiently informative
3899 message-id
3901 ;; Message has no Message-ID field.
3902 ;; Copy TEM, discarding text properties.
3906 ;; Use prin1 to fake RFC822 quoting
3908 ;; Wrap it in parens to make it a comment according to RFC822
3914 ;; These strings both match all non-ASCII characters.
3917 ;; "Unix Loser <Foo@bar.edu>" => "Unix Loser"
3918 from)
3921 ;; "<Bugs@bar.edu>" (Losing Unix) => "Losing Unix"
3922 from)))
3925 ;; Trim whitespace which above regexp match allows
3935 ;; "<AA259@bar.edu> (message from Unix Loser on 1-Apr-89)"
3937 ;; Wrap in parens to make it a comment, for RFC822.
3940 ;; If we can't kludge it simply, do it correctly
3943 \f
3945 "Forward the current message to another user.
3947 see the documentation of `rmail-resend'."
3957 ;; FIXME - huh?
3965 nil nil subject nil nil rmail-buffer
3967 forward-buffer
3970 rmail-forwarded-attr-index))
3971 ;; If only one window, use it for the mail buffer.
3972 ;; Otherwise, use another window for the mail buffer
3973 ;; so that the Rmail buffer remains visible
3974 ;; and sending the mail will get back to it.
3976 ;; The mail buffer is now current.
3978 ;; Insert after header separator--before signature if any.
3982 rmail-insert-mime-forwarded-message-function)
3985 forward-buffer)
3986 ;; rmail-insert-mime-forwarded-message-function
3987 ;; works by inserting MML tags into forward-buffer.
3988 ;; The MUA will need to convert it to MIME before
3989 ;; sending. mail-encode-mml tells them to do that.
3990 ;; message.el does that automagically.
3994 ;; Quote lines with `- ' if they start with `-'.
4012 \f
4014 "Resend current message to ADDRESSES.
4015 ADDRESSES should be a single address, a string consisting of several
4016 addresses separated by commas, or a list of addresses.
4018 Optional FROM is the address to resend the message from, and
4019 defaults from the value of `user-mail-address'.
4020 Optional COMMENT is a string to insert as a comment in the resent message.
4021 Optional ALIAS-FILE is alternate aliases file to be used by sendmail,
4022 typically for purposes of moderating a list."
4037 ;;>> Copy message into temp buffer
4039 rmail-insert-mime-resent-message-function)
4043 ;; Delete any Sender field, since that's not specifiable.
4044 ; Only delete Sender fields in the actual header.
4046 ; Using "while" here rather than "if" because some buggy mail
4047 ; software may have inserted multiple Sender fields.
4055 ; Go back to the beginning of the buffer so the Resent- fields
4056 ; are inserted there.
4058 ;;>> Insert resent-from:
4061 ;;>> Insert resent-to: and bcc if need be.
4066 address
4069 ;; Expand abbrevs in the recipients.
4088 ;;>> Set up comment, if any.
4091 after)
4099 ;; Don't expand aliases in the destination fields
4100 ;; of the original message.
4106 \f
4124 ;; This is a cut-down version of rmail-clear-headers from Emacs 22.
4125 ;; It doesn't have the same functionality, hence the name change.
4127 "Delete any mail headers matching REGEXP.
4128 The message should be narrowed to just the headers."
4133 ;; This code from Emacs 22 doesn't seem right, since r-n-h is
4134 ;; just for display.
4135 ;;; (if (looking-at rmail-nonignored-headers)
4136 ;;; (forward-line 1)
4151 "Edit a mail message which is based on the contents of the current message.
4152 For a message rejected by the mail system, extract the interesting headers and
4153 the body of the original message.
4154 If the failed message is a MIME multipart message, it is searched for a
4155 body part with a header which matches the variable `mail-mime-unsent-header'.
4156 Otherwise, the variable `mail-unsent-separator' should match the string that
4157 delimits the returned original message.
4158 The variable `rmail-retry-ignored-headers' is a regular expression
4159 specifying headers which should not be copied into the new message."
4162 ;; FIXME This does not handle rmail-mime-feature != 'rmailmm.
4163 ;; There is no API defined for rmail-mime-feature to provide
4164 ;; rmail-mime-message-p, rmail-mime-toggle-raw equivalents.
4165 ;; But does anyone actually use rmail-mime-feature != 'rmailmm?
4177 bounce-start bounce-end bounce-indent resending
4185 content-type))
4186 ;; Handle a MIME multipart bounce message.
4199 ;; Non-MIME bounce.
4203 ;; Support a style of failure message in which the original
4204 ;; message is indented, and included within lines saying
4205 ;; `Start of returned message' and `End of returned message'.
4214 ;; One message contained a few random lines before
4215 ;; the old message header. The first line of the
4216 ;; message started with two hyphens. A blank line
4217 ;; followed these random lines. The same line
4218 ;; beginning with two hyphens was possibly marking
4219 ;; the end of the message.
4234 ;; We have found the message that bounced, within the current message.
4235 ;; Now start sending new message; default header fields from original.
4236 ;; Turn off the usual actions for initializing the message body
4237 ;; because we want to get only the text from the failure message.
4241 rmail-this-buffer
4243 rmail-retried-attr-index)))
4244 ;; Insert original text as initial text of new draft message.
4245 ;; Bind inhibit-read-only since the header delimiter
4246 ;; of the previous message was probably read-only.
4248 eoh)
4251 bounce-start bounce-end)
4269 \f
4271 "Non-nil if in an RMAIL buffer and an associated summary buffer exists.
4272 In fact, the non-nil value returned is the summary buffer itself."
4274 rmail-summary-buffer))
4277 "t if in RMAIL buffer and an associated summary buffer is displayed."
4281 "Non-nil means Rmail should show the summary when it changes.
4282 This has an effect only if a summary buffer exists."
4287 "Non-nil means specify the height for an Rmail summary window."
4291 ;; Put the summary buffer back on the screen, if user wants that.
4297 ;; If `rmail-redisplay-summary' is non-nil, make sure the summary
4298 ;; buffer is displayed.
4300 rmail-summary-buffer
4306 ;; If `rmail-summary-window-size' is non-nil and the summary buffer
4307 ;; is displayed, make sure it gets resized.
4312 \f
4313 ;;;; *** Rmail Local Fontification ***
4316 ;; This function's symbol is bound to font-lock-fontify-buffer-function.
4318 ;; If we're already showing a message, fontify it now.
4320 ;; Prevent Font Lock mode from kicking in.
4324 ;; This function's symbol is bound to font-lock-fontify-unbuffer-function.
4333 ;; Fontify the current message if it is not already fontified.
4340 \f
4341 ;;; Speedbar support for RMAIL files.
4343 "Regexp matching Rmail folder names to be displayed in Speedbar.
4344 Enabling this permits Speedbar to display your folders for easy
4345 browsing, and moving of messages."
4359 "Install those variables used by speedbar to enhance rmail."
4368 ;; Mouse-3.
4379 ;; Make sure our special speedbar major mode is loaded
4385 "Create buttons for BUFFER containing rmail messages.
4386 Click on the address under Reply to: to reply to this person.
4387 Under Folders: Click a name to read it, or on the <M> to move the
4388 current message into that RMAIL folder."
4396 nil
4401 nil
4411 default-directory)
4412 nil rmail-speedbar-match-folder-regexp)))
4421 ;; Part of the macro expansion of dframe-with-attached-buffer.
4422 ;; At runtime, will be pulled in as a require of speedbar.
4427 "Execute an rmail command specified by TEXT.
4428 The command used is TOKEN. INDENT is not used."
4433 "Load in the rmail file TEXT.
4434 TOKEN and INDENT are not used."
4442 "If the current line is a folder, move current message to it."
4452 "From button TEXT, copy current message to the rmail file specified by TOKEN.
4453 TEXT and INDENT are not used."
4456 ;; expand-file-name is needed due to the unhelpful way in which
4457 ;; rmail-output expands non-absolute filenames against rmail-default-file.
4458 ;; What is the point of that, anyway?
4460 \f
4461 ;; Functions for setting, getting and encoding the POP password.
4462 ;; The password is encoded to prevent it from being easily accessible
4463 ;; to "prying eyes." Obviously, this encoding isn't "real security,"
4464 ;; nor is it meant to be.
4466 ;;;###autoload
4468 "Set PASSWORD to be used for retrieving mail from a POP or IMAP server."
4477 "Get the password for retrieving mail from a POP or IMAP server. If none
4478 has been set, then prompt the user for one."
4483 "IMAP password: "
4493 "Encode STRING with integer MASK, by taking the exclusive OR of the
4494 lowest byte in the mask with the first character of string, the
4495 second-lowest-byte with the second character of the string, etc.,
4496 restarting at the lowest byte of the mask whenever it runs out.
4497 Returns the encoded string. Calling the function again with an
4498 encoded string (and the same mask) will decode the string."
4512 "Decrypt a single GnuPG encrypted text in a message.
4513 The starting string of the encrypted text should have just been regexp-matched.
4514 Argument MIME is non-nil if this is a mime message."
4518 armor-start))
4520 armor-end after-end
4521 unquote)
4527 armor-prefix
4530 nil t))
4536 ;; Because epa--find-coding-system-for-mime-charset not autoloaded.
4539 ;; Advance over this armor.
4550 ;; Use the charset specified in the armor.
4558 (if (re-search-forward "^[ \t]*Content-transfer-encoding[ \t\n]*:[ \t\n]*quoted-printable[ \t]*$" nil t)
4566 ;; Decrypt it, maybe in place, maybe making new buffer.
4569 ;; Call back this function to prepare the output.
4577 armor-end-regexp)))
4579 ;; Should this have a key-binding, or be in a menu?
4580 ;; There doesn't really seem to be an appropriate menu.
4581 ;; Eg the edit command is not in a menu either.
4584 "Decrypt GnuPG or OpenPGP armors in current message."
4587 ;; Save the current buffer here for cleanliness, in case we
4588 ;; change it in one of the calls to `epa-decrypt-region'.
4592 mime-disabled)
4595 ;; Turn off mime processing.
4601 ;; Now find all armored messages in the buffer
4602 ;; and decrypt them one by one.
4623 ;; Find, in the real Rmail buffer, the same armors
4624 ;; that we found and decrypted in the view buffer.
4630 armor-end-regexp
4631 nil t))
4633 ;; Found as expected -- now replace it with the decrypt.
4638 ;; Change the mime type (if this is in a mime part)
4639 ;; so this part will display by default
4640 ;; when the message is shown later.
4651 )))))))
4654 mime mime-disabled)
4655 ;; Re-enable mime processing.
4657 ;; Find each Show button and show that part.
4671 )
4676 \f
4677 ;;;; Desktop support
4680 _buffer-name
4681 _buffer-misc)
4682 "Restore an rmail buffer specified in a desktop file."
4688 rmail-buffer))
4691 nil)))
4696 ;; We use this to record the encoding of the current message before
4697 ;; saving the message collection.
4700 ;; Used in `write-region-annotate-functions' to write rmail files.
4710 nil))
4712 ;; Used to restore the encoding of the buffer where we show the
4713 ;; current message, after we save the message collection. This is
4714 ;; needed because rmail-write-region-annotate switches buffers behind
4715 ;; save-file's back, with the side effect that last-coding-system-used
4716 ;; is assigned to buffer-file-coding-system of the wrong buffer.
4725 \f
4726 ;;; Start of automatically extracted autoloads.
4727 \f
4728 ;;;### (autoloads nil "rmailedit" "rmailedit.el" "1ed1c211e6e9c254ba3e0dd8d546e745")
4729 ;;; Generated autoloads from rmailedit.el
4732 Edit the contents of this message.
4736 ;;;***
4737 \f
4738 ;;;### (autoloads nil "rmailkwd" "rmailkwd.el" "298dcda7febb6e4ebf0a166101f40650")
4739 ;;; Generated autoloads from rmailkwd.el
4742 Add LABEL to labels associated with current RMAIL message.
4743 Completes (see `rmail-read-label') over known labels when reading.
4744 LABEL may be a symbol or string. Only one label is allowed.
4749 Remove LABEL from labels associated with current RMAIL message.
4750 Completes (see `rmail-read-label') over known labels when reading.
4751 LABEL may be a symbol or string. Only one label is allowed.
4756 Read a label with completion, prompting with PROMPT.
4757 Completions are chosen from `rmail-label-obarray'. The default
4758 is `rmail-last-label', if that is non-nil. Updates `rmail-last-label'
4759 according to the choice made, and returns a symbol.
4764 Show previous message with one of the labels LABELS.
4765 LABELS should be a comma-separated list of label names.
4766 If LABELS is empty, the last set of labels specified is used.
4767 With prefix argument N moves backward N messages with these labels.
4772 Show next message with one of the labels LABELS.
4773 LABELS should be a comma-separated list of label names.
4774 If LABELS is empty, the last set of labels specified is used.
4775 With prefix argument N moves forward N messages with these labels.
4779 ;;;***
4780 \f
4781 ;;;### (autoloads nil "rmailmm" "rmailmm.el" "36f518e036612a33eb436cb267fd39c7")
4782 ;;; Generated autoloads from rmailmm.el
4785 Toggle the display of a MIME message.
4787 The actual behavior depends on the value of `rmail-enable-mime'.
4789 If `rmail-enable-mime' is non-nil (the default), this command toggles
4790 the display of a MIME message between decoded presentation form and
4791 raw data. With optional prefix argument ARG, it toggles the display only
4792 of the MIME entity at point, if there is one. The optional argument
4793 STATE forces a particular display state, rather than toggling.
4794 `raw' forces raw mode, any other non-nil value forces decoded mode.
4797 buffer holding a decoded copy of the message. Inline content-types are
4798 handled according to `rmail-mime-media-type-handlers-alist'.
4799 By default, this displays text and multipart messages, and offers to
4800 download attachments as specified by `rmail-mime-attachment-dirs-alist'.
4801 The arguments ARG and STATE have no effect in this case.
4805 ;;;***
4806 \f
4807 ;;;### (autoloads nil "rmailmsc" "rmailmsc.el" "c3f0d33739768fc12acc4258ae0da72e")
4808 ;;; Generated autoloads from rmailmsc.el
4811 Set the inbox list of the current RMAIL file to FILE-NAME.
4812 You can specify one file name, or several names separated by commas.
4813 If FILE-NAME is empty, remove any existing inbox list.
4815 This applies only to the current session.
4819 ;;;***
4820 \f
4821 ;;;### (autoloads nil "rmailsort" "rmailsort.el" "8f551773021df4fa1a14ec2517e6a4f1")
4822 ;;; Generated autoloads from rmailsort.el
4826 If prefix argument REVERSE is non-nil, sorts in reverse order.
4833 non-nil, sorts in reverse order.
4838 Sort messages of current Rmail buffer by author.
4840 If prefix argument REVERSE is non-nil, sorts in reverse order.
4845 Sort messages of current Rmail buffer by recipient.
4847 If prefix argument REVERSE is non-nil, sorts in reverse order.
4852 Sort messages of current Rmail buffer by other correspondent.
4855 excluded by `mail-dont-reply-to-names'. If prefix argument
4856 REVERSE is non-nil, sorts in reverse order.
4861 Sort messages of current Rmail buffer by the number of lines.
4862 If prefix argument REVERSE is non-nil, sorts in reverse order.
4867 Sort messages of current Rmail buffer by labels.
4868 LABELS is a comma-separated list of labels. The order of these
4869 labels specifies the order of messages: messages with the first
4870 label come first, messages with the second label come second, and
4871 so on. Messages that have none of these labels come last.
4872 If prefix argument REVERSE is non-nil, sorts in reverse order.
4876 ;;;***
4877 \f
4878 ;;;### (autoloads nil "rmailsum" "rmailsum.el" "4bc0d1a65aede332348200e1937c84d4")
4879 ;;; Generated autoloads from rmailsum.el
4882 Display a summary of all messages, one line per message.
4887 Display a summary of all messages with one or more LABELS.
4888 LABELS should be a string containing the desired labels, separated by commas.
4893 Display a summary of all messages with the given RECIPIENTS.
4894 Normally checks the To, From and Cc fields of headers;
4895 but if PRIMARY-ONLY is non-nil (prefix arg given),
4896 only look in the To and From fields.
4897 RECIPIENTS is a regular expression.
4902 Display a summary of all messages according to regexp REGEXP.
4903 If the regular expression is found in the header of the message
4904 \(including in the date and other lines, as well as the subject line),
4905 Emacs will list the message in the summary.
4910 Display a summary of all messages with the given SUBJECT.
4911 Normally checks just the Subject field of headers; but with prefix
4912 argument WHOLE-MESSAGE is non-nil, looks in the whole message.
4913 SUBJECT is a regular expression.
4919 SENDERS is a regular expression.
4923 ;;;***
4924 \f
4925 ;;;### (autoloads nil "undigest" "undigest.el" "c0ddfad4fe34ef9c1e790c2cc72b571d")
4926 ;;; Generated autoloads from undigest.el
4929 Break up a digest message into its constituent messages.
4930 Leaves original message, deleted, before the undigestified messages.
4935 Extract a forwarded message from the containing message.
4936 This puts the forwarded message into a separate rmail message following
4937 the containing message. This command is only useful when messages are
4938 forwarded with `rmail-enable-mime-composing' set to nil.
4942 ;;;***
4943 \f
4944 ;;; End of automatically extracted autoloads.
4949 ;;; rmail.el ends here