| blob | 07ea7cc0d256556b83d6a88123ef4da30fe048a0 |
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')."
198 "Determine what flavor of movemail PROG is.
199 We do this by executing it with `--version' and analyzing its output."
205 ;; Should not happen...
206 nil
214 ;; FIXME:
218 "Determine the file name of the `movemail' program and return its flavor.
219 If `rmail-movemail-program' is non-nil, use it.
220 Otherwise, look for `movemail' in the directories in
221 `rmail-movemail-search-path', those in `exec-path', and `exec-directory'."
228 ;; Previously, this didn't have to work on Windows, because
229 ;; rmail-insert-inbox-text before r1.439 fell back to using
230 ;; (expand-file-name "movemail" exec-directory) and just
231 ;; assuming it would work.
232 ;; http://lists.gnu.org/archive/html/bug-gnu-emacs/2008-02/msg00087.html
245 "The movemail variant currently in use. Known variants are:
247 `emacs' Means any implementation, compatible with the native Emacs one.
248 This is the default;
249 `mailutils' Means GNU mailutils implementation, capable of handling full
252 ;;;###autoload
254 "Return t if the current movemail variant is any of VARIANTS.
255 Currently known variants are 'emacs and 'mailutils."
257 ;; Autodetect
261 ;; Call for effect, to set rmail-movemail-program (if not set by the
262 ;; user), and rmail-movemail-variant-in-use. Used by various functions.
263 ;; I'm not sure if M-x rmail is the only entry point to this package.
264 ;; If so, this can be moved there.
267 ;;;###autoload
269 "Regexp matching user mail addresses.
270 If non-nil, this variable is used to identify the correspondent
271 when receiving new mail. If it matches the address of the sender,
272 the recipient is taken as correspondent of a mail.
273 If nil \(default value\), your `user-login-name' and `user-mail-address'
274 are used to exclude yourself as correspondent.
276 Usually you don't have to set this variable, except if you collect mails
277 sent by you under different user names.
278 Then it should be a regexp matching your mail addresses.
280 Setting this variable has an effect only before reading a mail."
285 ;;;###autoload
287 "A regexp specifying addresses to prune from a reply message.
288 If this is nil, it is set the first time you compose a reply, to
289 a value which excludes your own email address, plus whatever is
290 specified by `rmail-default-dont-reply-to-names'.
292 Matching addresses are excluded from the CC field in replies, and
293 also the To field, unless this would leave an empty To field."
297 ;;;###autoload
299 "Regexp specifying part of the default value of `rmail-dont-reply-to-names'.
300 This is used when the user does not set `rmail-dont-reply-to-names'
301 explicitly. (The other part of the default value is the user's
302 email address and name.) It is useful to set this variable in
303 the site customization file. The default value is conventionally
305 ;; Is it really useful to set this site-wide?
307 ;;;###autoload
327 "Regexp to match header fields that Rmail should normally hide.
328 \(See also `rmail-nonignored-headers', which overrides this regexp.)
329 This variable is used for reformatting the message header,
330 which normally happens once for each message,
331 when you view the message for the first time in Rmail.
332 To make a change in this variable take effect
333 for a message that you have already viewed,
339 "Regexp to match X header fields that Rmail should show.
340 This regexp overrides `rmail-ignored-headers'; if both this regexp
341 and that one match a certain header field, Rmail shows the field.
342 If this is nil, ignore all header fields in `rmail-ignored-headers'.
344 This variable is used for reformatting the message header,
345 which normally happens once for each message,
346 when you view the message for the first time in Rmail.
347 To make a change in this variable take effect
348 for a message that you have already viewed,
353 ;;;###autoload
355 "Regexp to match Header fields that Rmail should display.
356 If nil, display all header fields except those matched by
357 `rmail-ignored-headers'."
361 ;;;###autoload
362 (defcustom rmail-retry-ignored-headers (purecopy "^x-authentication-warning:\\|^x-detected-operating-system:\\|^x-spam[-a-z]*:\\|content-type:\\|content-transfer-encoding:\\|mime-version:")
363 "Headers that should be stripped when retrying a failed message."
368 ;;;###autoload
370 "Regexp to match Header fields that Rmail should normally highlight.
371 A value of nil means don't highlight. Uses the face `rmail-highlight'."
377 "Face to use for highlighting the most important header fields.
378 The variable `rmail-highlighted-headers' specifies which headers."
382 ;; This was removed in Emacs 23.1 with no notification, an unnecessary
383 ;; incompatible change.
385 "Face used by Rmail for highlighting headers."
386 ;; Note that nil doesn't actually mean use the default face, it
387 ;; means use either bold or highlight. It's not worth fixing this
388 ;; now that this is obsolete.
390 face)
393 "customize the face `rmail-highlight' instead."
398 "Face to use for highlighting the header names.
399 The variable `rmail-font-lock-keywords' specifies which headers
400 get highlighted."
405 "Non-nil means automatically delete a message that is copied to a file."
409 ;;;###autoload
411 "List of files that are inboxes for your primary mail file `rmail-file-name'.
412 If this is nil, uses the environment variable MAIL. If that is
413 unset, uses a file named by the function `user-login-name' in the
414 directory `rmail-spool-directory' (whose value depends on the
416 ;; Don't use backquote here, because we don't want to need it at load time.
417 ;; (That must be an old comment - it's dumped these days.)
427 "Non-nil means Rmail makes a new frame for composing outgoing mail.
428 This is handy if you want to preserve the window configuration of
429 the frame where you have the RMAIL buffer displayed."
433 ;;;###autoload
435 "Directory for additional secondary Rmail files."
438 ;;;###autoload
440 "Regexp for which files are secondary Rmail files."
445 "Whether and how to ask for confirmation before expunging deleted messages.
446 The value, if non-nil is a function to call with a question (string)
447 as argument, to ask the user that question."
455 ;;;###autoload
462 ;;;###autoload
464 "List of functions to call when Rmail displays a message."
473 "List of functions to call when Rmail deletes a message.
474 When the hooks are called, the message has been marked deleted but is
477 ;; These may be altered by site-init.el to match the format of mmdf files
478 ;; delimiting used on a given host (delim1 and delim2 from the config
479 ;; files).
486 ;; FIXME Post-mbox, this is now unused.
487 ;; In Emacs-22, this was called:
488 ;; i) the very first time a message was shown.
489 ;; ii) when toggling the headers to the normal state, every time.
490 ;; It's not clear what it should do now, since there is nothing that
491 ;; records when a message is shown for the first time (unseen is not
492 ;; necessarily the same thing).
494 "If non-nil, a filter function for new messages in RMAIL.
495 Called with region narrowed to the message, including headers,
496 before obeying `rmail-ignored-headers'."
501 "List of directives specifying where to put a message.
502 Each element of the list is of the form:
504 (FOLDERNAME FIELD REGEXP [ FIELD REGEXP ] ... )
506 Where FOLDERNAME is the name of a folder to put the message.
507 If any of the field regexp's are nil, then it is ignored.
510 If FOLDERNAME is nil then it is deleted, and skipped.
512 FIELD is the plain text name of a field in the message, such as
516 REGEXP is an expression to match in the preceeding specified FIELD.
517 FIELD/REGEXP pairs continue in the list.
519 examples:
523 Note that this is only applied in the folder specifed by `rmail-file-name'."
531 ;; Some mailers use "Re(2):" or "Re^2:" or "Re: Re:" or "Re[2]:".
532 ;; This pattern should catch all the common variants.
533 ;; rms: I deleted the change to delete tags in square brackets
534 ;; because they mess up RT tags.
539 "If non-nil, Rmail always displays the summary buffer."
542 \f
547 "The RMAIL buffer related to the current buffer.
548 In an RMAIL buffer, this holds the RMAIL buffer itself.
560 ;; Message counters and markers. Deleted flags.
567 "Integer specifying the total number of messages in this folder.
572 "Vector of markers specifying the start and end of each message.
577 "A string of length `rmail-total-messages' plus one.
583 "In an Rmail buffer, a vector whose Nth element is a list (N).
584 When expunging renumbers messages, these lists are modified
591 ;; These are used by autoloaded rmail-summary.
596 "In an Rmail buffer, vector of (newline-terminated) strings.
600 ;; Rmail buffer swapping variables.
611 \f
612 ;; `Sticky' default variables.
614 ;; Last individual label specified to a or k.
617 ;; Last set of values specified to C-M-n, C-M-p, C-M-s or C-M-l.
633 ;; Mule and MIME related variables.
635 ;;;###autoload
637 "Coding system used in RMAIL file.
642 "If non-nil, RMAIL uses MIME features.
643 If the value is t, RMAIL automatically shows MIME decoded message.
644 If the value is neither t nor nil, RMAIL does not show MIME decoded message
645 until a user explicitly requires it.
647 Even if the value is non-nil, you can't use MIME features
648 unless the feature specified by `rmail-mime-feature' is available."
657 ;; FIXME unused.
659 "Function to show MIME decoded message of RMAIL file.
660 This function is called when `rmail-enable-mime' is non-nil.
663 ;;;###autoload
665 "Function to insert a message in MIME format so it can be forwarded.
666 This function is called if `rmail-enable-mime' or
667 `rmail-enable-mime-composing' 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
673 "Function to insert a message in MIME format so it can be resent.
674 This function is called by `rmail-resend' if `rmail-enable-mime' is non-nil.
675 It is called with one argument FORWARD-BUFFER, which is a
676 buffer containing the message to forward. The current buffer
679 ;; FIXME one might want to pass a LIMIT, as per
680 ;; rmail-search-mime-header-function.
682 "Function to check if a regexp matches a MIME message.
683 This function is called by `rmail-search-message' if
684 `rmail-enable-mime' is non-nil. It is called (with point at the
685 start of the message) with two arguments MSG and REGEXP, where
689 "Function to check if a regexp matches a header of MIME message.
690 This function is called by `rmail-message-regexp-p-1' if
691 `rmail-enable-mime' is non-nil. It is called (with point at the
692 start of the header) with three arguments MSG, REGEXP, and LIMIT,
693 where MSG is the message number, REGEXP is the regular
697 "Feature to require to load MIME support in Rmail.
698 When starting Rmail, if `rmail-enable-mime' is non-nil,
699 this feature is required with `require'.
701 The default value is `rmail-mime'. This feature is provided by
704 ;; FIXME this is unused.
706 "*Non-nil means a message is decoded by MIME's charset specification.
707 If this variable is nil, or the message has not MIME specification,
708 the message is decoded as normal way.
710 If the variable `rmail-enable-mime' is non-nil, this variable is
711 ignored, and all the decoding work is done by a feature specified by
718 "Regexp to match MIME-charset specification in a header of message.
721 \f
729 "From "
731 ;; Many things can happen to an RFC 822 mailbox before it is put into
732 ;; a `From' line. The leading phrase can be stripped, e.g.
733 ;; `Joe <@w.x:joe@y.z>' -> `<@w.x:joe@y.z>'. The <> can be stripped, e.g.
734 ;; `<@x.y:joe@y.z>' -> `@x.y:joe@y.z'. Everything starting with a CRLF
735 ;; can be removed, e.g.
736 ;; From: joe@y.z (Joe K
737 ;; User)
738 ;; can yield `From joe@y.z (Joe K Fri Mar 22 08:11:15 1996', and
739 ;; From: Joe User
740 ;; <joe@y.z>
741 ;; can yield `From Joe User Fri Mar 22 08:11:15 1996'.
742 ;; The mailbox can be removed or be replaced by white space, e.g.
743 ;; From: "Joe User"{space}{tab}
744 ;; <joe@y.z>
745 ;; can yield `From {space}{tab} Fri Mar 22 08:11:15 1996',
746 ;; where {space} and {tab} represent the Ascii space and tab characters.
747 ;; We want to match the results of any of these manglings.
748 ;; The following regexp rejects names whose first characters are
749 ;; obviously bogus, but after that anything goes.
752 ;; The time the message was sent.
758 ;; Perhaps a time zone, specified by an abbreviation, or by a
759 ;; numeric offset.
760 time-zone-regexp
762 ;; The year.
765 ;; On some systems the time zone can appear after the year, too.
766 time-zone-regexp
768 ;; Old uucp cruft.
772 "Regexp matching the delimiter of messages in UNIX mail format
773 \(UNIX From lines), minus the initial ^. Note that if you change
774 this expression, you must change the code in `rmail-nuke-pinhead-header'
777 ;; FIXME the rmail-header-name headers ought to be customizable.
778 ;; It seems a bit arbitrary, for example, that all of the Date: line
779 ;; gets highlighted.
781 ;; These are all matched case-insensitively.
789 ;; FIXME Mail-Followup-To should probably be here too.
794 ;; Use MATCH-ANCHORED to effectively anchor the regexp left side.
795 `(,cite-chars
807 ;; Rmail does not expect horizontal splitting. (Bug#2282)
809 "Like `pop-to-buffer', but with `split-width-threshold' set to nil."
813 ;; Perform BODY in the summary buffer
814 ;; in such a way that its cursor is properly updated in its own window.
823 ;; rmail-total-messages is a buffer-local var
824 ;; in the rmail buffer.
825 ;; This way we make it available for the body
826 ;; even tho the rmail buffer is not current.
834 \f
835 ;;;; *** Rmail Mode ***
838 "Require `rmail-mime-feature' if that is non-nil.
839 Signal an error and set `rmail-mime-feature' to nil if the feature
840 isn't provided."
846 'rmail
848 by setting `rmail-enable-mime' to non-nil, the required feature
849 `%s' (the value of `rmail-mime-feature')
850 is not available in the current session.
851 So, the MIME support is turned off for the moment."
852 rmail-mime-feature)
857 ;;;###autoload
859 "Read and edit incoming mail.
860 Moves messages into file named by `rmail-file-name' and edits that
861 file in RMAIL Mode.
864 May be called with file name as argument; then performs rmail editing on
865 that file, but does not copy any new mail into the file.
866 Interactively, if you supply a prefix argument, then you
867 have a chance to specify a file name with the minibuffer.
869 If `rmail-display-summary' is non-nil, make a summary for this RMAIL file."
874 ;; Use find-buffer-visiting, not get-file-buffer, for those users
875 ;; who have find-file-visit-truename set to t.
877 run-mail-hook mail-buf msg-shown)
878 ;; Determine if an existing mail file has been changed behind the
879 ;; scene...
881 ;; The mail file has been changed. Revisit it and reset the
882 ;; message state variables when in rmail mode.
889 ;; The mail file is either unchanged or not visited. Visit it.
892 ;; Force no-conversion by default, since that's what
893 ;; pre-mbox Rmail did with BABYL files (via
894 ;; auto-coding-regexp-alist).
898 ;; Ensure that the collection and view buffers are in sync and
899 ;; ensure that a message is not being edited.
906 ;; Ensure that the Rmail file is in mbox format, the buffer is in
907 ;; Rmail mode and has been scanned to find all the messages
908 ;; (setting the global message variables in the process).
915 ;; Show the first unread message and process summary mode.
917 ;; Only get new mail when there is not a file name argument.
930 "Determine if the file needs to be converted to mbox format."
933 ;; Detect previous Babyl format files.
936 ;; The file is Babyl version 5. Use unrmail to convert
937 ;; it.
940 ;; Losing babyl file made by old version of Rmail. Fix the
941 ;; babyl file header and use unrmail to convert to mbox
942 ;; format.
952 "Report that the buffer is not in the mbox file format.
953 MSGNUM, if present, indicates the malformed message."
959 "Convert the mail file from Babyl version 5 to mbox.
960 This function also reinitializes local variables used by Rmail."
974 ;; Rmail buffers need to be saved with Unix EOLs, or else
975 ;; the format will not be recognized.
989 "Return a suitable coding system to use for the current mail message.
990 The buffer is expected to be narrowed to just the header of the message."
996 \f
997 ;;; Set up Rmail mode keymaps
1008 ;; If you change this, change the rmail-resend menu-item's :keys.
1033 ;; I find I can't live without the default M-r command -- rms.
1034 ;; (define-key rmail-mode-map "\er" 'rmail-search-backwards)
1060 \f
1067 nil)
1070 nil)
1177 map)
1180 ;; Rmail toolbar
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)
1196 map rmail-mode-map)
1198 map rmail-mode-map)
1200 map rmail-mode-map)
1202 map rmail-mode-map)
1204 map rmail-mode-map)
1206 map rmail-mode-map)
1207 map))
1210 \f
1211 ;; Rmail mode is suitable only for specially formatted data.
1219 ;;;###autoload
1222 All normal editing commands are turned off.
1223 Instead, these commands are available:
1239 \\[rmail-undelete-previous-message] Undelete message. Tries current message, then earlier messages
1240 till a deleted message is found.
1241 \\[rmail-edit-current-message] Edit the current message. \\[rmail-cease-edit] to return to Rmail.
1254 \\[rmail-output-body-to-file] Save message body to a file. Default filename comes from Subject line.
1259 (label defaults to last one specified).
1260 Standard labels: filed, unseen, answered, forwarded, deleted.
1298 ;; No need to auto save RMAIL files in normal circumstances
1299 ;; because they contain no info except attribute changes
1300 ;; and deletion of messages.
1301 ;; The one exception is when messages are copied into another mbox buffer.
1302 ;; rmail-output enables auto save when you do that.
1307 ;; Functions to support buffer swapping:
1314 "Return a reusable buffer suitable for viewing messages.
1315 Create the buffer if necessary."
1316 ;; We want to reuse any existing view buffer, so as not to create an
1317 ;; endless number of them. But we must avoid clashes if we visit
1318 ;; two different rmail files with the same basename (Bug#4593).
1321 rmail-view-buffer
1327 "Swap text between current buffer and `rmail-view-buffer'.
1328 This function preserves the current buffer's modified flag, and also
1329 sets the current buffer's `buffer-file-coding-system' to that of
1330 `rmail-view-buffer'."
1337 buffer-file-coding-system)))
1346 "Return non-nil if the message collection is in `rmail-view-buffer'."
1347 ;; This is analogous to tar-data-swapped-p in tar-mode.el.
1349 rmail-buffer-swapped))
1352 ;; Bring the actual Rmail messages back into the main buffer.
1358 "Determine if the Rmail buffer is showing a message.
1359 If so restore the actual mbox message collection."
1366 "Warn if important modifications would change Rmail file's format."
1369 ;; If it's already modified, don't warn again.
1386 ;; Set up the permanent locals associated with an Rmail file.
1399 ;; Note that this does not erase the buffer. Should it?
1400 ;; It depends on how this is called. If somehow called with the
1401 ;; rmail buffers swapped, it would erase the message collection.
1404 ;; Force C-x C-s write Unix EOLs.
1414 ;; Provide default set of inboxes for primary mail file ~/RMAIL.
1422 ;; FIXME expand-file-name?
1427 ;; Set up the non-permanent locals associated with Rmail mode.
1429 ;; Turn off undo. We turn it back on in rmail-edit.
1431 ;; Don't let a local variables list in a message cause confusion.
1434 ;; Don't turn off auto-saving based on the size of the buffer
1435 ;; because that code does not understand buffer-swapping.
1443 t t nil nil
1458 \f
1459 ;; Handle M-x revert-buffer done in an rmail-mode buffer.
1464 ;; See similar code in `rmail'.
1465 ;; FIXME needs updating?
1468 ;; Call our caller again, but this time it does the default thing.
1470 ;; If the user said "yes", and we changed something,
1471 ;; reparse the messages.
1474 ;; Convert all or part to Babyl file if possible.
1476 ;; We have read the file as raw-text, so the buffer is set to
1477 ;; unibyte. Make it multibyte if necessary.
1487 "Expunge and save RMAIL file."
1491 ;; No need to swap buffers: rmail-write-region-annotate takes care of it.
1492 ;; (rmail-swap-buffers-maybe)
1498 "Quit out of RMAIL.
1499 Hook `rmail-quit-hook' is run after expunging."
1506 ;; Don't switch to the summary buffer even if it was recently visible.
1525 "Bury current Rmail buffer and its summary buffer."
1527 ;; This let var was called rmail-buffer, but that interfered
1528 ;; with the buffer-local var used in summary buffers.
1536 \f
1538 "Create a duplicated copy of the current message.
1539 The duplicate copy goes into the Rmail file just after the original."
1540 ;; If we are in a summary buffer, switch to the Rmail buffer.
1541 ;; FIXME simpler to swap the contents, not the buffers?
1563 \f
1564 ;;;###autoload
1566 "Run Rmail on file FILENAME."
1570 ;; This used to scan subdirectories recursively, but someone pointed out
1571 ;; that if the user wants that, person can put all the files in one dir.
1572 ;; And the recursive scan was slow. So I took it out.
1573 ;; rms, Sep 1996.
1575 "Return list of file in dir START that match `rmail-secondary-file-regexp'."
1577 ;; Don't sort here.
1580 ;; Sort here instead of in directory-files
1581 ;; because this list is usually much shorter.
1586 name)
1606 item)
1607 rmail-secondary-file-directory)))))
1611 menu))
1613 ;; This command is always "disabled" when it appears in a menu.
1623 files
1628 files
1636 \f
1637 ;;;; *** Rmail input ***
1645 ;; RLK feature not added in this version:
1646 ;; argument specifies inbox file or files in various ways.
1648 ;; In Babyl, the Mail: header in the preamble overrode rmail-inbox-list.
1649 ;; Mbox does not have this feature.
1651 "Move any new mail from this Rmail file's inbox files.
1652 The buffer-local variable `rmail-inbox-list' specifies the list
1653 of inbox files. By default, this is nil, except for your primary
1654 Rmail file `rmail-file-name'. In this case, when you first visit
1655 the Rmail file it is initialized using either
1657 or the function `user-login-name' and the directory
1658 `rmail-spool-directory' (whose value depends on the operating system).
1660 The command `set-rmail-inbox-list' sets `rmail-inbox-list' to the
1661 value you specify.
1663 You can also specify the file to get new mail from just for one
1664 instance of this command. In this case, the file of new mail is
1665 not changed or deleted. Noninteractively, you can pass the inbox
1666 file name as an argument. Interactively, a prefix argument
1667 causes us to read a file name and use that file as the inbox.
1669 If the variable `rmail-preserve-inbox' is non-nil, new mail will
1670 always be left in inbox files rather than deleted.
1672 Before doing anything, this runs `rmail-before-get-new-mail-hook'.
1673 Just before returning, it runs `rmail-after-get-new-mail-hook',
1674 whether or not there is new mail.
1676 If there is new mail, it runs `rmail-get-new-mail-hook', saves
1677 the updated file, and shows the first unseen message (which might
1678 not be a new one). It returns non-nil if it got any new messages."
1683 ;; If the disk file has been changed from under us,
1684 ;; revert to it before we get new mail.
1692 ;; Get rid of all undo records for this buffer.
1697 found)
1700 ;; This loops if any members of the inbox list have the same
1701 ;; basename (see "name conflict" below).
1704 ;; If buffer has not changed yet, and has not been
1705 ;; saved yet, don't replace the old backup file now.
1709 ;; Don't make undo records while getting mail.
1711 delete-files success files file-last-names)
1712 ;; Pull files off all-files onto files as long as there is
1713 ;; no name conflict. A conflict happens when two inbox
1714 ;; file names have the same last component.
1715 ;; The reason this careful handling is necessary seems
1716 ;; to be that rmail-insert-inbox-text uses .newmail-BASENAME.
1719 file-last-names)))
1721 file-last-names
1724 ;; Put them back in their original order.
1726 ;; In case of brain damage caused by require-final-newline.
1732 found))))
1733 ;; Move to the first new message unless we have other unseen
1734 ;; messages before it.
1737 found)
1738 ;; Don't leave the buffer screwed up if we get a disk-full error.
1745 "Return t if new messages are detected without error, nil otherwise."
1750 rmail-use-spam-filter))
1752 result success suffix)
1754 ;; Read in the contents of the inbox files, renaming them as
1755 ;; necessary, and adding to the list of files to delete
1756 ;; eventually.
1760 ;; Scan the new text and convert each message to
1761 ;; Rmail/mbox format.
1767 success t)
1768 ;; Try to delete the garbage just inserted.
1770 ;; If we could not convert the file's inboxes, rename the
1771 ;; files we tried to read so we won't over and over again.
1780 ;; Determine if there are messages.
1782 ;; There are. Process them.
1787 ;; Delete the old files, now that the Rmail file is saved.
1790 ;; First, try deleting.
1794 ;; If we can't delete it, truncate it.
1807 ;; Establish the return value.
1809 result))))
1812 "Parse the supplied URL. Return (list MAILBOX-NAME REMOTE PASSWORD GOT-PASSWORD)
1813 WHERE MAILBOX-NAME is the name of the mailbox suitable as argument to the
1814 actual version of `movemail', REMOTE is non-nil if MAILBOX-NAME refers to
1815 a remote mailbox, PASSWORD is the password if it should be
1816 supplied as a separate argument to `movemail' or nil otherwise, GOT-PASSWORD
1817 is non-nil if the user has supplied the password interactively.
1818 "
1833 ;; The password is embedded. Strip it out since movemail
1834 ;; does not really like it, in spite of the movemail spec.
1840 t
1842 got-password)
1847 got-password))))
1865 "Replace newly read mail in Babyl format with equivalent mbox format.
1867 FROM-FILE is the Babyl file from which the new mail should be read."
1869 size)
1877 size)))
1880 "If newly read mail from FILE is in Babyl format, convert it to mbox format.
1882 SIZE is the original size of the newly read mail.
1883 Value is the size of the newly read mail after conversion."
1884 ;; Detect previous Babyl format files.
1887 new-file)
1889 ;; The new mail is in Babyl version 5 format. Use unrmail
1890 ;; to convert it.
1893 ;; New mail is in Babyl format made by old version of
1894 ;; Rmail. Fix the babyl file header and use unrmail to
1895 ;; convert it.
1905 size))
1908 ;; Detect a locked file now, so that we avoid moving mail
1909 ;; out of the real inbox file. (That could scare people.)
1915 ;; Handle remote mailbox names specially; don't expand as filenames
1916 ;; in case the userid contains a directory separator.
1929 ;; Generate name to move to from inbox name,
1930 ;; in case of multiple inboxes that need moving.
1934 ;; cannot have colons in file name
1936 file)))
1937 ;; Use the directory of this rmail file
1938 ;; because it's a nuisance to use the homedir
1939 ;; if that is on a full disk and this rmail
1940 ;; file isn't.
1943 ;; Always use movemail to rename the file,
1944 ;; since there can be mailboxes in various directories.
1946 ;; On some systems, /usr/spool/mail/foo is a directory
1947 ;; and the actual inbox is /usr/spool/mail/foo/foo.
1950 file))))
1959 ;; Set TOFILE if have not already done so, and
1960 ;; rename or copy the file FILE to TOFILE if and as appropriate.
1965 nil)
1975 nil)
1978 rmail-movemail-flags)
1983 ;; No output => movemail won
1984 nil
1995 ;; If we just read the password, most likely it is
1996 ;; wrong. Otherwise, see if there is a specific
1997 ;; reason to think that the problem is a wrong passwd.
2000 nil t))
2003 ;; If using Mailutils, remove initial error code
2004 ;; abbreviation
2015 nil)))))
2017 ;; At this point, TOFILE contains the name to read:
2018 ;; Either the alternate name (if we renamed)
2019 ;; or the actual inbox (if not renaming).
2022 size)
2025 ;; If new mail is in Babyl format, convert it to mbox.
2027 tofile
2029 ;; Determine if a pair of newline message separators need
2030 ;; to be added to the new collection of messages. This is
2031 ;; the case for all new message collections added to a
2032 ;; non-empty mail file.
2049 delete-files))
2051 ;; Decode the region specified by FROM and TO by CODING.
2052 ;; If CODING is nil or an invalid coding system, decode by `undecided'.
2056 ;; Use -dos decoding, to remove ^M characters left from base64 or
2057 ;; rogue qp-encoded text.
2060 ;; Don't reveal the fact we used -dos decoding, as users generally
2061 ;; will not expect the RMAIL buffer to use DOS EOL format.
2074 "Ensure a message ends in a blank line.
2075 Call with point at the end of the message."
2082 "Validate the RFC2822 format for the new messages.
2083 Point should be at the first new message.
2084 An error is signalled if the new messages are not RFC2822
2085 compliant.
2086 Unless an Rmail attribute header already exists, add it to the
2087 new messages. Return the number of new messages."
2095 limit stop)
2096 ;; Detect an empty inbox file.
2098 ;; Scan the new messages to establish a count and to ensure that
2099 ;; an attribute header is present.
2102 ;; Determine if a new attribute header needs to be
2103 ;; added to the message.
2113 ;; Move to the next message.
2120 count))))
2121 \f
2123 "Subroutine of `rmail-get-header'.
2124 Narrow to header, call `mail-fetch-field' to find header NAME."
2132 "Return the value of message header NAME, nil if it has none.
2133 MSGNUM specifies the message number to get it from.
2134 If MSGNUM is nil, use the current message."
2138 "Subroutine of `rmail-set-header'.
2139 Narrow to header, set header NAME to VALUE, replacing existing if present.
2140 VALUE nil means to remove NAME altogether."
2157 "Set message header NAME to VALUE in message number MSGNUM.
2158 If MSGNUM is nil, use the current message. NAME and VALUE are strings.
2159 VALUE may also be nil, meaning to remove the header."
2162 ;; Ensure header changes get saved.
2163 ;; (Note replacing a header with an identical copy modifies.)
2165 ;; However: don't save in mbox format over a Babyl file
2166 ;; merely because of this.
2168 \f
2169 ;;;; *** Rmail Attributes and Keywords ***
2172 "Return the message attributes in a comma separated string.
2173 MSG specifies the message number to get it from.
2174 If MSG is nil, use the current message."
2177 result temp)
2184 result
2189 result)))
2192 "Return the message keywords in a comma separated string.
2193 MSG, if non-nil, identifies the message number to use.
2194 If nil, that means the current message."
2198 "Return a string with the labels (attributes and keywords) of msg MSG.
2199 It is put in comma-separated form.
2200 MSG, if non-nil, identifies the message number to use.
2201 If nil, that means the current message."
2204 ;; Combine the message attributes and keywords
2205 ;; into a comma-separated list.
2211 ;; FIXME ? old rmail did not have spaces in the comma-separated lists.
2218 "Update the current messages's attributes and keywords in mode line."
2222 rmail-current-message rmail-total-messages blurb))
2223 ;; If rmail-enable-mime is non-nil, we may have to update
2224 ;; `mode-line-process' of rmail-view-buffer too.
2233 "Return the character value for ATTR.
2234 ATTR is a (numeric) index, an offset into the mbox attribute
2235 header value. STATE is one of nil, t, or a character value."
2242 "Subroutine of `rmail-set-attribute'.
2243 Set Rmail attribute ATTR to STATE in `rmail-attribute-header',
2244 creating the header if necessary. Returns non-nil if a
2245 significant attribute change was made."
2249 altered)
2252 ;; If this message already records attributes, just change the
2253 ;; value for this one.
2255 ;; Position point at this attribute, adding attributes if necessary.
2262 ;; Change this attribute.
2267 ;; Otherwise add a header line to record the attributes and set
2268 ;; all but this one to no.
2274 altered))
2277 "Turn an attribute of a message on or off according to STATE.
2278 STATE is either nil or the character (numeric) value associated
2279 with the state (nil represents off and non-nil represents on).
2280 ATTR is either the index number of the attribute, or a string,
2281 both from `rmail-attr-array'. MSGNUM is message number to
2282 change; nil means current message."
2292 ;; Ask for confirmation before setting any attribute except `unseen'
2293 ;; if it would force a format change.
2299 ;; The "deleted" attribute is also stored in a special vector so
2300 ;; update that too.
2307 ;; Don't save in mbox format over a Babyl file
2308 ;; merely because of a change in `unseen' attribute.
2311 ;; Otherwise, if we modified the file text via the view buffer,
2312 ;; mark the main buffer modified too.
2316 "Return non-nil if message number MSG has attributes matching regexp ATTRS."
2321 "Return non-nil if message number MSGNUM has the unseen attribute."
2324 ;; FIXME rmail-get-labels does some formatting (eg leading space, `;'
2325 ;; between attributes and labels), so this might not do what you want.
2326 ;; Eg see rmail-sort-by-labels. rmail-get-labels could have an
2327 ;; optional `noformat' argument.
2329 "Return non-nil if message number MSG has labels matching regexp LABELS."
2331 \f
2332 ;;;; *** Rmail Message Selection And Support ***
2335 "Return the start position for message number N."
2339 "Return the end position for message number N."
2343 "Call FUNCTION on ARGS while narrowed to message MSGNUM.
2344 Point is at the start of the message.
2345 This returns what the call to FUNCTION returns.
2346 If MSGNUM is nil, use the current message."
2353 ;; All access to the rmail-buffer's local variables is now finished...
2355 ;; ... so it is ok to go to a different buffer.
2364 ;; Unused (save for commented out code in rmailedit.el).
2366 "Call FUNCTION with point at start of internal data of current message.
2367 Assumes that bounds were previously narrowed to display the message in Rmail.
2368 The bounds are widened enough to move point where desired, then narrowed
2369 again afterward.
2371 FUNCTION may not change the visible text of the message, but it may
2372 change the invisible header text."
2380 ;; Note: we don't use save-restriction because that does not work right
2381 ;; if changes are made outside the saved restriction
2382 ;; before that restriction is restored.
2385 \f
2386 ;; Manage the message vectors and counters.
2402 rmail-message-vector
2403 rmail-current-message
2404 rmail-total-messages))
2408 "Count the number of new messages.
2409 The buffer should be narrowed to include only the new messages.
2410 Output a helpful message unless NOMSG is non-nil."
2417 ;; Put at the end of messages-head
2418 ;; the entry for message N+1, which marks
2419 ;; the end of message N. (N = number of messages).
2435 ;; Fill in the new elements of rmail-msgref-vector.
2454 ;; Determine how many messages follow point.
2457 ;; Put at the end of messages-head
2458 ;; the entry for message N+1, which marks
2459 ;; the end of message N. (N = number of messages).
2470 ;; Make an element 0 in rmail-message-vector and rmail-deleted-vector
2471 ;; which will never be used.
2492 "Collect the message deletion flags for each message.
2493 MESSAGE-END is the buffer position corresponding to the end of
2494 the message. Point is at the beginning of the message."
2495 ;; NOTE: This piece of code will be executed on a per-message basis.
2496 ;; In the face of thousands of messages, it has to be as fast as
2497 ;; possible, hence some brute force constant use is employed in
2498 ;; addition to inlining.
2503 ?D
2507 "Collect the start positions of messages in list `messages-head'.
2508 Return the number of messages after the one containing SPOT-TO-FIND."
2510 messages-after-spot)
2521 ;; Show progress after every 20 messages or so.
2524 ;; Handle the first message, maybe.
2533 messages-after-spot))
2534 \f
2535 ;; Display a message.
2537 ;;;; *** Rmail Message Formatting and Header Manipulation ***
2539 ;; This is used outside of rmail.
2541 "Return nil if the current message is showing full headers."
2543 rmail-buffer)
2547 "Toggle between showing full and normal message headers.
2548 With optional integer ARG, show the normal message header if ARG
2549 is greater than zero; otherwise, show it in full."
2558 "Show current message starting from the beginning."
2562 rmail-view-buffer
2563 rmail-buffer)
2564 rmail-header-style)))
2568 "Show bottom of current message."
2574 rmail-view-buffer
2575 rmail-buffer)
2576 rmail-header-style)))
2581 Ask the user whether to add that list name to `mail-mailing-lists'."
2582 ;; FIXME s-r not needed? Use rmail-get-header?
2583 ;; We have not narrowed to the headers at ths point?
2594 ;; taken from rmailsum.el
2606 addr))
2609 addr)))
2614 "Display the entire mailbox file."
2618 \f
2628 "Show message number N (prefix argument), counting from start of file.
2629 If summary buffer is currently displayed, update current message there also.
2630 N defaults to the current message."
2634 ;; FIXME: Why do we swap the raw data back in?
2644 ;; If there is a summary buffer, try to move to this message
2645 ;; in that buffer. But don't complain if this message is
2646 ;; not mentioned in the summary. Don't do this at all if we
2647 ;; were called on behalf of cursor motion in the summary
2648 ;; buffer.
2659 "Return t if the region contains a text message, nil otherwise."
2663 ;; The message is text if either there is no content type header
2664 ;; (a default of "text/plain; charset=US-ASCII" is assumed) or
2665 ;; the base content type is either text or message.
2670 "Message size at which to show progress messages for displaying it."
2676 "Show message MSG (default: current message) using `rmail-view-buffer'.
2677 Return text to display in the minibuffer if MSG is out of
2678 range (displaying a reasonable choice as well), nil otherwise.
2679 The current mail message becomes the message displayed."
2682 blurb beg end body-start coding-system character-coding
2683 is-text-message header-style)
2689 rmail-current-message 1
2693 rmail-current-message rmail-total-messages
2698 ;; Mark the message as seen
2700 ;; bracket the message in the mail
2701 ;; buffer and determine the coding system the transfer encoding.
2721 ;; Decode the message body into an empty view buffer using a
2722 ;; unibyte temporary buffer where the character decoding takes
2723 ;; place.
2725 ;; We give the view buffer a buffer-local value of
2726 ;; rmail-header-style based on the binding in effect when
2727 ;; this function is called; `rmail-toggle-headers' can
2728 ;; inspect this value to determine how to toggle.
2732 ;; Do it directly since that is fast.
2734 ;; Can this be done directly, skipping the temp buffer?
2740 ;; See bug#5441.
2750 coding-system view-buf)))
2752 ;; Unquote quoted From lines
2759 ;; Copy the headers to the front of the message view buffer.
2761 ;; Add the separator (blank line) between headers and body;
2762 ;; highlight the message, activate any URL like text and add
2763 ;; special highlighting for and quoted material.
2768 ;(rmail-activate-urls)
2769 ;(rmail-process-quoted-material)
2770 )
2771 ;; Update the mode-line with message status information and swap
2772 ;; the view buffer/mail buffer contents.
2779 blurb))
2782 "Copy displayed header fields to the message viewer buffer.
2783 BEG and END marks the start and end positions of the message in
2784 the mbox buffer. If the optional argument IGNORED-HEADERS is
2785 non-nil, ignore all header fields whose names match that regexp.
2786 Otherwise, if `rmail-displayed-headers' is non-nil, copy only
2787 those header fields whose names match that regexp. Otherwise,
2788 copy all header fields whose names do not match
2789 `rmail-ignored-headers' (unless they also match
2790 `rmail-nonignored-headers'). Moves point in the message viewer
2791 buffer to the end of the headers."
2793 lim)
2798 ;; Put point right after the From header line.
2805 ;; Handle the case where all headers should be copied.
2808 ;; rmail-show-message-1 expects this function to leave point
2809 ;; at the end of the headers.
2815 ;; Handle the case where the headers matching the displayed
2816 ;; headers regexp should be copied.
2826 ;; Handle the ignored headers.
2841 "Decode the body of the current message using coding system CODING.
2842 This is useful with mail messages that have malformed or missing
2843 charset= headers.
2845 This function assumes that the current message is already decoded
2846 and displayed in the RMAIL buffer, but the coding system used to
2847 decode it was incorrect. It then decodes the message again,
2848 using the coding system CODING."
2858 body-start x-coding-header old-coding)
2865 ;; Narrow to headers
2873 ;; Make sure the new coding system uses the same EOL
2874 ;; conversion, to prevent ^M characters from popping up
2875 ;; all over the place.
2883 ;; Rewrite the coding-system header.
2895 "Highlight the headers specified by `rmail-highlighted-headers'.
2896 Uses the face specified by `rmail-highlight-face'."
2904 ;; When rmail-highlight-face is removed, just
2905 ;; use 'rmail-highlight here.
2909 ;; List of overlays to reuse.
2915 overlay)
2918 ;; Back up over newline, then trailing spaces or tabs
2923 ;; Reuse an overlay we already have.
2929 ;; Make a new overlay and add it to
2930 ;; rmail-overlay-list.
2937 "Automatically move a message into a sub-folder based on criteria.
2938 Called when a new message is displayed."
2943 ;; Do nothing if the message has already been filed or if there
2944 ;; are no messages.
2945 nil
2946 ;; Find out some basics (common fields)
2964 ;; If there are no directives left, then it was a complete match.
2973 \f
2974 ;; Simple message motion commands.
2977 "Show following message whether deleted or not.
2978 With prefix arg N, moves forward N messages, or backward if N is negative."
2985 "Show previous message whether deleted or not.
2986 With prefix arg N, moves backward N messages, or forward if N is negative."
2991 "Show following non-deleted message.
2992 With prefix arg N, moves forward N non-deleted messages,
2993 or backward if N is negative.
2995 Returns t if a new message is being shown, nil otherwise."
3011 t)
3016 nil)))
3019 "Show previous non-deleted message.
3020 With prefix argument N, moves backward N non-deleted messages,
3021 or forward if N is negative."
3026 "Show first message in file."
3032 "Show last message in file."
3038 "For debugging Rmail: find the message number that point is in."
3043 rmail-view-buffer
3052 \f
3053 ;; Searching in Rmail file.
3056 "Return non-nil, if for message number MSG, regexp REGEXP matches."
3057 ;; This is adequate because its only caller, rmail-search,
3058 ;; unswaps the buffers.
3068 "Show message containing next match for REGEXP (but not the current msg).
3069 Prefix argument gives repeat count; negative argument means search
3070 backwards (through earlier messages).
3071 Interactively, empty argument means use same regexp used last time."
3076 regexp)
3093 regexp)
3099 found)
3105 ;; Check messages one by one, advancing message number up or
3106 ;; down but searching forward through each message.
3118 ;; Search forward (if this is a normal search) or backward
3119 ;; (if this is a reverse search) through this message to
3120 ;; position point. This search may fail because REGEXP
3121 ;; was found in the hidden portion of this message. In
3122 ;; that case, move point to the beginning of visible
3123 ;; portion.
3132 regexp))
3139 "Show message containing previous match for REGEXP.
3140 Prefix argument gives repeat count; negative argument means search
3141 forward (through later messages).
3142 Interactively, empty argument means use same regexp used last time."
3147 regexp)
3162 \f
3163 ;; Scan for attributes, and compare subjects.
3166 "Return message number of first message which has `unseen' attribute."
3169 found)
3176 found))
3179 "Return the simplified subject of message MSGNUM (or current message).
3180 Simplifying the subject means stripping leading and trailing whitespace,
3181 and typical reply prefixes such as Re:."
3189 ;; If Subject is long, mailers will break it into several lines at
3190 ;; arbitrary places, so normalize whitespace by replacing every
3191 ;; run of whitespace characters with a single space.
3193 subject))
3196 "Return a regular expression matching the current simplified subject.
3197 The idea is to match it against simplified subjects of other messages."
3200 ;; Hide commas so it will work ok if parsed as a comma-separated list
3201 ;; of regexps.
3207 "Go to the next mail message having the same subject header.
3208 With prefix argument N, do this N times.
3209 If N is negative, go backwards instead."
3214 found)
3234 "Go to the previous mail message having the same subject header.
3235 With prefix argument N, do this N times.
3236 If N is negative, go forwards instead."
3239 \f
3240 ;;;; *** Rmail Message Deletion Commands ***
3243 "Return non-nil if message number N is deleted (in `rmail-deleted-vector')."
3247 "Set the deleted state of message number N (in `rmail-deleted-vector').
3248 STATE non-nil means mark as deleted."
3252 "Delete this message and stay on it."
3258 "Back up to deleted message, select it, and undelete it."
3276 "Delete this message and move to next nondeleted one.
3278 With prefix argument, delete and move backward.
3280 Returns t if a new message is displayed after the delete, or nil otherwise."
3292 "Delete this message and move to previous nondeleted one.
3296 \f
3297 ;; Expunging.
3299 ;; Compute the message number a given message would have after expunging.
3300 ;; The present number of the message is OLDNUM.
3301 ;; DELETEDVEC should be rmail-deleted-vector.
3302 ;; The value is nil for a message that would be deleted.
3305 nil
3312 newnum)))
3315 "Return t if expunge is needed and desirable.
3316 If `rmail-confirm-expunge' is non-nil, ask user to confirm."
3323 t)))
3326 "Actually erase all deleted messages in the file."
3331 ;; Discard all undo records for this buffer.
3339 0
3346 ;; Don't make any undo records for the expunging.
3355 new-summary
3364 rmail-current-message nil
3365 rmail-message-vector nil
3366 rmail-deleted-vector nil
3367 rmail-summary-vector nil)
3383 new-summary))
3386 new-msgref))
3394 rmail-total-messages counter
3399 win t)))
3409 ;; The DONT-SHOW argument is new in 23. Does not seem very important.
3411 "Erase deleted messages from Rmail file and summary buffer.
3412 This always shows a message (so as not to leave the Rmail buffer
3413 unswapped), and always updates any summary (so that it remains
3414 consistent with the Rmail buffer). If DONT-SHOW is non-nil, it
3415 does not pop any summary buffer."
3422 ;; We always update the summary buffer, so that the contents
3423 ;; remain consistent with the rmail buffer.
3424 ;; The only difference is, in the dont-show case, we use a
3425 ;; cut-down version of rmail-select-summary that does not pop
3426 ;; the summary buffer. It's only used by rmail-quit, which is
3427 ;; just going to bury any summary immediately after. If we made
3428 ;; rmail-quit bury the summary first, dont-show could be removed.
3429 ;; But the expunge might not be confirmed...
3437 ;; We always show a message, because (rmail-only-expunge t)
3438 ;; leaves the rmail buffer unswapped.
3439 ;; If we expunged the current message, a new one is current now,
3440 ;; so show it. If we weren't showing a message, show it.
3443 ;; We can just show the same message that was being shown before.
3447 \f
3448 ;;;; *** Rmail Mailing Commands ***
3451 replybuffer sendactions same-window others)
3454 ;; The function used here must behave like insert-buffer wrt
3455 ;; point and mark (see doc of sc-cite-original).
3461 noerase nil
3462 yank-action sendactions)
3466 noerase 'switch-to-buffer-other-frame
3467 yank-action sendactions)
3468 ;; This is not a standard frame parameter;
3469 ;; nothing except sendmail.el looks at it.
3473 noerase 'switch-to-buffer-other-window
3474 yank-action sendactions)))))
3477 "Send mail in another window.
3479 original message into it."
3483 ;; FIXME should complain if there is nothing to continue.
3485 "Continue composing outgoing message previously being composed."
3490 "Reply to the current message.
3491 Normally include CC: to all other recipients of original message;
3492 prefix argument means ignore them. While composing the reply,
3498 resent-to resent-cc resent-reply-to
3501 rmail-current-message
3508 from)
3514 ;; Bug#512. It's inappropriate to reply to these addresses.
3515 ;;; resent-cc (and (not just-sender)
3516 ;;; (mail-fetch-field "resent-cc" nil t))
3517 ;;; resent-to (or (mail-fetch-field "resent-to" nil t) "")
3518 ;;; resent-subject (mail-fetch-field "resent-subject")
3519 ;;; resent-date (mail-fetch-field "resent-date")
3520 ;;; resent-message-id (mail-fetch-field "resent-message-id")
3521 )
3524 ;; If this header field is present, use it instead of the
3525 ;; To and CC fields.
3529 ;; Merge the resent-to and resent-cc into the to and cc.
3530 ;; Bug#512. It's inappropriate to reply to these addresses.
3531 ;;; (if (and resent-to (not (equal resent-to "")))
3532 ;;; (if (not (equal to ""))
3533 ;;; (setq to (concat to ", " resent-to))
3534 ;;; (setq to resent-to)))
3535 ;;; (if (and resent-cc (not (equal resent-cc "")))
3536 ;;; (if (not (equal cc ""))
3537 ;;; (setq cc (concat cc ", " resent-cc))
3538 ;;; (setq cc resent-cc)))
3539 ;; Add `Re: ' to subject if not there already.
3546 subject))))
3548 nil
3549 ;; Using mail-strip-quoted-names is undesirable with newer mailers
3550 ;; since they can handle the names unstripped.
3551 ;; I don't know whether there are other mailers that still
3552 ;; need the names to be stripped.
3553 ;;; (mail-strip-quoted-names reply-to)
3554 ;; Remove unwanted names from reply-to, since Mail-Followup-To
3555 ;; header causes all the names in it to wind up in reply-to, not
3556 ;; in cc. But if what's left is an empty list, use the original.
3559 subject
3562 nil
3563 ;; mail-strip-quoted-names is NOT necessary for rmail-dont-reply-to
3564 ;; to do its job.
3570 rmail-buffer
3571 rmail-view-buffer)
3573 rmail-buffer
3576 rmail-answered-attr-index))
3577 nil
3583 message-id)))))))
3584 \f
3586 "Give BUFFER's message number in MSGNUM-LIST the attribute ATTRIBUTE.
3587 This is use in the send-actions for message buffers.
3588 MSGNUM-LIST is a list of the form (MSGNUM)
3589 which is an element of rmail-msgref-vector."
3597 message-id
3598 nil))
3608 tem))
3609 message-id))
3610 ;; missing From, or Message-ID is sufficiently informative
3611 message-id
3613 ;; Copy TEM, discarding text properties.
3617 ;; Use prin1 to fake RFC822 quoting
3621 field)))))
3624 ;; These strings both match all non-ASCII characters.
3627 ;; "Unix Loser <Foo@bar.edu>" => "Unix Loser"
3628 from)
3631 ;; "<Bugs@bar.edu>" (Losing Unix) => "Losing Unix"
3632 from)))
3635 ;; Trim whitespace which above regexp match allows
3645 ;; "<AA259@bar.edu> (message from Unix Loser on 1-Apr-89)"
3647 field))))
3649 ;; If we can't kludge it simply, do it correctly
3652 \f
3654 "Forward the current message to another user.
3656 see the documentation of `rmail-resend'."
3671 nil nil subject nil nil nil
3673 forward-buffer
3676 rmail-forwarded-attr-index))
3677 ;; If only one window, use it for the mail buffer.
3678 ;; Otherwise, use another window for the mail buffer
3679 ;; so that the Rmail buffer remains visible
3680 ;; and sending the mail will get back to it.
3682 ;; The mail buffer is now current.
3684 ;; Insert after header separator--before signature if any.
3689 forward-buffer)
3691 ;; Quote lines with `- ' if they start with `-'.
3709 \f
3711 "Resend current message to ADDRESSES.
3712 ADDRESSES should be a single address, a string consisting of several
3713 addresses separated by commas, or a list of addresses.
3715 Optional FROM is the address to resend the message from, and
3716 defaults from the value of `user-mail-address'.
3717 Optional COMMENT is a string to insert as a comment in the resent message.
3718 Optional ALIAS-FILE is alternate aliases file to be used by sendmail,
3719 typically for purposes of moderating a list."
3734 ;;>> Copy message into temp buffer
3741 ;; Delete any Sender field, since that's not specifiable.
3742 ; Only delete Sender fields in the actual header.
3744 ; Using "while" here rather than "if" because some buggy mail
3745 ; software may have inserted multiple Sender fields.
3753 ; Go back to the beginning of the buffer so the Resent- fields
3754 ; are inserted there.
3756 ;;>> Insert resent-from:
3759 ;;>> Insert resent-to: and bcc if need be.
3764 address
3767 ;; Expand abbrevs in the recipients.
3786 ;;>> Set up comment, if any.
3789 after)
3797 ;; Don't expand aliases in the destination fields
3798 ;; of the original message.
3804 \f
3822 ;; This is a cut-down version of rmail-clear-headers from Emacs 22.
3823 ;; It doesn't have the same functionality, hence the name change.
3825 "Delete any mail headers matching REGEXP.
3826 The message should be narrowed to just the headers."
3831 ;; This code from Emacs 22 doesn't seem right, since r-n-h is
3832 ;; just for display.
3833 ;;; (if (looking-at rmail-nonignored-headers)
3834 ;;; (forward-line 1)
3846 "Edit a mail message which is based on the contents of the current message.
3847 For a message rejected by the mail system, extract the interesting headers and
3848 the body of the original message.
3849 If the failed message is a MIME multipart message, it is searched for a
3850 body part with a header which matches the variable `mail-mime-unsent-header'.
3851 Otherwise, the variable `mail-unsent-separator' should match the string that
3852 delimits the returned original message.
3853 The variable `rmail-retry-ignored-headers' is a regular expression
3854 specifying headers which should not be copied into the new message."
3859 bounce-start bounce-end bounce-indent resending
3867 content-type))
3868 ;; Handle a MIME multipart bounce message.
3881 ;; Non-MIME bounce.
3885 ;; Support a style of failure message in which the original
3886 ;; message is indented, and included within lines saying
3887 ;; `Start of returned message' and `End of returned message'.
3896 ;; One message contained a few random lines before
3897 ;; the old message header. The first line of the
3898 ;; message started with two hyphens. A blank line
3899 ;; followed these random lines. The same line
3900 ;; beginning with two hyphens was possibly marking
3901 ;; the end of the message.
3916 ;; We have found the message that bounced, within the current message.
3917 ;; Now start sending new message; default header fields from original.
3918 ;; Turn off the usual actions for initializing the message body
3919 ;; because we want to get only the text from the failure message.
3923 rmail-this-buffer
3925 rmail-retried-attr-index)))
3926 ;; Insert original text as initial text of new draft message.
3927 ;; Bind inhibit-read-only since the header delimiter
3928 ;; of the previous message was probably read-only.
3932 bounce-start bounce-end)
3936 ;; FIXME better to replace sendmail functions.
3950 \f
3952 "Non-nil if in an RMAIL buffer and an associated summary buffer exists.
3953 In fact, the non-nil value returned is the summary buffer itself."
3955 rmail-summary-buffer))
3958 "t if in RMAIL buffer and an associated summary buffer is displayed."
3962 "Non-nil means Rmail should show the summary when it changes.
3963 This has an effect only if a summary buffer exists."
3968 "Non-nil means specify the height for an Rmail summary window."
3972 ;; Put the summary buffer back on the screen, if user wants that.
3975 window)
3976 ;; If requested, make sure the summary is displayed.
3978 rmail-redisplay-summary
3980 ;; It's already in some frame; show that one.
3986 ;; If requested, set the height of the summary window.
3988 rmail-summary-window-size
3990 ;; Don't try to change the size if just one window in frame.
3997 \f
3998 ;;;; *** Rmail Local Fontification ***
4001 ;; This function's symbol is bound to font-lock-fontify-buffer-function.
4003 ;; If we're already showing a message, fontify it now.
4005 ;; Prevent Font Lock mode from kicking in.
4009 ;; This function's symbol is bound to font-lock-fontify-unbuffer-function.
4012 before-change-functions after-change-functions
4013 buffer-file-name buffer-file-truename)
4023 ;; Fontify the current message if it is not already fontified.
4027 before-change-functions after-change-functions
4028 buffer-file-name buffer-file-truename)
4035 \f
4036 ;;; Speedbar support for RMAIL files.
4040 "*This regex is used to match folder names to be displayed in speedbar.
4041 Enabling this will permit speedbar to display your folders for easy
4051 "Install those variables used by speedbar to enhance rmail."
4053 nil
4062 ;; Mouse-3.
4070 ;; Make sure our special speedbar major mode is loaded
4076 "Create buttons for BUFFER containing rmail messages.
4077 Click on the address under Reply to: to reply to this person.
4078 Under Folders: Click a name to read it, or on the <M> to move the
4079 current message into that RMAIL folder."
4087 nil
4092 nil
4102 default-directory)
4103 nil rmail-speedbar-match-folder-regexp)))
4112 "Execute an rmail command specified by TEXT.
4113 The command used is TOKEN. INDENT is not used."
4118 "Load in the rmail file TEXT.
4119 TOKEN and INDENT are not used."
4125 "If the current line is a folder, move current message to it."
4135 "From button TEXT, copy current message to the rmail file specified by TOKEN.
4136 TEXT and INDENT are not used."
4139 ;; expand-file-name is needed due to the unhelpful way in which
4140 ;; rmail-output expands non-absolute filenames against rmail-default-file.
4141 ;; What is the point of that, anyway?
4144 ;; Functions for setting, getting and encoding the POP password.
4145 ;; The password is encoded to prevent it from being easily accessible
4146 ;; to "prying eyes." Obviously, this encoding isn't "real security,"
4147 ;; nor is it meant to be.
4149 ;;;###autoload
4151 "Set PASSWORD to be used for retrieving mail from a POP or IMAP server."
4160 "Get the password for retrieving mail from a POP or IMAP server. If none
4161 has been set, then prompt the user for one."
4166 "IMAP password: "
4176 "Encode STRING with integer MASK, by taking the exclusive OR of the
4177 lowest byte in the mask with the first character of string, the
4178 second-lowest-byte with the second character of the string, etc.,
4179 restarting at the lowest byte of the mask whenever it runs out.
4180 Returns the encoded string. Calling the function again with an
4181 encoded string (and the same mask) will decode the string."
4194 ;;;; Desktop support
4197 desktop-buffer-name
4198 desktop-buffer-misc)
4199 "Restore an rmail buffer specified in a desktop file."
4205 rmail-buffer))
4208 nil)))
4213 ;; We use this to record the encoding of the current message before
4214 ;; saving the message collection.
4217 ;; Used in `write-region-annotate-functions' to write rmail files.
4223 nil))
4225 ;; Used to restore the encoding of the buffer where we show the
4226 ;; current message, after we save the message collection. This is
4227 ;; needed because rmail-write-region-annotate switches buffers behind
4228 ;; save-file's back, with the side effect that last-coding-system-used
4229 ;; is assigned to buffer-file-coding-system of the wrong buffer.
4238 \f
4239 ;;; Start of automatically extracted autoloads.
4240 \f
4241 ;;;### (autoloads (rmail-edit-current-message) "rmailedit" "rmailedit.el"
4242 ;;;;;; "4bf8a5cdfc921b9e30680ee71b7f9ca6")
4243 ;;; Generated autoloads from rmailedit.el
4246 Edit the contents of this message.
4250 ;;;***
4251 \f
4252 ;;;### (autoloads (rmail-next-labeled-message rmail-previous-labeled-message
4253 ;;;;;; rmail-read-label rmail-kill-label rmail-add-label) "rmailkwd"
4254 ;;;;;; "rmailkwd.el" "112240cbb53c402294013cc49987771a")
4255 ;;; Generated autoloads from rmailkwd.el
4258 Add LABEL to labels associated with current RMAIL message.
4259 Completes (see `rmail-read-label') over known labels when reading.
4260 LABEL may be a symbol or string. Only one label is allowed.
4265 Remove LABEL from labels associated with current RMAIL message.
4266 Completes (see `rmail-read-label') over known labels when reading.
4267 LABEL may be a symbol or string. Only one label is allowed.
4272 Read a label with completion, prompting with PROMPT.
4273 Completions are chosen from `rmail-label-obarray'. The default
4274 is `rmail-last-label', if that is non-nil. Updates `rmail-last-label'
4275 according to the choice made, and returns a symbol.
4280 Show previous message with one of the labels LABELS.
4281 LABELS should be a comma-separated list of label names.
4282 If LABELS is empty, the last set of labels specified is used.
4283 With prefix argument N moves backward N messages with these labels.
4288 Show next message with one of the labels LABELS.
4289 LABELS should be a comma-separated list of label names.
4290 If LABELS is empty, the last set of labels specified is used.
4291 With prefix argument N moves forward N messages with these labels.
4295 ;;;***
4296 \f
4297 ;;;### (autoloads (rmail-mime) "rmailmm" "rmailmm.el" "9f67f3b67de9b700b128b73c52abfefa")
4298 ;;; Generated autoloads from rmailmm.el
4301 Process the current Rmail message as a MIME message.
4303 copy of the message. Inline content-types are handled according to
4304 `rmail-mime-media-type-handlers-alist'. By default, this
4305 displays text and multipart messages, and offers to download
4306 attachments as specfied by `rmail-mime-attachment-dirs-alist'.
4310 ;;;***
4311 \f
4312 ;;;### (autoloads (set-rmail-inbox-list) "rmailmsc" "rmailmsc.el"
4313 ;;;;;; "c3575020691d5769bcf08ecc932304c3")
4314 ;;; Generated autoloads from rmailmsc.el
4317 Set the inbox list of the current RMAIL file to FILE-NAME.
4318 You can specify one file name, or several names separated by commas.
4319 If FILE-NAME is empty, remove any existing inbox list.
4321 This applies only to the current session.
4325 ;;;***
4326 \f
4327 ;;;### (autoloads (rmail-sort-by-labels rmail-sort-by-lines rmail-sort-by-correspondent
4328 ;;;;;; rmail-sort-by-recipient rmail-sort-by-author rmail-sort-by-subject
4329 ;;;;;; rmail-sort-by-date) "rmailsort" "rmailsort.el" "b96e85edd736f23f1e9d54a299268d1e")
4330 ;;; Generated autoloads from rmailsort.el
4334 If prefix argument REVERSE is non-nil, sorts in reverse order.
4341 non-nil, sorts in reverse order.
4346 Sort messages of current Rmail buffer by author.
4348 If prefix argument REVERSE is non-nil, sorts in reverse order.
4353 Sort messages of current Rmail buffer by recipient.
4355 If prefix argument REVERSE is non-nil, sorts in reverse order.
4360 Sort messages of current Rmail buffer by other correspondent.
4363 excluded by `rmail-dont-reply-to-names'. If prefix argument
4364 REVERSE is non-nil, sorts in reverse order.
4369 Sort messages of current Rmail buffer by the number of lines.
4370 If prefix argument REVERSE is non-nil, sorts in reverse order.
4375 Sort messages of current Rmail buffer by labels.
4376 LABELS is a comma-separated list of labels. The order of these
4377 labels specifies the order of messages: messages with the first
4378 label come first, messages with the second label come second, and
4379 so on. Messages that have none of these labels come last.
4380 If prefix argument REVERSE is non-nil, sorts in reverse order.
4384 ;;;***
4385 \f
4386 ;;;### (autoloads (rmail-summary-by-senders rmail-summary-by-topic
4387 ;;;;;; rmail-summary-by-regexp rmail-summary-by-recipients rmail-summary-by-labels
4388 ;;;;;; rmail-summary) "rmailsum" "rmailsum.el" "4715fb58fb191bf6b192458ea75524b2")
4389 ;;; Generated autoloads from rmailsum.el
4392 Display a summary of all messages, one line per message.
4397 Display a summary of all messages with one or more LABELS.
4398 LABELS should be a string containing the desired labels, separated by commas.
4403 Display a summary of all messages with the given RECIPIENTS.
4404 Normally checks the To, From and Cc fields of headers;
4405 but if PRIMARY-ONLY is non-nil (prefix arg given),
4406 only look in the To and From fields.
4407 RECIPIENTS is a string of regexps separated by commas.
4412 Display a summary of all messages according to regexp REGEXP.
4413 If the regular expression is found in the header of the message
4414 \(including in the date and other lines, as well as the subject line),
4415 Emacs will list the message in the summary.
4420 Display a summary of all messages with the given SUBJECT.
4421 Normally checks just the Subject field of headers; but with prefix
4422 argument WHOLE-MESSAGE is non-nil, looks in the whole message.
4423 SUBJECT is a string of regexps separated by commas.
4429 SENDERS is a string of regexps separated by commas.
4433 ;;;***
4434 \f
4435 ;;;### (autoloads (unforward-rmail-message undigestify-rmail-message)
4436 ;;;;;; "undigest" "undigest.el" "8cf8a8ffa48eeddf0bde388fa8de1783")
4437 ;;; Generated autoloads from undigest.el
4440 Break up a digest message into its constituent messages.
4441 Leaves original message, deleted, before the undigestified messages.
4446 Extract a forwarded message from the containing message.
4447 This puts the forwarded message into a separate rmail message
4448 following the containing message.
4452 ;;;***
4453 \f
4454 ;;; End of automatically extracted autoloads.
4459 ;; arch-tag: 65d257d3-c281-4a65-9c38-e61af95af2f0
4460 ;;; rmail.el ends here