| blob | 370999dabf85319ac43f5b2b49ceef5b277b0a73 |
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, 2011
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 ;;
50 ;;; Attribute indexes
85 "An array that provides a mapping between an attribute index,
97 "The current header display style choice, one of
100 ;; rmail-spool-directory and rmail-file-name are defined in paths.el.
103 "Mail reader for Emacs."
107 "Rmail retrieval options."
112 "Rmail files."
117 "Rmail header options."
122 "Rmail reply options."
127 "Rmail summary options."
133 "Output message to a file."
139 "Rmail editing."
144 "If non-nil, the file name of the `movemail' program."
152 "Password to use when reading mail from a remote server.
153 This setting is ignored for mailboxes whose URL already contains a password."
163 "Non-nil if a password is required when reading mail from a remote server."
169 "List of flags to pass to movemail.
170 Most commonly used to specify `-g' to enable GSS-API authentication
171 or `-k' to enable Kerberos authentication."
178 "Regular expression matching incorrect-password POP or IMAP server error
179 messages.
180 If you get an incorrect-password error that this expression does not match,
186 "Non-nil means leave incoming mail in the user's inbox--don't delete it."
191 "List of directories to search for movemail (in addition to `exec-path')."
199 "Determine what flavor of movemail PROG is.
200 We do this by executing it with `--version' and analyzing its output."
206 ;; Should not happen...
207 nil
215 ;; FIXME:
219 "Determine the file name of the `movemail' program and return its flavor.
220 If `rmail-movemail-program' is non-nil, use it.
221 Otherwise, look for `movemail' in the directories in
222 `rmail-movemail-search-path', those in `exec-path', and `exec-directory'."
229 ;; Previously, this didn't have to work on Windows, because
230 ;; rmail-insert-inbox-text before r1.439 fell back to using
231 ;; (expand-file-name "movemail" exec-directory) and just
232 ;; assuming it would work.
233 ;; http://lists.gnu.org/archive/html/bug-gnu-emacs/2008-02/msg00087.html
246 "The movemail variant currently in use. Known variants are:
248 `emacs' Means any implementation, compatible with the native Emacs one.
249 This is the default;
250 `mailutils' Means GNU mailutils implementation, capable of handling full
253 ;;;###autoload
255 "Return t if the current movemail variant is any of VARIANTS.
256 Currently known variants are 'emacs and 'mailutils."
258 ;; Autodetect
262 ;; Call for effect, to set rmail-movemail-program (if not set by the
263 ;; user), and rmail-movemail-variant-in-use. Used by various functions.
264 ;; I'm not sure if M-x rmail is the only entry point to this package.
265 ;; If so, this can be moved there.
268 ;;;###autoload
270 "Regexp matching user mail addresses.
271 If non-nil, this variable is used to identify the correspondent
272 when receiving new mail. If it matches the address of the sender,
273 the recipient is taken as correspondent of a mail.
274 If nil \(default value\), your `user-login-name' and `user-mail-address'
275 are used to exclude yourself as correspondent.
277 Usually you don't have to set this variable, except if you collect mails
278 sent by you under different user names.
279 Then it should be a regexp matching your mail addresses.
281 Setting this variable has an effect only before reading a mail."
286 ;;;###autoload
288 "A regexp specifying addresses to prune from a reply message.
289 If this is nil, it is set the first time you compose a reply, to
290 a value which excludes your own email address, plus whatever is
291 specified by `rmail-default-dont-reply-to-names'.
293 Matching addresses are excluded from the CC field in replies, and
294 also the To field, unless this would leave an empty To field."
298 ;;;###autoload
300 "Regexp specifying part of the default value of `rmail-dont-reply-to-names'.
301 This is used when the user does not set `rmail-dont-reply-to-names'
302 explicitly. (The other part of the default value is the user's
303 email address and name.) It is useful to set this variable in
304 the site customization file. The default value is conventionally
306 ;; Is it really useful to set this site-wide?
308 ;;;###autoload
328 "Regexp to match header fields that Rmail should normally hide.
329 \(See also `rmail-nonignored-headers', which overrides this regexp.)
330 This variable is used for reformatting the message header,
331 which normally happens once for each message,
332 when you view the message for the first time in Rmail.
333 To make a change in this variable take effect
334 for a message that you have already viewed,
340 "Regexp to match X header fields that Rmail should show.
341 This regexp overrides `rmail-ignored-headers'; if both this regexp
342 and that one match a certain header field, Rmail shows the field.
343 If this is nil, ignore all header fields in `rmail-ignored-headers'.
345 This variable is used for reformatting the message header,
346 which normally happens once for each message,
347 when you view the message for the first time in Rmail.
348 To make a change in this variable take effect
349 for a message that you have already viewed,
354 ;;;###autoload
356 "Regexp to match Header fields that Rmail should display.
357 If nil, display all header fields except those matched by
358 `rmail-ignored-headers'."
362 ;;;###autoload
363 (defcustom rmail-retry-ignored-headers (purecopy "^x-authentication-warning:\\|^x-detected-operating-system:\\|^x-spam[-a-z]*:\\|content-type:\\|content-transfer-encoding:\\|mime-version:")
364 "Headers that should be stripped when retrying a failed message."
369 ;;;###autoload
371 "Regexp to match Header fields that Rmail should normally highlight.
372 A value of nil means don't highlight. Uses the face `rmail-highlight'."
378 "Face to use for highlighting the most important header fields.
379 The variable `rmail-highlighted-headers' specifies which headers."
383 ;; This was removed in Emacs 23.1 with no notification, an unnecessary
384 ;; incompatible change.
386 "Face used by Rmail for highlighting headers."
387 ;; Note that nil doesn't actually mean use the default face, it
388 ;; means use either bold or highlight. It's not worth fixing this
389 ;; now that this is obsolete.
391 face)
394 "customize the face `rmail-highlight' instead."
399 "Face to use for highlighting the header names.
400 The variable `rmail-font-lock-keywords' specifies which headers
401 get highlighted."
406 "Non-nil means automatically delete a message that is copied to a file."
410 ;;;###autoload
412 "List of files that are inboxes for your primary mail file `rmail-file-name'.
413 If this is nil, uses the environment variable MAIL. If that is
414 unset, uses a file named by the function `user-login-name' in the
415 directory `rmail-spool-directory' (whose value depends on the
417 ;; Don't use backquote here, because we don't want to need it at load time.
418 ;; (That must be an old comment - it's dumped these days.)
428 "Non-nil means Rmail makes a new frame for composing outgoing mail.
429 This is handy if you want to preserve the window configuration of
430 the frame where you have the RMAIL buffer displayed."
434 ;;;###autoload
436 "Directory for additional secondary Rmail files."
439 ;;;###autoload
441 "Regexp for which files are secondary Rmail files."
446 "Whether and how to ask for confirmation before expunging deleted messages.
447 The value, if non-nil is a function to call with a question (string)
448 as argument, to ask the user that question."
456 ;;;###autoload
463 ;;;###autoload
465 "List of functions to call when Rmail displays a message."
474 "List of functions to call when Rmail deletes a message.
475 When the hooks are called, the message has been marked deleted but is
478 ;; These may be altered by site-init.el to match the format of mmdf files
479 ;; delimiting used on a given host (delim1 and delim2 from the config
480 ;; files).
487 ;; FIXME Post-mbox, this is now unused.
488 ;; In Emacs-22, this was called:
489 ;; i) the very first time a message was shown.
490 ;; ii) when toggling the headers to the normal state, every time.
491 ;; It's not clear what it should do now, since there is nothing that
492 ;; records when a message is shown for the first time (unseen is not
493 ;; necessarily the same thing).
495 "If non-nil, a filter function for new messages in RMAIL.
496 Called with region narrowed to the message, including headers,
497 before obeying `rmail-ignored-headers'."
502 "List of directives specifying where to put a message.
503 Each element of the list is of the form:
505 (FOLDERNAME FIELD REGEXP [ FIELD REGEXP ] ... )
507 Where FOLDERNAME is the name of a folder to put the message.
508 If any of the field regexp's are nil, then it is ignored.
511 If FOLDERNAME is nil then it is deleted, and skipped.
513 FIELD is the plain text name of a field in the message, such as
517 REGEXP is an expression to match in the preceeding specified FIELD.
518 FIELD/REGEXP pairs continue in the list.
520 examples:
524 Note that this is only applied in the folder specifed by `rmail-file-name'."
532 ;; Some mailers use "Re(2):" or "Re^2:" or "Re: Re:" or "Re[2]:".
533 ;; This pattern should catch all the common variants.
534 ;; rms: I deleted the change to delete tags in square brackets
535 ;; because they mess up RT tags.
540 "If non-nil, Rmail always displays the summary buffer."
543 \f
548 "The RMAIL buffer related to the current buffer.
549 In an RMAIL buffer, this holds the RMAIL buffer itself.
561 ;; Message counters and markers. Deleted flags.
568 "Integer specifying the total number of messages in this folder.
573 "Vector of markers specifying the start and end of each message.
578 "A string of length `rmail-total-messages' plus one.
584 "In an Rmail buffer, a vector whose Nth element is a list (N).
585 When expunging renumbers messages, these lists are modified
592 ;; These are used by autoloaded rmail-summary.
597 "In an Rmail buffer, vector of (newline-terminated) strings.
601 ;; Rmail buffer swapping variables.
612 \f
613 ;; `Sticky' default variables.
615 ;; Last individual label specified to a or k.
618 ;; Last set of values specified to C-M-n, C-M-p, C-M-s or C-M-l.
634 ;; Mule and MIME related variables.
636 ;;;###autoload
638 "Coding system used in RMAIL file.
643 "If non-nil, RMAIL uses MIME features.
644 If the value is t, RMAIL automatically shows MIME decoded message.
645 If the value is neither t nor nil, RMAIL does not show MIME decoded message
646 until a user explicitly requires it.
648 Even if the value is non-nil, you can't use MIME features
649 unless the feature specified by `rmail-mime-feature' is available."
659 ;; FIXME unused.
661 "Function to show MIME decoded message of RMAIL file.
662 This function is called when `rmail-enable-mime' is non-nil.
665 ;;;###autoload
667 "Function to insert a message in MIME format so it can be forwarded.
668 This function is called if `rmail-enable-mime' or
669 `rmail-enable-mime-composing' is non-nil.
670 It is called with one argument FORWARD-BUFFER, which is a
671 buffer containing the message to forward. The current buffer
675 "Function to insert a message in MIME format so it can be resent.
676 This function is called by `rmail-resend' if `rmail-enable-mime' is non-nil.
677 It is called with one argument FORWARD-BUFFER, which is a
678 buffer containing the message to forward. The current buffer
681 ;; FIXME one might want to pass a LIMIT, as per
682 ;; rmail-search-mime-header-function.
684 "Function to check if a regexp matches a MIME message.
685 This function is called by `rmail-search-message' if
686 `rmail-enable-mime' is non-nil. It is called (with point at the
687 start of the message) with two arguments MSG and REGEXP, where
691 "Function to check if a regexp matches a header of MIME message.
692 This function is called by `rmail-message-regexp-p-1' if
693 `rmail-enable-mime' is non-nil. It is called (with point at the
694 start of the header) with three arguments MSG, REGEXP, and LIMIT,
695 where MSG is the message number, REGEXP is the regular
699 "Feature to require to load MIME support in Rmail.
700 When starting Rmail, if `rmail-enable-mime' is non-nil,
701 this feature is required with `require'.
705 ;; FIXME this is unused.
707 "*Non-nil means a message is decoded by MIME's charset specification.
708 If this variable is nil, or the message has not MIME specification,
709 the message is decoded as normal way.
711 If the variable `rmail-enable-mime' is non-nil, this variable is
712 ignored, and all the decoding work is done by a feature specified by
719 "Regexp to match MIME-charset specification in a header of message.
722 \f
730 "From "
732 ;; Many things can happen to an RFC 822 mailbox before it is put into
733 ;; a `From' line. The leading phrase can be stripped, e.g.
734 ;; `Joe <@w.x:joe@y.z>' -> `<@w.x:joe@y.z>'. The <> can be stripped, e.g.
735 ;; `<@x.y:joe@y.z>' -> `@x.y:joe@y.z'. Everything starting with a CRLF
736 ;; can be removed, e.g.
737 ;; From: joe@y.z (Joe K
738 ;; User)
739 ;; can yield `From joe@y.z (Joe K Fri Mar 22 08:11:15 1996', and
740 ;; From: Joe User
741 ;; <joe@y.z>
742 ;; can yield `From Joe User Fri Mar 22 08:11:15 1996'.
743 ;; The mailbox can be removed or be replaced by white space, e.g.
744 ;; From: "Joe User"{space}{tab}
745 ;; <joe@y.z>
746 ;; can yield `From {space}{tab} Fri Mar 22 08:11:15 1996',
747 ;; where {space} and {tab} represent the Ascii space and tab characters.
748 ;; We want to match the results of any of these manglings.
749 ;; The following regexp rejects names whose first characters are
750 ;; obviously bogus, but after that anything goes.
753 ;; The time the message was sent.
759 ;; Perhaps a time zone, specified by an abbreviation, or by a
760 ;; numeric offset.
761 time-zone-regexp
763 ;; The year.
766 ;; On some systems the time zone can appear after the year, too.
767 time-zone-regexp
769 ;; Old uucp cruft.
773 "Regexp matching the delimiter of messages in UNIX mail format
774 \(UNIX From lines), minus the initial ^. Note that if you change
775 this expression, you must change the code in `rmail-nuke-pinhead-header'
778 ;; FIXME the rmail-header-name headers ought to be customizable.
779 ;; It seems a bit arbitrary, for example, that all of the Date: line
780 ;; gets highlighted.
782 ;; These are all matched case-insensitively.
790 ;; FIXME Mail-Followup-To should probably be here too.
795 ;; Use MATCH-ANCHORED to effectively anchor the regexp left side.
796 `(,cite-chars
808 ;; Rmail does not expect horizontal splitting. (Bug#2282)
810 "Like `pop-to-buffer', but with `split-width-threshold' set to nil."
814 ;; Perform BODY in the summary buffer
815 ;; in such a way that its cursor is properly updated in its own window.
824 ;; rmail-total-messages is a buffer-local var
825 ;; in the rmail buffer.
826 ;; This way we make it available for the body
827 ;; even tho the rmail buffer is not current.
835 \f
836 ;;;; *** Rmail Mode ***
839 "Require `rmail-mime-feature' if that is non-nil.
840 Signal an error and set `rmail-mime-feature' to nil if the feature
841 isn't provided."
847 'rmail
849 by setting `rmail-enable-mime' to non-nil, the required feature
850 `%s' (the value of `rmail-mime-feature')
851 is not available in the current session.
852 So, the MIME support is turned off for the moment."
853 rmail-mime-feature)
858 ;;;###autoload
860 "Read and edit incoming mail.
861 Moves messages into file named by `rmail-file-name' and edits that
862 file in RMAIL Mode.
865 May be called with file name as argument; then performs rmail editing on
866 that file, but does not copy any new mail into the file.
867 Interactively, if you supply a prefix argument, then you
868 have a chance to specify a file name with the minibuffer.
870 If `rmail-display-summary' is non-nil, make a summary for this RMAIL file."
875 ;; Use find-buffer-visiting, not get-file-buffer, for those users
876 ;; who have find-file-visit-truename set to t.
878 run-mail-hook mail-buf msg-shown)
879 ;; Determine if an existing mail file has been changed behind the
880 ;; scene...
882 ;; The mail file has been changed. Revisit it and reset the
883 ;; message state variables when in rmail mode.
890 ;; The mail file is either unchanged or not visited. Visit it.
893 ;; Force no-conversion by default, since that's what
894 ;; pre-mbox Rmail did with BABYL files (via
895 ;; auto-coding-regexp-alist).
899 ;; Ensure that the collection and view buffers are in sync and
900 ;; ensure that a message is not being edited.
907 ;; Ensure that the Rmail file is in mbox format, the buffer is in
908 ;; Rmail mode and has been scanned to find all the messages
909 ;; (setting the global message variables in the process).
916 ;; Show the first unread message and process summary mode.
918 ;; Only get new mail when there is not a file name argument.
931 "Determine if the file needs to be converted to mbox format."
934 ;; Detect previous Babyl format files.
937 ;; The file is Babyl version 5. Use unrmail to convert
938 ;; it.
941 ;; Losing babyl file made by old version of Rmail. Fix the
942 ;; babyl file header and use unrmail to convert to mbox
943 ;; format.
953 "Report that the buffer is not in the mbox file format.
954 MSGNUM, if present, indicates the malformed message."
960 "Convert the mail file from Babyl version 5 to mbox.
961 This function also reinitializes local variables used by Rmail."
975 ;; Rmail buffers need to be saved with Unix EOLs, or else
976 ;; the format will not be recognized.
990 "Return a suitable coding system to use for the current mail message.
991 The buffer is expected to be narrowed to just the header of the message."
997 \f
998 ;;; Set up Rmail mode keymaps
1009 ;; If you change this, change the rmail-resend menu-item's :keys.
1034 ;; I find I can't live without the default M-r command -- rms.
1035 ;; (define-key rmail-mode-map "\er" 'rmail-search-backwards)
1061 \f
1068 nil)
1071 nil)
1178 map)
1181 ;; Rmail toolbar
1185 map rmail-mode-map)
1187 map rmail-mode-map)
1189 map rmail-mode-map)
1191 map rmail-mode-map)
1193 map rmail-mode-map)
1195 map rmail-mode-map)
1197 map rmail-mode-map)
1199 map rmail-mode-map)
1201 map rmail-mode-map)
1203 map rmail-mode-map)
1205 map rmail-mode-map)
1207 map rmail-mode-map)
1208 map))
1211 \f
1212 ;; Rmail mode is suitable only for specially formatted data.
1220 ;;;###autoload
1223 All normal editing commands are turned off.
1224 Instead, these commands are available:
1240 \\[rmail-undelete-previous-message] Undelete message. Tries current message, then earlier messages
1241 till a deleted message is found.
1242 \\[rmail-edit-current-message] Edit the current message. \\[rmail-cease-edit] to return to Rmail.
1255 \\[rmail-output-body-to-file] Save message body to a file. Default filename comes from Subject line.
1260 (label defaults to last one specified).
1261 Standard labels: filed, unseen, answered, forwarded, deleted.
1299 ;; No need to auto save RMAIL files in normal circumstances
1300 ;; because they contain no info except attribute changes
1301 ;; and deletion of messages.
1302 ;; The one exception is when messages are copied into another mbox buffer.
1303 ;; rmail-output enables auto save when you do that.
1308 ;; Functions to support buffer swapping:
1315 "Return a reusable buffer suitable for viewing messages.
1316 Create the buffer if necessary."
1317 ;; We want to reuse any existing view buffer, so as not to create an
1318 ;; endless number of them. But we must avoid clashes if we visit
1319 ;; two different rmail files with the same basename (Bug#4593).
1322 rmail-view-buffer
1328 "Swap text between current buffer and `rmail-view-buffer'.
1329 This function preserves the current buffer's modified flag, and also
1330 sets the current buffer's `buffer-file-coding-system' to that of
1331 `rmail-view-buffer'."
1338 buffer-file-coding-system)))
1347 "Return non-nil if the message collection is in `rmail-view-buffer'."
1348 ;; This is analogous to tar-data-swapped-p in tar-mode.el.
1350 rmail-buffer-swapped))
1353 ;; Bring the actual Rmail messages back into the main buffer.
1359 "Determine if the Rmail buffer is showing a message.
1360 If so restore the actual mbox message collection."
1367 "Warn if important modifications would change Rmail file's format."
1370 ;; If it's already modified, don't warn again.
1387 ;; Set up the permanent locals associated with an Rmail file.
1400 ;; Note that this does not erase the buffer. Should it?
1401 ;; It depends on how this is called. If somehow called with the
1402 ;; rmail buffers swapped, it would erase the message collection.
1405 ;; Force C-x C-s write Unix EOLs.
1415 ;; Provide default set of inboxes for primary mail file ~/RMAIL.
1423 ;; FIXME expand-file-name?
1428 ;; Set up the non-permanent locals associated with Rmail mode.
1430 ;; Turn off undo. We turn it back on in rmail-edit.
1432 ;; Don't let a local variables list in a message cause confusion.
1435 ;; Don't turn off auto-saving based on the size of the buffer
1436 ;; because that code does not understand buffer-swapping.
1444 t t nil nil
1459 \f
1460 ;; Handle M-x revert-buffer done in an rmail-mode buffer.
1465 ;; See similar code in `rmail'.
1466 ;; FIXME needs updating?
1469 ;; Call our caller again, but this time it does the default thing.
1471 ;; If the user said "yes", and we changed something,
1472 ;; reparse the messages.
1475 ;; Convert all or part to Babyl file if possible.
1477 ;; We have read the file as raw-text, so the buffer is set to
1478 ;; unibyte. Make it multibyte if necessary.
1488 "Expunge and save RMAIL file."
1492 ;; No need to swap buffers: rmail-write-region-annotate takes care of it.
1493 ;; (rmail-swap-buffers-maybe)
1499 "Quit out of RMAIL.
1500 Hook `rmail-quit-hook' is run after expunging."
1507 ;; Don't switch to the summary buffer even if it was recently visible.
1518 "Bury current Rmail buffer and its summary buffer."
1520 ;; This let var was called rmail-buffer, but that interfered
1521 ;; with the buffer-local var used in summary buffers.
1529 \f
1531 "Create a duplicated copy of the current message.
1532 The duplicate copy goes into the Rmail file just after the original."
1533 ;; If we are in a summary buffer, switch to the Rmail buffer.
1534 ;; FIXME simpler to swap the contents, not the buffers?
1556 \f
1557 ;;;###autoload
1559 "Run Rmail on file FILENAME."
1563 ;; This used to scan subdirectories recursively, but someone pointed out
1564 ;; that if the user wants that, person can put all the files in one dir.
1565 ;; And the recursive scan was slow. So I took it out.
1566 ;; rms, Sep 1996.
1568 "Return list of file in dir START that match `rmail-secondary-file-regexp'."
1570 ;; Don't sort here.
1573 ;; Sort here instead of in directory-files
1574 ;; because this list is usually much shorter.
1579 name)
1599 item)
1600 rmail-secondary-file-directory)))))
1604 menu))
1606 ;; This command is always "disabled" when it appears in a menu.
1616 files
1621 files
1629 \f
1630 ;;;; *** Rmail input ***
1638 ;; RLK feature not added in this version:
1639 ;; argument specifies inbox file or files in various ways.
1641 ;; In Babyl, the Mail: header in the preamble overrode rmail-inbox-list.
1642 ;; Mbox does not have this feature.
1644 "Move any new mail from this Rmail file's inbox files.
1645 The buffer-local variable `rmail-inbox-list' specifies the list
1646 of inbox files. By default, this is nil, except for your primary
1647 Rmail file `rmail-file-name'. In this case, when you first visit
1648 the Rmail file it is initialized using either
1650 or the function `user-login-name' and the directory
1651 `rmail-spool-directory' (whose value depends on the operating system).
1653 The command `set-rmail-inbox-list' sets `rmail-inbox-list' to the
1654 value you specify.
1656 You can also specify the file to get new mail from just for one
1657 instance of this command. In this case, the file of new mail is
1658 not changed or deleted. Noninteractively, you can pass the inbox
1659 file name as an argument. Interactively, a prefix argument
1660 causes us to read a file name and use that file as the inbox.
1662 If the variable `rmail-preserve-inbox' is non-nil, new mail will
1663 always be left in inbox files rather than deleted.
1665 Before doing anything, this runs `rmail-before-get-new-mail-hook'.
1666 Just before returning, it runs `rmail-after-get-new-mail-hook',
1667 whether or not there is new mail.
1669 If there is new mail, it runs `rmail-get-new-mail-hook', saves
1670 the updated file, and shows the first unseen message (which might
1671 not be a new one). It returns non-nil if it got any new messages."
1676 ;; If the disk file has been changed from under us,
1677 ;; revert to it before we get new mail.
1685 ;; Get rid of all undo records for this buffer.
1690 found)
1693 ;; This loops if any members of the inbox list have the same
1694 ;; basename (see "name conflict" below).
1697 ;; If buffer has not changed yet, and has not been
1698 ;; saved yet, don't replace the old backup file now.
1702 ;; Don't make undo records while getting mail.
1704 delete-files success files file-last-names)
1705 ;; Pull files off all-files onto files as long as there is
1706 ;; no name conflict. A conflict happens when two inbox
1707 ;; file names have the same last component.
1708 ;; The reason this careful handling is necessary seems
1709 ;; to be that rmail-insert-inbox-text uses .newmail-BASENAME.
1712 file-last-names)))
1714 file-last-names
1717 ;; Put them back in their original order.
1719 ;; In case of brain damage caused by require-final-newline.
1725 found))))
1726 ;; Move to the first new message unless we have other unseen
1727 ;; messages before it.
1730 found)
1731 ;; Don't leave the buffer screwed up if we get a disk-full error.
1738 "Return t if new messages are detected without error, nil otherwise."
1743 rmail-use-spam-filter))
1745 result success suffix)
1747 ;; Read in the contents of the inbox files, renaming them as
1748 ;; necessary, and adding to the list of files to delete
1749 ;; eventually.
1753 ;; Scan the new text and convert each message to
1754 ;; Rmail/mbox format.
1760 success t)
1761 ;; Try to delete the garbage just inserted.
1763 ;; If we could not convert the file's inboxes, rename the
1764 ;; files we tried to read so we won't over and over again.
1773 ;; Determine if there are messages.
1775 ;; There are. Process them.
1780 ;; Delete the old files, now that the Rmail file is saved.
1783 ;; First, try deleting.
1787 ;; If we can't delete it, truncate it.
1800 ;; Establish the return value.
1802 result))))
1805 "Parse the supplied URL. Return (list MAILBOX-NAME REMOTE PASSWORD GOT-PASSWORD)
1806 WHERE MAILBOX-NAME is the name of the mailbox suitable as argument to the
1807 actual version of `movemail', REMOTE is non-nil if MAILBOX-NAME refers to
1808 a remote mailbox, PASSWORD is the password if it should be
1809 supplied as a separate argument to `movemail' or nil otherwise, GOT-PASSWORD
1810 is non-nil if the user has supplied the password interactively.
1811 "
1826 ;; The password is embedded. Strip it out since movemail
1827 ;; does not really like it, in spite of the movemail spec.
1833 t
1835 got-password)
1840 got-password))))
1858 "Replace newly read mail in Babyl format with equivalent mbox format.
1860 FROM-FILE is the Babyl file from which the new mail should be read."
1862 size)
1870 size)))
1873 "If newly read mail from FILE is in Babyl format, convert it to mbox format.
1875 SIZE is the original size of the newly read mail.
1876 Value is the size of the newly read mail after conversion."
1877 ;; Detect previous Babyl format files.
1880 new-file)
1882 ;; The new mail is in Babyl version 5 format. Use unrmail
1883 ;; to convert it.
1886 ;; New mail is in Babyl format made by old version of
1887 ;; Rmail. Fix the babyl file header and use unrmail to
1888 ;; convert it.
1898 size))
1901 ;; Detect a locked file now, so that we avoid moving mail
1902 ;; out of the real inbox file. (That could scare people.)
1908 ;; Handle remote mailbox names specially; don't expand as filenames
1909 ;; in case the userid contains a directory separator.
1922 ;; Generate name to move to from inbox name,
1923 ;; in case of multiple inboxes that need moving.
1927 ;; cannot have colons in file name
1929 file)))
1930 ;; Use the directory of this rmail file
1931 ;; because it's a nuisance to use the homedir
1932 ;; if that is on a full disk and this rmail
1933 ;; file isn't.
1936 ;; Always use movemail to rename the file,
1937 ;; since there can be mailboxes in various directories.
1939 ;; On some systems, /usr/spool/mail/foo is a directory
1940 ;; and the actual inbox is /usr/spool/mail/foo/foo.
1943 file))))
1952 ;; Set TOFILE if have not already done so, and
1953 ;; rename or copy the file FILE to TOFILE if and as appropriate.
1958 nil)
1968 nil)
1971 rmail-movemail-flags)
1976 ;; No output => movemail won
1977 nil
1988 ;; If we just read the password, most likely it is
1989 ;; wrong. Otherwise, see if there is a specific
1990 ;; reason to think that the problem is a wrong passwd.
1993 nil t))
1996 ;; If using Mailutils, remove initial error code
1997 ;; abbreviation
2008 nil)))))
2010 ;; At this point, TOFILE contains the name to read:
2011 ;; Either the alternate name (if we renamed)
2012 ;; or the actual inbox (if not renaming).
2015 size)
2018 ;; If new mail is in Babyl format, convert it to mbox.
2020 tofile
2022 ;; Determine if a pair of newline message separators need
2023 ;; to be added to the new collection of messages. This is
2024 ;; the case for all new message collections added to a
2025 ;; non-empty mail file.
2042 delete-files))
2044 ;; Decode the region specified by FROM and TO by CODING.
2045 ;; If CODING is nil or an invalid coding system, decode by `undecided'.
2049 ;; Use -dos decoding, to remove ^M characters left from base64 or
2050 ;; rogue qp-encoded text.
2053 ;; Don't reveal the fact we used -dos decoding, as users generally
2054 ;; will not expect the RMAIL buffer to use DOS EOL format.
2067 "Ensure a message ends in a blank line.
2068 Call with point at the end of the message."
2075 "Validate the RFC2822 format for the new messages.
2076 Point should be at the first new message.
2077 An error is signalled if the new messages are not RFC2822
2078 compliant.
2079 Unless an Rmail attribute header already exists, add it to the
2080 new messages. Return the number of new messages."
2088 limit stop)
2089 ;; Detect an empty inbox file.
2091 ;; Scan the new messages to establish a count and to ensure that
2092 ;; an attribute header is present.
2095 ;; Determine if a new attribute header needs to be
2096 ;; added to the message.
2106 ;; Move to the next message.
2113 count))))
2114 \f
2116 "Subroutine of `rmail-get-header'.
2117 Narrow to header, call `mail-fetch-field' to find header NAME."
2125 "Return the value of message header NAME, nil if it has none.
2126 MSGNUM specifies the message number to get it from.
2127 If MSGNUM is nil, use the current message."
2131 "Subroutine of `rmail-set-header'.
2132 Narrow to header, set header NAME to VALUE, replacing existing if present.
2133 VALUE nil means to remove NAME altogether."
2150 "Set message header NAME to VALUE in message number MSGNUM.
2151 If MSGNUM is nil, use the current message. NAME and VALUE are strings.
2152 VALUE may also be nil, meaning to remove the header."
2155 ;; Ensure header changes get saved.
2156 ;; (Note replacing a header with an identical copy modifies.)
2158 ;; However: don't save in mbox format over a Babyl file
2159 ;; merely because of this.
2161 \f
2162 ;;;; *** Rmail Attributes and Keywords ***
2165 "Return the message attributes in a comma separated string.
2166 MSG specifies the message number to get it from.
2167 If MSG is nil, use the current message."
2170 result temp)
2177 result
2182 result)))
2185 "Return the message keywords in a comma separated string.
2186 MSG, if non-nil, identifies the message number to use.
2187 If nil, that means the current message."
2191 "Return a string with the labels (attributes and keywords) of msg MSG.
2192 It is put in comma-separated form.
2193 MSG, if non-nil, identifies the message number to use.
2194 If nil, that means the current message."
2197 ;; Combine the message attributes and keywords
2198 ;; into a comma-separated list.
2204 ;; FIXME ? old rmail did not have spaces in the comma-separated lists.
2211 "Update the current messages's attributes and keywords in mode line."
2215 rmail-current-message rmail-total-messages blurb))))
2218 "Return the character value for ATTR.
2219 ATTR is a (numeric) index, an offset into the mbox attribute
2220 header value. STATE is one of nil, t, or a character value."
2227 "Subroutine of `rmail-set-attribute'.
2228 Set Rmail attribute ATTR to STATE in `rmail-attribute-header',
2229 creating the header if necessary. Returns non-nil if a
2230 significant attribute change was made."
2234 altered)
2237 ;; If this message already records attributes, just change the
2238 ;; value for this one.
2240 ;; Position point at this attribute, adding attributes if necessary.
2247 ;; Change this attribute.
2252 ;; Otherwise add a header line to record the attributes and set
2253 ;; all but this one to no.
2259 altered))
2262 "Turn an attribute of a message on or off according to STATE.
2263 STATE is either nil or the character (numeric) value associated
2264 with the state (nil represents off and non-nil represents on).
2265 ATTR is either the index number of the attribute, or a string,
2266 both from `rmail-attr-array'. MSGNUM is message number to
2267 change; nil means current message."
2277 ;; Ask for confirmation before setting any attribute except `unseen'
2278 ;; if it would force a format change.
2284 ;; The "deleted" attribute is also stored in a special vector so
2285 ;; update that too.
2292 ;; Don't save in mbox format over a Babyl file
2293 ;; merely because of a change in `unseen' attribute.
2296 ;; Otherwise, if we modified the file text via the view buffer,
2297 ;; mark the main buffer modified too.
2301 "Return non-nil if message number MSG has attributes matching regexp ATTRS."
2306 "Return non-nil if message number MSGNUM has the unseen attribute."
2309 ;; FIXME rmail-get-labels does some formatting (eg leading space, `;'
2310 ;; between attributes and labels), so this might not do what you want.
2311 ;; Eg see rmail-sort-by-labels. rmail-get-labels could have an
2312 ;; optional `noformat' argument.
2314 "Return non-nil if message number MSG has labels matching regexp LABELS."
2316 \f
2317 ;;;; *** Rmail Message Selection And Support ***
2320 "Return the start position for message number N."
2324 "Return the end position for message number N."
2328 "Call FUNCTION on ARGS while narrowed to message MSGNUM.
2329 Point is at the start of the message.
2330 This returns what the call to FUNCTION returns.
2331 If MSGNUM is nil, use the current message."
2338 ;; All access to the rmail-buffer's local variables is now finished...
2340 ;; ... so it is ok to go to a different buffer.
2349 ;; Unused (save for commented out code in rmailedit.el).
2351 "Call FUNCTION with point at start of internal data of current message.
2352 Assumes that bounds were previously narrowed to display the message in Rmail.
2353 The bounds are widened enough to move point where desired, then narrowed
2354 again afterward.
2356 FUNCTION may not change the visible text of the message, but it may
2357 change the invisible header text."
2365 ;; Note: we don't use save-restriction because that does not work right
2366 ;; if changes are made outside the saved restriction
2367 ;; before that restriction is restored.
2370 \f
2371 ;; Manage the message vectors and counters.
2387 rmail-message-vector
2388 rmail-current-message
2389 rmail-total-messages))
2393 "Count the number of new messages.
2394 The buffer should be narrowed to include only the new messages.
2395 Output a helpful message unless NOMSG is non-nil."
2402 ;; Put at the end of messages-head
2403 ;; the entry for message N+1, which marks
2404 ;; the end of message N. (N = number of messages).
2420 ;; Fill in the new elements of rmail-msgref-vector.
2439 ;; Determine how many messages follow point.
2442 ;; Put at the end of messages-head
2443 ;; the entry for message N+1, which marks
2444 ;; the end of message N. (N = number of messages).
2455 ;; Make an element 0 in rmail-message-vector and rmail-deleted-vector
2456 ;; which will never be used.
2477 "Collect the message deletion flags for each message.
2478 MESSAGE-END is the buffer position corresponding to the end of
2479 the message. Point is at the beginning of the message."
2480 ;; NOTE: This piece of code will be executed on a per-message basis.
2481 ;; In the face of thousands of messages, it has to be as fast as
2482 ;; possible, hence some brute force constant use is employed in
2483 ;; addition to inlining.
2488 ?D
2492 "Collect the start positions of messages in list `messages-head'.
2493 Return the number of messages after the one containing SPOT-TO-FIND."
2495 messages-after-spot)
2506 ;; Show progress after every 20 messages or so.
2509 ;; Handle the first message, maybe.
2518 messages-after-spot))
2519 \f
2520 ;; Display a message.
2522 ;;;; *** Rmail Message Formatting and Header Manipulation ***
2524 ;; This is used outside of rmail.
2526 "Return nil if the current message is showing full headers."
2528 rmail-buffer)
2532 "Toggle between showing full and normal message headers.
2533 With optional integer ARG, show the normal message header if ARG
2534 is greater than zero; otherwise, show it in full."
2543 "Show current message starting from the beginning."
2547 rmail-view-buffer
2548 rmail-buffer)
2549 rmail-header-style)))
2553 "Show bottom of current message."
2559 rmail-view-buffer
2560 rmail-buffer)
2561 rmail-header-style)))
2566 Ask the user whether to add that list name to `mail-mailing-lists'."
2567 ;; FIXME s-r not needed? Use rmail-get-header?
2568 ;; We have not narrowed to the headers at ths point?
2579 ;; taken from rmailsum.el
2591 addr))
2594 addr)))
2599 "Display the entire mailbox file."
2603 \f
2613 "Show message number N (prefix argument), counting from start of file.
2614 If summary buffer is currently displayed, update current message there also.
2615 N defaults to the current message."
2619 ;; FIXME: Why do we swap the raw data back in?
2629 ;; If there is a summary buffer, try to move to this message
2630 ;; in that buffer. But don't complain if this message is
2631 ;; not mentioned in the summary. Don't do this at all if we
2632 ;; were called on behalf of cursor motion in the summary
2633 ;; buffer.
2644 "Return t if the region contains a text message, nil otherwise."
2648 ;; The message is text if either there is no content type header
2649 ;; (a default of "text/plain; charset=US-ASCII" is assumed) or
2650 ;; the base content type is either text or message.
2655 "Message size at which to show progress messages for displaying it."
2661 "Show message MSG (default: current message) using `rmail-view-buffer'.
2662 Return text to display in the minibuffer if MSG is out of
2663 range (displaying a reasonable choice as well), nil otherwise.
2664 The current mail message becomes the message displayed."
2667 blurb beg end body-start coding-system character-coding
2668 is-text-message header-style)
2674 rmail-current-message 1
2678 rmail-current-message rmail-total-messages
2683 ;; Mark the message as seen
2685 ;; bracket the message in the mail
2686 ;; buffer and determine the coding system the transfer encoding.
2695 ;; We give the view buffer a buffer-local value of
2696 ;; rmail-header-style based on the binding in effect when
2697 ;; this function is called; `rmail-toggle-headers' can
2698 ;; inspect this value to determine how to toggle.
2717 ;; Decode the message body into an empty view buffer using a
2718 ;; unibyte temporary buffer where the character decoding takes
2719 ;; place.
2723 ;; Do it directly since that is fast.
2725 ;; Can this be done directly, skipping the temp buffer?
2731 ;; See bug#5441.
2743 coding-system view-buf)))
2745 ;; Prepare the separator (blank line) before the body.
2748 ;; Unquote quoted From lines
2754 ;; Copy the headers to the front of the message view buffer.
2756 ;; highlight the message, activate any URL like text and add
2757 ;; special highlighting for and quoted material.
2761 ;(rmail-activate-urls)
2762 ;(rmail-process-quoted-material)
2763 )
2764 ;; Update the mode-line with message status information and swap
2765 ;; the view buffer/mail buffer contents.
2772 blurb))
2775 "Copy displayed header fields to the message viewer buffer.
2776 BEG and END marks the start and end positions of the message in
2777 the mbox buffer. If the optional argument IGNORED-HEADERS is
2778 non-nil, ignore all header fields whose names match that regexp.
2779 Otherwise, if `rmail-displayed-headers' is non-nil, copy only
2780 those header fields whose names match that regexp. Otherwise,
2781 copy all header fields whose names do not match
2782 `rmail-ignored-headers' (unless they also match
2783 `rmail-nonignored-headers'). Moves point in the message viewer
2784 buffer to the end of the headers."
2786 lim)
2791 ;; Put point right after the From header line.
2798 ;; Handle the case where all headers should be copied.
2801 ;; rmail-show-message-1 expects this function to leave point
2802 ;; at the end of the headers.
2808 ;; Handle the case where the headers matching the displayed
2809 ;; headers regexp should be copied.
2819 ;; Handle the ignored headers.
2834 "Decode the body of the current message using coding system CODING.
2835 This is useful with mail messages that have malformed or missing
2836 charset= headers.
2838 This function assumes that the current message is already decoded
2839 and displayed in the RMAIL buffer, but the coding system used to
2840 decode it was incorrect. It then decodes the message again,
2841 using the coding system CODING."
2851 body-start x-coding-header old-coding)
2858 ;; Narrow to headers
2866 ;; Make sure the new coding system uses the same EOL
2867 ;; conversion, to prevent ^M characters from popping up
2868 ;; all over the place.
2876 ;; Rewrite the coding-system header.
2888 "Highlight the headers specified by `rmail-highlighted-headers'.
2889 Uses the face specified by `rmail-highlight-face'."
2897 ;; When rmail-highlight-face is removed, just
2898 ;; use 'rmail-highlight here.
2902 ;; List of overlays to reuse.
2908 overlay)
2911 ;; Back up over newline, then trailing spaces or tabs
2916 ;; Reuse an overlay we already have.
2922 ;; Make a new overlay and add it to
2923 ;; rmail-overlay-list.
2930 "Automatically move a message into a sub-folder based on criteria.
2931 Called when a new message is displayed."
2936 ;; Do nothing if the message has already been filed or if there
2937 ;; are no messages.
2938 nil
2939 ;; Find out some basics (common fields)
2957 ;; If there are no directives left, then it was a complete match.
2966 \f
2967 ;; Simple message motion commands.
2970 "Show following message whether deleted or not.
2971 With prefix arg N, moves forward N messages, or backward if N is negative."
2978 "Show previous message whether deleted or not.
2979 With prefix arg N, moves backward N messages, or forward if N is negative."
2984 "Show following non-deleted message.
2985 With prefix arg N, moves forward N non-deleted messages,
2986 or backward if N is negative.
2988 Returns t if a new message is being shown, nil otherwise."
3004 t)
3009 nil)))
3012 "Show previous non-deleted message.
3013 With prefix argument N, moves backward N non-deleted messages,
3014 or forward if N is negative."
3019 "Show first message in file."
3025 "Show last message in file."
3031 "For debugging Rmail: find the message number that point is in."
3036 rmail-view-buffer
3045 \f
3046 ;; Searching in Rmail file.
3049 "Return non-nil, if for message number MSG, regexp REGEXP matches."
3050 ;; This is adequate because its only caller, rmail-search,
3051 ;; unswaps the buffers.
3061 "Show message containing next match for REGEXP (but not the current msg).
3062 Prefix argument gives repeat count; negative argument means search
3063 backwards (through earlier messages).
3064 Interactively, empty argument means use same regexp used last time."
3069 regexp)
3086 regexp)
3092 found)
3098 ;; Check messages one by one, advancing message number up or
3099 ;; down but searching forward through each message.
3111 ;; Search forward (if this is a normal search) or backward
3112 ;; (if this is a reverse search) through this message to
3113 ;; position point. This search may fail because REGEXP
3114 ;; was found in the hidden portion of this message. In
3115 ;; that case, move point to the beginning of visible
3116 ;; portion.
3125 regexp))
3132 "Show message containing previous match for REGEXP.
3133 Prefix argument gives repeat count; negative argument means search
3134 forward (through later messages).
3135 Interactively, empty argument means use same regexp used last time."
3140 regexp)
3155 \f
3156 ;; Scan for attributes, and compare subjects.
3159 "Return message number of first message which has `unseen' attribute."
3162 found)
3169 found))
3172 "Return the simplified subject of message MSGNUM (or current message).
3173 Simplifying the subject means stripping leading and trailing whitespace,
3174 and typical reply prefixes such as Re:."
3182 ;; If Subject is long, mailers will break it into several lines at
3183 ;; arbitrary places, so normalize whitespace by replacing every
3184 ;; run of whitespace characters with a single space.
3186 subject))
3189 "Return a regular expression matching the current simplified subject.
3190 The idea is to match it against simplified subjects of other messages."
3193 ;; Hide commas so it will work ok if parsed as a comma-separated list
3194 ;; of regexps.
3200 "Go to the next mail message having the same subject header.
3201 With prefix argument N, do this N times.
3202 If N is negative, go backwards instead."
3207 found)
3227 "Go to the previous mail message having the same subject header.
3228 With prefix argument N, do this N times.
3229 If N is negative, go forwards instead."
3232 \f
3233 ;;;; *** Rmail Message Deletion Commands ***
3236 "Return non-nil if message number N is deleted (in `rmail-deleted-vector')."
3240 "Set the deleted state of message number N (in `rmail-deleted-vector').
3241 STATE non-nil means mark as deleted."
3245 "Delete this message and stay on it."
3251 "Back up to deleted message, select it, and undelete it."
3269 "Delete this message and move to next nondeleted one.
3271 With prefix argument, delete and move backward.
3273 Returns t if a new message is displayed after the delete, or nil otherwise."
3285 "Delete this message and move to previous nondeleted one.
3289 \f
3290 ;; Expunging.
3292 ;; Compute the message number a given message would have after expunging.
3293 ;; The present number of the message is OLDNUM.
3294 ;; DELETEDVEC should be rmail-deleted-vector.
3295 ;; The value is nil for a message that would be deleted.
3298 nil
3305 newnum)))
3308 "Return t if expunge is needed and desirable.
3309 If `rmail-confirm-expunge' is non-nil, ask user to confirm."
3316 t)))
3319 "Actually erase all deleted messages in the file."
3324 ;; Discard all undo records for this buffer.
3332 0
3339 ;; Don't make any undo records for the expunging.
3348 new-summary
3357 rmail-current-message nil
3358 rmail-message-vector nil
3359 rmail-deleted-vector nil
3360 rmail-summary-vector nil)
3376 new-summary))
3379 new-msgref))
3387 rmail-total-messages counter
3392 win t)))
3402 ;; The DONT-SHOW argument is new in 23. Does not seem very important.
3404 "Erase deleted messages from Rmail file and summary buffer.
3405 This always shows a message (so as not to leave the Rmail buffer
3406 unswapped), and always updates any summary (so that it remains
3407 consistent with the Rmail buffer). If DONT-SHOW is non-nil, it
3408 does not pop any summary buffer."
3415 ;; We always update the summary buffer, so that the contents
3416 ;; remain consistent with the rmail buffer.
3417 ;; The only difference is, in the dont-show case, we use a
3418 ;; cut-down version of rmail-select-summary that does not pop
3419 ;; the summary buffer. It's only used by rmail-quit, which is
3420 ;; just going to bury any summary immediately after. If we made
3421 ;; rmail-quit bury the summary first, dont-show could be removed.
3422 ;; But the expunge might not be confirmed...
3430 ;; We always show a message, because (rmail-only-expunge t)
3431 ;; leaves the rmail buffer unswapped.
3432 ;; If we expunged the current message, a new one is current now,
3433 ;; so show it. If we weren't showing a message, show it.
3436 ;; We can just show the same message that was being shown before.
3440 \f
3441 ;;;; *** Rmail Mailing Commands ***
3444 replybuffer sendactions same-window others)
3447 ;; The function used here must behave like insert-buffer wrt
3448 ;; point and mark (see doc of sc-cite-original).
3454 noerase nil
3455 yank-action sendactions)
3459 noerase 'switch-to-buffer-other-frame
3460 yank-action sendactions)
3461 ;; This is not a standard frame parameter;
3462 ;; nothing except sendmail.el looks at it.
3466 noerase 'switch-to-buffer-other-window
3467 yank-action sendactions)))))
3470 "Send mail in another window.
3472 original message into it."
3476 ;; FIXME should complain if there is nothing to continue.
3478 "Continue composing outgoing message previously being composed."
3483 "Reply to the current message.
3484 Normally include CC: to all other recipients of original message;
3485 prefix argument means ignore them. While composing the reply,
3491 resent-to resent-cc resent-reply-to
3494 rmail-current-message
3501 from)
3507 ;; Bug#512. It's inappropriate to reply to these addresses.
3508 ;;; resent-cc (and (not just-sender)
3509 ;;; (mail-fetch-field "resent-cc" nil t))
3510 ;;; resent-to (or (mail-fetch-field "resent-to" nil t) "")
3511 ;;; resent-subject (mail-fetch-field "resent-subject")
3512 ;;; resent-date (mail-fetch-field "resent-date")
3513 ;;; resent-message-id (mail-fetch-field "resent-message-id")
3514 )
3517 ;; If this header field is present, use it instead of the
3518 ;; To and CC fields.
3522 ;; Merge the resent-to and resent-cc into the to and cc.
3523 ;; Bug#512. It's inappropriate to reply to these addresses.
3524 ;;; (if (and resent-to (not (equal resent-to "")))
3525 ;;; (if (not (equal to ""))
3526 ;;; (setq to (concat to ", " resent-to))
3527 ;;; (setq to resent-to)))
3528 ;;; (if (and resent-cc (not (equal resent-cc "")))
3529 ;;; (if (not (equal cc ""))
3530 ;;; (setq cc (concat cc ", " resent-cc))
3531 ;;; (setq cc resent-cc)))
3532 ;; Add `Re: ' to subject if not there already.
3539 subject))))
3541 nil
3542 ;; Using mail-strip-quoted-names is undesirable with newer mailers
3543 ;; since they can handle the names unstripped.
3544 ;; I don't know whether there are other mailers that still
3545 ;; need the names to be stripped.
3546 ;;; (mail-strip-quoted-names reply-to)
3547 ;; Remove unwanted names from reply-to, since Mail-Followup-To
3548 ;; header causes all the names in it to wind up in reply-to, not
3549 ;; in cc. But if what's left is an empty list, use the original.
3552 subject
3555 nil
3556 ;; mail-strip-quoted-names is NOT necessary for rmail-dont-reply-to
3557 ;; to do its job.
3563 rmail-buffer
3564 rmail-view-buffer)
3566 rmail-buffer
3569 rmail-answered-attr-index))
3570 nil
3576 message-id)))))))
3577 \f
3579 "Give BUFFER's message number in MSGNUM-LIST the attribute ATTRIBUTE.
3580 This is use in the send-actions for message buffers.
3581 MSGNUM-LIST is a list of the form (MSGNUM)
3582 which is an element of rmail-msgref-vector."
3590 message-id
3591 nil))
3601 tem))
3602 message-id))
3603 ;; missing From, or Message-ID is sufficiently informative
3604 message-id
3606 ;; Copy TEM, discarding text properties.
3610 ;; Use prin1 to fake RFC822 quoting
3614 field)))))
3617 ;; These strings both match all non-ASCII characters.
3620 ;; "Unix Loser <Foo@bar.edu>" => "Unix Loser"
3621 from)
3624 ;; "<Bugs@bar.edu>" (Losing Unix) => "Losing Unix"
3625 from)))
3628 ;; Trim whitespace which above regexp match allows
3638 ;; "<AA259@bar.edu> (message from Unix Loser on 1-Apr-89)"
3640 field))))
3642 ;; If we can't kludge it simply, do it correctly
3645 \f
3647 "Forward the current message to another user.
3649 see the documentation of `rmail-resend'."
3664 nil nil subject nil nil nil
3666 forward-buffer
3669 rmail-forwarded-attr-index))
3670 ;; If only one window, use it for the mail buffer.
3671 ;; Otherwise, use another window for the mail buffer
3672 ;; so that the Rmail buffer remains visible
3673 ;; and sending the mail will get back to it.
3675 ;; The mail buffer is now current.
3677 ;; Insert after header separator--before signature if any.
3682 forward-buffer)
3684 ;; Quote lines with `- ' if they start with `-'.
3702 \f
3704 "Resend current message to ADDRESSES.
3705 ADDRESSES should be a single address, a string consisting of several
3706 addresses separated by commas, or a list of addresses.
3708 Optional FROM is the address to resend the message from, and
3709 defaults from the value of `user-mail-address'.
3710 Optional COMMENT is a string to insert as a comment in the resent message.
3711 Optional ALIAS-FILE is alternate aliases file to be used by sendmail,
3712 typically for purposes of moderating a list."
3727 ;;>> Copy message into temp buffer
3734 ;; Delete any Sender field, since that's not specifiable.
3735 ; Only delete Sender fields in the actual header.
3737 ; Using "while" here rather than "if" because some buggy mail
3738 ; software may have inserted multiple Sender fields.
3746 ; Go back to the beginning of the buffer so the Resent- fields
3747 ; are inserted there.
3749 ;;>> Insert resent-from:
3752 ;;>> Insert resent-to: and bcc if need be.
3757 address
3760 ;; Expand abbrevs in the recipients.
3779 ;;>> Set up comment, if any.
3782 after)
3790 ;; Don't expand aliases in the destination fields
3791 ;; of the original message.
3797 \f
3815 ;; This is a cut-down version of rmail-clear-headers from Emacs 22.
3816 ;; It doesn't have the same functionality, hence the name change.
3818 "Delete any mail headers matching REGEXP.
3819 The message should be narrowed to just the headers."
3824 ;; This code from Emacs 22 doesn't seem right, since r-n-h is
3825 ;; just for display.
3826 ;;; (if (looking-at rmail-nonignored-headers)
3827 ;;; (forward-line 1)
3839 "Edit a mail message which is based on the contents of the current message.
3840 For a message rejected by the mail system, extract the interesting headers and
3841 the body of the original message.
3842 If the failed message is a MIME multipart message, it is searched for a
3843 body part with a header which matches the variable `mail-mime-unsent-header'.
3844 Otherwise, the variable `mail-unsent-separator' should match the string that
3845 delimits the returned original message.
3846 The variable `rmail-retry-ignored-headers' is a regular expression
3847 specifying headers which should not be copied into the new message."
3852 bounce-start bounce-end bounce-indent resending
3860 content-type))
3861 ;; Handle a MIME multipart bounce message.
3874 ;; Non-MIME bounce.
3878 ;; Support a style of failure message in which the original
3879 ;; message is indented, and included within lines saying
3880 ;; `Start of returned message' and `End of returned message'.
3889 ;; One message contained a few random lines before
3890 ;; the old message header. The first line of the
3891 ;; message started with two hyphens. A blank line
3892 ;; followed these random lines. The same line
3893 ;; beginning with two hyphens was possibly marking
3894 ;; the end of the message.
3909 ;; We have found the message that bounced, within the current message.
3910 ;; Now start sending new message; default header fields from original.
3911 ;; Turn off the usual actions for initializing the message body
3912 ;; because we want to get only the text from the failure message.
3916 rmail-this-buffer
3918 rmail-retried-attr-index)))
3919 ;; Insert original text as initial text of new draft message.
3920 ;; Bind inhibit-read-only since the header delimiter
3921 ;; of the previous message was probably read-only.
3925 bounce-start bounce-end)
3929 ;; FIXME better to replace sendmail functions.
3943 \f
3945 "Non-nil if in an RMAIL buffer and an associated summary buffer exists.
3946 In fact, the non-nil value returned is the summary buffer itself."
3948 rmail-summary-buffer))
3951 "t if in RMAIL buffer and an associated summary buffer is displayed."
3955 "Non-nil means Rmail should show the summary when it changes.
3956 This has an effect only if a summary buffer exists."
3961 "Non-nil means specify the height for an Rmail summary window."
3965 ;; Put the summary buffer back on the screen, if user wants that.
3968 window)
3969 ;; If requested, make sure the summary is displayed.
3971 rmail-redisplay-summary
3973 ;; It's already in some frame; show that one.
3979 ;; If requested, set the height of the summary window.
3981 rmail-summary-window-size
3983 ;; Don't try to change the size if just one window in frame.
3990 \f
3991 ;;;; *** Rmail Local Fontification ***
3994 ;; This function's symbol is bound to font-lock-fontify-buffer-function.
3996 ;; If we're already showing a message, fontify it now.
3998 ;; Prevent Font Lock mode from kicking in.
4002 ;; This function's symbol is bound to font-lock-fontify-unbuffer-function.
4005 before-change-functions after-change-functions
4006 buffer-file-name buffer-file-truename)
4016 ;; Fontify the current message if it is not already fontified.
4020 before-change-functions after-change-functions
4021 buffer-file-name buffer-file-truename)
4028 \f
4029 ;;; Speedbar support for RMAIL files.
4033 "*This regex is used to match folder names to be displayed in speedbar.
4034 Enabling this will permit speedbar to display your folders for easy
4044 "Install those variables used by speedbar to enhance rmail."
4046 nil
4055 ;; Mouse-3.
4063 ;; Make sure our special speedbar major mode is loaded
4069 "Create buttons for BUFFER containing rmail messages.
4070 Click on the address under Reply to: to reply to this person.
4071 Under Folders: Click a name to read it, or on the <M> to move the
4072 current message into that RMAIL folder."
4080 nil
4085 nil
4095 default-directory)
4096 nil rmail-speedbar-match-folder-regexp)))
4105 "Execute an rmail command specified by TEXT.
4106 The command used is TOKEN. INDENT is not used."
4111 "Load in the rmail file TEXT.
4112 TOKEN and INDENT are not used."
4118 "If the current line is a folder, move current message to it."
4128 "From button TEXT, copy current message to the rmail file specified by TOKEN.
4129 TEXT and INDENT are not used."
4132 ;; expand-file-name is needed due to the unhelpful way in which
4133 ;; rmail-output expands non-absolute filenames against rmail-default-file.
4134 ;; What is the point of that, anyway?
4137 ;; Functions for setting, getting and encoding the POP password.
4138 ;; The password is encoded to prevent it from being easily accessible
4139 ;; to "prying eyes." Obviously, this encoding isn't "real security,"
4140 ;; nor is it meant to be.
4142 ;;;###autoload
4144 "Set PASSWORD to be used for retrieving mail from a POP or IMAP server."
4153 "Get the password for retrieving mail from a POP or IMAP server. If none
4154 has been set, then prompt the user for one."
4159 "IMAP password: "
4169 "Encode STRING with integer MASK, by taking the exclusive OR of the
4170 lowest byte in the mask with the first character of string, the
4171 second-lowest-byte with the second character of the string, etc.,
4172 restarting at the lowest byte of the mask whenever it runs out.
4173 Returns the encoded string. Calling the function again with an
4174 encoded string (and the same mask) will decode the string."
4187 ;;;; Desktop support
4190 desktop-buffer-name
4191 desktop-buffer-misc)
4192 "Restore an rmail buffer specified in a desktop file."
4198 rmail-buffer))
4201 nil)))
4206 ;; We use this to record the encoding of the current message before
4207 ;; saving the message collection.
4210 ;; Used in `write-region-annotate-functions' to write rmail files.
4216 nil))
4218 ;; Used to restore the encoding of the buffer where we show the
4219 ;; current message, after we save the message collection. This is
4220 ;; needed because rmail-write-region-annotate switches buffers behind
4221 ;; save-file's back, with the side effect that last-coding-system-used
4222 ;; is assigned to buffer-file-coding-system of the wrong buffer.
4231 \f
4232 ;;; Start of automatically extracted autoloads.
4233 \f
4234 ;;;### (autoloads (rmail-edit-current-message) "rmailedit" "rmailedit.el"
4235 ;;;;;; "ecd28d8d92983488673388eced6fbf50")
4236 ;;; Generated autoloads from rmailedit.el
4239 Edit the contents of this message.
4243 ;;;***
4244 \f
4245 ;;;### (autoloads (rmail-next-labeled-message rmail-previous-labeled-message
4246 ;;;;;; rmail-read-label rmail-kill-label rmail-add-label) "rmailkwd"
4247 ;;;;;; "rmailkwd.el" "bc72ffe3652be6f4c72048ae8f226fce")
4248 ;;; Generated autoloads from rmailkwd.el
4251 Add LABEL to labels associated with current RMAIL message.
4252 Completes (see `rmail-read-label') over known labels when reading.
4253 LABEL may be a symbol or string. Only one label is allowed.
4258 Remove LABEL from 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 Read a label with completion, prompting with PROMPT.
4266 Completions are chosen from `rmail-label-obarray'. The default
4267 is `rmail-last-label', if that is non-nil. Updates `rmail-last-label'
4268 according to the choice made, and returns a symbol.
4273 Show previous message with one of the labels LABELS.
4274 LABELS should be a comma-separated list of label names.
4275 If LABELS is empty, the last set of labels specified is used.
4276 With prefix argument N moves backward N messages with these labels.
4281 Show next message with one of the labels LABELS.
4282 LABELS should be a comma-separated list of label names.
4283 If LABELS is empty, the last set of labels specified is used.
4284 With prefix argument N moves forward N messages with these labels.
4288 ;;;***
4289 \f
4290 ;;;### (autoloads (rmail-mime) "rmailmm" "rmailmm.el" "7f6ad821b4543a18139fee9250beea5c")
4291 ;;; Generated autoloads from rmailmm.el
4294 Toggle displaying of a MIME message.
4296 The actualy behavior depends on the value of `rmail-enable-mime'.
4298 If `rmail-enable-mime' is t (default), this command change the
4299 displaying of a MIME message between decoded presentation form
4300 and raw data.
4302 With ARG, toggle the displaying of the current MIME entity only.
4304 If `rmail-enable-mime' is nil, this creates a temporary
4306 content-types are handled according to
4307 `rmail-mime-media-type-handlers-alist'. By default, this
4308 displays text and multipart messages, and offers to download
4309 attachments as specfied by `rmail-mime-attachment-dirs-alist'.
4313 ;;;***
4314 \f
4315 ;;;### (autoloads (set-rmail-inbox-list) "rmailmsc" "rmailmsc.el"
4316 ;;;;;; "9319e5b606ad5786c0c5994a307a38e8")
4317 ;;; Generated autoloads from rmailmsc.el
4320 Set the inbox list of the current RMAIL file to FILE-NAME.
4321 You can specify one file name, or several names separated by commas.
4322 If FILE-NAME is empty, remove any existing inbox list.
4324 This applies only to the current session.
4328 ;;;***
4329 \f
4330 ;;;### (autoloads (rmail-sort-by-labels rmail-sort-by-lines rmail-sort-by-correspondent
4331 ;;;;;; rmail-sort-by-recipient rmail-sort-by-author rmail-sort-by-subject
4332 ;;;;;; rmail-sort-by-date) "rmailsort" "rmailsort.el" "16144a77fdc880034875fd624e4d73e6")
4333 ;;; Generated autoloads from rmailsort.el
4337 If prefix argument REVERSE is non-nil, sorts in reverse order.
4344 non-nil, sorts in reverse order.
4349 Sort messages of current Rmail buffer by author.
4351 If prefix argument REVERSE is non-nil, sorts in reverse order.
4356 Sort messages of current Rmail buffer by recipient.
4358 If prefix argument REVERSE is non-nil, sorts in reverse order.
4363 Sort messages of current Rmail buffer by other correspondent.
4366 excluded by `rmail-dont-reply-to-names'. If prefix argument
4367 REVERSE is non-nil, sorts in reverse order.
4372 Sort messages of current Rmail buffer by the number of lines.
4373 If prefix argument REVERSE is non-nil, sorts in reverse order.
4378 Sort messages of current Rmail buffer by labels.
4379 LABELS is a comma-separated list of labels. The order of these
4380 labels specifies the order of messages: messages with the first
4381 label come first, messages with the second label come second, and
4382 so on. Messages that have none of these labels come last.
4383 If prefix argument REVERSE is non-nil, sorts in reverse order.
4387 ;;;***
4388 \f
4389 ;;;### (autoloads (rmail-summary-by-senders rmail-summary-by-topic
4390 ;;;;;; rmail-summary-by-regexp rmail-summary-by-recipients rmail-summary-by-labels
4391 ;;;;;; rmail-summary) "rmailsum" "rmailsum.el" "6bcfd5937a56902944a929b89b33adaa")
4392 ;;; Generated autoloads from rmailsum.el
4395 Display a summary of all messages, one line per message.
4400 Display a summary of all messages with one or more LABELS.
4401 LABELS should be a string containing the desired labels, separated by commas.
4406 Display a summary of all messages with the given RECIPIENTS.
4407 Normally checks the To, From and Cc fields of headers;
4408 but if PRIMARY-ONLY is non-nil (prefix arg given),
4409 only look in the To and From fields.
4410 RECIPIENTS is a string of regexps separated by commas.
4415 Display a summary of all messages according to regexp REGEXP.
4416 If the regular expression is found in the header of the message
4417 \(including in the date and other lines, as well as the subject line),
4418 Emacs will list the message in the summary.
4423 Display a summary of all messages with the given SUBJECT.
4424 Normally checks just the Subject field of headers; but with prefix
4425 argument WHOLE-MESSAGE is non-nil, looks in the whole message.
4426 SUBJECT is a string of regexps separated by commas.
4432 SENDERS is a string of regexps separated by commas.
4436 ;;;***
4437 \f
4438 ;;;### (autoloads (unforward-rmail-message undigestify-rmail-message)
4439 ;;;;;; "undigest" "undigest.el" "2869c38a0051d0acab1a5968627fa57d")
4440 ;;; Generated autoloads from undigest.el
4443 Break up a digest message into its constituent messages.
4444 Leaves original message, deleted, before the undigestified messages.
4449 Extract a forwarded message from the containing message.
4450 This puts the forwarded message into a separate rmail message
4451 following the containing message.
4455 ;;;***
4456 \f
4457 ;;; End of automatically extracted autoloads.
4462 ;; arch-tag: 65d257d3-c281-4a65-9c38-e61af95af2f0
4463 ;;; rmail.el ends here