| blob | a535d3a86db853a82224bda61ea4f2aa33e849f4 |
1 ;;; rmail.el --- main code of "RMAIL" mail reader for Emacs
3 ;; Copyright (C) 1985-1988, 1993-1998, 2000-2011
4 ;; Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: mail
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
28 ;; Souped up by shane@mit-ajax based on ideas of rlk@athena.mit.edu
29 ;; New features include attribute and keyword support, message
30 ;; selection by dispatch table, summary by attributes and keywords,
31 ;; expunging by dispatch table, sticky options for file commands.
33 ;; Extended by Bob Weiner of Motorola
34 ;; New features include: rmail and rmail-summary buffers remain
35 ;; synchronized and key bindings basically operate the same way in both
36 ;; buffers, summary by topic or by regular expression, rmail-reply-prefix
37 ;; variable, and a bury rmail buffer (wipe) command.
38 ;;
49 ;;; Attribute indexes
84 "An array that provides a mapping between an attribute index,
97 "The current header display style choice, one of
100 ;; rmail-spool-directory and rmail-file-name are defined in paths.el.
103 "Mail reader for Emacs."
107 "Rmail retrieval options."
112 "Rmail files."
117 "Rmail header options."
122 "Rmail reply options."
127 "Rmail summary options."
133 "Output message to a file."
139 "Rmail editing."
144 "If non-nil, the file name of the `movemail' program."
152 "Password to use when reading mail from a remote server.
153 This setting is ignored for mailboxes whose URL already contains a password."
163 "Non-nil if a password is required when reading mail from a remote server."
169 "List of flags to pass to movemail.
170 Most commonly used to specify `-g' to enable GSS-API authentication
171 or `-k' to enable Kerberos authentication."
178 "Regular expression matching incorrect-password POP or IMAP server error
179 messages.
180 If you get an incorrect-password error that this expression does not match,
186 "Non-nil means leave incoming mail in the user's inbox--don't delete it."
191 "List of directories to search for movemail (in addition to `exec-path')."
200 "Determine what flavor of movemail PROG is.
201 We do this by executing it with `--version' and analyzing its output."
207 ;; Should not happen...
208 nil
216 ;; FIXME:
220 "Determine the file name of the `movemail' program and return its flavor.
221 If `rmail-movemail-program' is non-nil, use it.
222 Otherwise, look for `movemail' in the directories in
223 `rmail-movemail-search-path', those in `exec-path', and `exec-directory'."
230 ;; Previously, this didn't have to work on Windows, because
231 ;; rmail-insert-inbox-text before r1.439 fell back to using
232 ;; (expand-file-name "movemail" exec-directory) and just
233 ;; assuming it would work.
234 ;; http://lists.gnu.org/archive/html/bug-gnu-emacs/2008-02/msg00087.html
247 "The movemail variant currently in use. Known variants are:
249 `emacs' Means any implementation, compatible with the native Emacs one.
250 This is the default;
251 `mailutils' Means GNU mailutils implementation, capable of handling full
254 ;;;###autoload
256 "Return t if the current movemail variant is any of VARIANTS.
257 Currently known variants are 'emacs and 'mailutils."
259 ;; Autodetect
263 ;; Call for effect, to set rmail-movemail-program (if not set by the
264 ;; user), and rmail-movemail-variant-in-use. Used by various functions.
265 ;; I'm not sure if M-x rmail is the only entry point to this package.
266 ;; If so, this can be moved there.
269 ;;;###autoload
271 "Regexp matching user mail addresses.
272 If non-nil, this variable is used to identify the correspondent
273 when receiving new mail. If it matches the address of the sender,
274 the recipient is taken as correspondent of a mail.
275 If nil \(default value\), your `user-login-name' and `user-mail-address'
276 are used to exclude yourself as correspondent.
278 Usually you don't have to set this variable, except if you collect mails
279 sent by you under different user names.
280 Then it should be a regexp matching your mail addresses.
282 Setting this variable has an effect only before reading a mail."
287 ;;;###autoload
290 ;;;###autoload
292 "Regexp specifying part of the default value of `mail-dont-reply-to-names'.
293 This is used when the user does not set `mail-dont-reply-to-names'
295 ;;;###autoload
299 ;;;###autoload
319 "Regexp to match header fields that Rmail should normally hide.
320 \(See also `rmail-nonignored-headers', which overrides this regexp.)
321 This variable is used for reformatting the message header,
322 which normally happens once for each message,
323 when you view the message for the first time in Rmail.
324 To make a change in this variable take effect
325 for a message that you have already viewed,
331 "Regexp to match X header fields that Rmail should show.
332 This regexp overrides `rmail-ignored-headers'; if both this regexp
333 and that one match a certain header field, Rmail shows the field.
334 If this is nil, ignore all header fields in `rmail-ignored-headers'.
336 This variable is used for reformatting the message header,
337 which normally happens once for each message,
338 when you view the message for the first time in Rmail.
339 To make a change in this variable take effect
340 for a message that you have already viewed,
345 ;;;###autoload
347 "Regexp to match Header fields that Rmail should display.
348 If nil, display all header fields except those matched by
349 `rmail-ignored-headers'."
353 ;;;###autoload
354 (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:")
355 "Headers that should be stripped when retrying a failed message."
360 ;;;###autoload
362 "Regexp to match Header fields that Rmail should normally highlight.
363 A value of nil means don't highlight. Uses the face `rmail-highlight'."
369 "Face to use for highlighting the most important header fields.
370 The variable `rmail-highlighted-headers' specifies which headers."
374 ;; This was removed in Emacs 23.1 with no notification, an unnecessary
375 ;; incompatible change.
377 "Face used by Rmail for highlighting headers."
378 ;; Note that nil doesn't actually mean use the default face, it
379 ;; means use either bold or highlight. It's not worth fixing this
380 ;; now that this is obsolete.
382 face)
385 "customize the face `rmail-highlight' instead."
390 "Face to use for highlighting the header names.
391 The variable `rmail-font-lock-keywords' specifies which headers
392 get highlighted."
397 "Non-nil means automatically delete a message that is copied to a file."
401 ;;;###autoload
403 "List of files that are inboxes for your primary mail file `rmail-file-name'.
404 If this is nil, uses the environment variable MAIL. If that is
405 unset, uses a file named by the function `user-login-name' in the
406 directory `rmail-spool-directory' (whose value depends on the
408 ;; Don't use backquote here, because we don't want to need it at load time.
409 ;; (That must be an old comment - it's dumped these days.)
419 "Non-nil means Rmail makes a new frame for composing outgoing mail.
420 This is handy if you want to preserve the window configuration of
421 the frame where you have the RMAIL buffer displayed."
425 ;;;###autoload
427 "Directory for additional secondary Rmail files."
430 ;;;###autoload
432 "Regexp for which files are secondary Rmail files."
437 "Whether and how to ask for confirmation before expunging deleted messages.
438 The value, if non-nil is a function to call with a question (string)
439 as argument, to ask the user that question."
447 ;;;###autoload
454 ;;;###autoload
456 "List of functions to call when Rmail displays a message."
465 "List of functions to call when Rmail deletes a message.
466 When the hooks are called, the message has been marked deleted but is
469 ;; These may be altered by site-init.el to match the format of mmdf files
470 ;; delimiting used on a given host (delim1 and delim2 from the config
471 ;; files).
478 ;; FIXME Post-mbox, this is now unused.
479 ;; In Emacs-22, this was called:
480 ;; i) the very first time a message was shown.
481 ;; ii) when toggling the headers to the normal state, every time.
482 ;; It's not clear what it should do now, since there is nothing that
483 ;; records when a message is shown for the first time (unseen is not
484 ;; necessarily the same thing).
486 "If non-nil, a filter function for new messages in RMAIL.
487 Called with region narrowed to the message, including headers,
488 before obeying `rmail-ignored-headers'."
493 "List of directives specifying where to put a message.
494 Each element of the list is of the form:
496 (FOLDERNAME FIELD REGEXP [ FIELD REGEXP ] ... )
498 Where FOLDERNAME is the name of a folder to put the message.
499 If any of the field regexp's are nil, then it is ignored.
502 If FOLDERNAME is nil then it is deleted, and skipped.
504 FIELD is the plain text name of a field in the message, such as
508 REGEXP is an expression to match in the preceding specified FIELD.
509 FIELD/REGEXP pairs continue in the list.
511 examples:
515 Note that this is only applied in the folder specifed by `rmail-file-name'."
523 ;; Some mailers use "Re(2):" or "Re^2:" or "Re: Re:" or "Re[2]:".
524 ;; This pattern should catch all the common variants.
525 ;; rms: I deleted the change to delete tags in square brackets
526 ;; because they mess up RT tags.
531 "If non-nil, Rmail always displays the summary buffer."
534 \f
539 "The RMAIL buffer related to the current buffer.
540 In an RMAIL buffer, this holds the RMAIL buffer itself.
552 ;; Message counters and markers. Deleted flags.
559 "Integer specifying the total number of messages in this folder.
564 "Vector of markers specifying the start and end of each message.
569 "A string of length `rmail-total-messages' plus one.
575 "In an Rmail buffer, a vector whose Nth element is a list (N).
576 When expunging renumbers messages, these lists are modified
583 ;; These are used by autoloaded rmail-summary.
588 "In an Rmail buffer, vector of (newline-terminated) strings.
592 ;; Rmail buffer swapping variables.
603 \f
604 ;; `Sticky' default variables.
606 ;; Last individual label specified to a or k.
609 ;; Last set of values specified to C-M-n, C-M-p, C-M-s or C-M-l.
625 ;; Mule and MIME related variables.
627 ;;;###autoload
629 "Coding system used in RMAIL file.
634 "If non-nil, RMAIL uses MIME features.
635 If the value is t, RMAIL automatically shows MIME decoded message.
636 If the value is neither t nor nil, RMAIL does not show MIME decoded message
637 until a user explicitly requires it.
639 Even if the value is non-nil, you can't use MIME features
640 unless the feature specified by `rmail-mime-feature' is available."
650 ;; FIXME unused.
652 "Function to show MIME decoded message of RMAIL file.
653 This function is called when `rmail-enable-mime' is non-nil.
656 ;;;###autoload
658 "Function to insert a message in MIME format so it can be forwarded.
659 This function is called if `rmail-enable-mime' or
660 `rmail-enable-mime-composing' is non-nil.
661 It is called with one argument FORWARD-BUFFER, which is a
662 buffer containing the message to forward. The current buffer
666 "Function to insert a message in MIME format so it can be resent.
667 This function is called by `rmail-resend' if `rmail-enable-mime' is non-nil.
668 It is called with one argument FORWARD-BUFFER, which is a
669 buffer containing the message to forward. The current buffer
672 ;; FIXME one might want to pass a LIMIT, as per
673 ;; rmail-search-mime-header-function.
675 "Function to check if a regexp matches a MIME message.
676 This function is called by `rmail-search-message' if
677 `rmail-enable-mime' is non-nil. It is called (with point at the
678 start of the message) with two arguments MSG and REGEXP, where
682 "Function to check if a regexp matches a header of MIME message.
683 This function is called by `rmail-message-regexp-p-1' if
684 `rmail-enable-mime' is non-nil. It is called (with point at the
685 start of the header) with three arguments MSG, REGEXP, and LIMIT,
686 where MSG is the message number, REGEXP is the regular
690 "Feature to require to load MIME support in Rmail.
691 When starting Rmail, if `rmail-enable-mime' is non-nil,
692 this feature is required with `require'.
696 ;; FIXME this is unused.
698 "*Non-nil means a message is decoded by MIME's charset specification.
699 If this variable is nil, or the message has not MIME specification,
700 the message is decoded as normal way.
702 If the variable `rmail-enable-mime' is non-nil, this variable is
703 ignored, and all the decoding work is done by a feature specified by
710 "Regexp to match MIME-charset specification in a header of message.
713 \f
721 "From "
723 ;; Many things can happen to an RFC 822 mailbox before it is put into
724 ;; a `From' line. The leading phrase can be stripped, e.g.
725 ;; `Joe <@w.x:joe@y.z>' -> `<@w.x:joe@y.z>'. The <> can be stripped, e.g.
726 ;; `<@x.y:joe@y.z>' -> `@x.y:joe@y.z'. Everything starting with a CRLF
727 ;; can be removed, e.g.
728 ;; From: joe@y.z (Joe K
729 ;; User)
730 ;; can yield `From joe@y.z (Joe K Fri Mar 22 08:11:15 1996', and
731 ;; From: Joe User
732 ;; <joe@y.z>
733 ;; can yield `From Joe User Fri Mar 22 08:11:15 1996'.
734 ;; The mailbox can be removed or be replaced by white space, e.g.
735 ;; From: "Joe User"{space}{tab}
736 ;; <joe@y.z>
737 ;; can yield `From {space}{tab} Fri Mar 22 08:11:15 1996',
738 ;; where {space} and {tab} represent the Ascii space and tab characters.
739 ;; We want to match the results of any of these manglings.
740 ;; The following regexp rejects names whose first characters are
741 ;; obviously bogus, but after that anything goes.
744 ;; The time the message was sent.
750 ;; Perhaps a time zone, specified by an abbreviation, or by a
751 ;; numeric offset.
752 time-zone-regexp
754 ;; The year.
757 ;; On some systems the time zone can appear after the year, too.
758 time-zone-regexp
760 ;; Old uucp cruft.
764 "Regexp matching the delimiter of messages in UNIX mail format
765 \(UNIX From lines), minus the initial ^. Note that if you change
766 this expression, you must change the code in `rmail-nuke-pinhead-header'
769 ;; FIXME the rmail-header-name headers ought to be customizable.
770 ;; It seems a bit arbitrary, for example, that all of the Date: line
771 ;; gets highlighted.
773 ;; These are all matched case-insensitively.
781 ;; FIXME Mail-Followup-To should probably be here too.
786 ;; Use MATCH-ANCHORED to effectively anchor the regexp left side.
787 `(,cite-chars
799 ;; Rmail does not expect horizontal splitting. (Bug#2282)
801 "Like `pop-to-buffer', but with `split-width-threshold' set to nil."
805 ;; Perform BODY in the summary buffer
806 ;; in such a way that its cursor is properly updated in its own window.
815 ;; rmail-total-messages is a buffer-local var
816 ;; in the rmail buffer.
817 ;; This way we make it available for the body
818 ;; even tho the rmail buffer is not current.
826 \f
827 ;;;; *** Rmail Mode ***
830 "Require `rmail-mime-feature' if that is non-nil.
831 Signal an error and set `rmail-mime-feature' to nil if the feature
832 isn't provided."
838 'rmail
840 by setting `rmail-enable-mime' to non-nil, the required feature
841 `%s' (the value of `rmail-mime-feature')
842 is not available in the current session.
843 So, the MIME support is turned off for the moment."
844 rmail-mime-feature)
849 ;;;###autoload
851 "Read and edit incoming mail.
852 Moves messages into file named by `rmail-file-name' and edits that
853 file in RMAIL Mode.
856 May be called with file name as argument; then performs rmail editing on
857 that file, but does not copy any new mail into the file.
858 Interactively, if you supply a prefix argument, then you
859 have a chance to specify a file name with the minibuffer.
861 If `rmail-display-summary' is non-nil, make a summary for this RMAIL file."
866 ;; Use find-buffer-visiting, not get-file-buffer, for those users
867 ;; who have find-file-visit-truename set to t.
869 run-mail-hook mail-buf msg-shown)
870 ;; Determine if an existing mail file has been changed behind the
871 ;; scene...
873 ;; The mail file has been changed. Revisit it and reset the
874 ;; message state variables when in rmail mode.
881 ;; The mail file is either unchanged or not visited. Visit it.
884 ;; Force no-conversion by default, since that's what
885 ;; pre-mbox Rmail did with BABYL files (via
886 ;; auto-coding-regexp-alist).
890 ;; Ensure that the collection and view buffers are in sync and
891 ;; ensure that a message is not being edited.
898 ;; Ensure that the Rmail file is in mbox format, the buffer is in
899 ;; Rmail mode and has been scanned to find all the messages
900 ;; (setting the global message variables in the process).
907 ;; Show the first unread message and process summary mode.
909 ;; Only get new mail when there is not a file name argument.
922 "Determine if the file needs to be converted to mbox format."
925 ;; Detect previous Babyl format files.
928 ;; The file is Babyl version 5. Use unrmail to convert
929 ;; it.
932 ;; Losing babyl file made by old version of Rmail. Fix the
933 ;; babyl file header and use unrmail to convert to mbox
934 ;; format.
944 "Report that the buffer is not in the mbox file format.
945 MSGNUM, if present, indicates the malformed message."
951 "Convert the mail file from Babyl version 5 to mbox.
952 This function also reinitializes local variables used by Rmail."
966 ;; Rmail buffers need to be saved with Unix EOLs, or else
967 ;; the format will not be recognized.
981 "Return a suitable coding system to use for the current mail message.
982 The buffer is expected to be narrowed to just the header of the message."
988 \f
989 ;;; Set up Rmail mode keymaps
1000 ;; If you change this, change the rmail-resend menu-item's :keys.
1026 ;; I find I can't live without the default M-r command -- rms.
1027 ;; (define-key rmail-mode-map "\er" 'rmail-search-backwards)
1053 \f
1060 nil)
1063 nil)
1170 map)
1173 ;; Rmail toolbar
1177 map rmail-mode-map)
1179 map rmail-mode-map)
1181 map rmail-mode-map)
1183 map rmail-mode-map)
1185 map rmail-mode-map)
1187 map rmail-mode-map)
1189 map rmail-mode-map)
1191 map rmail-mode-map)
1193 map rmail-mode-map)
1195 map rmail-mode-map)
1197 map rmail-mode-map)
1199 map rmail-mode-map)
1200 map))
1203 \f
1204 ;; Rmail mode is suitable only for specially formatted data.
1212 ;;;###autoload
1215 All normal editing commands are turned off.
1216 Instead, these commands are available:
1232 \\[rmail-undelete-previous-message] Undelete message. Tries current message, then earlier messages
1233 till a deleted message is found.
1234 \\[rmail-edit-current-message] Edit the current message. \\[rmail-cease-edit] to return to Rmail.
1247 \\[rmail-output-body-to-file] Save message body to a file. Default filename comes from Subject line.
1252 (label defaults to last one specified).
1253 Standard labels: filed, unseen, answered, forwarded, deleted.
1291 ;; No need to auto save RMAIL files in normal circumstances
1292 ;; because they contain no info except attribute changes
1293 ;; and deletion of messages.
1294 ;; The one exception is when messages are copied into another mbox buffer.
1295 ;; rmail-output enables auto save when you do that.
1300 ;; Functions to support buffer swapping:
1307 "Return a reusable buffer suitable for viewing messages.
1308 Create the buffer if necessary."
1309 ;; We want to reuse any existing view buffer, so as not to create an
1310 ;; endless number of them. But we must avoid clashes if we visit
1311 ;; two different rmail files with the same basename (Bug#4593).
1314 rmail-view-buffer
1322 newbuf)))
1325 "Swap text between current buffer and `rmail-view-buffer'.
1326 This function preserves the current buffer's modified flag, and also
1327 sets the current buffer's `buffer-file-coding-system' to that of
1328 `rmail-view-buffer'."
1335 buffer-file-coding-system)))
1344 "Return non-nil if the message collection is in `rmail-view-buffer'."
1345 ;; This is analogous to tar-data-swapped-p in tar-mode.el.
1347 rmail-buffer-swapped))
1350 ;; Bring the actual Rmail messages back into the main buffer.
1356 "Determine if the Rmail buffer is showing a message.
1357 If so restore the actual mbox message collection."
1364 "Warn if important modifications would change Rmail file's format."
1367 ;; If it's already modified, don't warn again.
1382 ;; Turn off the hook on the view buffer, so we can kill it, then kill it.
1391 ;; Set up the permanent locals associated with an Rmail file.
1404 ;; Note that this does not erase the buffer. Should it?
1405 ;; It depends on how this is called. If somehow called with the
1406 ;; rmail buffers swapped, it would erase the message collection.
1409 ;; Force C-x C-s write Unix EOLs.
1419 ;; Provide default set of inboxes for primary mail file ~/RMAIL.
1427 ;; FIXME expand-file-name?
1432 ;; Set up the non-permanent locals associated with Rmail mode.
1434 ;; Turn off undo. We turn it back on in rmail-edit.
1436 ;; Don't let a local variables list in a message cause confusion.
1439 ;; Don't turn off auto-saving based on the size of the buffer
1440 ;; because that code does not understand buffer-swapping.
1448 t t nil nil
1464 \f
1465 ;; Handle M-x revert-buffer done in an rmail-mode buffer.
1470 ;; See similar code in `rmail'.
1471 ;; FIXME needs updating?
1474 ;; Call our caller again, but this time it does the default thing.
1476 ;; If the user said "yes", and we changed something,
1477 ;; reparse the messages.
1480 ;; Convert all or part to Babyl file if possible.
1482 ;; We have read the file as raw-text, so the buffer is set to
1483 ;; unibyte. Make it multibyte if necessary.
1493 "Expunge and save RMAIL file."
1497 ;; No need to swap buffers: rmail-write-region-annotate takes care of it.
1498 ;; (rmail-swap-buffers-maybe)
1504 "Quit out of RMAIL.
1505 Hook `rmail-quit-hook' is run after expunging."
1512 ;; Don't switch to the summary buffer even if it was recently visible.
1523 "Bury current Rmail buffer and its summary buffer."
1525 ;; This let var was called rmail-buffer, but that interfered
1526 ;; with the buffer-local var used in summary buffers.
1534 \f
1536 "Create a duplicated copy of the current message.
1537 The duplicate copy goes into the Rmail file just after the original."
1538 ;; If we are in a summary buffer, switch to the Rmail buffer.
1539 ;; FIXME simpler to swap the contents, not the buffers?
1561 \f
1562 ;;;###autoload
1564 "Run Rmail on file FILENAME."
1568 ;; This used to scan subdirectories recursively, but someone pointed out
1569 ;; that if the user wants that, person can put all the files in one dir.
1570 ;; And the recursive scan was slow. So I took it out.
1571 ;; rms, Sep 1996.
1573 "Return list of file in dir START that match `rmail-secondary-file-regexp'."
1575 ;; Don't sort here.
1578 ;; Sort here instead of in directory-files
1579 ;; because this list is usually much shorter.
1584 name)
1604 item)
1605 rmail-secondary-file-directory)))))
1609 menu))
1611 ;; This command is always "disabled" when it appears in a menu.
1621 files
1626 files
1634 \f
1635 ;;;; *** Rmail input ***
1643 ;; RLK feature not added in this version:
1644 ;; argument specifies inbox file or files in various ways.
1646 ;; In Babyl, the Mail: header in the preamble overrode rmail-inbox-list.
1647 ;; Mbox does not have this feature.
1649 "Move any new mail from this Rmail file's inbox files.
1650 The buffer-local variable `rmail-inbox-list' specifies the list
1651 of inbox files. By default, this is nil, except for your primary
1652 Rmail file `rmail-file-name'. In this case, when you first visit
1653 the Rmail file it is initialized using either
1655 or the function `user-login-name' and the directory
1656 `rmail-spool-directory' (whose value depends on the operating system).
1658 The command `set-rmail-inbox-list' sets `rmail-inbox-list' to the
1659 value you specify.
1661 You can also specify the file to get new mail from just for one
1662 instance of this command. In this case, the file of new mail is
1663 not changed or deleted. Noninteractively, you can pass the inbox
1664 file name as an argument. Interactively, a prefix argument
1665 causes us to read a file name and use that file as the inbox.
1667 If the variable `rmail-preserve-inbox' is non-nil, new mail will
1668 always be left in inbox files rather than deleted.
1670 Before doing anything, this runs `rmail-before-get-new-mail-hook'.
1671 Just before returning, it runs `rmail-after-get-new-mail-hook',
1672 whether or not there is new mail.
1674 If there is new mail, it runs `rmail-get-new-mail-hook', saves
1675 the updated file, and shows the first unseen message (which might
1676 not be a new one). It returns non-nil if it got any new messages."
1681 ;; If the disk file has been changed from under us,
1682 ;; revert to it before we get new mail.
1690 ;; Get rid of all undo records for this buffer.
1695 found)
1698 ;; This loops if any members of the inbox list have the same
1699 ;; basename (see "name conflict" below).
1702 ;; If buffer has not changed yet, and has not been
1703 ;; saved yet, don't replace the old backup file now.
1707 ;; Don't make undo records while getting mail.
1709 delete-files success files file-last-names)
1710 ;; Pull files off all-files onto files as long as there is
1711 ;; no name conflict. A conflict happens when two inbox
1712 ;; file names have the same last component.
1713 ;; The reason this careful handling is necessary seems
1714 ;; to be that rmail-insert-inbox-text uses .newmail-BASENAME.
1717 file-last-names)))
1719 file-last-names
1722 ;; Put them back in their original order.
1724 ;; In case of brain damage caused by require-final-newline.
1730 found))))
1731 ;; Move to the first new message unless we have other unseen
1732 ;; messages before it.
1735 found)
1736 ;; Don't leave the buffer screwed up if we get a disk-full error.
1743 "Return t if new messages are detected without error, nil otherwise."
1748 rmail-use-spam-filter))
1750 result success suffix)
1752 ;; Read in the contents of the inbox files, renaming them as
1753 ;; necessary, and adding to the list of files to delete
1754 ;; eventually.
1758 ;; Scan the new text and convert each message to
1759 ;; Rmail/mbox format.
1765 success t)
1766 ;; Try to delete the garbage just inserted.
1768 ;; If we could not convert the file's inboxes, rename the
1769 ;; files we tried to read so we won't over and over again.
1778 ;; Determine if there are messages.
1780 ;; There are. Process them.
1785 ;; Delete the old files, now that the Rmail file is saved.
1788 ;; First, try deleting.
1792 ;; If we can't delete it, truncate it.
1805 ;; Establish the return value.
1807 result))))
1810 "Parse the supplied URL. Return (list MAILBOX-NAME REMOTE PASSWORD GOT-PASSWORD)
1811 WHERE MAILBOX-NAME is the name of the mailbox suitable as argument to the
1812 actual version of `movemail', REMOTE is non-nil if MAILBOX-NAME refers to
1813 a remote mailbox, PASSWORD is the password if it should be
1814 supplied as a separate argument to `movemail' or nil otherwise, GOT-PASSWORD
1815 is non-nil if the user has supplied the password interactively.
1816 "
1831 ;; The password is embedded. Strip it out since movemail
1832 ;; does not really like it, in spite of the movemail spec.
1838 t
1840 got-password)
1845 got-password))))
1863 "Replace newly read mail in Babyl format with equivalent mbox format.
1865 FROM-FILE is the Babyl file from which the new mail should be read."
1867 size)
1875 size)))
1878 "If newly read mail from FILE is in Babyl format, convert it to mbox format.
1880 SIZE is the original size of the newly read mail.
1881 Value is the size of the newly read mail after conversion."
1882 ;; Detect previous Babyl format files.
1885 new-file)
1887 ;; The new mail is in Babyl version 5 format. Use unrmail
1888 ;; to convert it.
1891 ;; New mail is in Babyl format made by old version of
1892 ;; Rmail. Fix the babyl file header and use unrmail to
1893 ;; convert it.
1903 size))
1906 ;; Detect a locked file now, so that we avoid moving mail
1907 ;; out of the real inbox file. (That could scare people.)
1913 ;; Handle remote mailbox names specially; don't expand as filenames
1914 ;; in case the userid contains a directory separator.
1927 ;; Generate name to move to from inbox name,
1928 ;; in case of multiple inboxes that need moving.
1932 ;; cannot have colons in file name
1934 file)))
1935 ;; Use the directory of this rmail file
1936 ;; because it's a nuisance to use the homedir
1937 ;; if that is on a full disk and this rmail
1938 ;; file isn't.
1941 ;; Always use movemail to rename the file,
1942 ;; since there can be mailboxes in various directories.
1944 ;; On some systems, /usr/spool/mail/foo is a directory
1945 ;; and the actual inbox is /usr/spool/mail/foo/foo.
1948 file))))
1957 ;; Set TOFILE if have not already done so, and
1958 ;; rename or copy the file FILE to TOFILE if and as appropriate.
1963 nil)
1973 nil)
1976 rmail-movemail-flags)
1981 ;; No output => movemail won
1982 nil
1993 ;; If we just read the password, most likely it is
1994 ;; wrong. Otherwise, see if there is a specific
1995 ;; reason to think that the problem is a wrong passwd.
1998 nil t))
2001 ;; If using Mailutils, remove initial error code
2002 ;; abbreviation
2013 nil)))))
2015 ;; At this point, TOFILE contains the name to read:
2016 ;; Either the alternate name (if we renamed)
2017 ;; or the actual inbox (if not renaming).
2020 size)
2023 ;; If new mail is in Babyl format, convert it to mbox.
2025 tofile
2027 ;; Determine if a pair of newline message separators need
2028 ;; to be added to the new collection of messages. This is
2029 ;; the case for all new message collections added to a
2030 ;; non-empty mail file.
2047 delete-files))
2049 ;; Decode the region specified by FROM and TO by CODING.
2050 ;; If CODING is nil or an invalid coding system, decode by `undecided'.
2054 ;; Use -dos decoding, to remove ^M characters left from base64 or
2055 ;; rogue qp-encoded text.
2058 ;; Don't reveal the fact we used -dos decoding, as users generally
2059 ;; will not expect the RMAIL buffer to use DOS EOL format.
2072 "Ensure a message ends in a blank line.
2073 Call with point at the end of the message."
2080 "Validate the RFC2822 format for the new messages.
2081 Point should be at the first new message.
2082 An error is signalled if the new messages are not RFC2822
2083 compliant.
2084 Unless an Rmail attribute header already exists, add it to the
2085 new messages. Return the number of new messages."
2093 limit stop)
2094 ;; Detect an empty inbox file.
2096 ;; Scan the new messages to establish a count and to ensure that
2097 ;; an attribute header is present.
2100 ;; Determine if a new attribute header needs to be
2101 ;; added to the message.
2111 ;; Move to the next message.
2118 count))))
2119 \f
2121 "Subroutine of `rmail-get-header'.
2122 Narrow to header, call `mail-fetch-field' to find header NAME."
2130 "Return the value of message header NAME, nil if it has none.
2131 MSGNUM specifies the message number to get it from.
2132 If MSGNUM is nil, use the current message."
2136 "Subroutine of `rmail-set-header'.
2137 Narrow to header, set header NAME to VALUE, replacing existing if present.
2138 VALUE nil means to remove NAME altogether."
2155 "Set message header NAME to VALUE in message number MSGNUM.
2156 If MSGNUM is nil, use the current message. NAME and VALUE are strings.
2157 VALUE may also be nil, meaning to remove the header."
2160 ;; Ensure header changes get saved.
2161 ;; (Note replacing a header with an identical copy modifies.)
2163 ;; However: don't save in mbox format over a Babyl file
2164 ;; merely because of this.
2166 \f
2167 ;;;; *** Rmail Attributes and Keywords ***
2170 "Return the message attributes in a comma separated string.
2171 MSG specifies the message number to get it from.
2172 If MSG is nil, use the current message."
2175 result temp)
2182 result
2187 result)))
2190 "Return the message keywords in a comma separated string.
2191 MSG, if non-nil, identifies the message number to use.
2192 If nil, that means the current message."
2196 "Return a string with the labels (attributes and keywords) of msg MSG.
2197 It is put in comma-separated form.
2198 MSG, if non-nil, identifies the message number to use.
2199 If nil, that means the current message."
2202 ;; Combine the message attributes and keywords
2203 ;; into a comma-separated list.
2209 ;; FIXME ? old rmail did not have spaces in the comma-separated lists.
2216 "Update the current messages's attributes and keywords in mode line."
2220 rmail-current-message rmail-total-messages blurb))))
2223 "Return the character value for ATTR.
2224 ATTR is a (numeric) index, an offset into the mbox attribute
2225 header value. STATE is one of nil, t, or a character value."
2232 "Subroutine of `rmail-set-attribute'.
2233 Set Rmail attribute ATTR to STATE in `rmail-attribute-header',
2234 creating the header if necessary. Returns non-nil if a
2235 significant attribute change was made."
2239 altered)
2242 ;; If this message already records attributes, just change the
2243 ;; value for this one.
2245 ;; Position point at this attribute, adding attributes if necessary.
2252 ;; Change this attribute.
2257 ;; Otherwise add a header line to record the attributes and set
2258 ;; all but this one to no.
2264 altered))
2267 "Turn an attribute of a message on or off according to STATE.
2268 STATE is either nil or the character (numeric) value associated
2269 with the state (nil represents off and non-nil represents on).
2270 ATTR is either the index number of the attribute, or a string,
2271 both from `rmail-attr-array'. MSGNUM is message number to
2272 change; nil means current message."
2282 ;; Ask for confirmation before setting any attribute except `unseen'
2283 ;; if it would force a format change.
2289 ;; The "deleted" attribute is also stored in a special vector so
2290 ;; update that too.
2297 ;; Don't save in mbox format over a Babyl file
2298 ;; merely because of a change in `unseen' attribute.
2301 ;; Otherwise, if we modified the file text via the view buffer,
2302 ;; mark the main buffer modified too.
2306 "Return non-nil if message number MSG has attributes matching regexp ATTRS."
2311 "Return non-nil if message number MSGNUM has the unseen attribute."
2314 ;; FIXME rmail-get-labels does some formatting (eg leading space, `;'
2315 ;; between attributes and labels), so this might not do what you want.
2316 ;; Eg see rmail-sort-by-labels. rmail-get-labels could have an
2317 ;; optional `noformat' argument.
2319 "Return non-nil if message number MSG has labels matching regexp LABELS."
2321 \f
2322 ;;;; *** Rmail Message Selection And Support ***
2325 "Return the end position for message number N."
2329 "Return the start position for message number N."
2333 "Call FUNCTION on ARGS while narrowed to message MSGNUM.
2334 Point is at the start of the message.
2335 This returns what the call to FUNCTION returns.
2336 If MSGNUM is nil, use the current message."
2343 ;; All access to the rmail-buffer's local variables is now finished...
2345 ;; ... so it is ok to go to a different buffer.
2354 ;; Unused (save for commented out code in rmailedit.el).
2356 "Call FUNCTION with point at start of internal data of current message.
2357 Assumes that bounds were previously narrowed to display the message in Rmail.
2358 The bounds are widened enough to move point where desired, then narrowed
2359 again afterward.
2361 FUNCTION may not change the visible text of the message, but it may
2362 change the invisible header text."
2370 ;; Note: we don't use save-restriction because that does not work right
2371 ;; if changes are made outside the saved restriction
2372 ;; before that restriction is restored.
2375 \f
2376 ;; Manage the message vectors and counters.
2392 rmail-message-vector
2393 rmail-current-message
2394 rmail-total-messages))
2398 "Count the number of new messages.
2399 The buffer should be narrowed to include only the new messages.
2400 Output a helpful message unless NOMSG is non-nil."
2407 ;; Put at the end of messages-head
2408 ;; the entry for message N+1, which marks
2409 ;; the end of message N. (N = number of messages).
2425 ;; Fill in the new elements of rmail-msgref-vector.
2444 ;; Determine how many messages follow point.
2447 ;; Put at the end of messages-head
2448 ;; the entry for message N+1, which marks
2449 ;; the end of message N. (N = number of messages).
2460 ;; Make an element 0 in rmail-message-vector and rmail-deleted-vector
2461 ;; which will never be used.
2482 "Collect the message deletion flags for each message.
2483 MESSAGE-END is the buffer position corresponding to the end of
2484 the message. Point is at the beginning of the message."
2485 ;; NOTE: This piece of code will be executed on a per-message basis.
2486 ;; In the face of thousands of messages, it has to be as fast as
2487 ;; possible, hence some brute force constant use is employed in
2488 ;; addition to inlining.
2493 ?D
2497 "Collect the start positions of messages in list `messages-head'.
2498 Return the number of messages after the one containing SPOT-TO-FIND."
2500 messages-after-spot)
2511 ;; Show progress after every 20 messages or so.
2514 ;; Handle the first message, maybe.
2523 messages-after-spot))
2524 \f
2525 ;; Display a message.
2527 ;;;; *** Rmail Message Formatting and Header Manipulation ***
2529 ;; This is used outside of rmail.
2531 "Return nil if the current message is showing full headers."
2533 rmail-buffer)
2537 "Toggle between showing full and normal message headers.
2538 With optional integer ARG, show the normal message header if ARG
2539 is greater than zero; otherwise, show it in full."
2548 "Show current message starting from the beginning."
2552 rmail-view-buffer
2553 rmail-buffer)
2554 rmail-header-style)))
2558 "Show bottom of current message."
2564 rmail-view-buffer
2565 rmail-buffer)
2566 rmail-header-style)))
2571 Ask the user whether to add that list name to `mail-mailing-lists'."
2572 ;; FIXME s-r not needed? Use rmail-get-header?
2573 ;; We have not narrowed to the headers at ths point?
2584 ;; taken from rmailsum.el
2596 addr))
2599 addr)))
2604 "Display the entire mailbox file."
2608 \f
2618 "Show message number N (prefix argument), counting from start of file.
2619 If summary buffer is currently displayed, update current message there also.
2620 N defaults to the current message."
2624 ;; FIXME: Why do we swap the raw data back in?
2634 ;; If there is a summary buffer, try to move to this message
2635 ;; in that buffer. But don't complain if this message is
2636 ;; not mentioned in the summary. Don't do this at all if we
2637 ;; were called on behalf of cursor motion in the summary
2638 ;; buffer.
2649 "Return t if the region contains a text message, nil otherwise."
2653 ;; The message is text if either there is no content type header
2654 ;; (a default of "text/plain; charset=US-ASCII" is assumed) or
2655 ;; the base content type is either text or message.
2660 "Message size at which to show progress messages for displaying it."
2666 "Show message MSG (default: current message) using `rmail-view-buffer'.
2667 Return text to display in the minibuffer if MSG is out of
2668 range (displaying a reasonable choice as well), nil otherwise.
2669 The current mail message becomes the message displayed."
2672 blurb beg end body-start coding-system character-coding
2673 is-text-message header-style)
2679 rmail-current-message 1
2683 rmail-current-message rmail-total-messages
2688 ;; Mark the message as seen, but preserve buffer modified flag.
2693 ;; bracket the message in the mail
2694 ;; buffer and determine the coding system the transfer encoding.
2703 ;; We give the view buffer a buffer-local value of
2704 ;; rmail-header-style based on the binding in effect when
2705 ;; this function is called; `rmail-toggle-headers' can
2706 ;; inspect this value to determine how to toggle.
2725 ;; Decode the message body into an empty view buffer using a
2726 ;; unibyte temporary buffer where the character decoding takes
2727 ;; place.
2731 ;; Do it directly since that is fast.
2733 ;; Can this be done directly, skipping the temp buffer?
2739 ;; See bug#5441.
2751 coding-system view-buf)))
2753 ;; Prepare the separator (blank line) before the body.
2756 ;; Unquote quoted From lines
2762 ;; Copy the headers to the front of the message view buffer.
2764 ;; highlight the message, activate any URL like text and add
2765 ;; special highlighting for and quoted material.
2769 ;(rmail-activate-urls)
2770 ;(rmail-process-quoted-material)
2771 )
2772 ;; Update the mode-line with message status information and swap
2773 ;; the view buffer/mail buffer contents.
2780 blurb))
2783 "Copy displayed header fields to the message viewer buffer.
2784 BEG and END marks the start and end positions of the message in
2785 the mbox buffer. If the optional argument IGNORED-HEADERS is
2786 non-nil, ignore all header fields whose names match that regexp.
2787 Otherwise, if `rmail-displayed-headers' is non-nil, copy only
2788 those header fields whose names match that regexp. Otherwise,
2789 copy all header fields whose names do not match
2790 `rmail-ignored-headers' (unless they also match
2791 `rmail-nonignored-headers'). Moves point in the message viewer
2792 buffer to the end of the headers."
2794 lim)
2799 ;; Put point right after the From header line.
2806 ;; Handle the case where all headers should be copied.
2809 ;; rmail-show-message-1 expects this function to leave point
2810 ;; at the end of the headers.
2816 ;; Handle the case where the headers matching the displayed
2817 ;; headers regexp should be copied.
2827 ;; Handle the ignored headers.
2842 "Decode the body of the current message using coding system CODING.
2843 This is useful with mail messages that have malformed or missing
2844 charset= headers.
2846 This function assumes that the current message is already decoded
2847 and displayed in the RMAIL buffer, but the coding system used to
2848 decode it was incorrect. It then decodes the message again,
2849 using the coding system CODING."
2859 body-start x-coding-header old-coding)
2866 ;; Narrow to headers
2874 ;; Make sure the new coding system uses the same EOL
2875 ;; conversion, to prevent ^M characters from popping up
2876 ;; all over the place.
2884 ;; Rewrite the coding-system header.
2896 "Highlight the headers specified by `rmail-highlighted-headers'.
2897 Uses the face specified by `rmail-highlight-face'."
2905 ;; When rmail-highlight-face is removed, just
2906 ;; use 'rmail-highlight here.
2910 ;; List of overlays to reuse.
2916 overlay)
2919 ;; Back up over newline, then trailing spaces or tabs
2924 ;; Reuse an overlay we already have.
2930 ;; Make a new overlay and add it to
2931 ;; rmail-overlay-list.
2938 "Automatically move a message into a sub-folder based on criteria.
2939 Called when a new message is displayed."
2944 ;; Do nothing if the message has already been filed or if there
2945 ;; are no messages.
2946 nil
2947 ;; Find out some basics (common fields)
2965 ;; If there are no directives left, then it was a complete match.
2974 \f
2975 ;; Simple message motion commands.
2978 "Show following message whether deleted or not.
2979 With prefix arg N, moves forward N messages, or backward if N is negative."
2986 "Show previous message whether deleted or not.
2987 With prefix arg N, moves backward N messages, or forward if N is negative."
2992 "Show following non-deleted message.
2993 With prefix arg N, moves forward N non-deleted messages,
2994 or backward if N is negative.
2996 Returns t if a new message is being shown, nil otherwise."
3012 t)
3017 nil)))
3020 "Show previous non-deleted message.
3021 With prefix argument N, moves backward N non-deleted messages,
3022 or forward if N is negative."
3027 "Show first message in file."
3033 "Show last message in file."
3039 "Move to an error locus (probably grep hit) in an Rmail buffer.
3040 MSG-POS is a marker pointing at the error message in the grep buffer.
3041 BAD-MARKER is a marker that ought to point at where to move to,
3042 but probably is garbage."
3049 line-text
3050 pos
3051 msgnum msgbeg msgend
3052 header-field
3053 line-number-within)
3055 ;; Look at the whole Rmail file.
3061 ;; Find the line that the error message points at.
3066 ;; Find the text at the start of the line,
3067 ;; before the first = sign.
3068 ;; This text has a good chance of being also in the
3069 ;; decoded message.
3074 ;; Find which message this position is in,
3075 ;; and the limits of that message.
3080 ;; Find which header this locus is in,
3081 ;; or if it's in the message body,
3082 ;; and the line-based position within that.
3097 ;; Display the right message.
3100 ;; Move to the right position within the displayed message.
3101 ;; Or at least try. The decoded message's lines may not
3102 ;; correspond to the lines in the inbox file.
3112 ;; If the decoded message doesn't have enough lines,
3113 ;; go to the beginning rather than the end.
3115 ;; Otherwise, go to the right column.
3120 "Return message number POS (or point) is in."
3126 rmail-view-buffer
3135 \f
3136 ;; Searching in Rmail file.
3139 "Return non-nil, if for message number MSG, regexp REGEXP matches."
3140 ;; This is adequate because its only caller, rmail-search,
3141 ;; unswaps the buffers.
3151 "Show message containing next match for REGEXP (but not the current msg).
3152 Prefix argument gives repeat count; negative argument means search
3153 backwards (through earlier messages).
3154 Interactively, empty argument means use same regexp used last time."
3159 regexp)
3176 regexp)
3182 found)
3188 ;; Check messages one by one, advancing message number up or
3189 ;; down but searching forward through each message.
3201 ;; Search forward (if this is a normal search) or backward
3202 ;; (if this is a reverse search) through this message to
3203 ;; position point. This search may fail because REGEXP
3204 ;; was found in the hidden portion of this message. In
3205 ;; that case, move point to the beginning of visible
3206 ;; portion.
3215 regexp))
3222 "Show message containing previous match for REGEXP.
3223 Prefix argument gives repeat count; negative argument means search
3224 forward (through later messages).
3225 Interactively, empty argument means use same regexp used last time."
3230 regexp)
3245 \f
3246 ;; Scan for attributes, and compare subjects.
3249 "Return message number of first message which has `unseen' attribute."
3252 found)
3259 found))
3262 "Return the simplified subject of message MSGNUM (or current message).
3263 Simplifying the subject means stripping leading and trailing whitespace,
3264 and typical reply prefixes such as Re:."
3273 ;; If Subject is long, mailers will break it into several lines at
3274 ;; arbitrary places, so normalize whitespace by replacing every
3275 ;; run of whitespace characters with a single space.
3277 subject))
3280 "Return a regular expression matching the current simplified subject.
3281 The idea is to match it against simplified subjects of other messages."
3284 ;; Hide commas so it will work ok if parsed as a comma-separated list
3285 ;; of regexps.
3291 "Go to the next mail message having the same subject header.
3292 With prefix argument N, do this N times.
3293 If N is negative, go backwards instead."
3298 found)
3318 "Go to the previous mail message having the same subject header.
3319 With prefix argument N, do this N times.
3320 If N is negative, go forwards instead."
3323 \f
3324 ;;;; *** Rmail Message Deletion Commands ***
3327 "Return non-nil if message number N is deleted (in `rmail-deleted-vector')."
3331 "Set the deleted state of message number N (in `rmail-deleted-vector').
3332 STATE non-nil means mark as deleted."
3336 "Delete this message and stay on it."
3342 "Back up to deleted message, select it, and undelete it."
3360 "Delete this message and move to next nondeleted one.
3362 With prefix argument, delete and move backward.
3364 Returns t if a new message is displayed after the delete, or nil otherwise."
3376 "Delete this message and move to previous nondeleted one.
3380 \f
3381 ;; Expunging.
3383 ;; Compute the message number a given message would have after expunging.
3384 ;; The present number of the message is OLDNUM.
3385 ;; DELETEDVEC should be rmail-deleted-vector.
3386 ;; The value is nil for a message that would be deleted.
3389 nil
3396 newnum)))
3399 "Return t if expunge is needed and desirable.
3400 If `rmail-confirm-expunge' is non-nil, ask user to confirm."
3407 t)))
3410 "Actually erase all deleted messages in the file."
3415 ;; Discard all undo records for this buffer.
3423 0
3430 ;; Don't make any undo records for the expunging.
3439 new-summary
3448 rmail-current-message nil
3449 rmail-message-vector nil
3450 rmail-deleted-vector nil
3451 rmail-summary-vector nil)
3467 new-summary))
3470 new-msgref))
3478 rmail-total-messages counter
3483 win t)))
3493 ;; The DONT-SHOW argument is new in 23. Does not seem very important.
3495 "Erase deleted messages from Rmail file and summary buffer.
3496 This always shows a message (so as not to leave the Rmail buffer
3497 unswapped), and always updates any summary (so that it remains
3498 consistent with the Rmail buffer). If DONT-SHOW is non-nil, it
3499 does not pop any summary buffer."
3506 ;; We always update the summary buffer, so that the contents
3507 ;; remain consistent with the rmail buffer.
3508 ;; The only difference is, in the dont-show case, we use a
3509 ;; cut-down version of rmail-select-summary that does not pop
3510 ;; the summary buffer. It's only used by rmail-quit, which is
3511 ;; just going to bury any summary immediately after. If we made
3512 ;; rmail-quit bury the summary first, dont-show could be removed.
3513 ;; But the expunge might not be confirmed...
3521 ;; We always show a message, because (rmail-only-expunge t)
3522 ;; leaves the rmail buffer unswapped.
3523 ;; If we expunged the current message, a new one is current now,
3524 ;; so show it. If we weren't showing a message, show it.
3527 ;; We can just show the same message that was being shown before.
3531 \f
3532 ;;;; *** Rmail Mailing Commands ***
3535 replybuffer sendactions same-window
3536 other-headers)
3541 yank-action)
3543 ;; The function used here must behave like insert-buffer wrt
3544 ;; point and mark (see doc of sc-cite-original).
3552 other-headers))
3560 switch-function yank-action sendactions)
3562 ;; This is not a standard frame parameter; nothing except
3563 ;; sendmail.el looks at it.
3568 "NEWBUF is a buffer to switch to."
3570 ;; If there is only one visible frame with no special handling,
3571 ;; consider deleting the mail window to return to Rmail.
3584 mail-bury-selects-summary
3586 rmail-summary-buffer
3589 rmail-summary-buffer))))
3591 ;; If the Rmail buffer has a summary, show that.
3595 ;; If the frame was probably made for this buffer, the user
3596 ;; probably wants to delete it now.
3599 ;; The previous frame is where normally they have the Rmail buffer
3600 ;; displayed.
3604 "Send mail in another window.
3606 original message into it."
3610 ;; FIXME should complain if there is nothing to continue.
3612 "Continue composing outgoing message previously being composed."
3617 "Reply to the current message.
3618 Normally include CC: to all other recipients of original message;
3619 prefix argument means ignore them. While composing the reply,
3625 resent-to resent-cc resent-reply-to
3628 rmail-current-message
3635 from)
3641 ;; Bug#512. It's inappropriate to reply to these addresses.
3642 ;;; resent-cc (and (not just-sender)
3643 ;;; (mail-fetch-field "resent-cc" nil t))
3644 ;;; resent-to (or (mail-fetch-field "resent-to" nil t) "")
3645 ;;; resent-subject (mail-fetch-field "resent-subject")
3646 ;;; resent-date (mail-fetch-field "resent-date")
3647 ;;; resent-message-id (mail-fetch-field "resent-message-id")
3648 )
3651 ;; If this header field is present, use it instead of the
3652 ;; To and CC fields.
3656 ;; Merge the resent-to and resent-cc into the to and cc.
3657 ;; Bug#512. It's inappropriate to reply to these addresses.
3658 ;;; (if (and resent-to (not (equal resent-to "")))
3659 ;;; (if (not (equal to ""))
3660 ;;; (setq to (concat to ", " resent-to))
3661 ;;; (setq to resent-to)))
3662 ;;; (if (and resent-cc (not (equal resent-cc "")))
3663 ;;; (if (not (equal cc ""))
3664 ;;; (setq cc (concat cc ", " resent-cc))
3665 ;;; (setq cc resent-cc)))
3666 ;; Add `Re: ' to subject if not there already.
3673 subject))))
3675 nil
3676 ;; Using mail-strip-quoted-names is undesirable with newer mailers
3677 ;; since they can handle the names unstripped.
3678 ;; I don't know whether there are other mailers that still
3679 ;; need the names to be stripped.
3680 ;;; (mail-strip-quoted-names reply-to)
3681 ;; Remove unwanted names from reply-to, since Mail-Followup-To
3682 ;; header causes all the names in it to wind up in reply-to, not
3683 ;; in cc. But if what's left is an empty list, use the original.
3686 subject
3689 nil
3690 ;; `mail-dont-reply-to' doesn't need `mail-strip-quoted-names'.
3696 rmail-buffer
3697 rmail-view-buffer)
3699 rmail-buffer
3702 rmail-answered-attr-index))
3703 nil
3709 message-id)))))))
3710 \f
3712 "Give BUFFER's message number in MSGNUM-LIST the attribute ATTRIBUTE.
3713 This is use in the send-actions for message buffers.
3714 MSGNUM-LIST is a list of the form (MSGNUM)
3715 which is an element of rmail-msgref-vector."
3723 message-id
3724 nil))
3734 tem))
3735 message-id))
3736 ;; missing From, or Message-ID is sufficiently informative
3737 message-id
3739 ;; Copy TEM, discarding text properties.
3743 ;; Use prin1 to fake RFC822 quoting
3747 field)))))
3750 ;; These strings both match all non-ASCII characters.
3753 ;; "Unix Loser <Foo@bar.edu>" => "Unix Loser"
3754 from)
3757 ;; "<Bugs@bar.edu>" (Losing Unix) => "Losing Unix"
3758 from)))
3761 ;; Trim whitespace which above regexp match allows
3771 ;; "<AA259@bar.edu> (message from Unix Loser on 1-Apr-89)"
3773 field))))
3775 ;; If we can't kludge it simply, do it correctly
3778 \f
3780 "Forward the current message to another user.
3782 see the documentation of `rmail-resend'."
3797 nil nil subject nil nil nil
3799 forward-buffer
3802 rmail-forwarded-attr-index))
3803 ;; If only one window, use it for the mail buffer.
3804 ;; Otherwise, use another window for the mail buffer
3805 ;; so that the Rmail buffer remains visible
3806 ;; and sending the mail will get back to it.
3808 ;; The mail buffer is now current.
3810 ;; Insert after header separator--before signature if any.
3816 forward-buffer)
3817 ;; rmail-insert-mime-forwarded-message-function
3818 ;; works by inserting MML tags into forward-buffer.
3819 ;; The MUA will need to convert it to MIME before
3820 ;; sending. mail-encode-mml tells them to do that.
3821 ;; message.el does that automagically.
3825 ;; Quote lines with `- ' if they start with `-'.
3843 \f
3845 "Resend current message to ADDRESSES.
3846 ADDRESSES should be a single address, a string consisting of several
3847 addresses separated by commas, or a list of addresses.
3849 Optional FROM is the address to resend the message from, and
3850 defaults from the value of `user-mail-address'.
3851 Optional COMMENT is a string to insert as a comment in the resent message.
3852 Optional ALIAS-FILE is alternate aliases file to be used by sendmail,
3853 typically for purposes of moderating a list."
3868 ;;>> Copy message into temp buffer
3875 ;; Delete any Sender field, since that's not specifiable.
3876 ; Only delete Sender fields in the actual header.
3878 ; Using "while" here rather than "if" because some buggy mail
3879 ; software may have inserted multiple Sender fields.
3887 ; Go back to the beginning of the buffer so the Resent- fields
3888 ; are inserted there.
3890 ;;>> Insert resent-from:
3893 ;;>> Insert resent-to: and bcc if need be.
3898 address
3901 ;; Expand abbrevs in the recipients.
3920 ;;>> Set up comment, if any.
3923 after)
3931 ;; Don't expand aliases in the destination fields
3932 ;; of the original message.
3938 \f
3956 ;; This is a cut-down version of rmail-clear-headers from Emacs 22.
3957 ;; It doesn't have the same functionality, hence the name change.
3959 "Delete any mail headers matching REGEXP.
3960 The message should be narrowed to just the headers."
3965 ;; This code from Emacs 22 doesn't seem right, since r-n-h is
3966 ;; just for display.
3967 ;;; (if (looking-at rmail-nonignored-headers)
3968 ;;; (forward-line 1)
3978 "Edit a mail message which is based on the contents of the current message.
3979 For a message rejected by the mail system, extract the interesting headers and
3980 the body of the original message.
3981 If the failed message is a MIME multipart message, it is searched for a
3982 body part with a header which matches the variable `mail-mime-unsent-header'.
3983 Otherwise, the variable `mail-unsent-separator' should match the string that
3984 delimits the returned original message.
3985 The variable `rmail-retry-ignored-headers' is a regular expression
3986 specifying headers which should not be copied into the new message."
3991 bounce-start bounce-end bounce-indent resending
3999 content-type))
4000 ;; Handle a MIME multipart bounce message.
4013 ;; Non-MIME bounce.
4017 ;; Support a style of failure message in which the original
4018 ;; message is indented, and included within lines saying
4019 ;; `Start of returned message' and `End of returned message'.
4028 ;; One message contained a few random lines before
4029 ;; the old message header. The first line of the
4030 ;; message started with two hyphens. A blank line
4031 ;; followed these random lines. The same line
4032 ;; beginning with two hyphens was possibly marking
4033 ;; the end of the message.
4048 ;; We have found the message that bounced, within the current message.
4049 ;; Now start sending new message; default header fields from original.
4050 ;; Turn off the usual actions for initializing the message body
4051 ;; because we want to get only the text from the failure message.
4055 rmail-this-buffer
4057 rmail-retried-attr-index)))
4058 ;; Insert original text as initial text of new draft message.
4059 ;; Bind inhibit-read-only since the header delimiter
4060 ;; of the previous message was probably read-only.
4062 eoh)
4065 bounce-start bounce-end)
4083 \f
4085 "Non-nil if in an RMAIL buffer and an associated summary buffer exists.
4086 In fact, the non-nil value returned is the summary buffer itself."
4088 rmail-summary-buffer))
4091 "t if in RMAIL buffer and an associated summary buffer is displayed."
4095 "Non-nil means Rmail should show the summary when it changes.
4096 This has an effect only if a summary buffer exists."
4101 "Non-nil means specify the height for an Rmail summary window."
4105 ;; Put the summary buffer back on the screen, if user wants that.
4108 window)
4109 ;; If requested, make sure the summary is displayed.
4111 rmail-redisplay-summary
4113 ;; It's already in some frame; show that one.
4119 ;; If requested, set the height of the summary window.
4121 rmail-summary-window-size
4123 ;; Don't try to change the size if just one window in frame.
4130 \f
4131 ;;;; *** Rmail Local Fontification ***
4134 ;; This function's symbol is bound to font-lock-fontify-buffer-function.
4136 ;; If we're already showing a message, fontify it now.
4138 ;; Prevent Font Lock mode from kicking in.
4142 ;; This function's symbol is bound to font-lock-fontify-unbuffer-function.
4145 before-change-functions after-change-functions
4146 buffer-file-name buffer-file-truename)
4156 ;; Fontify the current message if it is not already fontified.
4160 before-change-functions after-change-functions
4161 buffer-file-name buffer-file-truename)
4168 \f
4169 ;;; Speedbar support for RMAIL files.
4173 "*This regex is used to match folder names to be displayed in speedbar.
4174 Enabling this will permit speedbar to display your folders for easy
4184 "Install those variables used by speedbar to enhance rmail."
4186 nil
4195 ;; Mouse-3.
4203 ;; Make sure our special speedbar major mode is loaded
4209 "Create buttons for BUFFER containing rmail messages.
4210 Click on the address under Reply to: to reply to this person.
4211 Under Folders: Click a name to read it, or on the <M> to move the
4212 current message into that RMAIL folder."
4220 nil
4225 nil
4235 default-directory)
4236 nil rmail-speedbar-match-folder-regexp)))
4245 "Execute an rmail command specified by TEXT.
4246 The command used is TOKEN. INDENT is not used."
4251 "Load in the rmail file TEXT.
4252 TOKEN and INDENT are not used."
4258 "If the current line is a folder, move current message to it."
4268 "From button TEXT, copy current message to the rmail file specified by TOKEN.
4269 TEXT and INDENT are not used."
4272 ;; expand-file-name is needed due to the unhelpful way in which
4273 ;; rmail-output expands non-absolute filenames against rmail-default-file.
4274 ;; What is the point of that, anyway?
4276 \f
4277 ;; Functions for setting, getting and encoding the POP password.
4278 ;; The password is encoded to prevent it from being easily accessible
4279 ;; to "prying eyes." Obviously, this encoding isn't "real security,"
4280 ;; nor is it meant to be.
4282 ;;;###autoload
4284 "Set PASSWORD to be used for retrieving mail from a POP or IMAP server."
4293 "Get the password for retrieving mail from a POP or IMAP server. If none
4294 has been set, then prompt the user for one."
4299 "IMAP password: "
4309 "Encode STRING with integer MASK, by taking the exclusive OR of the
4310 lowest byte in the mask with the first character of string, the
4311 second-lowest-byte with the second character of the string, etc.,
4312 restarting at the lowest byte of the mask whenever it runs out.
4313 Returns the encoded string. Calling the function again with an
4314 encoded string (and the same mask) will decode the string."
4328 "Decrypt OpenPGP armors in current message."
4331 ;; Save the current buffer here for cleanliness, in case we
4332 ;; change it in one of the calls to `epa-decrypt-region'.
4338 ;; In case the encrypted data is inside a mime attachment,
4339 ;; show it. This is a kludge; to be clean, it should not
4340 ;; modify the buffer, but I don't see how to do that.
4347 ;; Now find all armored messages in the buffer
4348 ;; and decrypt them one by one.
4352 armor-start armor-end after-end)
4355 nil t))
4360 ;; Because epa--find-coding-system-for-mime-charset not autoloaded.
4363 ;; Use the charset specified in the armor.
4370 ;; Advance over this armor.
4374 ;; Decrypt it, maybe in place, maybe making new buffer.
4376 armor-start armor-end
4377 ;; Call back this function to prepare the output.
4385 decrypts)))
4401 nil t))
4405 \f
4406 ;;;; Desktop support
4409 desktop-buffer-name
4410 desktop-buffer-misc)
4411 "Restore an rmail buffer specified in a desktop file."
4417 rmail-buffer))
4420 nil)))
4425 ;; We use this to record the encoding of the current message before
4426 ;; saving the message collection.
4429 ;; Used in `write-region-annotate-functions' to write rmail files.
4435 nil))
4437 ;; Used to restore the encoding of the buffer where we show the
4438 ;; current message, after we save the message collection. This is
4439 ;; needed because rmail-write-region-annotate switches buffers behind
4440 ;; save-file's back, with the side effect that last-coding-system-used
4441 ;; is assigned to buffer-file-coding-system of the wrong buffer.
4450 \f
4451 ;;; Start of automatically extracted autoloads.
4452 \f
4453 ;;;### (autoloads (rmail-edit-current-message) "rmailedit" "rmailedit.el"
4454 ;;;;;; "090ad9432c3bf9a6098bb9c3d7c71baf")
4455 ;;; Generated autoloads from rmailedit.el
4458 Edit the contents of this message.
4462 ;;;***
4463 \f
4464 ;;;### (autoloads (rmail-next-labeled-message rmail-previous-labeled-message
4465 ;;;;;; rmail-read-label rmail-kill-label rmail-add-label) "rmailkwd"
4466 ;;;;;; "rmailkwd.el" "08c288c88cfe7be50830122c064e3884")
4467 ;;; Generated autoloads from rmailkwd.el
4470 Add LABEL to labels associated with current RMAIL message.
4471 Completes (see `rmail-read-label') over known labels when reading.
4472 LABEL may be a symbol or string. Only one label is allowed.
4477 Remove LABEL from labels associated with current RMAIL message.
4478 Completes (see `rmail-read-label') over known labels when reading.
4479 LABEL may be a symbol or string. Only one label is allowed.
4484 Read a label with completion, prompting with PROMPT.
4485 Completions are chosen from `rmail-label-obarray'. The default
4486 is `rmail-last-label', if that is non-nil. Updates `rmail-last-label'
4487 according to the choice made, and returns a symbol.
4492 Show previous message with one of the labels LABELS.
4493 LABELS should be a comma-separated list of label names.
4494 If LABELS is empty, the last set of labels specified is used.
4495 With prefix argument N moves backward N messages with these labels.
4500 Show next message with one of the labels LABELS.
4501 LABELS should be a comma-separated list of label names.
4502 If LABELS is empty, the last set of labels specified is used.
4503 With prefix argument N moves forward N messages with these labels.
4507 ;;;***
4508 \f
4509 ;;;### (autoloads (rmail-mime) "rmailmm" "rmailmm.el" "2c8675d7c069c68bc36a4003b15448d1")
4510 ;;; Generated autoloads from rmailmm.el
4513 Toggle displaying of a MIME message.
4515 The actualy behavior depends on the value of `rmail-enable-mime'.
4517 If `rmail-enable-mime' is t (default), this command change the
4518 displaying of a MIME message between decoded presentation form
4519 and raw data.
4521 With ARG, toggle the displaying of the current MIME entity only.
4523 If `rmail-enable-mime' is nil, this creates a temporary
4525 content-types are handled according to
4526 `rmail-mime-media-type-handlers-alist'. By default, this
4527 displays text and multipart messages, and offers to download
4528 attachments as specfied by `rmail-mime-attachment-dirs-alist'.
4532 ;;;***
4533 \f
4534 ;;;### (autoloads (set-rmail-inbox-list) "rmailmsc" "rmailmsc.el"
4535 ;;;;;; "ca19b2f8a3e8aa01aa75ca7413f8a5ef")
4536 ;;; Generated autoloads from rmailmsc.el
4539 Set the inbox list of the current RMAIL file to FILE-NAME.
4540 You can specify one file name, or several names separated by commas.
4541 If FILE-NAME is empty, remove any existing inbox list.
4543 This applies only to the current session.
4547 ;;;***
4548 \f
4549 ;;;### (autoloads (rmail-sort-by-labels rmail-sort-by-lines rmail-sort-by-correspondent
4550 ;;;;;; rmail-sort-by-recipient rmail-sort-by-author rmail-sort-by-subject
4551 ;;;;;; rmail-sort-by-date) "rmailsort" "rmailsort.el" "ad1c98fe868c0e5804cf945d6c980d0b")
4552 ;;; Generated autoloads from rmailsort.el
4556 If prefix argument REVERSE is non-nil, sorts in reverse order.
4563 non-nil, sorts in reverse order.
4568 Sort messages of current Rmail buffer by author.
4570 If prefix argument REVERSE is non-nil, sorts in reverse order.
4575 Sort messages of current Rmail buffer by recipient.
4577 If prefix argument REVERSE is non-nil, sorts in reverse order.
4582 Sort messages of current Rmail buffer by other correspondent.
4585 excluded by `mail-dont-reply-to-names'. If prefix argument
4586 REVERSE is non-nil, sorts in reverse order.
4591 Sort messages of current Rmail buffer by the number of lines.
4592 If prefix argument REVERSE is non-nil, sorts in reverse order.
4597 Sort messages of current Rmail buffer by labels.
4598 LABELS is a comma-separated list of labels. The order of these
4599 labels specifies the order of messages: messages with the first
4600 label come first, messages with the second label come second, and
4601 so on. Messages that have none of these labels come last.
4602 If prefix argument REVERSE is non-nil, sorts in reverse order.
4606 ;;;***
4607 \f
4608 ;;;### (autoloads (rmail-summary-by-senders rmail-summary-by-topic
4609 ;;;;;; rmail-summary-by-regexp rmail-summary-by-recipients rmail-summary-by-labels
4610 ;;;;;; rmail-summary) "rmailsum" "rmailsum.el" "3817e21639db697abe5832d3223ecfc2")
4611 ;;; Generated autoloads from rmailsum.el
4614 Display a summary of all messages, one line per message.
4619 Display a summary of all messages with one or more LABELS.
4620 LABELS should be a string containing the desired labels, separated by commas.
4625 Display a summary of all messages with the given RECIPIENTS.
4626 Normally checks the To, From and Cc fields of headers;
4627 but if PRIMARY-ONLY is non-nil (prefix arg given),
4628 only look in the To and From fields.
4629 RECIPIENTS is a string of regexps separated by commas.
4634 Display a summary of all messages according to regexp REGEXP.
4635 If the regular expression is found in the header of the message
4636 \(including in the date and other lines, as well as the subject line),
4637 Emacs will list the message in the summary.
4642 Display a summary of all messages with the given SUBJECT.
4643 Normally checks just the Subject field of headers; but with prefix
4644 argument WHOLE-MESSAGE is non-nil, looks in the whole message.
4645 SUBJECT is a string of regexps separated by commas.
4651 SENDERS is a string of regexps separated by commas.
4655 ;;;***
4656 \f
4657 ;;;### (autoloads (unforward-rmail-message undigestify-rmail-message)
4658 ;;;;;; "undigest" "undigest.el" "41e6a48ea63224385c447a944528feb6")
4659 ;;; Generated autoloads from undigest.el
4662 Break up a digest message into its constituent messages.
4663 Leaves original message, deleted, before the undigestified messages.
4668 Extract a forwarded message from the containing message.
4669 This puts the forwarded message into a separate rmail message
4670 following the containing message.
4674 ;;;***
4675 \f
4676 ;;; End of automatically extracted autoloads.
4681 ;;; rmail.el ends here