| blob | 29926108c150672e9ca1f4f0d30c06b54bf22396 |
1 ;;; rmail.el --- main code of "RMAIL" mail reader for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1988, 1993-1998, 2000-2016 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 ;;
54 ;;; Attribute indexes
89 "An array that provides a mapping between an attribute index,
102 "The current header display style choice, one of
110 "Non-nil if and only if the current message is a MIME."
115 "Mail reader for Emacs."
119 "Rmail retrieval options."
124 "Rmail files."
129 "Rmail header options."
134 "Rmail reply options."
139 "Rmail summary options."
145 "Output message to a file."
151 "Rmail editing."
155 ;;;###autoload
157 "Name of user's primary mail file."
162 ;;;###autoload
169 ;;;###autoload
173 ;; SVR4 and recent BSD are said to use this.
174 ;; Rather than trying to know precisely which systems use it,
175 ;; let's assume this dir is never used for anything else.
177 ;; Many GNU/Linux systems use this name.
181 "Name of directory used by system mailer for delivering new mail.
182 Its name should end with a slash."
187 ;;;###autoload(custom-initialize-delay 'rmail-spool-directory nil)
190 "If non-nil, the file name of the `movemail' program."
198 "Password to use when reading mail from a remote server.
199 This setting is ignored for mailboxes whose URL already contains a password."
209 "Non-nil if a password is required when reading mail from a remote server."
215 "List of flags to pass to movemail.
216 Most commonly used to specify `-g' to enable GSS-API authentication
217 or `-k' to enable Kerberos authentication."
224 "Regular expression matching incorrect-password POP or IMAP server error
225 messages.
226 If you get an incorrect-password error that this expression does not match,
232 "Non-nil means leave incoming mail in the user's inbox--don't delete it."
237 "List of directories to search for movemail (in addition to `exec-path')."
247 "Determine what flavor of movemail PROG is.
248 We do this by executing it with `--version' and analyzing its output."
254 ;; Should not happen...
255 nil
263 ;; FIXME:
267 "Determine the file name of the `movemail' program and return its flavor.
268 If `rmail-movemail-program' is non-nil, use it.
269 Otherwise, look for `movemail' in the directories in
270 `rmail-movemail-search-path', those in `exec-path', and `exec-directory'."
277 ;; Previously, this didn't have to work on Windows, because
278 ;; rmail-insert-inbox-text before r1.439 fell back to using
279 ;; (expand-file-name "movemail" exec-directory) and just
280 ;; assuming it would work.
281 ;; http://lists.gnu.org/archive/html/bug-gnu-emacs/2008-02/msg00087.html
294 "The movemail variant currently in use. Known variants are:
296 `emacs' Means any implementation, compatible with the native Emacs one.
297 This is the default;
298 `mailutils' Means GNU mailutils implementation, capable of handling full
301 ;;;###autoload
303 "Return t if the current movemail variant is any of VARIANTS.
304 Currently known variants are `emacs' and `mailutils'."
306 ;; Autodetect
310 ;; Call for effect, to set rmail-movemail-program (if not set by the
311 ;; user), and rmail-movemail-variant-in-use. Used by various functions.
312 ;; I'm not sure if M-x rmail is the only entry point to this package.
313 ;; If so, this can be moved there.
316 ;;;###autoload
318 "Regexp matching user mail addresses.
319 If non-nil, this variable is used to identify the correspondent
320 when receiving new mail. If it matches the address of the sender,
321 the recipient is taken as correspondent of a mail.
322 If nil \(default value), your `user-login-name' and `user-mail-address'
323 are used to exclude yourself as correspondent.
325 Usually you don't have to set this variable, except if you collect mails
326 sent by you under different user names.
327 Then it should be a regexp matching your mail addresses.
329 Setting this variable has an effect only before reading a mail."
334 ;;;###autoload
338 ;; Prior to 24.1, this used to contain "\\`info-".
339 ;;;###autoload
341 "Regexp specifying part of the default value of `mail-dont-reply-to-names'.
342 This is used when the user does not set `mail-dont-reply-to-names'
344 ;;;###autoload
348 ;;;###autoload
368 "Regexp to match header fields that Rmail should normally hide.
369 \(See also `rmail-nonignored-headers', which overrides this regexp.)
370 This variable is used for reformatting the message header,
371 which normally happens once for each message,
372 when you view the message for the first time in Rmail.
373 To make a change in this variable take effect
374 for a message that you have already viewed,
380 "Regexp to match X header fields that Rmail should show.
381 This regexp overrides `rmail-ignored-headers'; if both this regexp
382 and that one match a certain header field, Rmail shows the field.
383 If this is nil, ignore all header fields in `rmail-ignored-headers'.
385 This variable is used for reformatting the message header,
386 which normally happens once for each message,
387 when you view the message for the first time in Rmail.
388 To make a change in this variable take effect
389 for a message that you have already viewed,
394 ;;;###autoload
396 "Regexp to match Header fields that Rmail should display.
397 If nil, display all header fields except those matched by
398 `rmail-ignored-headers'."
402 ;;;###autoload
403 (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:")
404 "Headers that should be stripped when retrying a failed message."
409 ;;;###autoload
411 "Regexp to match Header fields that Rmail should normally highlight.
412 A value of nil means don't highlight. Uses the face `rmail-highlight'."
418 "Face to use for highlighting the most important header fields.
419 The variable `rmail-highlighted-headers' specifies which headers."
423 ;; This was removed in Emacs 23.1 with no notification, an unnecessary
424 ;; incompatible change.
426 "Face used by Rmail for highlighting headers."
427 ;; Note that nil doesn't actually mean use the default face, it
428 ;; means use either bold or highlight. It's not worth fixing this
429 ;; now that this is obsolete.
431 face)
434 "customize the face `rmail-highlight' instead."
439 "Face to use for highlighting the header names.
440 The variable `rmail-font-lock-keywords' specifies which headers
441 get highlighted."
446 "Non-nil means automatically delete a message that is copied to a file."
450 ;;;###autoload
452 "List of files that are inboxes for your primary mail file `rmail-file-name'.
453 If this is nil, uses the environment variable MAIL. If that is
454 unset, uses a file named by the function `user-login-name' in the
455 directory `rmail-spool-directory' (whose value depends on the
457 ;; Don't use backquote here, because we don't want to need it at load time.
458 ;; (That must be an old comment - it's dumped these days.)
468 "Non-nil means Rmail makes a new frame for composing outgoing mail.
469 This is handy if you want to preserve the window configuration of
470 the frame where you have the RMAIL buffer displayed."
474 ;;;###autoload
476 "Directory for additional secondary Rmail files."
479 ;;;###autoload
481 "Regexp for which files are secondary Rmail files."
486 "Whether and how to ask for confirmation before expunging deleted messages.
487 The value, if non-nil is a function to call with a question (string)
488 as argument, to ask the user that question."
496 ;;;###autoload
503 ;;;###autoload
505 "List of functions to call when Rmail displays a message."
514 "List of functions to call when Rmail deletes a message.
515 When the hooks are called, the message has been marked deleted but is
518 ;; These may be altered by site-init.el to match the format of mmdf files
519 ;; delimiting used on a given host (delim1 and delim2 from the config
520 ;; files).
527 ;; FIXME Post-mbox, this is now unused.
528 ;; In Emacs-22, this was called:
529 ;; i) the very first time a message was shown.
530 ;; ii) when toggling the headers to the normal state, every time.
531 ;; It's not clear what it should do now, since there is nothing that
532 ;; records when a message is shown for the first time (unseen is not
533 ;; necessarily the same thing).
534 ;; See http://lists.gnu.org/archive/html/emacs-devel/2009-03/msg00013.html
536 "If non-nil, a filter function for new messages in RMAIL.
537 Called with region narrowed to the message, including headers,
538 before obeying `rmail-ignored-headers'."
543 "it is not used (try `rmail-show-message-hook')."
547 "List of directives specifying how to automatically file messages.
548 Whenever Rmail shows a message in the folder that `rmail-file-name'
549 specifies, it calls `rmail-auto-file' to maybe file the message in
550 another folder according to this list. Messages that are already
551 marked as `filed', or are in different folders, are left alone.
553 Each element of the list is of the form:
555 (FOLDERNAME FIELD REGEXP [ FIELD REGEXP ] ... )
557 FOLDERNAME is the name of a folder in which to put the message.
558 If FOLDERNAME is nil then Rmail deletes the message, and moves on to
560 but does not move to the next.
562 FIELD is the name of a header field in the message, such as
566 REGEXP is a regular expression to match (case-sensitively) against
567 the preceding specified FIELD.
569 There may be any number of FIELD/REGEXP pairs.
570 All pairs must match for a directive to apply to a message.
571 For a given message, Rmail applies only the first matching directive.
573 Examples:
576 "
584 ;; Some mailers use "Re(2):" or "Re^2:" or "Re: Re:" or "Re[2]:".
585 ;; This pattern should catch all the common variants.
586 ;; rms: I deleted the change to delete tags in square brackets
587 ;; because they mess up RT tags.
592 "If non-nil, Rmail always displays the summary buffer."
595 \f
600 "The RMAIL buffer related to the current buffer.
601 In an RMAIL buffer, this holds the RMAIL buffer itself.
613 ;; Message counters and markers. Deleted flags.
616 "Integer specifying the message currently being displayed in this folder.
617 Counts messages from 1 to `rmail-total-messages'. A value of 0
622 "Integer specifying the total number of messages in this folder.
627 "Vector of markers specifying the start and end of each message.
632 "A string of length `rmail-total-messages' plus one.
638 "In an Rmail buffer, a vector whose Nth element is a list (N).
639 When expunging renumbers messages, these lists are modified
646 ;; These are used by autoloaded rmail-summary.
651 "In an Rmail buffer, vector of (newline-terminated) strings.
655 ;; Rmail buffer swapping variables.
666 \f
667 ;; `Sticky' default variables.
669 ;; Last individual label specified to a or k.
672 ;; Last set of values specified to C-M-n, C-M-p, C-M-s or C-M-l.
678 ;; Note that rmail-output-read-file-name modifies this.
689 ;; Mule and MIME related variables.
691 ;;;###autoload
693 "Coding system used in RMAIL file.
698 "Function of no args to try to determine coding system for a message.
699 If nil, just search for `rmail-mime-charset-pattern'."
705 "If non-nil, RMAIL automatically displays decoded MIME messages.
706 For this to work, the feature specified by `rmail-mime-feature' must
707 be available."
713 "If non-nil, use `rmail-insert-mime-forwarded-message-function' to forward."
719 "Function of no argument called to show a decoded MIME message.
720 This function is called when `rmail-enable-mime' is non-nil.
723 ;;;###autoload
725 "Function to insert a message in MIME format so it can be forwarded.
726 This function is called if `rmail-enable-mime' and
727 `rmail-enable-mime-composing' are non-nil.
728 It is called with one argument FORWARD-BUFFER, which is a
729 buffer containing the message to forward. The current buffer
733 "Function to insert a message in MIME format so it can be resent.
734 This function is called by `rmail-resend' if `rmail-enable-mime' is non-nil.
735 It is called with one argument FORWARD-BUFFER, which is a
736 buffer containing the message to forward. The current buffer
739 ;; FIXME one might want to pass a LIMIT, as per
740 ;; rmail-search-mime-header-function.
742 "Function to check if a regexp matches a MIME message.
743 This function is called by `rmail-search-message' if
744 `rmail-enable-mime' is non-nil. It is called (with point at the
745 start of the message) with two arguments MSG and REGEXP, where
749 "Function to check if a regexp matches a header of MIME message.
750 This function is called by `rmail-message-regexp-p-1' if
751 `rmail-enable-mime' is non-nil. It is called (with point at the
752 start of the header) with three arguments MSG, REGEXP, and LIMIT,
753 where MSG is the message number, REGEXP is the regular
757 "Feature to require for MIME support in Rmail.
758 When starting Rmail, if `rmail-enable-mime' is non-nil, this
759 feature is loaded with `require'. The default value is `rmailmm'.
761 The library should set the variable `rmail-show-mime-function'
762 to an appropriate value, and optionally also set
763 `rmail-search-mime-message-function',
764 `rmail-search-mime-header-function',
765 `rmail-insert-mime-forwarded-message-function', and
772 "Regexp to match MIME-charset specification in a header of message.
775 \f
783 "From "
785 ;; Many things can happen to an RFC 822 mailbox before it is put into
786 ;; a `From' line. The leading phrase can be stripped, e.g.
787 ;; `Joe <@w.x:joe@y.z>' -> `<@w.x:joe@y.z>'. The <> can be stripped, e.g.
788 ;; `<@x.y:joe@y.z>' -> `@x.y:joe@y.z'. Everything starting with a CRLF
789 ;; can be removed, e.g.
790 ;; From: joe@y.z (Joe K
791 ;; User)
792 ;; can yield `From joe@y.z (Joe K Fri Mar 22 08:11:15 1996', and
793 ;; From: Joe User
794 ;; <joe@y.z>
795 ;; can yield `From Joe User Fri Mar 22 08:11:15 1996'.
796 ;; The mailbox can be removed or be replaced by white space, e.g.
797 ;; From: "Joe User"{space}{tab}
798 ;; <joe@y.z>
799 ;; can yield `From {space}{tab} Fri Mar 22 08:11:15 1996',
800 ;; where {space} and {tab} represent the Ascii space and tab characters.
801 ;; We want to match the results of any of these manglings.
802 ;; The following regexp rejects names whose first characters are
803 ;; obviously bogus, but after that anything goes.
806 ;; The time the message was sent.
812 ;; Perhaps a time zone, specified by an abbreviation, or by a
813 ;; numeric offset.
814 time-zone-regexp
816 ;; The year.
819 ;; On some systems the time zone can appear after the year, too.
820 time-zone-regexp
822 ;; Old uucp cruft.
826 "Regexp matching the delimiter of messages in UNIX mail format
827 \(UNIX From lines), minus the initial ^. Note that if you change
828 this expression, you must change the code in `rmail-nuke-pinhead-header'
831 ;; FIXME the rmail-header-name headers ought to be customizable.
832 ;; It seems a bit arbitrary, for example, that all of the Date: line
833 ;; gets highlighted.
835 ;; These are all matched case-insensitively.
843 ;; FIXME Mail-Followup-To should probably be here too.
848 ;; Use MATCH-ANCHORED to effectively anchor the regexp left side.
849 `(,cite-chars
861 ;; Rmail does not expect horizontal splitting. (Bug#2282)
863 "Like `pop-to-buffer', but with `split-width-threshold' set to nil."
867 ;; Perform BODY in the summary buffer
868 ;; in such a way that its cursor is properly updated in its own window.
877 ;; rmail-total-messages is a buffer-local var
878 ;; in the rmail buffer.
879 ;; This way we make it available for the body
880 ;; even tho the rmail buffer is not current.
888 \f
889 ;;;; *** Rmail Mode ***
892 "Require `rmail-mime-feature' if that is non-nil.
893 Signal an error and set `rmail-mime-feature' to nil if the feature
894 isn't provided."
900 'rmail
902 through `rmail-enable-mime' being non-nil, the required feature
903 `%s' (the value of `rmail-mime-feature')
904 is not available in the current session.
905 So, MIME support is turned off for the moment."
906 rmail-mime-feature)
911 ;;;###autoload
913 "Read and edit incoming mail.
914 Moves messages into file named by `rmail-file-name' and edits that
915 file in RMAIL Mode.
918 May be called with file name as argument; then performs rmail editing on
919 that file, but does not copy any new mail into the file.
920 Interactively, if you supply a prefix argument, then you
921 have a chance to specify a file name with the minibuffer.
923 If `rmail-display-summary' is non-nil, make a summary for this RMAIL file."
928 ;; Use find-buffer-visiting, not get-file-buffer, for those users
929 ;; who have find-file-visit-truename set to t.
931 run-mail-hook mail-buf msg-shown)
932 ;; Determine if an existing mail file has been changed behind the
933 ;; scene...
935 ;; The mail file has been changed. Revisit it and reset the
936 ;; message state variables when in rmail mode.
943 ;; The mail file is either unchanged or not visited. Visit it.
946 ;; Force no-conversion by default, since that's what
947 ;; pre-mbox Rmail did with BABYL files (via
948 ;; auto-coding-regexp-alist).
952 ;; Ensure that the collection and view buffers are in sync and
953 ;; ensure that a message is not being edited.
960 ;; Ensure that the Rmail file is in mbox format, the buffer is in
961 ;; Rmail mode and has been scanned to find all the messages
962 ;; (setting the global message variables in the process).
969 ;; Show the first unread message and process summary mode.
971 ;; Only get new mail when there is not a file name argument.
984 "Determine if the file needs to be converted to mbox format."
987 ;; Detect previous Babyl format files.
990 ;; The file is Babyl version 5. Use unrmail to convert
991 ;; it.
994 ;; Losing babyl file made by old version of Rmail. Fix the
995 ;; babyl file header and use unrmail to convert to mbox
996 ;; format.
1006 "Report that the buffer is not in the mbox file format.
1007 MSGNUM, if present, indicates the malformed message."
1013 "Convert the mail file from Babyl version 5 to mbox.
1014 This function also reinitializes local variables used by Rmail."
1028 ;; Rmail buffers need to be saved with Unix EOLs, or else
1029 ;; the format will not be recognized.
1043 "Return a suitable coding system to use for the current mail message.
1044 The buffer is expected to be narrowed to just the header of the message."
1052 \f
1053 ;;; Set up Rmail mode keymaps
1064 ;; If you change this, change the rmail-resend menu-item's :keys.
1090 ;; I find I can't live without the default M-r command -- rms.
1091 ;; (define-key rmail-mode-map "\er" 'rmail-search-backwards)
1118 \f
1125 nil)
1128 nil)
1235 map)
1238 ;; Rmail toolbar
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)
1262 map rmail-mode-map)
1264 map rmail-mode-map)
1265 map))
1268 \f
1269 ;; Rmail mode is suitable only for specially formatted data.
1277 ;;;###autoload
1280 All normal editing commands are turned off.
1281 Instead, these commands are available:
1297 \\[rmail-undelete-previous-message] Undelete message. Tries current message, then earlier messages
1298 till a deleted message is found.
1299 \\[rmail-edit-current-message] Edit the current message. \\[rmail-cease-edit] to return to Rmail.
1312 \\[rmail-output-body-to-file] Save message body to a file. Default filename comes from Subject line.
1317 (label defaults to last one specified).
1318 Standard labels: filed, unseen, answered, forwarded, deleted.
1356 ;; No need to auto save RMAIL files in normal circumstances
1357 ;; because they contain no info except attribute changes
1358 ;; and deletion of messages.
1359 ;; The one exception is when messages are copied into another mbox buffer.
1360 ;; rmail-output enables auto save when you do that.
1365 ;; Functions to support buffer swapping:
1372 "Return a reusable buffer suitable for viewing messages.
1373 Create the buffer if necessary."
1374 ;; We want to reuse any existing view buffer, so as not to create an
1375 ;; endless number of them. But we must avoid clashes if we visit
1376 ;; two different rmail files with the same basename (Bug#4593).
1379 rmail-view-buffer
1387 newbuf)))
1390 "Swap text between current buffer and `rmail-view-buffer'.
1391 This function preserves the current buffer's modified flag, and also
1392 sets the current buffer's `buffer-file-coding-system' to that of
1393 `rmail-view-buffer'."
1400 buffer-file-coding-system)))
1409 "Return non-nil if the message collection is in `rmail-view-buffer'."
1410 ;; This is analogous to tar-data-swapped-p in tar-mode.el.
1411 rmail-buffer-swapped)
1414 ;; Bring the actual Rmail messages back into the main buffer.
1420 "Determine if the Rmail buffer is showing a message.
1421 If so restore the actual mbox message collection."
1428 "Warn if important modifications would change Rmail file's format."
1431 ;; If it's already modified, don't warn again.
1446 ;; Turn off the hook on the view buffer, so we can kill it, then kill it.
1456 ;; Set up the permanent locals associated with an Rmail file.
1469 ;; Note that this does not erase the buffer. Should it?
1470 ;; It depends on how this is called. If somehow called with the
1471 ;; rmail buffers swapped, it would erase the message collection.
1474 ;; Force C-x C-s write Unix EOLs.
1484 ;; Provide default set of inboxes for primary mail file ~/RMAIL.
1492 ;; FIXME expand-file-name?
1497 ;; Set up the non-permanent locals associated with Rmail mode.
1499 ;; Turn off undo. We turn it back on in rmail-edit.
1501 ;; Don't let a local variables list in a message cause confusion.
1504 ;; Don't turn off auto-saving based on the size of the buffer
1505 ;; because that code does not understand buffer-swapping.
1513 t t nil nil
1530 \f
1531 ;; Handle M-x revert-buffer done in an rmail-mode buffer.
1536 ;; See similar code in `rmail'.
1537 ;; FIXME needs updating?
1540 ;; Call our caller again, but this time it does the default thing.
1542 ;; If the user said "yes", and we changed something,
1543 ;; reparse the messages.
1546 ;; Convert all or part to Babyl file if possible.
1548 ;; We have read the file as raw-text, so the buffer is set to
1549 ;; unibyte. Make it multibyte if necessary.
1559 "Expunge and save RMAIL file."
1563 ;; No need to swap buffers: rmail-write-region-annotate takes care of it.
1564 ;; (rmail-swap-buffers-maybe)
1570 "Quit out of RMAIL.
1571 Hook `rmail-quit-hook' is run after expunging."
1578 ;; Don't switch to the summary buffer even if it was recently visible.
1589 "Bury current Rmail buffer and its summary buffer."
1591 ;; This let var was called rmail-buffer, but that interfered
1592 ;; with the buffer-local var used in summary buffers.
1599 \f
1601 "Create a duplicated copy of the current message.
1602 The duplicate copy goes into the Rmail file just after the original."
1603 ;; If we are in a summary buffer, switch to the Rmail buffer.
1604 ;; FIXME simpler to swap the contents, not the buffers?
1626 \f
1627 ;;;###autoload
1629 "Run Rmail on file FILENAME."
1633 ;; This used to scan subdirectories recursively, but someone pointed out
1634 ;; that if the user wants that, person can put all the files in one dir.
1635 ;; And the recursive scan was slow. So I took it out.
1636 ;; rms, Sep 1996.
1638 "Return list of file in dir START that match `rmail-secondary-file-regexp'."
1640 ;; Don't sort here.
1643 ;; Sort here instead of in directory-files
1644 ;; because this list is usually much shorter.
1649 name)
1669 item)
1670 rmail-secondary-file-directory)))))
1674 menu))
1676 ;; This command is always "disabled" when it appears in a menu.
1686 files
1691 files
1699 \f
1700 ;;;; *** Rmail input ***
1708 ;; RLK feature not added in this version:
1709 ;; argument specifies inbox file or files in various ways.
1711 ;; In Babyl, the Mail: header in the preamble overrode rmail-inbox-list.
1712 ;; Mbox does not have this feature.
1714 "Move any new mail from this Rmail file's inbox files.
1715 The buffer-local variable `rmail-inbox-list' specifies the list
1716 of inbox files. By default, this is nil, except for your primary
1717 Rmail file `rmail-file-name'. In this case, when you first visit
1718 the Rmail file it is initialized using either
1720 or the function `user-login-name' and the directory
1721 `rmail-spool-directory' (whose value depends on the operating system).
1723 The command `set-rmail-inbox-list' sets `rmail-inbox-list' to the
1724 value you specify.
1726 You can also specify the file to get new mail from just for one
1727 instance of this command. In this case, the file of new mail is
1728 not changed or deleted. Noninteractively, you can pass the inbox
1729 file name as an argument. Interactively, a prefix argument
1730 causes us to read a file name and use that file as the inbox.
1732 If the variable `rmail-preserve-inbox' is non-nil, new mail will
1733 always be left in inbox files rather than deleted.
1735 Before doing anything, this runs `rmail-before-get-new-mail-hook'.
1736 Just before returning, it runs `rmail-after-get-new-mail-hook',
1737 whether or not there is new mail.
1739 If there is new mail, it runs `rmail-get-new-mail-hook', saves
1740 the updated file, and shows the first unseen message (which might
1741 not be a new one). It returns non-nil if it got any new messages."
1746 ;; If the disk file has been changed from under us,
1747 ;; revert to it before we get new mail.
1755 ;; Get rid of all undo records for this buffer.
1760 found)
1763 ;; This loops if any members of the inbox list have the same
1764 ;; basename (see "name conflict" below).
1767 ;; saved yet, don't replace the old backup file now.
1771 ;; Don't make undo records while getting mail.
1773 delete-files files file-last-names)
1774 ;; Pull files off all-files onto files as long as there is
1775 ;; no name conflict. A conflict happens when two inbox
1776 ;; file names have the same last component.
1777 ;; The reason this careful handling is necessary seems
1778 ;; to be that rmail-insert-inbox-text uses .newmail-BASENAME.
1781 file-last-names)))
1783 file-last-names
1786 ;; Put them back in their original order.
1789 ;; Make sure we end with a blank line unless there are
1790 ;; no messages, as required by mbox format (Bug#9974).
1796 found))))
1797 ;; Move to the first new message unless we have other unseen
1798 ;; messages before it.
1801 found)
1802 ;; Don't leave the buffer screwed up if we get a disk-full error.
1809 "Return t if new messages are detected without error, nil otherwise."
1814 rmail-use-spam-filter))
1816 result success suffix)
1818 ;; Read in the contents of the inbox files, renaming them as
1819 ;; necessary, and adding to the list of files to delete
1820 ;; eventually.
1824 ;; Scan the new text and convert each message to
1825 ;; Rmail/mbox format.
1831 success t)
1832 ;; Try to delete the garbage just inserted.
1834 ;; If we could not convert the file's inboxes, rename the
1835 ;; files we tried to read so we won't over and over again.
1844 ;; Determine if there are messages.
1846 ;; There are. Process them.
1851 ;; Delete the old files, now that the Rmail file is saved.
1854 ;; First, try deleting.
1858 ;; If we can't delete it, truncate it.
1871 ;; Establish the return value.
1873 result))))
1876 "Parse the supplied URL. Return (list MAILBOX-NAME REMOTE PASSWORD GOT-PASSWORD)
1877 WHERE MAILBOX-NAME is the name of the mailbox suitable as argument to the
1878 actual version of `movemail', REMOTE is non-nil if MAILBOX-NAME refers to
1879 a remote mailbox, PASSWORD is the password if it should be
1880 supplied as a separate argument to `movemail' or nil otherwise, GOT-PASSWORD
1881 is non-nil if the user has supplied the password interactively.
1882 "
1897 ;; The password is embedded. Strip it out since movemail
1898 ;; does not really like it, in spite of the movemail spec.
1904 t
1906 got-password)
1911 got-password))))
1915 ;; (proto "pop")
1916 ;; (user (match-string 1 file))
1917 ;; (host (match-string 3 file))
1918 )
1930 "Replace newly read mail in Babyl format with equivalent mbox format.
1932 FROM-FILE is the Babyl file from which the new mail should be read."
1934 size)
1942 size)))
1945 "If newly read mail from FILE is in Babyl format, convert it to mbox format.
1947 SIZE is the original size of the newly read mail.
1948 Value is the size of the newly read mail after conversion."
1949 ;; Detect previous Babyl format files.
1953 ;; The new mail is in Babyl version 5 format. Use unrmail
1954 ;; to convert it.
1957 ;; New mail is in Babyl format made by old version of
1958 ;; Rmail. Fix the babyl file header and use unrmail to
1959 ;; convert it.
1969 size))
1972 ;; Detect a locked file now, so that we avoid moving mail
1973 ;; out of the real inbox file. (That could scare people.)
1979 ;; Handle remote mailbox names specially; don't expand as filenames
1980 ;; in case the userid contains a directory separator.
1993 ;; Generate name to move to from inbox name,
1994 ;; in case of multiple inboxes that need moving.
1998 ;; cannot have colons in file name
2000 file)))
2001 ;; Use the directory of this rmail file
2002 ;; because it's a nuisance to use the homedir
2003 ;; if that is on a full disk and this rmail
2004 ;; file isn't.
2007 ;; Always use movemail to rename the file,
2008 ;; since there can be mailboxes in various directories.
2010 ;; On some systems, /usr/spool/mail/foo is a directory
2011 ;; and the actual inbox is /usr/spool/mail/foo/foo.
2014 file))))
2023 ;; Set TOFILE if have not already done so, and
2024 ;; rename or copy the file FILE to TOFILE if and as appropriate.
2029 nil)
2039 nil)
2042 rmail-movemail-flags)
2047 ;; No output => movemail won
2048 nil
2059 ;; If we just read the password, most likely it is
2060 ;; wrong. Otherwise, see if there is a specific
2061 ;; reason to think that the problem is a wrong passwd.
2064 nil t))
2067 ;; If using Mailutils, remove initial error code
2068 ;; abbreviation
2079 nil)))))
2081 ;; At this point, TOFILE contains the name to read:
2082 ;; Either the alternate name (if we renamed)
2083 ;; or the actual inbox (if not renaming).
2086 size)
2089 ;; If new mail is in Babyl format, convert it to mbox.
2091 tofile
2094 ;; Make sure the read-in mbox data properly ends with a
2095 ;; blank line unless it is of size 0.
2103 delete-files))
2105 ;; Decode the region specified by FROM and TO by CODING.
2106 ;; If CODING is nil or an invalid coding system, decode by `undecided'.
2110 ;; Use -dos decoding, to remove ^M characters left from base64 or
2111 ;; rogue qp-encoded text.
2114 ;; Don't reveal the fact we used -dos decoding, as users generally
2115 ;; will not expect the RMAIL buffer to use DOS EOL format.
2128 "Ensure a message ends in a blank line.
2129 Call with point at the end of the message."
2136 "Validate the RFC2822 format for the new messages.
2137 Point should be at the first new message.
2138 An error is signaled if the new messages are not RFC2822
2139 compliant.
2140 Unless an Rmail attribute header already exists, add it to the
2141 new messages. Return the number of new messages."
2149 stop)
2150 ;; Detect an empty inbox file.
2152 ;; Scan the new messages to establish a count and to ensure that
2153 ;; an attribute header is present.
2156 ;; Determine if a new attribute header needs to be
2157 ;; added to the message.
2167 ;; Move to the next message.
2174 count))))
2175 \f
2177 "Subroutine of `rmail-get-header'.
2178 Narrow to header, call `mail-fetch-field' to find header NAME."
2186 "Return the value of message header NAME, nil if it has none.
2187 MSGNUM specifies the message number to get it from.
2188 If MSGNUM is nil, use the current message."
2192 "Subroutine of `rmail-set-header'.
2193 Narrow to headers, set header NAME to VALUE, replacing existing if present.
2194 VALUE nil means to remove NAME altogether.
2196 Only changes the first instance of NAME. If VALUE is multi-line,
2197 continuation lines should already be indented. VALUE should not
2198 end in a newline."
2203 ;; cf mail-fetch-field.
2209 end)
2212 ;; Back up over newline.
2221 ;; Not already present: insert at end of headers.
2226 "Set message header NAME to VALUE in message number MSGNUM.
2227 If MSGNUM is nil, use the current message. NAME and VALUE are strings.
2228 VALUE may also be nil, meaning to remove the header."
2231 ;; Ensure header changes get saved.
2232 ;; (Note replacing a header with an identical copy modifies.)
2234 ;; However: don't save in mbox format over a Babyl file
2235 ;; merely because of this.
2237 \f
2238 ;;;; *** Rmail Attributes and Keywords ***
2241 "Return the message attributes in a comma separated string.
2242 MSG specifies the message number to get it from.
2243 If MSG is nil, use the current message."
2246 result temp)
2253 result
2258 result)))
2261 "Return the message keywords in a comma separated string.
2262 MSG, if non-nil, identifies the message number to use.
2263 If nil, that means the current message."
2267 "Return a string with the labels (attributes and keywords) of msg MSG.
2268 It is put in comma-separated form.
2269 MSG, if non-nil, identifies the message number to use.
2270 If nil, that means the current message."
2273 ;; Combine the message attributes and keywords
2274 ;; into a comma-separated list.
2280 ;; FIXME ? old rmail did not have spaces in the comma-separated lists.
2287 "Update the current messages's attributes and keywords in mode line."
2291 rmail-current-message rmail-total-messages blurb))))
2294 "Return the character value for ATTR.
2295 ATTR is a (numeric) index, an offset into the mbox attribute
2296 header value. STATE is one of nil, t, or a character value."
2303 "Subroutine of `rmail-set-attribute'.
2304 Set Rmail attribute ATTR to STATE in `rmail-attribute-header',
2305 creating the header if necessary. Returns non-nil if a
2306 significant attribute change was made."
2310 altered)
2313 ;; If this message already records attributes, just change the
2314 ;; value for this one.
2316 ;; Position point at this attribute, adding attributes if necessary.
2323 ;; Change this attribute.
2328 ;; Otherwise add a header line to record the attributes and set
2329 ;; all but this one to no.
2335 altered))
2338 "Turn an attribute of a message on or off according to STATE.
2339 STATE is either nil or the character (numeric) value associated
2340 with the state (nil represents off and non-nil represents on).
2341 ATTR is either the index number of the attribute, or a string,
2342 both from `rmail-attr-array'. MSGNUM is message number to
2343 change; nil means current message."
2353 ;; Ask for confirmation before setting any attribute except `unseen'
2354 ;; if it would force a format change.
2360 ;; The "deleted" attribute is also stored in a special vector so
2361 ;; update that too.
2368 ;; Don't save in mbox format over a Babyl file
2369 ;; merely because of a change in `unseen' attribute.
2372 ;; Otherwise, if we modified the file text via the view buffer,
2373 ;; mark the main buffer modified too.
2377 "Return non-nil if message number MSG has attributes matching regexp ATTRS."
2382 "Return non-nil if message number MSGNUM has the unseen attribute."
2385 ;; FIXME rmail-get-labels does some formatting (eg leading space, `;'
2386 ;; between attributes and labels), so this might not do what you want.
2387 ;; Eg see rmail-sort-by-labels. rmail-get-labels could have an
2388 ;; optional `noformat' argument.
2390 "Return non-nil if message number MSG has labels matching regexp LABELS."
2392 \f
2393 ;;;; *** Rmail Message Selection And Support ***
2396 "Return the end position for message number N."
2400 "Return the start position for message number N."
2404 "Call FUNCTION on ARGS while narrowed to message MSGNUM.
2405 Point is at the start of the message.
2406 This returns what the call to FUNCTION returns.
2407 If MSGNUM is nil, use the current message."
2414 ;; All access to the rmail-buffer's local variables is now finished...
2416 ;; ... so it is ok to go to a different buffer.
2425 ;; Unused (save for commented out code in rmailedit.el).
2427 "Call FUNCTION with point at start of internal data of current message.
2428 Assumes that bounds were previously narrowed to display the message in Rmail.
2429 The bounds are widened enough to move point where desired, then narrowed
2430 again afterward.
2432 FUNCTION may not change the visible text of the message, but it may
2433 change the invisible header text."
2441 ;; Note: we don't use save-restriction because that does not work right
2442 ;; if changes are made outside the saved restriction
2443 ;; before that restriction is restored.
2446 \f
2447 ;; Manage the message vectors and counters.
2463 rmail-message-vector
2464 rmail-current-message
2465 rmail-total-messages))
2469 "Count the number of new messages.
2470 The buffer should be narrowed to include only the new messages.
2471 Output a helpful message unless NOMSG is non-nil."
2478 ;; Put at the end of messages-head
2479 ;; the entry for message N+1, which marks
2480 ;; the end of message N. (N = number of messages).
2496 ;; Fill in the new elements of rmail-msgref-vector.
2515 ;; Determine how many messages follow point.
2518 ;; Put at the end of messages-head
2519 ;; the entry for message N+1, which marks
2520 ;; the end of message N. (N = number of messages).
2531 ;; Make an element 0 in rmail-message-vector and rmail-deleted-vector
2532 ;; which will never be used.
2553 "Collect the message deletion flags for each message.
2554 MESSAGE-END is the buffer position corresponding to the end of
2555 the message. Point is at the beginning of the message."
2556 ;; NOTE: This piece of code will be executed on a per-message basis.
2557 ;; In the face of thousands of messages, it has to be as fast as
2558 ;; possible, hence some brute force constant use is employed in
2559 ;; addition to inlining.
2564 ?D
2568 "Collect the start positions of messages in list `messages-head'.
2569 Return the number of messages after the one containing SPOT-TO-FIND."
2571 messages-after-spot)
2582 ;; Show progress after every 20 messages or so.
2585 ;; Handle the first message, maybe.
2594 messages-after-spot))
2595 \f
2596 ;; Display a message.
2598 ;;;; *** Rmail Message Formatting and Header Manipulation ***
2600 ;; This is used outside of rmail.
2602 "Return nil if the current message is showing full headers."
2604 rmail-buffer)
2608 "Toggle between showing full and normal message headers.
2609 With optional integer ARG, show the normal message header if ARG
2610 is greater than zero; otherwise, show it in full."
2619 "Show current message starting from the beginning."
2623 rmail-view-buffer
2624 rmail-buffer)
2625 rmail-header-style)))
2629 "Show bottom of current message."
2635 rmail-view-buffer
2636 rmail-buffer)
2637 rmail-header-style)))
2642 Ask the user whether to add that list name to `mail-mailing-lists'."
2643 ;; FIXME s-r not needed? Use rmail-get-header?
2644 ;; We have not narrowed to the headers at ths point?
2655 ;; taken from rmailsum.el
2667 addr))
2670 addr)))
2675 "Display the entire mailbox file."
2679 \f
2684 ;; Eg we deleted all the messages, so remove the old N/M mark.
2691 "Show message number N (prefix argument), counting from start of file.
2692 If summary buffer is currently displayed, update current message there also.
2693 N defaults to the current message."
2697 ;; FIXME: Why do we swap the raw data back in?
2707 ;; If there is a summary buffer, try to move to this message
2708 ;; in that buffer. But don't complain if this message is
2709 ;; not mentioned in the summary. Don't do this at all if we
2710 ;; were called on behalf of cursor motion in the summary
2711 ;; buffer.
2722 "Return t if the region contains a text message, nil otherwise."
2726 ;; The message is text if either there is no content type header
2727 ;; (a default of "text/plain; charset=US-ASCII" is assumed) or
2728 ;; the base content type is either text or message.
2733 "Message size at which to show progress messages for displaying it."
2738 ;; FIXME?
2739 ;; rmail-show-mime-function does not unquote >From lines. Should it?
2741 "The mbox format that your system uses.
2742 There is no way to determine this, so you should set the appropriate value.
2744 The choices are:
2747 The `mboxo' format is ambiguous, in that one cannot know whether
2750 It is not critical to set this to the correct value; it only affects
2753 See also `unrmail-mbox-format'."
2760 "Show message MSG (default: current message) using `rmail-view-buffer'.
2761 Return text to display in the minibuffer if MSG is out of
2762 range (displaying a reasonable choice as well), nil otherwise.
2763 The current mail message becomes the message displayed."
2766 blurb beg end body-start coding-system character-coding
2767 is-text-message header-style
2768 showing-message)
2774 rmail-current-message 1
2778 rmail-current-message rmail-total-messages
2783 ;; Mark the message as seen, but preserve buffer modified flag.
2788 ;; bracket the message in the mail
2789 ;; buffer and determine the coding system the transfer encoding.
2799 ;; We give the view buffer a buffer-local value of
2800 ;; rmail-header-style based on the binding in effect when
2801 ;; this function is called; `rmail-toggle-headers' can
2802 ;; inspect this value to determine how to toggle.
2804 ;; In case viewing the previous message sets the paragraph
2805 ;; direction non-nil, we reset it here to allow independent
2806 ;; dynamic determination of paragraph direction in every
2807 ;; message.
2810 rmail-show-mime-function
2830 ;; Decode the message body into an empty view buffer using a
2831 ;; unibyte temporary buffer where the character decoding takes
2832 ;; place.
2836 ;; Do it directly since that is fast.
2838 ;; Can this be done directly, skipping the temp buffer?
2844 ;; See bug#5441.
2856 coding-system view-buf)))
2858 ;; Prepare the separator (blank line) before the body.
2861 ;; Unquote quoted From lines.
2863 "^>+From "
2865 case-fold-search)
2871 ;; Copy the headers to the front of the message view buffer.
2873 ;; Decode any RFC2047 encoded message headers.
2881 ;; highlight the message, activate any URL like text and add
2882 ;; special highlighting for and quoted material.
2886 ;(rmail-activate-urls)
2887 ;(rmail-process-quoted-material)
2888 )
2889 ;; Update the mode-line with message status information and swap
2890 ;; the view buffer/mail buffer contents.
2897 blurb))
2900 "Copy displayed header fields to the message viewer buffer.
2901 BEG and END marks the start and end positions of the message in
2902 the mbox buffer. If the optional argument IGNORED-HEADERS is
2903 non-nil, ignore all header fields whose names match that regexp.
2904 Otherwise, if `rmail-displayed-headers' is non-nil, copy only
2905 those header fields whose names match that regexp. Otherwise,
2906 copy all header fields whose names do not match
2907 `rmail-ignored-headers' (unless they also match
2908 `rmail-nonignored-headers'). Moves point in the message viewer
2909 buffer to the end of the headers."
2911 lim)
2916 ;; Put point right after the From header line.
2923 ;; Handle the case where all headers should be copied.
2926 ;; rmail-show-message-1 expects this function to leave point
2927 ;; at the end of the headers.
2933 ;; Handle the case where the headers matching the displayed
2934 ;; headers regexp should be copied.
2944 ;; Handle the ignored headers.
2960 "Decode the body of the current message using coding system CODING.
2961 This is useful with mail messages that have malformed or missing
2962 charset= headers.
2964 This function assumes that the current message is already decoded
2965 and displayed in the RMAIL buffer, but the coding system used to
2966 decode it was incorrect. It then decodes the message again,
2967 using the coding system CODING."
2977 body-start x-coding-header old-coding)
2984 ;; Narrow to headers
2992 ;; Make sure the new coding system uses the same EOL
2993 ;; conversion, to prevent ^M characters from popping up
2994 ;; all over the place.
3002 ;; Rewrite the coding-system header.
3014 "Highlight the headers specified by `rmail-highlighted-headers'.
3015 Uses the face specified by `rmail-highlight-face'."
3023 ;; When rmail-highlight-face is removed, just
3024 ;; use 'rmail-highlight here.
3028 ;; List of overlays to reuse.
3034 overlay)
3037 ;; Back up over newline, then trailing spaces or tabs
3042 ;; Reuse an overlay we already have.
3048 ;; Make a new overlay and add it to
3049 ;; rmail-overlay-list.
3056 "Automatically move a message into another sfolder based on criteria.
3057 This moves messages according to `rmail-automatic-folder-directives'.
3058 It only does something in the folder that `rmail-file-name' specifies.
3059 The function `rmail-show-message' calls this whenever it shows a message.
3060 This leaves a message alone if it already has the `filed' attribute."
3065 ;; Do nothing if the message has already been filed or if there
3066 ;; are no messages.
3067 nil
3068 ;; Find out some basics (common fields)
3081 from)
3083 to)
3087 ;; FIXME - shouldn't this ignore case?
3090 ;; If there are no directives left, then it was a complete match.
3099 \f
3100 ;; Simple message motion commands.
3103 "Show following message whether deleted or not.
3104 With prefix arg N, moves forward N messages, or backward if N is negative."
3111 "Show previous message whether deleted or not.
3112 With prefix arg N, moves backward N messages, or forward if N is negative."
3117 "Show following non-deleted message.
3118 With prefix arg N, moves forward N non-deleted messages,
3119 or backward if N is negative.
3121 Returns t if a new message is being shown, nil otherwise."
3137 t)
3142 nil)))
3145 "Show previous non-deleted message.
3146 With prefix argument N, moves backward N non-deleted messages,
3147 or forward if N is negative."
3152 "Show first message in file."
3158 "Show last message in file."
3164 "Move to an error locus (probably grep hit) in an Rmail buffer.
3165 MSG-POS is a marker pointing at the error message in the grep buffer.
3166 BAD-MARKER is a marker that ought to point at where to move to,
3167 but probably is garbage."
3174 line-text
3175 pos
3176 msgnum msgbeg msgend
3177 header-field
3178 line-number-within)
3180 ;; Look at the whole Rmail file.
3186 ;; Find the line that the error message points at.
3191 ;; Find the text at the start of the line,
3192 ;; before the first = sign.
3193 ;; This text has a good chance of being also in the
3194 ;; decoded message.
3199 ;; Find which message this position is in,
3200 ;; and the limits of that message.
3205 ;; Find which header this locus is in,
3206 ;; or if it's in the message body,
3207 ;; and the line-based position within that.
3222 ;; Display the right message.
3225 ;; Move to the right position within the displayed message.
3226 ;; Or at least try. The decoded message's lines may not
3227 ;; correspond to the lines in the inbox file.
3237 ;; If the decoded message doesn't have enough lines,
3238 ;; go to the beginning rather than the end.
3240 ;; Otherwise, go to the right column.
3245 "Return message number POS (or point) is in."
3251 rmail-view-buffer
3260 \f
3261 ;; Searching in Rmail file.
3264 "Return non-nil, if for message number MSG, regexp REGEXP matches."
3265 ;; This is adequate because its only caller, rmail-search,
3266 ;; unswaps the buffers.
3269 rmail-search-mime-message-function)
3275 "Show message containing next match for REGEXP (but not the current msg).
3276 Prefix argument gives repeat count; negative argument means search
3277 backwards (through earlier messages).
3278 Interactively, empty argument means use same regexp used last time."
3283 regexp)
3300 regexp)
3306 found)
3312 ;; Check messages one by one, advancing message number up or
3313 ;; down but searching forward through each message.
3325 ;; Search forward (if this is a normal search) or backward
3326 ;; (if this is a reverse search) through this message to
3327 ;; position point. This search may fail because REGEXP
3328 ;; was found in the hidden portion of this message. In
3329 ;; that case, move point to the beginning of visible
3330 ;; portion.
3339 regexp))
3346 "Show message containing previous match for REGEXP.
3347 Prefix argument gives repeat count; negative argument means search
3348 forward (through later messages).
3349 Interactively, empty argument means use same regexp used last time."
3354 regexp)
3369 \f
3370 ;; Scan for attributes, and compare subjects.
3373 "Return message number of first message which has `unseen' attribute."
3376 found)
3383 found))
3386 "Return the simplified subject of message MSGNUM (or current message).
3387 Simplifying the subject means stripping leading and trailing whitespace,
3388 and typical reply prefixes such as Re:."
3397 ;; If Subject is long, mailers will break it into several lines at
3398 ;; arbitrary places, so normalize whitespace by replacing every
3399 ;; run of whitespace characters with a single space.
3401 subject))
3404 "Return a regular expression matching the current simplified subject.
3405 The idea is to match it against simplified subjects of other messages."
3408 ;; Hide commas so it will work ok if parsed as a comma-separated list
3409 ;; of regexps.
3415 "Go to the next mail message having the same subject header.
3416 With prefix argument N, do this N times.
3417 If N is negative, go backwards instead."
3422 found)
3442 "Go to the previous mail message having the same subject header.
3443 With prefix argument N, do this N times.
3444 If N is negative, go forwards instead."
3447 \f
3448 ;;;; *** Rmail Message Deletion Commands ***
3451 "Return non-nil if message number N is deleted (in `rmail-deleted-vector')."
3455 "Set the deleted state of message number N (in `rmail-deleted-vector').
3456 STATE non-nil means mark as deleted."
3460 "Delete this message and stay on it."
3470 "Back up to deleted message, select it, and undelete it."
3489 "Delete this message and move to next nondeleted one.
3491 Optional argument COUNT (interactively, prefix argument) is a repeat count;
3492 negative argument means move backwards instead of forwards.
3494 Returns t if a new message is displayed after the delete, or nil otherwise."
3509 value))
3512 "Delete this message and move to previous nondeleted one.
3514 Optional argument COUNT (interactively, prefix argument) is a repeat count;
3515 negative argument means move forwards instead of backwards.
3517 Returns t if a new message is displayed after the delete, or nil otherwise."
3522 \f
3523 ;; Expunging.
3525 ;; Compute the message number a given message would have after expunging.
3526 ;; The present number of the message is OLDNUM.
3527 ;; DELETEDVEC should be rmail-deleted-vector.
3528 ;; The value is nil for a message that would be deleted.
3531 nil
3538 newnum)))
3541 "Return t if expunge is needed and desirable.
3542 If `rmail-confirm-expunge' is non-nil, ask user to confirm."
3549 t)))
3552 "Actually erase all deleted messages in the file."
3557 ;; Discard all undo records for this buffer.
3565 0
3572 ;; Don't make any undo records for the expunging.
3581 new-summary
3590 rmail-current-message nil
3591 rmail-message-vector nil
3592 rmail-deleted-vector nil
3593 rmail-summary-vector nil)
3609 new-summary))
3612 new-msgref))
3620 rmail-total-messages counter
3625 win t)))
3635 ;; The DONT-SHOW argument is new in 23. Does not seem very important.
3637 "Erase deleted messages from Rmail file and summary buffer.
3638 This always shows a message (so as not to leave the Rmail buffer
3639 unswapped), and always updates any summary (so that it remains
3640 consistent with the Rmail buffer). If DONT-SHOW is non-nil, it
3641 does not pop any summary buffer."
3648 ;; We always update the summary buffer, so that the contents
3649 ;; remain consistent with the rmail buffer.
3650 ;; The only difference is, in the dont-show case, we use a
3651 ;; cut-down version of rmail-select-summary that does not pop
3652 ;; the summary buffer. It's only used by rmail-quit, which is
3653 ;; just going to bury any summary immediately after. If we made
3654 ;; rmail-quit bury the summary first, dont-show could be removed.
3655 ;; But the expunge might not be confirmed...
3663 ;; We always show a message, because (rmail-only-expunge t)
3664 ;; leaves the rmail buffer unswapped.
3665 ;; If we expunged the current message, a new one is current now,
3666 ;; so show it. If we weren't showing a message, show it.
3669 ;; We can just show the same message that was being shown before.
3673 \f
3674 ;;;; *** Rmail Mailing Commands ***
3677 "Yank into the current buffer the current message of Rmail buffer BUFFER.
3678 If BUFFER is swapped with its message viewer buffer, yank out of BUFFER.
3679 If BUFFER is not swapped, yank out of its message viewer buffer."
3684 ;; If they yank the text of BUFFER, the encoding of BUFFER is a
3685 ;; better default for the reply message than the default value of
3686 ;; buffer-file-coding-system.
3688 buffer-file-coding-system)
3693 buffer-file-coding-system))))))
3696 replybuffer sendactions same-window
3697 other-headers)
3702 yank-action)
3704 ;; The function used here must behave like insert-buffer wrt
3705 ;; point and mark (see doc of sc-cite-original).
3714 other-headers))
3722 switch-function yank-action sendactions
3725 ;; This is not a standard frame parameter; nothing except
3726 ;; sendmail.el looks at it.
3731 "Try to return to Rmail from the mail window.
3732 If optional argument NEWBUF is specified, it is the Rmail buffer
3733 to switch to."
3735 ;; If there is only one visible frame with no special handling,
3736 ;; consider deleting the mail window to return to Rmail.
3749 mail-bury-selects-summary
3751 rmail-summary-buffer
3754 rmail-summary-buffer))))
3756 ;; If the Rmail buffer is not in the next window, switch
3757 ;; directly to the Rmail buffer specified by NEWBUF.
3760 ;; If the Rmail buffer is in the next window, switch to
3761 ;; the summary buffer if `mail-bury-selects-summary' is
3762 ;; non-nil. Otherwise just delete this window.
3767 ;; If the frame was probably made for this buffer, the user
3768 ;; probably wants to delete it now.
3771 ;; The previous frame is where normally they have the Rmail buffer
3772 ;; displayed.
3776 "Send mail in another window.
3778 original message into it."
3782 ;; FIXME should complain if there is nothing to continue.
3784 "Continue composing outgoing message previously being composed."
3789 "Reply to the current message.
3790 Normally include CC: to all other recipients of original message;
3791 prefix argument means ignore them. While composing the reply,
3797 ;; resent-to resent-cc resent-reply-to
3800 rmail-current-message
3807 from)
3812 ;; Bug#512. It's inappropriate to reply to these addresses.
3813 ;;resent-reply-to (mail-fetch-field "resent-reply-to" nil t)
3814 ;;resent-cc (and (not just-sender)
3815 ;; (mail-fetch-field "resent-cc" nil t))
3816 ;;resent-to (or (mail-fetch-field "resent-to" nil t) "")
3817 ;;resent-subject (mail-fetch-field "resent-subject")
3818 ;;resent-date (mail-fetch-field "resent-date")
3819 ;;resent-message-id (mail-fetch-field "resent-message-id")
3820 )
3823 ;; If this header field is present, use it instead of the
3824 ;; To and CC fields.
3828 ;; Merge the resent-to and resent-cc into the to and cc.
3829 ;; Bug#512. It's inappropriate to reply to these addresses.
3830 ;;(if (and resent-to (not (equal resent-to "")))
3831 ;; (setq to (if (not (equal to ""))
3832 ;; (concat to ", " resent-to)
3833 ;; resent-to)))
3834 ;;(if (and resent-cc (not (equal resent-cc "")))
3835 ;; (setq cc (if (not (equal cc ""))
3836 ;; (concat cc ", " resent-cc)
3837 ;; resent-cc)))
3838 ;; Add `Re: ' to subject if not there already.
3841 subject
3846 subject))))
3848 nil
3849 ;; Using mail-strip-quoted-names is undesirable with newer mailers
3850 ;; since they can handle the names unstripped.
3851 ;; I don't know whether there are other mailers that still
3852 ;; need the names to be stripped.
3853 ;;; (mail-strip-quoted-names reply-to)
3854 ;; Remove unwanted names from reply-to, since Mail-Followup-To
3855 ;; header causes all the names in it to wind up in reply-to, not
3856 ;; in cc. But if what's left is an empty list, use the original.
3859 subject
3862 nil
3863 ;; `mail-dont-reply-to' doesn't need `mail-strip-quoted-names'.
3868 rmail-buffer
3870 rmail-buffer
3873 rmail-answered-attr-index))
3874 nil
3880 message-id)))))))
3881 \f
3883 "Give BUFFER's message number in MSGNUM-LIST the attribute ATTRIBUTE.
3884 This is use in the send-actions for message buffers.
3885 MSGNUM-LIST is a list of the form (MSGNUM)
3886 which is an element of rmail-msgref-vector."
3894 message-id
3895 nil))
3905 tem))
3906 message-id))
3907 ;; missing From, or Message-ID is sufficiently informative
3908 message-id
3910 ;; Message has no Message-ID field.
3911 ;; Copy TEM, discarding text properties.
3915 ;; Use prin1 to fake RFC822 quoting
3917 ;; Wrap it in parens to make it a comment according to RFC822
3923 ;; These strings both match all non-ASCII characters.
3926 ;; "Unix Loser <Foo@bar.edu>" => "Unix Loser"
3927 from)
3930 ;; "<Bugs@bar.edu>" (Losing Unix) => "Losing Unix"
3931 from)))
3934 ;; Trim whitespace which above regexp match allows
3944 ;; "<AA259@bar.edu> (message from Unix Loser on 1-Apr-89)"
3946 ;; Wrap in parens to make it a comment, for RFC822.
3949 ;; If we can't kludge it simply, do it correctly
3952 \f
3954 "Forward the current message to another user.
3956 see the documentation of `rmail-resend'."
3966 ;; FIXME - huh?
3974 nil nil subject nil nil rmail-buffer
3976 forward-buffer
3979 rmail-forwarded-attr-index))
3980 ;; If only one window, use it for the mail buffer.
3981 ;; Otherwise, use another window for the mail buffer
3982 ;; so that the Rmail buffer remains visible
3983 ;; and sending the mail will get back to it.
3985 ;; The mail buffer is now current.
3987 ;; Insert after header separator--before signature if any.
3991 rmail-insert-mime-forwarded-message-function)
3994 forward-buffer)
3995 ;; rmail-insert-mime-forwarded-message-function
3996 ;; works by inserting MML tags into forward-buffer.
3997 ;; The MUA will need to convert it to MIME before
3998 ;; sending. mail-encode-mml tells them to do that.
3999 ;; message.el does that automagically.
4003 ;; Quote lines with `- ' if they start with `-'.
4021 \f
4023 "Resend current message to ADDRESSES.
4024 ADDRESSES should be a single address, a string consisting of several
4025 addresses separated by commas, or a list of addresses.
4027 Optional FROM is the address to resend the message from, and
4028 defaults from the value of `user-mail-address'.
4029 Optional COMMENT is a string to insert as a comment in the resent message.
4030 Optional ALIAS-FILE is alternate aliases file to be used by sendmail,
4031 typically for purposes of moderating a list."
4046 ;;>> Copy message into temp buffer
4048 rmail-insert-mime-resent-message-function)
4052 ;; Delete any Sender field, since that's not specifiable.
4053 ; Only delete Sender fields in the actual header.
4055 ; Using "while" here rather than "if" because some buggy mail
4056 ; software may have inserted multiple Sender fields.
4064 ; Go back to the beginning of the buffer so the Resent- fields
4065 ; are inserted there.
4067 ;;>> Insert resent-from:
4070 ;;>> Insert resent-to: and bcc if need be.
4075 address
4078 ;; Expand abbrevs in the recipients.
4097 ;;>> Set up comment, if any.
4100 after)
4108 ;; Don't expand aliases in the destination fields
4109 ;; of the original message.
4115 \f
4133 ;; This is a cut-down version of rmail-clear-headers from Emacs 22.
4134 ;; It doesn't have the same functionality, hence the name change.
4136 "Delete any mail headers matching REGEXP.
4137 The message should be narrowed to just the headers."
4142 ;; This code from Emacs 22 doesn't seem right, since r-n-h is
4143 ;; just for display.
4144 ;;; (if (looking-at rmail-nonignored-headers)
4145 ;;; (forward-line 1)
4160 "Edit a mail message which is based on the contents of the current message.
4161 For a message rejected by the mail system, extract the interesting headers and
4162 the body of the original message.
4163 If the failed message is a MIME multipart message, it is searched for a
4164 body part with a header which matches the variable `mail-mime-unsent-header'.
4165 Otherwise, the variable `mail-unsent-separator' should match the string that
4166 delimits the returned original message.
4167 The variable `rmail-retry-ignored-headers' is a regular expression
4168 specifying headers which should not be copied into the new message."
4171 ;; FIXME This does not handle rmail-mime-feature != 'rmailmm.
4172 ;; There is no API defined for rmail-mime-feature to provide
4173 ;; rmail-mime-message-p, rmail-mime-toggle-raw equivalents.
4174 ;; But does anyone actually use rmail-mime-feature != 'rmailmm?
4186 bounce-start bounce-end bounce-indent resending
4194 content-type))
4195 ;; Handle a MIME multipart bounce message.
4208 ;; Non-MIME bounce.
4212 ;; Support a style of failure message in which the original
4213 ;; message is indented, and included within lines saying
4214 ;; `Start of returned message' and `End of returned message'.
4223 ;; One message contained a few random lines before
4224 ;; the old message header. The first line of the
4225 ;; message started with two hyphens. A blank line
4226 ;; followed these random lines. The same line
4227 ;; beginning with two hyphens was possibly marking
4228 ;; the end of the message.
4243 ;; We have found the message that bounced, within the current message.
4244 ;; Now start sending new message; default header fields from original.
4245 ;; Turn off the usual actions for initializing the message body
4246 ;; because we want to get only the text from the failure message.
4250 rmail-this-buffer
4252 rmail-retried-attr-index)))
4253 ;; Insert original text as initial text of new draft message.
4254 ;; Bind inhibit-read-only since the header delimiter
4255 ;; of the previous message was probably read-only.
4257 eoh)
4260 bounce-start bounce-end)
4278 \f
4280 "Non-nil if in an RMAIL buffer and an associated summary buffer exists.
4281 In fact, the non-nil value returned is the summary buffer itself."
4283 rmail-summary-buffer))
4286 "t if in RMAIL buffer and an associated summary buffer is displayed."
4290 "Non-nil means Rmail should show the summary when it changes.
4291 This has an effect only if a summary buffer exists."
4296 "Non-nil means specify the height for an Rmail summary window."
4300 ;; Put the summary buffer back on the screen, if user wants that.
4306 ;; If `rmail-redisplay-summary' is non-nil, make sure the summary
4307 ;; buffer is displayed.
4309 rmail-summary-buffer
4315 ;; If `rmail-summary-window-size' is non-nil and the summary buffer
4316 ;; is displayed, make sure it gets resized.
4321 \f
4322 ;;;; *** Rmail Local Fontification ***
4325 ;; This function's symbol is bound to font-lock-fontify-buffer-function.
4327 ;; If we're already showing a message, fontify it now.
4329 ;; Prevent Font Lock mode from kicking in.
4333 ;; This function's symbol is bound to font-lock-fontify-unbuffer-function.
4342 ;; Fontify the current message if it is not already fontified.
4349 \f
4350 ;;; Speedbar support for RMAIL files.
4352 "Regexp matching Rmail folder names to be displayed in Speedbar.
4353 Enabling this permits Speedbar to display your folders for easy
4354 browsing, and moving of messages."
4368 "Install those variables used by speedbar to enhance rmail."
4377 ;; Mouse-3.
4388 ;; Make sure our special speedbar major mode is loaded
4394 "Create buttons for BUFFER containing rmail messages.
4395 Click on the address under Reply to: to reply to this person.
4396 Under Folders: Click a name to read it, or on the <M> to move the
4397 current message into that RMAIL folder."
4405 nil
4410 nil
4420 default-directory)
4421 nil rmail-speedbar-match-folder-regexp)))
4430 ;; Part of the macro expansion of dframe-with-attached-buffer.
4431 ;; At runtime, will be pulled in as a require of speedbar.
4436 "Execute an rmail command specified by TEXT.
4437 The command used is TOKEN. INDENT is not used."
4442 "Load in the rmail file TEXT.
4443 TOKEN and INDENT are not used."
4451 "If the current line is a folder, move current message to it."
4461 "From button TEXT, copy current message to the rmail file specified by TOKEN.
4462 TEXT and INDENT are not used."
4465 ;; expand-file-name is needed due to the unhelpful way in which
4466 ;; rmail-output expands non-absolute filenames against rmail-default-file.
4467 ;; What is the point of that, anyway?
4469 \f
4470 ;; Functions for setting, getting and encoding the POP password.
4471 ;; The password is encoded to prevent it from being easily accessible
4472 ;; to "prying eyes." Obviously, this encoding isn't "real security,"
4473 ;; nor is it meant to be.
4475 ;;;###autoload
4477 "Set PASSWORD to be used for retrieving mail from a POP or IMAP server."
4486 "Get the password for retrieving mail from a POP or IMAP server. If none
4487 has been set, then prompt the user for one."
4492 "IMAP password: "
4502 "Encode STRING with integer MASK, by taking the exclusive OR of the
4503 lowest byte in the mask with the first character of string, the
4504 second-lowest-byte with the second character of the string, etc.,
4505 restarting at the lowest byte of the mask whenever it runs out.
4506 Returns the encoded string. Calling the function again with an
4507 encoded string (and the same mask) will decode the string."
4521 "Decrypt a single GnuPG encrypted text in a message.
4522 The starting string of the encrypted text should have just been regexp-matched.
4523 Argument MIME is non-nil if this is a mime message."
4527 armor-start))
4529 armor-end after-end
4530 unquote)
4536 armor-prefix
4539 nil t))
4545 ;; Because epa--find-coding-system-for-mime-charset not autoloaded.
4548 ;; Advance over this armor.
4559 ;; Use the charset specified in the armor.
4567 (if (re-search-forward "^[ \t]*Content-transfer-encoding[ \t\n]*:[ \t\n]*quoted-printable[ \t]*$" nil t)
4575 ;; Decrypt it, maybe in place, maybe making new buffer.
4578 ;; Call back this function to prepare the output.
4586 armor-end-regexp)))
4588 ;; Should this have a key-binding, or be in a menu?
4589 ;; There doesn't really seem to be an appropriate menu.
4590 ;; Eg the edit command is not in a menu either.
4594 "Decrypt GnuPG or OpenPGP armors in current message."
4597 ;; Save the current buffer here for cleanliness, in case we
4598 ;; change it in one of the calls to `epa-decrypt-region'.
4602 mime-disabled)
4605 ;; Turn off mime processing.
4611 ;; Now find all armored messages in the buffer
4612 ;; and decrypt them one by one.
4633 ;; Find, in the real Rmail buffer, the same armors
4634 ;; that we found and decrypted in the view buffer.
4640 armor-end-regexp
4641 nil t))
4643 ;; Found as expected -- now replace it with the decrypt.
4648 ;; Change the mime type (if this is in a mime part)
4649 ;; so this part will display by default
4650 ;; when the message is shown later.
4661 )))))))
4664 mime mime-disabled)
4665 ;; Re-enable mime processing.
4667 ;; Find each Show button and show that part.
4681 )
4686 \f
4687 ;;;; Desktop support
4690 _buffer-name
4691 _buffer-misc)
4692 "Restore an rmail buffer specified in a desktop file."
4698 rmail-buffer))
4701 nil)))
4706 ;; We use this to record the encoding of the current message before
4707 ;; saving the message collection.
4710 ;; Used in `write-region-annotate-functions' to write rmail files.
4720 nil))
4722 ;; Used to restore the encoding of the buffer where we show the
4723 ;; current message, after we save the message collection. This is
4724 ;; needed because rmail-write-region-annotate switches buffers behind
4725 ;; save-file's back, with the side effect that last-coding-system-used
4726 ;; is assigned to buffer-file-coding-system of the wrong buffer.
4738 ;;; rmail.el ends here