| blob | a737b99c29ece5745d77acbf199ba14f09363a6b |
1 ;;; rmail.el --- main code of "RMAIL" mail reader for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 ;; Free Software Foundation, Inc.
7 ;; Maintainer: FSF
8 ;; Keywords: mail
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;;; Code:
29 ;; Souped up by shane@mit-ajax based on ideas of rlk@athena.mit.edu
30 ;; New features include attribute and keyword support, message
31 ;; selection by dispatch table, summary by attributes and keywords,
32 ;; expunging by dispatch table, sticky options for file commands.
34 ;; Extended by Bob Weiner of Motorola
35 ;; New features include: rmail and rmail-summary buffers remain
36 ;; synchronized and key bindings basically operate the same way in both
37 ;; buffers, summary by topic or by regular expression, rmail-reply-prefix
38 ;; variable, and a bury rmail buffer (wipe) command.
39 ;;
49 ;;; Attribute indexes
84 "An array that provides a mapping between an attribute index,
96 "The current header display style choice, one of
99 ;; rmail-spool-directory and rmail-file-name are defined in paths.el.
102 "Mail reader for Emacs."
106 "Rmail retrieval options."
111 "Rmail files."
116 "Rmail header options."
121 "Rmail reply options."
126 "Rmail summary options."
132 "Output message to a file."
138 "Rmail editing."
143 "If non-nil, the file name of the `movemail' program."
151 "Password to use when reading mail from a remote server.
152 This setting is ignored for mailboxes whose URL already contains a password."
162 "Non-nil if a password is required when reading mail from a remote server."
168 "List of flags to pass to movemail.
169 Most commonly used to specify `-g' to enable GSS-API authentication
170 or `-k' to enable Kerberos authentication."
177 "Regular expression matching incorrect-password POP or IMAP server error
178 messages.
179 If you get an incorrect-password error that this expression does not match,
185 "Non-nil means leave incoming mail in the user's inbox--don't delete it."
190 "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
289 "A regexp specifying addresses to prune from a reply message.
290 If this is nil, it is set the first time you compose a reply, to
291 a value which excludes your own email address, plus whatever is
292 specified by `rmail-default-dont-reply-to-names'.
294 Matching addresses are excluded from the CC field in replies, and
295 also the To field, unless this would leave an empty To field."
299 ;;;###autoload
301 "Regexp specifying part of the default value of `rmail-dont-reply-to-names'.
302 This is used when the user does not set `rmail-dont-reply-to-names'
303 explicitly. (The other part of the default value is the user's
304 email address and name.) It is useful to set this variable in
305 the site customization file. The default value is conventionally
307 ;; Is it really useful to set this site-wide?
309 ;;;###autoload
329 "Regexp to match header fields that Rmail should normally hide.
330 \(See also `rmail-nonignored-headers', which overrides this regexp.)
331 This variable is used for reformatting the message header,
332 which normally happens once for each message,
333 when you view the message for the first time in Rmail.
334 To make a change in this variable take effect
335 for a message that you have already viewed,
341 "Regexp to match X header fields that Rmail should show.
342 This regexp overrides `rmail-ignored-headers'; if both this regexp
343 and that one match a certain header field, Rmail shows the field.
344 If this is nil, ignore all header fields in `rmail-ignored-headers'.
346 This variable is used for reformatting the message header,
347 which normally happens once for each message,
348 when you view the message for the first time in Rmail.
349 To make a change in this variable take effect
350 for a message that you have already viewed,
355 ;;;###autoload
357 "Regexp to match Header fields that Rmail should display.
358 If nil, display all header fields except those matched by
359 `rmail-ignored-headers'."
363 ;;;###autoload
364 (defcustom rmail-retry-ignored-headers (purecopy "^x-authentication-warning:\\|^x-detected-operating-system:\\|^x-spam[-a-z]*:\\|content-type:\\|content-transfer-encoding:\\|mime-version:")
365 "Headers that should be stripped when retrying a failed message."
370 ;;;###autoload
372 "Regexp to match Header fields that Rmail should normally highlight.
373 A value of nil means don't highlight. Uses the face `rmail-highlight'."
379 "Face to use for highlighting the most important header fields.
380 The variable `rmail-highlighted-headers' specifies which headers."
386 "Face to use for highlighting the header names.
387 The variable `rmail-font-lock-keywords' specifies which headers
388 get highlighted."
393 "Non-nil means automatically delete a message that is copied to a file."
397 ;;;###autoload
399 "List of files that are inboxes for your primary mail file `rmail-file-name'.
400 If this is nil, uses the environment variable MAIL. If that is
401 unset, uses a file named by the function `user-login-name' in the
402 directory `rmail-spool-directory' (whose value depends on the
404 ;; Don't use backquote here, because we don't want to need it at load time.
405 ;; (That must be an old comment - it's dumped these days.)
415 "Non-nil means Rmail makes a new frame for composing outgoing mail.
416 This is handy if you want to preserve the window configuration of
417 the frame where you have the RMAIL buffer displayed."
421 ;;;###autoload
423 "Directory for additional secondary Rmail files."
426 ;;;###autoload
428 "Regexp for which files are secondary Rmail files."
433 "Whether and how to ask for confirmation before expunging deleted messages.
434 The value, if non-nil is a function to call with a question (string)
435 as argument, to ask the user that question."
443 ;;;###autoload
450 ;;;###autoload
452 "List of functions to call when Rmail displays a message."
461 "List of functions to call when Rmail deletes a message.
462 When the hooks are called, the message has been marked deleted but is
465 ;; These may be altered by site-init.el to match the format of mmdf files
466 ;; delimiting used on a given host (delim1 and delim2 from the config
467 ;; files).
474 ;; FIXME Post-mbox, this is now unused.
475 ;; In Emacs-22, this was called:
476 ;; i) the very first time a message was shown.
477 ;; ii) when toggling the headers to the normal state, every time.
478 ;; It's not clear what it should do now, since there is nothing that
479 ;; records when a message is shown for the first time (unseen is not
480 ;; necessarily the same thing).
482 "If non-nil, a filter function for new messages in RMAIL.
483 Called with region narrowed to the message, including headers,
484 before obeying `rmail-ignored-headers'."
489 "List of directives specifying where to put a message.
490 Each element of the list is of the form:
492 (FOLDERNAME FIELD REGEXP [ FIELD REGEXP ] ... )
494 Where FOLDERNAME is the name of a folder to put the message.
495 If any of the field regexp's are nil, then it is ignored.
498 If FOLDERNAME is nil then it is deleted, and skipped.
500 FIELD is the plain text name of a field in the message, such as
504 REGEXP is an expression to match in the preceeding specified FIELD.
505 FIELD/REGEXP pairs continue in the list.
507 examples:
511 Note that this is only applied in the folder specifed by `rmail-file-name'."
519 ;; Some mailers use "Re(2):" or "Re^2:" or "Re: Re:" or "Re[2]:".
520 ;; This pattern should catch all the common variants.
521 ;; rms: I deleted the change to delete tags in square brackets
522 ;; because they mess up RT tags.
527 "If non-nil, Rmail always displays the summary buffer."
530 \f
535 "The RMAIL buffer related to the current buffer.
536 In an RMAIL buffer, this holds the RMAIL buffer itself.
548 ;; Message counters and markers. Deleted flags.
555 "Integer specifying the total number of messages in this folder.
560 "Vector of markers specifying the start and end of each message.
565 "A string of length `rmail-total-messages' plus one.
571 "In an Rmail buffer, a vector whose Nth element is a list (N).
572 When expunging renumbers messages, these lists are modified
579 ;; These are used by autoloaded rmail-summary.
584 "In an Rmail buffer, vector of (newline-terminated) strings.
588 ;; Rmail buffer swapping variables.
599 \f
600 ;; `Sticky' default variables.
602 ;; Last individual label specified to a or k.
605 ;; Last set of values specified to C-M-n, C-M-p, C-M-s or C-M-l.
621 ;; Mule and MIME related variables.
623 ;;;###autoload
625 "Coding system used in RMAIL file.
630 "If non-nil, RMAIL uses MIME features.
631 If the value is t, RMAIL automatically shows MIME decoded message.
632 If the value is neither t nor nil, RMAIL does not show MIME decoded message
633 until a user explicitly requires it.
635 Even if the value is non-nil, you can't use MIME features
636 unless the feature specified by `rmail-mime-feature' is available."
645 ;; FIXME unused.
647 "Function to show MIME decoded message of RMAIL file.
648 This function is called when `rmail-enable-mime' is non-nil.
651 ;;;###autoload
653 "Function to insert a message in MIME format so it can be forwarded.
654 This function is called if `rmail-enable-mime' or
655 `rmail-enable-mime-composing' is non-nil.
656 It is called with one argument FORWARD-BUFFER, which is a
657 buffer containing the message to forward. The current buffer
661 "Function to insert a message in MIME format so it can be resent.
662 This function is called by `rmail-resend' if `rmail-enable-mime' is non-nil.
663 It is called with one argument FORWARD-BUFFER, which is a
664 buffer containing the message to forward. The current buffer
667 ;; FIXME one might want to pass a LIMIT, as per
668 ;; rmail-search-mime-header-function.
670 "Function to check if a regexp matches a MIME message.
671 This function is called by `rmail-search-message' if
672 `rmail-enable-mime' is non-nil. It is called (with point at the
673 start of the message) with two arguments MSG and REGEXP, where
677 "Function to check if a regexp matches a header of MIME message.
678 This function is called by `rmail-message-regexp-p-1' if
679 `rmail-enable-mime' is non-nil. It is called (with point at the
680 start of the header) with three arguments MSG, REGEXP, and LIMIT,
681 where MSG is the message number, REGEXP is the regular
685 "Feature to require to load MIME support in Rmail.
686 When starting Rmail, if `rmail-enable-mime' is non-nil,
687 this feature is required with `require'.
689 The default value is `rmail-mime'. This feature is provided by
692 ;; FIXME this is unused.
694 "*Non-nil means a message is decoded by MIME's charset specification.
695 If this variable is nil, or the message has not MIME specification,
696 the message is decoded as normal way.
698 If the variable `rmail-enable-mime' is non-nil, this variable is
699 ignored, and all the decoding work is done by a feature specified by
706 "Regexp to match MIME-charset specification in a header of message.
709 \f
717 "From "
719 ;; Many things can happen to an RFC 822 mailbox before it is put into
720 ;; a `From' line. The leading phrase can be stripped, e.g.
721 ;; `Joe <@w.x:joe@y.z>' -> `<@w.x:joe@y.z>'. The <> can be stripped, e.g.
722 ;; `<@x.y:joe@y.z>' -> `@x.y:joe@y.z'. Everything starting with a CRLF
723 ;; can be removed, e.g.
724 ;; From: joe@y.z (Joe K
725 ;; User)
726 ;; can yield `From joe@y.z (Joe K Fri Mar 22 08:11:15 1996', and
727 ;; From: Joe User
728 ;; <joe@y.z>
729 ;; can yield `From Joe User Fri Mar 22 08:11:15 1996'.
730 ;; The mailbox can be removed or be replaced by white space, e.g.
731 ;; From: "Joe User"{space}{tab}
732 ;; <joe@y.z>
733 ;; can yield `From {space}{tab} Fri Mar 22 08:11:15 1996',
734 ;; where {space} and {tab} represent the Ascii space and tab characters.
735 ;; We want to match the results of any of these manglings.
736 ;; The following regexp rejects names whose first characters are
737 ;; obviously bogus, but after that anything goes.
740 ;; The time the message was sent.
746 ;; Perhaps a time zone, specified by an abbreviation, or by a
747 ;; numeric offset.
748 time-zone-regexp
750 ;; The year.
753 ;; On some systems the time zone can appear after the year, too.
754 time-zone-regexp
756 ;; Old uucp cruft.
760 "Regexp matching the delimiter of messages in UNIX mail format
761 \(UNIX From lines), minus the initial ^. Note that if you change
762 this expression, you must change the code in `rmail-nuke-pinhead-header'
765 ;; FIXME the rmail-header-name headers ought to be customizable.
766 ;; It seems a bit arbitrary, for example, that all of the Date: line
767 ;; gets highlighted.
769 ;; These are all matched case-insensitively.
777 ;; FIXME Mail-Followup-To should probably be here too.
782 ;; Use MATCH-ANCHORED to effectively anchor the regexp left side.
783 `(,cite-chars
795 ;; Rmail does not expect horizontal splitting. (Bug#2282)
797 "Like `pop-to-buffer', but with `split-width-threshold' set to nil."
801 ;; Perform BODY in the summary buffer
802 ;; in such a way that its cursor is properly updated in its own window.
811 ;; rmail-total-messages is a buffer-local var
812 ;; in the rmail buffer.
813 ;; This way we make it available for the body
814 ;; even tho the rmail buffer is not current.
822 \f
823 ;;;; *** Rmail Mode ***
826 "Require `rmail-mime-feature' if that is non-nil.
827 Signal an error and set `rmail-mime-feature' to nil if the feature
828 isn't provided."
834 'rmail
836 by setting `rmail-enable-mime' to non-nil, the required feature
837 `%s' (the value of `rmail-mime-feature')
838 is not available in the current session.
839 So, the MIME support is turned off for the moment."
840 rmail-mime-feature)
845 ;;;###autoload
847 "Read and edit incoming mail.
848 Moves messages into file named by `rmail-file-name' and edits that
849 file in RMAIL Mode.
852 May be called with file name as argument; then performs rmail editing on
853 that file, but does not copy any new mail into the file.
854 Interactively, if you supply a prefix argument, then you
855 have a chance to specify a file name with the minibuffer.
857 If `rmail-display-summary' is non-nil, make a summary for this RMAIL file."
862 ;; Use find-buffer-visiting, not get-file-buffer, for those users
863 ;; who have find-file-visit-truename set to t.
865 run-mail-hook mail-buf msg-shown)
866 ;; Determine if an existing mail file has been changed behind the
867 ;; scene...
869 ;; The mail file has been changed. Revisit it and reset the
870 ;; message state variables when in rmail mode.
877 ;; The mail file is either unchanged or not visited. Visit it.
880 ;; Force no-conversion by default, since that's what
881 ;; pre-mbox Rmail did with BABYL files (via
882 ;; auto-coding-regexp-alist).
886 ;; Ensure that the collection and view buffers are in sync and
887 ;; ensure that a message is not being edited.
894 ;; Ensure that the Rmail file is in mbox format, the buffer is in
895 ;; Rmail mode and has been scanned to find all the messages
896 ;; (setting the global message variables in the process).
903 ;; Show the first unread message and process summary mode.
905 ;; Only get new mail when there is not a file name argument.
918 "Determine if the file needs to be converted to mbox format."
921 ;; Detect previous Babyl format files.
924 ;; The file is Babyl version 5. Use unrmail to convert
925 ;; it.
928 ;; Losing babyl file made by old version of Rmail. Fix the
929 ;; babyl file header and use unrmail to convert to mbox
930 ;; format.
940 "Report that the buffer is not in the mbox file format.
941 MSGNUM, if present, indicates the malformed message."
947 "Convert the mail file from Babyl version 5 to mbox.
948 This function also reinitializes local variables used by Rmail."
962 ;; Rmail buffers need to be saved with Unix EOLs, or else
963 ;; the format will not be recognized.
977 "Return a suitable coding system to use for the current mail message.
978 The buffer is expected to be narrowed to just the header of the message."
984 \f
985 ;;; Set up Rmail mode keymaps
996 ;; If you change this, change the rmail-resend menu-item's :keys.
1021 ;; I find I can't live without the default M-r command -- rms.
1022 ;; (define-key rmail-mode-map "\er" 'rmail-search-backwards)
1048 \f
1055 nil)
1058 nil)
1165 map)
1168 ;; Rmail toolbar
1172 map rmail-mode-map)
1174 map rmail-mode-map)
1176 map rmail-mode-map)
1178 map rmail-mode-map)
1180 map rmail-mode-map)
1182 map rmail-mode-map)
1184 map rmail-mode-map)
1186 map rmail-mode-map)
1188 map rmail-mode-map)
1190 map rmail-mode-map)
1192 map rmail-mode-map)
1194 map rmail-mode-map)
1195 map))
1198 \f
1199 ;; Rmail mode is suitable only for specially formatted data.
1207 ;;;###autoload
1210 All normal editing commands are turned off.
1211 Instead, these commands are available:
1227 \\[rmail-undelete-previous-message] Undelete message. Tries current message, then earlier messages
1228 till a deleted message is found.
1229 \\[rmail-edit-current-message] Edit the current message. \\[rmail-cease-edit] to return to Rmail.
1242 \\[rmail-output-body-to-file] Save message body to a file. Default filename comes from Subject line.
1247 (label defaults to last one specified).
1248 Standard labels: filed, unseen, answered, forwarded, deleted.
1286 ;; No need to auto save RMAIL files in normal circumstances
1287 ;; because they contain no info except attribute changes
1288 ;; and deletion of messages.
1289 ;; The one exception is when messages are copied into another mbox buffer.
1290 ;; rmail-output enables auto save when you do that.
1295 ;; Functions to support buffer swapping:
1302 "Return a reusable buffer suitable for viewing messages.
1303 Create the buffer if necessary."
1304 ;; We want to reuse any existing view buffer, so as not to create an
1305 ;; endless number of them. But we must avoid clashes if we visit
1306 ;; two different rmail files with the same basename (Bug#4593).
1309 rmail-view-buffer
1315 "Swap text between current buffer and `rmail-view-buffer'.
1316 This function preserves the current buffer's modified flag, and also
1317 sets the current buffer's `buffer-file-coding-system' to that of
1318 `rmail-view-buffer'."
1325 buffer-file-coding-system)))
1334 "Return non-nil if the message collection is in `rmail-view-buffer'."
1335 ;; This is analogous to tar-data-swapped-p in tar-mode.el.
1337 rmail-buffer-swapped))
1340 ;; Bring the actual Rmail messages back into the main buffer.
1346 "Determine if the Rmail buffer is showing a message.
1347 If so restore the actual mbox message collection."
1354 "Warn if important modifications would change Rmail file's format."
1357 ;; If it's already modified, don't warn again.
1374 ;; Set up the permanent locals associated with an Rmail file.
1387 ;; Note that this does not erase the buffer. Should it?
1388 ;; It depends on how this is called. If somehow called with the
1389 ;; rmail buffers swapped, it would erase the message collection.
1392 ;; Force C-x C-s write Unix EOLs.
1402 ;; Provide default set of inboxes for primary mail file ~/RMAIL.
1410 ;; FIXME expand-file-name?
1415 ;; Set up the non-permanent locals associated with Rmail mode.
1417 ;; Turn off undo. We turn it back on in rmail-edit.
1419 ;; Don't let a local variables list in a message cause confusion.
1422 ;; Don't turn off auto-saving based on the size of the buffer
1423 ;; because that code does not understand buffer-swapping.
1431 t t nil nil
1446 \f
1447 ;; Handle M-x revert-buffer done in an rmail-mode buffer.
1452 ;; See similar code in `rmail'.
1453 ;; FIXME needs updating?
1456 ;; Call our caller again, but this time it does the default thing.
1458 ;; If the user said "yes", and we changed something,
1459 ;; reparse the messages.
1462 ;; Convert all or part to Babyl file if possible.
1464 ;; We have read the file as raw-text, so the buffer is set to
1465 ;; unibyte. Make it multibyte if necessary.
1475 "Expunge and save RMAIL file."
1479 ;; No need to swap buffers: rmail-write-region-annotate takes care of it.
1480 ;; (rmail-swap-buffers-maybe)
1486 "Quit out of RMAIL.
1487 Hook `rmail-quit-hook' is run after expunging."
1494 ;; Don't switch to the summary buffer even if it was recently visible.
1513 "Bury current Rmail buffer and its summary buffer."
1515 ;; This let var was called rmail-buffer, but that interfered
1516 ;; with the buffer-local var used in summary buffers.
1524 \f
1526 "Create a duplicated copy of the current message.
1527 The duplicate copy goes into the Rmail file just after the original."
1528 ;; If we are in a summary buffer, switch to the Rmail buffer.
1529 ;; FIXME simpler to swap the contents, not the buffers?
1551 \f
1552 ;;;###autoload
1554 "Run Rmail on file FILENAME."
1558 ;; This used to scan subdirectories recursively, but someone pointed out
1559 ;; that if the user wants that, person can put all the files in one dir.
1560 ;; And the recursive scan was slow. So I took it out.
1561 ;; rms, Sep 1996.
1563 "Return list of file in dir START that match `rmail-secondary-file-regexp'."
1565 ;; Don't sort here.
1568 ;; Sort here instead of in directory-files
1569 ;; because this list is usually much shorter.
1574 name)
1594 item)
1595 rmail-secondary-file-directory)))))
1599 menu))
1601 ;; This command is always "disabled" when it appears in a menu.
1611 files
1616 files
1624 \f
1625 ;;;; *** Rmail input ***
1635 ;; RLK feature not added in this version:
1636 ;; argument specifies inbox file or files in various ways.
1638 ;; In Babyl, the Mail: header in the preamble overrode rmail-inbox-list.
1639 ;; Mbox does not have this feature.
1641 "Move any new mail from this Rmail file's inbox files.
1642 The buffer-local variable `rmail-inbox-list' specifies the list
1643 of inbox files. By default, this is nil, except for your primary
1644 Rmail file `rmail-file-name'. In this case, when you first visit
1645 the Rmail file it is initialized using either
1647 or the function `user-login-name' and the directory
1648 `rmail-spool-directory' (whose value depends on the operating system).
1650 The command `set-rmail-inbox-list' sets `rmail-inbox-list' to the
1651 value you specify.
1653 You can also specify the file to get new mail from just for one
1654 instance of this command. In this case, the file of new mail is
1655 not changed or deleted. Noninteractively, you can pass the inbox
1656 file name as an argument. Interactively, a prefix argument
1657 causes us to read a file name and use that file as the inbox.
1659 If the variable `rmail-preserve-inbox' is non-nil, new mail will
1660 always be left in inbox files rather than deleted.
1662 Before doing anything, this runs `rmail-before-get-new-mail-hook'.
1663 Just before returning, it runs `rmail-after-get-new-mail-hook',
1664 whether or not there is new mail.
1666 If there is new mail, it runs `rmail-get-new-mail-hook', saves
1667 the updated file, and shows the first unseen message (which might
1668 not be a new one). It returns non-nil if it got any new messages."
1673 ;; If the disk file has been changed from under us,
1674 ;; revert to it before we get new mail.
1682 ;; Get rid of all undo records for this buffer.
1687 found)
1690 ;; This loops if any members of the inbox list have the same
1691 ;; basename (see "name conflict" below).
1694 ;; If buffer has not changed yet, and has not been
1695 ;; saved yet, don't replace the old backup file now.
1699 ;; Don't make undo records while getting mail.
1701 delete-files success files file-last-names)
1702 ;; Pull files off all-files onto files as long as there is
1703 ;; no name conflict. A conflict happens when two inbox
1704 ;; file names have the same last component.
1705 ;; The reason this careful handling is necessary seems
1706 ;; to be that rmail-insert-inbox-text uses .newmail-BASENAME.
1709 file-last-names)))
1711 file-last-names
1714 ;; Put them back in their original order.
1716 ;; In case of brain damage caused by require-final-newline.
1722 found))))
1723 ;; Move to the first new message unless we have other unseen
1724 ;; messages before it.
1727 found)
1728 ;; Don't leave the buffer screwed up if we get a disk-full error.
1735 "Return t if new messages are detected without error, nil otherwise."
1740 rmail-use-spam-filter))
1742 result success suffix)
1744 ;; Read in the contents of the inbox files, renaming them as
1745 ;; necessary, and adding to the list of files to delete
1746 ;; eventually.
1750 ;; Scan the new text and convert each message to
1751 ;; Rmail/mbox format.
1757 success t)
1758 ;; Try to delete the garbage just inserted.
1760 ;; If we could not convert the file's inboxes, rename the
1761 ;; files we tried to read so we won't over and over again.
1770 ;; Determine if there are messages.
1772 ;; There are. Process them.
1777 ;; Delete the old files, now that the Rmail file is saved.
1780 ;; First, try deleting.
1784 ;; If we can't delete it, truncate it.
1797 ;; Establish the return value.
1799 result))))
1802 "Parse the supplied URL. Return (list MAILBOX-NAME REMOTE PASSWORD GOT-PASSWORD)
1803 WHERE MAILBOX-NAME is the name of the mailbox suitable as argument to the
1804 actual version of `movemail', REMOTE is non-nil if MAILBOX-NAME refers to
1805 a remote mailbox, PASSWORD is the password if it should be
1806 supplied as a separate argument to `movemail' or nil otherwise, GOT-PASSWORD
1807 is non-nil if the user has supplied the password interactively.
1808 "
1823 ;; The password is embedded. Strip it out since movemail
1824 ;; does not really like it, in spite of the movemail spec.
1830 t
1832 got-password)
1837 got-password))))
1855 "Replace newly read mail in Babyl format with equivalent mbox format.
1857 FROM-FILE is the Babyl file from which the new mail should be read."
1859 size)
1867 size)))
1870 "If newly read mail from FILE is in Babyl format, convert it to mbox format.
1872 SIZE is the original size of the newly read mail.
1873 Value is the size of the newly read mail after conversion."
1874 ;; Detect previous Babyl format files.
1877 new-file)
1879 ;; The new mail is in Babyl version 5 format. Use unrmail
1880 ;; to convert it.
1883 ;; New mail is in Babyl format made by old version of
1884 ;; Rmail. Fix the babyl file header and use unrmail to
1885 ;; convert it.
1895 size))
1898 ;; Detect a locked file now, so that we avoid moving mail
1899 ;; out of the real inbox file. (That could scare people.)
1905 ;; Handle remote mailbox names specially; don't expand as filenames
1906 ;; in case the userid contains a directory separator.
1919 ;; Generate name to move to from inbox name,
1920 ;; in case of multiple inboxes that need moving.
1924 ;; cannot have colons in file name
1926 file)))
1927 ;; Use the directory of this rmail file
1928 ;; because it's a nuisance to use the homedir
1929 ;; if that is on a full disk and this rmail
1930 ;; file isn't.
1933 ;; Always use movemail to rename the file,
1934 ;; since there can be mailboxes in various directories.
1936 ;; On some systems, /usr/spool/mail/foo is a directory
1937 ;; and the actual inbox is /usr/spool/mail/foo/foo.
1940 file))))
1949 ;; Set TOFILE if have not already done so, and
1950 ;; rename or copy the file FILE to TOFILE if and as appropriate.
1955 nil)
1965 nil)
1968 rmail-movemail-flags)
1973 ;; No output => movemail won
1974 nil
1985 ;; If we just read the password, most likely it is
1986 ;; wrong. Otherwise, see if there is a specific
1987 ;; reason to think that the problem is a wrong passwd.
1990 nil t))
1993 ;; If using Mailutils, remove initial error code
1994 ;; abbreviation
2005 nil)))))
2007 ;; At this point, TOFILE contains the name to read:
2008 ;; Either the alternate name (if we renamed)
2009 ;; or the actual inbox (if not renaming).
2012 size)
2015 ;; If new mail is in Babyl format, convert it to mbox.
2017 tofile
2019 ;; Determine if a pair of newline message separators need
2020 ;; to be added to the new collection of messages. This is
2021 ;; the case for all new message collections added to a
2022 ;; non-empty mail file.
2039 delete-files))
2041 ;; Decode the region specified by FROM and TO by CODING.
2042 ;; If CODING is nil or an invalid coding system, decode by `undecided'.
2046 ;; Use -dos decoding, to remove ^M characters left from base64 or
2047 ;; rogue qp-encoded text.
2050 ;; Don't reveal the fact we used -dos decoding, as users generally
2051 ;; will not expect the RMAIL buffer to use DOS EOL format.
2064 "Ensure a message ends in a blank line.
2065 Call with point at the end of the message."
2072 "Validate the RFC2822 format for the new messages.
2073 Point should be at the first new message.
2074 An error is signalled if the new messages are not RFC2822
2075 compliant.
2076 Unless an Rmail attribute header already exists, add it to the
2077 new messages. Return the number of new messages."
2085 limit stop)
2086 ;; Detect an empty inbox file.
2088 ;; Scan the new messages to establish a count and to ensure that
2089 ;; an attribute header is present.
2092 ;; Determine if a new attribute header needs to be
2093 ;; added to the message.
2103 ;; Move to the next message.
2110 count))))
2111 \f
2113 "Subroutine of `rmail-get-header'.
2114 Narrow to header, call `mail-fetch-field' to find header NAME."
2122 "Return the value of message header NAME, nil if it has none.
2123 MSGNUM specifies the message number to get it from.
2124 If MSGNUM is nil, use the current message."
2128 "Subroutine of `rmail-set-header'.
2129 Narrow to header, set header NAME to VALUE, replacing existing if present.
2130 VALUE nil means to remove NAME altogether."
2147 "Set message header NAME to VALUE in message number MSGNUM.
2148 If MSGNUM is nil, use the current message. NAME and VALUE are strings.
2149 VALUE may also be nil, meaning to remove the header."
2152 ;; Ensure header changes get saved.
2153 ;; (Note replacing a header with an identical copy modifies.)
2155 ;; However: don't save in mbox format over a Babyl file
2156 ;; merely because of this.
2158 \f
2159 ;;;; *** Rmail Attributes and Keywords ***
2162 "Return the message attributes in a comma separated string.
2163 MSG specifies the message number to get it from.
2164 If MSG is nil, use the current message."
2167 result temp)
2174 result
2179 result)))
2182 "Return the message keywords in a comma separated string.
2183 MSG, if non-nil, identifies the message number to use.
2184 If nil, that means the current message."
2188 "Return a string with the labels (attributes and keywords) of msg MSG.
2189 It is put in comma-separated form.
2190 MSG, if non-nil, identifies the message number to use.
2191 If nil, that means the current message."
2194 ;; Combine the message attributes and keywords
2195 ;; into a comma-separated list.
2201 ;; FIXME ? old rmail did not have spaces in the comma-separated lists.
2208 "Update the current messages's attributes and keywords in mode line."
2212 rmail-current-message rmail-total-messages blurb))
2213 ;; If rmail-enable-mime is non-nil, we may have to update
2214 ;; `mode-line-process' of rmail-view-buffer too.
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 start position for message number N."
2329 "Return the end 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
2690 ;; bracket the message in the mail
2691 ;; buffer and determine the coding system the transfer encoding.
2711 ;; Decode the message body into an empty view buffer using a
2712 ;; unibyte temporary buffer where the character decoding takes
2713 ;; place.
2715 ;; We give the view buffer a buffer-local value of
2716 ;; rmail-header-style based on the binding in effect when
2717 ;; this function is called; `rmail-toggle-headers' can
2718 ;; inspect this value to determine how to toggle.
2722 ;; Do it directly since that is fast.
2724 ;; Can this be done directly, skipping the temp buffer?
2730 ;; See bug#5441.
2740 coding-system view-buf)))
2742 ;; Unquote quoted From lines
2749 ;; Copy the headers to the front of the message view buffer.
2751 ;; Add the separator (blank line) between headers and body;
2752 ;; highlight the message, activate any URL like text and add
2753 ;; special highlighting for and quoted material.
2758 ;(rmail-activate-urls)
2759 ;(rmail-process-quoted-material)
2760 )
2761 ;; Update the mode-line with message status information and swap
2762 ;; the view buffer/mail buffer contents.
2769 blurb))
2772 "Copy displayed header fields to the message viewer buffer.
2773 BEG and END marks the start and end positions of the message in
2774 the mbox buffer. If the optional argument IGNORED-HEADERS is
2775 non-nil, ignore all header fields whose names match that regexp.
2776 Otherwise, if `rmail-displayed-headers' is non-nil, copy only
2777 those header fields whose names match that regexp. Otherwise,
2778 copy all header fields whose names do not match
2779 `rmail-ignored-headers' (unless they also match
2780 `rmail-nonignored-headers'). Moves point in the message viewer
2781 buffer to the end of the headers."
2783 lim)
2788 ;; Put point right after the From header line.
2795 ;; Handle the case where all headers should be copied.
2798 ;; rmail-show-message-1 expects this function to leave point
2799 ;; at the end of the headers.
2805 ;; Handle the case where the headers matching the displayed
2806 ;; headers regexp should be copied.
2816 ;; Handle the ignored headers.
2831 "Decode the body of the current message using coding system CODING.
2832 This is useful with mail messages that have malformed or missing
2833 charset= headers.
2835 This function assumes that the current message is already decoded
2836 and displayed in the RMAIL buffer, but the coding system used to
2837 decode it was incorrect. It then decodes the message again,
2838 using the coding system CODING."
2848 body-start x-coding-header old-coding)
2855 ;; Narrow to headers
2863 ;; Make sure the new coding system uses the same EOL
2864 ;; conversion, to prevent ^M characters from popping up
2865 ;; all over the place.
2873 ;; Rewrite the coding-system header.
2885 "Highlight the headers specified by `rmail-highlighted-headers'.
2886 Uses the face `rmail-highlight'."
2894 ;; List of overlays to reuse.
2900 overlay)
2903 ;; Back up over newline, then trailing spaces or tabs
2908 ;; Reuse an overlay we already have.
2914 ;; Make a new overlay and add it to
2915 ;; rmail-overlay-list.
2922 "Automatically move a message into a sub-folder based on criteria.
2923 Called when a new message is displayed."
2928 ;; Do nothing if the message has already been filed or if there
2929 ;; are no messages.
2930 nil
2931 ;; Find out some basics (common fields)
2949 ;; If there are no directives left, then it was a complete match.
2958 \f
2959 ;; Simple message motion commands.
2962 "Show following message whether deleted or not.
2963 With prefix arg N, moves forward N messages, or backward if N is negative."
2970 "Show previous message whether deleted or not.
2971 With prefix arg N, moves backward N messages, or forward if N is negative."
2976 "Show following non-deleted message.
2977 With prefix arg N, moves forward N non-deleted messages,
2978 or backward if N is negative.
2980 Returns t if a new message is being shown, nil otherwise."
2996 t)
3001 nil)))
3004 "Show previous non-deleted message.
3005 With prefix argument N, moves backward N non-deleted messages,
3006 or forward if N is negative."
3011 "Show first message in file."
3017 "Show last message in file."
3023 "For debugging Rmail: find the message number that point is in."
3028 rmail-view-buffer
3037 \f
3038 ;; Searching in Rmail file.
3041 "Return non-nil, if for message number MSG, regexp REGEXP matches."
3042 ;; This is adequate because its only caller, rmail-search,
3043 ;; unswaps the buffers.
3053 "Show message containing next match for REGEXP (but not the current msg).
3054 Prefix argument gives repeat count; negative argument means search
3055 backwards (through earlier messages).
3056 Interactively, empty argument means use same regexp used last time."
3061 regexp)
3078 regexp)
3084 found)
3090 ;; Check messages one by one, advancing message number up or
3091 ;; down but searching forward through each message.
3103 ;; Search forward (if this is a normal search) or backward
3104 ;; (if this is a reverse search) through this message to
3105 ;; position point. This search may fail because REGEXP
3106 ;; was found in the hidden portion of this message. In
3107 ;; that case, move point to the beginning of visible
3108 ;; portion.
3117 regexp))
3124 "Show message containing previous match for REGEXP.
3125 Prefix argument gives repeat count; negative argument means search
3126 forward (through later messages).
3127 Interactively, empty argument means use same regexp used last time."
3132 regexp)
3147 \f
3148 ;; Scan for attributes, and compare subjects.
3151 "Return message number of first message which has `unseen' attribute."
3154 found)
3161 found))
3164 "Return the simplified subject of message MSGNUM (or current message).
3165 Simplifying the subject means stripping leading and trailing whitespace,
3166 and typical reply prefixes such as Re:."
3174 ;; If Subject is long, mailers will break it into several lines at
3175 ;; arbitrary places, so normalize whitespace by replacing every
3176 ;; run of whitespace characters with a single space.
3178 subject))
3181 "Return a regular expression matching the current simplified subject.
3182 The idea is to match it against simplified subjects of other messages."
3185 ;; Hide commas so it will work ok if parsed as a comma-separated list
3186 ;; of regexps.
3192 "Go to the next mail message having the same subject header.
3193 With prefix argument N, do this N times.
3194 If N is negative, go backwards instead."
3199 found)
3219 "Go to the previous mail message having the same subject header.
3220 With prefix argument N, do this N times.
3221 If N is negative, go forwards instead."
3224 \f
3225 ;;;; *** Rmail Message Deletion Commands ***
3228 "Return non-nil if message number N is deleted (in `rmail-deleted-vector')."
3232 "Set the deleted state of message number N (in `rmail-deleted-vector').
3233 STATE non-nil means mark as deleted."
3237 "Delete this message and stay on it."
3243 "Back up to deleted message, select it, and undelete it."
3261 "Delete this message and move to next nondeleted one.
3263 With prefix argument, delete and move backward.
3265 Returns t if a new message is displayed after the delete, or nil otherwise."
3277 "Delete this message and move to previous nondeleted one.
3281 \f
3282 ;; Expunging.
3284 ;; Compute the message number a given message would have after expunging.
3285 ;; The present number of the message is OLDNUM.
3286 ;; DELETEDVEC should be rmail-deleted-vector.
3287 ;; The value is nil for a message that would be deleted.
3290 nil
3297 newnum)))
3300 "Return t if expunge is needed and desirable.
3301 If `rmail-confirm-expunge' is non-nil, ask user to confirm."
3308 t)))
3311 "Actually erase all deleted messages in the file."
3316 ;; Discard all undo records for this buffer.
3324 0
3331 ;; Don't make any undo records for the expunging.
3340 new-summary
3349 rmail-current-message nil
3350 rmail-message-vector nil
3351 rmail-deleted-vector nil
3352 rmail-summary-vector nil)
3368 new-summary))
3371 new-msgref))
3379 rmail-total-messages counter
3384 win t)))
3394 ;; The DONT-SHOW argument is new in 23. Does not seem very important.
3396 "Erase deleted messages from Rmail file and summary buffer.
3397 This always shows a message (so as not to leave the Rmail buffer
3398 unswapped), and always updates any summary (so that it remains
3399 consistent with the Rmail buffer). If DONT-SHOW is non-nil, it
3400 does not pop any summary buffer."
3407 ;; We always update the summary buffer, so that the contents
3408 ;; remain consistent with the rmail buffer.
3409 ;; The only difference is, in the dont-show case, we use a
3410 ;; cut-down version of rmail-select-summary that does not pop
3411 ;; the summary buffer. It's only used by rmail-quit, which is
3412 ;; just going to bury any summary immediately after. If we made
3413 ;; rmail-quit bury the summary first, dont-show could be removed.
3414 ;; But the expunge might not be confirmed...
3422 ;; We always show a message, because (rmail-only-expunge t)
3423 ;; leaves the rmail buffer unswapped.
3424 ;; If we expunged the current message, a new one is current now,
3425 ;; so show it. If we weren't showing a message, show it.
3428 ;; We can just show the same message that was being shown before.
3432 \f
3433 ;;;; *** Rmail Mailing Commands ***
3436 replybuffer sendactions same-window others)
3439 ;; The function used here must behave like insert-buffer wrt
3440 ;; point and mark (see doc of sc-cite-original).
3446 noerase nil
3447 yank-action sendactions)
3451 noerase 'switch-to-buffer-other-frame
3452 yank-action sendactions)
3453 ;; This is not a standard frame parameter;
3454 ;; nothing except sendmail.el looks at it.
3458 noerase 'switch-to-buffer-other-window
3459 yank-action sendactions)))))
3462 "Send mail in another window.
3464 original message into it."
3468 ;; FIXME should complain if there is nothing to continue.
3470 "Continue composing outgoing message previously being composed."
3475 "Reply to the current message.
3476 Normally include CC: to all other recipients of original message;
3477 prefix argument means ignore them. While composing the reply,
3483 resent-to resent-cc resent-reply-to
3486 rmail-current-message
3493 from)
3499 ;; Bug#512. It's inappropriate to reply to these addresses.
3500 ;;; resent-cc (and (not just-sender)
3501 ;;; (mail-fetch-field "resent-cc" nil t))
3502 ;;; resent-to (or (mail-fetch-field "resent-to" nil t) "")
3503 ;;; resent-subject (mail-fetch-field "resent-subject")
3504 ;;; resent-date (mail-fetch-field "resent-date")
3505 ;;; resent-message-id (mail-fetch-field "resent-message-id")
3506 )
3509 ;; If this header field is present, use it instead of the
3510 ;; To and CC fields.
3514 ;; Merge the resent-to and resent-cc into the to and cc.
3515 ;; Bug#512. It's inappropriate to reply to these addresses.
3516 ;;; (if (and resent-to (not (equal resent-to "")))
3517 ;;; (if (not (equal to ""))
3518 ;;; (setq to (concat to ", " resent-to))
3519 ;;; (setq to resent-to)))
3520 ;;; (if (and resent-cc (not (equal resent-cc "")))
3521 ;;; (if (not (equal cc ""))
3522 ;;; (setq cc (concat cc ", " resent-cc))
3523 ;;; (setq cc resent-cc)))
3524 ;; Add `Re: ' to subject if not there already.
3531 subject))))
3533 nil
3534 ;; Using mail-strip-quoted-names is undesirable with newer mailers
3535 ;; since they can handle the names unstripped.
3536 ;; I don't know whether there are other mailers that still
3537 ;; need the names to be stripped.
3538 ;;; (mail-strip-quoted-names reply-to)
3539 ;; Remove unwanted names from reply-to, since Mail-Followup-To
3540 ;; header causes all the names in it to wind up in reply-to, not
3541 ;; in cc. But if what's left is an empty list, use the original.
3544 subject
3547 nil
3548 ;; mail-strip-quoted-names is NOT necessary for rmail-dont-reply-to
3549 ;; to do its job.
3555 rmail-buffer
3556 rmail-view-buffer)
3558 rmail-buffer
3561 rmail-answered-attr-index))
3562 nil
3568 message-id)))))))
3569 \f
3571 "Give BUFFER's message number in MSGNUM-LIST the attribute ATTRIBUTE.
3572 This is use in the send-actions for message buffers.
3573 MSGNUM-LIST is a list of the form (MSGNUM)
3574 which is an element of rmail-msgref-vector."
3582 message-id
3583 nil))
3593 tem))
3594 message-id))
3595 ;; missing From, or Message-ID is sufficiently informative
3596 message-id
3598 ;; Copy TEM, discarding text properties.
3602 ;; Use prin1 to fake RFC822 quoting
3606 field)))))
3609 ;; These strings both match all non-ASCII characters.
3612 ;; "Unix Loser <Foo@bar.edu>" => "Unix Loser"
3613 from)
3616 ;; "<Bugs@bar.edu>" (Losing Unix) => "Losing Unix"
3617 from)))
3620 ;; Trim whitespace which above regexp match allows
3630 ;; "<AA259@bar.edu> (message from Unix Loser on 1-Apr-89)"
3632 field))))
3634 ;; If we can't kludge it simply, do it correctly
3637 \f
3639 "Forward the current message to another user.
3641 see the documentation of `rmail-resend'."
3656 nil nil subject nil nil nil
3658 forward-buffer
3661 rmail-forwarded-attr-index))
3662 ;; If only one window, use it for the mail buffer.
3663 ;; Otherwise, use another window for the mail buffer
3664 ;; so that the Rmail buffer remains visible
3665 ;; and sending the mail will get back to it.
3667 ;; The mail buffer is now current.
3669 ;; Insert after header separator--before signature if any.
3673 forward-buffer)
3675 ;; Quote lines with `- ' if they start with `-'.
3693 \f
3695 "Resend current message to ADDRESSES.
3696 ADDRESSES should be a single address, a string consisting of several
3697 addresses separated by commas, or a list of addresses.
3699 Optional FROM is the address to resend the message from, and
3700 defaults from the value of `user-mail-address'.
3701 Optional COMMENT is a string to insert as a comment in the resent message.
3702 Optional ALIAS-FILE is alternate aliases file to be used by sendmail,
3703 typically for purposes of moderating a list."
3718 ;;>> Copy message into temp buffer
3725 ;; Delete any Sender field, since that's not specifiable.
3726 ; Only delete Sender fields in the actual header.
3728 ; Using "while" here rather than "if" because some buggy mail
3729 ; software may have inserted multiple Sender fields.
3737 ; Go back to the beginning of the buffer so the Resent- fields
3738 ; are inserted there.
3740 ;;>> Insert resent-from:
3743 ;;>> Insert resent-to: and bcc if need be.
3748 address
3751 ;; Expand abbrevs in the recipients.
3770 ;;>> Set up comment, if any.
3773 after)
3781 ;; Don't expand aliases in the destination fields
3782 ;; of the original message.
3788 \f
3806 ;; This is a cut-down version of rmail-clear-headers from Emacs 22.
3807 ;; It doesn't have the same functionality, hence the name change.
3809 "Delete any mail headers matching REGEXP.
3810 The message should be narrowed to just the headers."
3815 ;; This code from Emacs 22 doesn't seem right, since r-n-h is
3816 ;; just for display.
3817 ;;; (if (looking-at rmail-nonignored-headers)
3818 ;;; (forward-line 1)
3826 "Edit a mail message which is based on the contents of the current message.
3827 For a message rejected by the mail system, extract the interesting headers and
3828 the body of the original message.
3829 If the failed message is a MIME multipart message, it is searched for a
3830 body part with a header which matches the variable `mail-mime-unsent-header'.
3831 Otherwise, the variable `mail-unsent-separator' should match the string that
3832 delimits the returned original message.
3833 The variable `rmail-retry-ignored-headers' is a regular expression
3834 specifying headers which should not be copied into the new message."
3839 bounce-start bounce-end bounce-indent resending
3847 content-type))
3848 ;; Handle a MIME multipart bounce message.
3861 ;; Non-MIME bounce.
3865 ;; Support a style of failure message in which the original
3866 ;; message is indented, and included within lines saying
3867 ;; `Start of returned message' and `End of returned message'.
3876 ;; One message contained a few random lines before
3877 ;; the old message header. The first line of the
3878 ;; message started with two hyphens. A blank line
3879 ;; followed these random lines. The same line
3880 ;; beginning with two hyphens was possibly marking
3881 ;; the end of the message.
3896 ;; We have found the message that bounced, within the current message.
3897 ;; Now start sending new message; default header fields from original.
3898 ;; Turn off the usual actions for initializing the message body
3899 ;; because we want to get only the text from the failure message.
3903 rmail-this-buffer
3905 rmail-retried-attr-index)))
3906 ;; Insert original text as initial text of new draft message.
3907 ;; Bind inhibit-read-only since the header delimiter
3908 ;; of the previous message was probably read-only.
3912 bounce-start bounce-end)
3928 \f
3930 "Non-nil if in an RMAIL buffer and an associated summary buffer exists.
3931 In fact, the non-nil value returned is the summary buffer itself."
3933 rmail-summary-buffer))
3936 "t if in RMAIL buffer and an associated summary buffer is displayed."
3940 "Non-nil means Rmail should show the summary when it changes.
3941 This has an effect only if a summary buffer exists."
3946 "Non-nil means specify the height for an Rmail summary window."
3950 ;; Put the summary buffer back on the screen, if user wants that.
3953 window)
3954 ;; If requested, make sure the summary is displayed.
3956 rmail-redisplay-summary
3958 ;; It's already in some frame; show that one.
3964 ;; If requested, set the height of the summary window.
3966 rmail-summary-window-size
3968 ;; Don't try to change the size if just one window in frame.
3975 \f
3976 ;;;; *** Rmail Local Fontification ***
3979 ;; This function's symbol is bound to font-lock-fontify-buffer-function.
3981 ;; If we're already showing a message, fontify it now.
3983 ;; Prevent Font Lock mode from kicking in.
3987 ;; This function's symbol is bound to font-lock-fontify-unbuffer-function.
3990 before-change-functions after-change-functions
3991 buffer-file-name buffer-file-truename)
4001 ;; Fontify the current message if it is not already fontified.
4005 before-change-functions after-change-functions
4006 buffer-file-name buffer-file-truename)
4013 \f
4014 ;;; Speedbar support for RMAIL files.
4018 "*This regex is used to match folder names to be displayed in speedbar.
4019 Enabling this will permit speedbar to display your folders for easy
4029 "Install those variables used by speedbar to enhance rmail."
4031 nil
4040 ;; Mouse-3.
4048 ;; Make sure our special speedbar major mode is loaded
4054 "Create buttons for BUFFER containing rmail messages.
4055 Click on the address under Reply to: to reply to this person.
4056 Under Folders: Click a name to read it, or on the <M> to move the
4057 current message into that RMAIL folder."
4065 nil
4070 nil
4080 default-directory)
4081 nil rmail-speedbar-match-folder-regexp)))
4090 "Execute an rmail command specified by TEXT.
4091 The command used is TOKEN. INDENT is not used."
4096 "Load in the rmail file TEXT.
4097 TOKEN and INDENT are not used."
4103 "If the current line is a folder, move current message to it."
4113 "From button TEXT, copy current message to the rmail file specified by TOKEN.
4114 TEXT and INDENT are not used."
4117 ;; expand-file-name is needed due to the unhelpful way in which
4118 ;; rmail-output expands non-absolute filenames against rmail-default-file.
4119 ;; What is the point of that, anyway?
4122 ;; Functions for setting, getting and encoding the POP password.
4123 ;; The password is encoded to prevent it from being easily accessible
4124 ;; to "prying eyes." Obviously, this encoding isn't "real security,"
4125 ;; nor is it meant to be.
4127 ;;;###autoload
4129 "Set PASSWORD to be used for retrieving mail from a POP or IMAP server."
4138 "Get the password for retrieving mail from a POP or IMAP server. If none
4139 has been set, then prompt the user for one."
4144 "IMAP password: "
4154 "Encode STRING with integer MASK, by taking the exclusive OR of the
4155 lowest byte in the mask with the first character of string, the
4156 second-lowest-byte with the second character of the string, etc.,
4157 restarting at the lowest byte of the mask whenever it runs out.
4158 Returns the encoded string. Calling the function again with an
4159 encoded string (and the same mask) will decode the string."
4172 ;;;; Desktop support
4175 desktop-buffer-name
4176 desktop-buffer-misc)
4177 "Restore an rmail buffer specified in a desktop file."
4183 rmail-buffer))
4186 nil)))
4191 ;; We use this to record the encoding of the current message before
4192 ;; saving the message collection.
4195 ;; Used in `write-region-annotate-functions' to write rmail files.
4201 nil))
4203 ;; Used to restore the encoding of the buffer where we show the
4204 ;; current message, after we save the message collection. This is
4205 ;; needed because rmail-write-region-annotate switches buffers behind
4206 ;; save-file's back, with the side effect that last-coding-system-used
4207 ;; is assigned to buffer-file-coding-system of the wrong buffer.
4216 \f
4217 ;;; Start of automatically extracted autoloads.
4218 \f
4219 ;;;### (autoloads (rmail-edit-current-message) "rmailedit" "rmailedit.el"
4220 ;;;;;; "60db8013bf16d7999914a16cda435287")
4221 ;;; Generated autoloads from rmailedit.el
4224 Edit the contents of this message.
4228 ;;;***
4229 \f
4230 ;;;### (autoloads (rmail-next-labeled-message rmail-previous-labeled-message
4231 ;;;;;; rmail-read-label rmail-kill-label rmail-add-label) "rmailkwd"
4232 ;;;;;; "rmailkwd.el" "7027ce1ac922c0dd51262b641e4d42c1")
4233 ;;; Generated autoloads from rmailkwd.el
4236 Add LABEL to labels associated with current RMAIL message.
4237 Completes (see `rmail-read-label') over known labels when reading.
4238 LABEL may be a symbol or string. Only one label is allowed.
4243 Remove LABEL from labels associated with current RMAIL message.
4244 Completes (see `rmail-read-label') over known labels when reading.
4245 LABEL may be a symbol or string. Only one label is allowed.
4250 Read a label with completion, prompting with PROMPT.
4251 Completions are chosen from `rmail-label-obarray'. The default
4252 is `rmail-last-label', if that is non-nil. Updates `rmail-last-label'
4253 according to the choice made, and returns a symbol.
4258 Show previous message with one of the labels LABELS.
4259 LABELS should be a comma-separated list of label names.
4260 If LABELS is empty, the last set of labels specified is used.
4261 With prefix argument N moves backward N messages with these labels.
4266 Show next message with one of the labels LABELS.
4267 LABELS should be a comma-separated list of label names.
4268 If LABELS is empty, the last set of labels specified is used.
4269 With prefix argument N moves forward N messages with these labels.
4273 ;;;***
4274 \f
4275 ;;;### (autoloads (rmail-mime) "rmailmm" "rmailmm.el" "93033f2136fcd111e2b52a116ff4cf29")
4276 ;;; Generated autoloads from rmailmm.el
4279 Process the current Rmail message as a MIME message.
4281 copy of the message. Inline content-types are handled according to
4282 `rmail-mime-media-type-handlers-alist'. By default, this
4283 displays text and multipart messages, and offers to download
4284 attachments as specfied by `rmail-mime-attachment-dirs-alist'.
4288 ;;;***
4289 \f
4290 ;;;### (autoloads (set-rmail-inbox-list) "rmailmsc" "rmailmsc.el"
4291 ;;;;;; "b2a72d4e370f2d2b31b6f8f0794820e4")
4292 ;;; Generated autoloads from rmailmsc.el
4295 Set the inbox list of the current RMAIL file to FILE-NAME.
4296 You can specify one file name, or several names separated by commas.
4297 If FILE-NAME is empty, remove any existing inbox list.
4299 This applies only to the current session.
4303 ;;;***
4304 \f
4305 ;;;### (autoloads (rmail-sort-by-labels rmail-sort-by-lines rmail-sort-by-correspondent
4306 ;;;;;; rmail-sort-by-recipient rmail-sort-by-author rmail-sort-by-subject
4307 ;;;;;; rmail-sort-by-date) "rmailsort" "rmailsort.el" "5a3b5ee477d2fbf79d0c566d776a7fd4")
4308 ;;; Generated autoloads from rmailsort.el
4312 If prefix argument REVERSE is non-nil, sorts in reverse order.
4319 non-nil, sorts in reverse order.
4324 Sort messages of current Rmail buffer by author.
4326 If prefix argument REVERSE is non-nil, sorts in reverse order.
4331 Sort messages of current Rmail buffer by recipient.
4333 If prefix argument REVERSE is non-nil, sorts in reverse order.
4338 Sort messages of current Rmail buffer by other correspondent.
4341 excluded by `rmail-dont-reply-to-names'. If prefix argument
4342 REVERSE is non-nil, sorts in reverse order.
4347 Sort messages of current Rmail buffer by the number of lines.
4348 If prefix argument REVERSE is non-nil, sorts in reverse order.
4353 Sort messages of current Rmail buffer by labels.
4354 LABELS is a comma-separated list of labels. The order of these
4355 labels specifies the order of messages: messages with the first
4356 label come first, messages with the second label come second, and
4357 so on. Messages that have none of these labels come last.
4358 If prefix argument REVERSE is non-nil, sorts in reverse order.
4362 ;;;***
4363 \f
4364 ;;;### (autoloads (rmail-summary-by-senders rmail-summary-by-topic
4365 ;;;;;; rmail-summary-by-regexp rmail-summary-by-recipients rmail-summary-by-labels
4366 ;;;;;; rmail-summary) "rmailsum" "rmailsum.el" "26b95919c7e1f8c5609ce7323aee77ae")
4367 ;;; Generated autoloads from rmailsum.el
4370 Display a summary of all messages, one line per message.
4375 Display a summary of all messages with one or more LABELS.
4376 LABELS should be a string containing the desired labels, separated by commas.
4381 Display a summary of all messages with the given RECIPIENTS.
4382 Normally checks the To, From and Cc fields of headers;
4383 but if PRIMARY-ONLY is non-nil (prefix arg given),
4384 only look in the To and From fields.
4385 RECIPIENTS is a string of regexps separated by commas.
4390 Display a summary of all messages according to regexp REGEXP.
4391 If the regular expression is found in the header of the message
4392 \(including in the date and other lines, as well as the subject line),
4393 Emacs will list the message in the summary.
4398 Display a summary of all messages with the given SUBJECT.
4399 Normally checks just the Subject field of headers; but with prefix
4400 argument WHOLE-MESSAGE is non-nil, looks in the whole message.
4401 SUBJECT is a string of regexps separated by commas.
4407 SENDERS is a string of regexps separated by commas.
4411 ;;;***
4412 \f
4413 ;;;### (autoloads (unforward-rmail-message undigestify-rmail-message)
4414 ;;;;;; "undigest" "undigest.el" "8cf8a8ffa48eeddf0bde388fa8de1783")
4415 ;;; Generated autoloads from undigest.el
4418 Break up a digest message into its constituent messages.
4419 Leaves original message, deleted, before the undigestified messages.
4424 Extract a forwarded message from the containing message.
4425 This puts the forwarded message into a separate rmail message
4426 following the containing message.
4430 ;;;***
4431 \f
4432 ;;; End of automatically extracted autoloads.
4437 ;; arch-tag: 65d257d3-c281-4a65-9c38-e61af95af2f0
4438 ;;; rmail.el ends here