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
5 ;; Free Software Foundation, Inc.
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/>.
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.
42 (eval-when-compile (require 'mule-util)) ; for detect-coding-with-priority
44 (defconst rmail-attribute-header "X-RMAIL-ATTRIBUTES"
45 "The header that stores the Rmail attribute data.")
47 (defconst rmail-keyword-header "X-RMAIL-KEYWORDS"
48 "The header that stores the Rmail keyword data.")
52 (defconst rmail-answered-attr-index 0
53 "The index for the `answered' attribute.")
55 (defconst rmail-deleted-attr-index 1
56 "The index for the `deleted' attribute.")
58 (defconst rmail-edited-attr-index 2
59 "The index for the `edited' attribute.")
61 (defconst rmail-filed-attr-index 3
62 "The index for the `filed' attribute.")
64 (defconst rmail-retried-attr-index 4
65 "The index for the `retried' attribute.")
67 (defconst rmail-forwarded-attr-index 5
68 "The index for the `forwarded' attribute.")
70 (defconst rmail-unseen-attr-index 6
71 "The index for the `unseen' attribute.")
73 (defconst rmail-resent-attr-index 6
74 "The index for the `resent' attribute.")
76 (defconst rmail-attr-array
85 "An array that provides a mapping between an attribute index,
86 its character representation and its display representation.")
89 (defvar font-lock-fontified)
90 (defvar mail-abbrev-syntax-table)
92 (defvar messages-head)
93 (defvar rmail-use-spam-filter)
95 (defvar rsf-sleep-after-message)
96 (defvar total-messages)
99 (defvar rmail-header-style 'normal
100 "The current header display style choice, one of
101 'normal (selected headers) or 'full (all headers).")
103 ; These variables now declared in paths.el.
104 ;(defvar rmail-spool-directory "/usr/spool/mail/"
105 ; "This is the name of the directory used by the system mailer for\n\
106 ;delivering new mail. Its name should end with a slash.")
107 ;(defvar rmail-file-name
108 ; (expand-file-name "~/RMAIL")
111 ;; Temporary support for mbox.
112 (defcustom rmail-file-name "~/RMAIL"
113 "*Name of user's primary mail file."
119 "Mail reader for Emacs."
122 (defgroup rmail-retrieve nil
123 "Rmail retrieval options."
127 (defgroup rmail-files nil
132 (defgroup rmail-headers nil
133 "Rmail header options."
137 (defgroup rmail-reply nil
138 "Rmail reply options."
142 (defgroup rmail-summary nil
143 "Rmail summary options."
145 :prefix "rmail-summary-"
148 (defgroup rmail-output nil
149 "Output message to a file."
150 :prefix "rmail-output-"
154 (defgroup rmail-edit nil
156 :prefix "rmail-edit-"
159 (defgroup rmail-obsolete nil
160 "Rmail obsolete customization variables."
163 (defcustom rmail-movemail-program nil
164 "If non-nil, the file name of the `movemail' program."
165 :group 'rmail-retrieve
166 :type '(choice (const nil) string))
168 (defcustom rmail-pop-password nil
169 "*Password to use when reading mail from POP server.
170 Please use `rmail-remote-password' instead."
171 :type '(choice (string :tag "Password")
172 (const :tag "Not Required" nil))
173 :group 'rmail-obsolete)
175 (defcustom rmail-pop-password-required nil
176 "*Non-nil if a password is required when reading mail from a POP server.
177 Please use rmail-remote-password-required instead."
179 :group 'rmail-obsolete)
181 (defcustom rmail-remote-password nil
182 "*Password to use when reading mail from a remote server.
183 This setting is ignored for mailboxes whose URL already contains a password."
184 :type '(choice (string :tag "Password")
185 (const :tag "Not Required" nil))
186 :set-after '(rmail-pop-password)
187 :set #'(lambda (symbol value)
190 (boundp 'rmail-pop-password)
194 (setq rmail-pop-password nil))
195 :group 'rmail-retrieve
198 (defcustom rmail-remote-password-required nil
199 "*Non-nil if a password is required when reading mail from a remote server."
201 :set-after '(rmail-pop-password-required)
202 :set #'(lambda (symbol value)
205 (boundp 'rmail-pop-password-required)
206 rmail-pop-password-required)
207 rmail-pop-password-required
209 (setq rmail-pop-password-required nil))
210 :group 'rmail-retrieve
213 (defcustom rmail-movemail-flags nil
214 "*List of flags to pass to movemail.
215 Most commonly used to specify `-g' to enable GSS-API authentication
216 or `-k' to enable Kerberos authentication."
217 :type '(repeat string)
218 :group 'rmail-retrieve
221 (defvar rmail-remote-password-error "invalid usercode or password\\|
222 unknown user name or bad password\\|Authentication failed\\|MU_ERR_AUTH_FAILURE"
223 "Regular expression matching incorrect-password POP or IMAP server error
225 If you get an incorrect-password error that this expression does not match,
226 please report it with \\[report-emacs-bug].")
228 (defvar rmail-encoded-remote-password nil)
230 (defcustom rmail-preserve-inbox nil
231 "*Non-nil means leave incoming mail in the user's inbox--don't delete it."
233 :group 'rmail-retrieve)
235 (defcustom rmail-movemail-search-path nil
236 "*List of directories to search for movemail (in addition to `exec-path')."
237 :group 'rmail-retrieve
238 :type '(repeat (directory)))
240 (declare-function mail-position-on-field "sendmail" (field &optional soft))
241 (declare-function mail-text-start "sendmail" ())
242 (declare-function rmail-dont-reply-to "mail-utils" (destinations))
243 (declare-function rmail-update-summary "rmailsum" (&rest ignore))
245 (defun rmail-probe (prog)
246 "Determine what flavor of movemail PROG is.
247 We do this by executing it with `--version' and analyzing its output."
249 (let ((tbuf (current-buffer)))
250 (buffer-disable-undo tbuf)
251 (call-process prog nil tbuf nil "--version")
252 (if (not (buffer-modified-p tbuf))
253 ;; Should not happen...
255 (goto-char (point-min))
257 ((looking-at ".*movemail: invalid option")
258 'emacs) ;; Possibly...
259 ((looking-at "movemail (GNU Mailutils .*)")
265 (defun rmail-autodetect ()
266 "Determine the file name of the `movemail' program and return its flavor.
267 If `rmail-movemail-program' is non-nil, use it.
268 Otherwise, look for `movemail' in the directories in
269 `rmail-movemail-search-path', those in `exec-path', and `exec-directory'."
270 (if rmail-movemail-program
271 (rmail-probe rmail-movemail-program)
273 (dolist (dir (append rmail-movemail-search-path exec-path
274 (list exec-directory)))
275 (when (and dir (file-accessible-directory-p dir))
276 ;; Previously, this didn't have to work on Windows, because
277 ;; rmail-insert-inbox-text before r1.439 fell back to using
278 ;; (expand-file-name "movemail" exec-directory) and just
279 ;; assuming it would work.
280 ;; http://lists.gnu.org/archive/html/bug-gnu-emacs/2008-02/msg00087.html
281 (let ((progname (expand-file-name
283 (if (memq system-type '(ms-dos windows-nt))
285 (when (and (not (file-directory-p progname))
286 (file-executable-p progname))
287 (let ((x (rmail-probe progname)))
289 (setq rmail-movemail-program progname)
290 (throw 'scan x))))))))))
292 (defvar rmail-movemail-variant-in-use nil
293 "The movemail variant currently in use. Known variants are:
295 `emacs' Means any implementation, compatible with the native Emacs one.
297 `mailutils' Means GNU mailutils implementation, capable of handling full
298 mail URLs as the source mailbox.")
301 (defun rmail-movemail-variant-p (&rest variants)
302 "Return t if the current movemail variant is any of VARIANTS.
303 Currently known variants are 'emacs and 'mailutils."
304 (when (not rmail-movemail-variant-in-use)
306 (setq rmail-movemail-variant-in-use (rmail-autodetect)))
307 (not (null (member rmail-movemail-variant-in-use variants))))
309 ;; Call for effect, to set rmail-movemail-program (if not set by the
310 ;; user), and rmail-movemail-variant-in-use. Used by various functions.
311 ;; I'm not sure if M-x rmail is the only entry point to this package.
312 ;; If so, this can be moved there.
313 (rmail-movemail-variant-p)
316 (defcustom rmail-dont-reply-to-names nil "\
317 *A regexp specifying addresses to prune from a reply message.
318 A value of nil means exclude your own email address as an address
319 plus whatever is specified by `rmail-default-dont-reply-to-names'."
320 :type '(choice regexp (const :tag "Your Name" nil))
324 (defvar rmail-default-dont-reply-to-names "\\`info-" "\
325 A regular expression specifying part of the default value of the
326 variable `rmail-dont-reply-to-names', for when the user does not set
327 `rmail-dont-reply-to-names' explicitly. (The other part of the default
328 value is the user's email address and name.)
329 It is useful to set this variable in the site customization file.")
332 (defcustom rmail-ignored-headers
333 (concat "^via:\\|^mail-from:\\|^origin:\\|^references:\\|^sender:"
334 "\\|^status:\\|^received:\\|^x400-originator:\\|^x400-recipients:"
335 "\\|^x400-received:\\|^x400-mts-identifier:\\|^x400-content-type:"
336 "\\|^\\(resent-\\|\\)message-id:\\|^summary-line:\\|^resent-date:"
337 "\\|^nntp-posting-host:\\|^path:\\|^x-char.*:\\|^x-face:\\|^face:"
338 "\\|^x-mailer:\\|^delivered-to:\\|^lines:"
339 "\\|^content-transfer-encoding:\\|^x-coding-system:"
340 "\\|^return-path:\\|^errors-to:\\|^return-receipt-to:"
341 "\\|^precedence:\\|^mime-version:"
342 "\\|^list-owner:\\|^list-help:\\|^list-post:\\|^list-subscribe:"
343 "\\|^list-id:\\|^list-unsubscribe:\\|^list-archive:"
344 "\\|^content-length:\\|^nntp-posting-date:\\|^user-agent"
345 "\\|^importance:\\|^envelope-to:\\|^delivery-date\\|^openpgp:"
346 "\\|^mbox-line:\\|^cancel-lock:"
347 "\\|^DomainKey-Signature:\\|^dkim-signature:"
348 "\\|^resent-face:\\|^resent-x.*:\\|^resent-organization:\\|^resent-openpgp:"
350 "*Regexp to match header fields that Rmail should normally hide.
351 \(See also `rmail-nonignored-headers', which overrides this regexp.)
352 This variable is used for reformatting the message header,
353 which normally happens once for each message,
354 when you view the message for the first time in Rmail.
355 To make a change in this variable take effect
356 for a message that you have already viewed,
357 go to that message and type \\[rmail-toggle-header] twice."
359 :group 'rmail-headers)
361 (defcustom rmail-nonignored-headers "^x-spam-status:"
362 "*Regexp to match X header fields that Rmail should show.
363 This regexp overrides `rmail-ignored-headers'; if both this regexp
364 and that one match a certain header field, Rmail shows the field.
365 If this is nil, ignore all header fields in `rmail-ignored-headers'.
367 This variable is used for reformatting the message header,
368 which normally happens once for each message,
369 when you view the message for the first time in Rmail.
370 To make a change in this variable take effect
371 for a message that you have already viewed,
372 go to that message and type \\[rmail-toggle-header] twice."
373 :type '(choice (const nil) (regexp))
374 :group 'rmail-headers)
377 (defcustom rmail-displayed-headers nil
378 "*Regexp to match Header fields that Rmail should display.
379 If nil, display all header fields except those matched by
380 `rmail-ignored-headers'."
381 :type '(choice regexp (const :tag "All"))
382 :group 'rmail-headers)
385 (defcustom rmail-retry-ignored-headers "^x-authentication-warning:" "\
386 *Headers that should be stripped when retrying a failed message."
387 :type '(choice regexp (const nil :tag "None"))
388 :group 'rmail-headers)
391 (defcustom rmail-highlighted-headers "^From:\\|^Subject:" "\
392 *Regexp to match Header fields that Rmail should normally highlight.
393 A value of nil means don't highlight."
395 :group 'rmail-headers)
397 (defface rmail-highlight
398 '((t (:inherit highlight)))
399 "Face to use for highlighting the most important header fields."
400 :group 'rmail-headers
403 (defface rmail-header-name
404 '((t (:inherit font-lock-function-name-face)))
405 "Face to use for highlighting the header names."
406 :group 'rmail-headers
410 (defcustom rmail-delete-after-output nil "\
411 *Non-nil means automatically delete a message that is copied to a file."
416 (defcustom rmail-primary-inbox-list nil "\
417 *List of files which are inboxes for user's primary mail file `~/RMAIL'.
418 nil means the default, which is (\"/usr/spool/mail/$USER\")
419 \(the name varies depending on the operating system,
420 and the value of the environment variable MAIL overrides it)."
421 ;; Don't use backquote here, because we don't want to need it
423 :type (list 'choice '(const :tag "Default" nil)
424 (list 'repeat ':value (list (or (getenv "MAIL")
425 (concat "/var/spool/mail/"
428 :group 'rmail-retrieve
432 (defcustom rmail-mail-new-frame nil
433 "*Non-nil means Rmail makes a new frame for composing outgoing mail.
434 This is handy if you want to preserve the window configuration of
435 the frame where you have the RMAIL buffer displayed."
440 (defcustom rmail-secondary-file-directory "~/"
441 "*Directory for additional secondary Rmail files."
445 (defcustom rmail-secondary-file-regexp "\\.xmail$"
446 "*Regexp for which files are secondary Rmail files."
451 (defcustom rmail-confirm-expunge 'y-or-n-p
452 "*Whether and how to ask for confirmation before expunging deleted messages."
453 :type '(choice (const :tag "No confirmation" nil)
454 (const :tag "Confirm with y-or-n-p" y-or-n-p)
455 (const :tag "Confirm with yes-or-no-p" yes-or-no-p))
460 (defvar rmail-mode-hook nil
461 "List of functions to call when Rmail is invoked.")
464 (defvar rmail-get-new-mail-hook nil
465 "List of functions to call when Rmail has retrieved new mail.")
468 (defcustom rmail-show-message-hook nil
469 "List of functions to call when Rmail displays a message."
471 :options '(goto-address)
475 (defvar rmail-quit-hook nil
476 "List of functions to call when quitting out of Rmail.")
479 (defvar rmail-delete-message-hook nil
480 "List of functions to call when Rmail deletes a message.
481 When the hooks are called, the message has been marked deleted but is
482 still the current message in the Rmail buffer.")
484 ;; These may be altered by site-init.el to match the format of mmdf files
485 ;; delimiting used on a given host (delim1 and delim2 from the config
488 (defvar rmail-mmdf-delim1 "^\001\001\001\001\n"
489 "Regexp marking the start of an mmdf message.")
490 (defvar rmail-mmdf-delim2 "^\001\001\001\001\n"
491 "Regexp marking the end of an mmdf message.")
493 (defcustom rmail-message-filter nil
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'."
497 :group 'rmail-headers
498 :type '(choice (const nil) function))
500 (defcustom rmail-automatic-folder-directives nil
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 BABYL format folder to put the
507 message. If any of the field regexp's are nil, then it is ignored.
509 If FOLDERNAME is \"/dev/null\", it is deleted.
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
513 \"subject\" or \"from\". A FIELD of \"to\" will automatically include
514 all text from the \"cc\" field as well.
516 REGEXP is an expression to match in the preceeding specified FIELD.
517 FIELD/REGEXP pairs continue in the list.
520 (\"/dev/null\" \"from\" \"@spam.com\") ; delete all mail from spam.com
521 (\"RMS\" \"from\" \"rms@\") ; save all mail from RMS."
524 :type '(repeat (sexp :tag "Directive")))
526 (defvar rmail-reply-prefix "Re: "
527 "String to prepend to Subject line when replying to a message.")
529 ;; Some mailers use "Re(2):" or "Re^2:" or "Re: Re:" or "Re[2]:".
530 ;; This pattern should catch all the common variants.
531 ;; rms: I deleted the change to delete tags in square brackets
532 ;; because they mess up RT tags.
533 (defvar rmail-reply-regexp "\\`\\(Re\\(([0-9]+)\\|\\[[0-9]+\\]\\|\\^[0-9]+\\)?: *\\)*"
534 "Regexp to delete from Subject line before inserting `rmail-reply-prefix'.")
536 (defcustom rmail-display-summary nil
537 "*If non-nil, Rmail always displays the summary buffer."
538 :group 'rmail-summary
541 (defvar rmail-inbox-list nil)
542 (put 'rmail-inbox-list 'permanent-local t)
544 (defvar rmail-buffer nil
545 "The RMAIL buffer related to the current buffer.
546 In an RMAIL buffer, this holds the RMAIL buffer itself.
547 In a summary buffer, this holds the RMAIL buffer it is a summary for.")
548 (put 'rmail-buffer 'permanent-local t)
550 ;; Message counters and markers. Deleted flags.
552 (defvar rmail-current-message nil)
553 (put 'rmail-current-message 'permanent-local t)
555 (defvar rmail-total-messages nil)
556 (put 'rmail-total-messages 'permanent-local t)
558 (defvar rmail-message-vector nil)
559 (put 'rmail-message-vector 'permanent-local t)
561 (defvar rmail-deleted-vector nil)
562 (put 'rmail-deleted-vector 'permanent-local t)
564 (defvar rmail-msgref-vector nil
565 "In an Rmail buffer, a vector whose Nth element is a list (N).
566 When expunging renumbers messages, these lists are modified
567 by substituting the new message number into the existing list.")
568 (put 'rmail-msgref-vector 'permanent-local t)
570 (defvar rmail-overlay-list nil)
571 (put 'rmail-overlay-list 'permanent-local t)
573 ;; These are used by autoloaded rmail-summary.
575 (defvar rmail-summary-buffer nil)
576 (put 'rmail-summary-buffer 'permanent-local t)
577 (defvar rmail-summary-vector nil)
578 (put 'rmail-summary-vector 'permanent-local t)
580 ;; Rmail buffer swapping variables.
582 (defvar rmail-buffer-swapped nil
583 "If non-nil, `rmail-buffer' is swapped with `rmail-view-buffer'.")
584 (put 'rmail-buffer-swapped 'permanent-local t)
586 (defvar rmail-view-buffer nil
587 "Buffer which holds RMAIL message for MIME displaying.")
588 (put 'rmail-view-buffer 'permanent-local t)
590 ;; `Sticky' default variables.
592 ;; Last individual label specified to a or k.
593 (defvar rmail-last-label nil)
595 ;; Last set of values specified to C-M-n, C-M-p, C-M-s or C-M-l.
596 (defvar rmail-last-multi-labels nil)
598 (defvar rmail-last-regexp nil)
599 (put 'rmail-last-regexp 'permanent-local t)
601 (defcustom rmail-default-file "~/xmail"
602 "*Default file name for \\[rmail-output]."
605 (defcustom rmail-default-body-file "~/mailout"
606 "*Default file name for \\[rmail-output-body-to-file]."
611 ;; Mule and MIME related variables.
614 (defvar rmail-file-coding-system nil
615 "Coding system used in RMAIL file.
617 This is set to nil by default.")
620 (defcustom rmail-enable-mime nil
621 "*If non-nil, RMAIL uses MIME feature.
622 If the value is t, RMAIL automatically shows MIME decoded message.
623 If the value is neither t nor nil, RMAIL does not show MIME decoded message
624 until a user explicitly requires it.
626 Even if the value is non-nil, you can't use MIME feature
627 if the feature specified by `rmail-mime-feature' is not available
629 :type '(choice (const :tag "on" t)
630 (const :tag "off" nil)
631 (other :tag "when asked" ask))
634 (defvar rmail-enable-mime-composing nil
635 "*If non-nil, RMAIL uses `rmail-insert-mime-forwarded-message-function' to forward.")
638 (defvar rmail-show-mime-function nil
639 "Function to show MIME decoded message of RMAIL file.
640 This function is called when `rmail-enable-mime' is non-nil.
641 It is called with no argument.")
644 (defvar rmail-insert-mime-forwarded-message-function nil
645 "Function to insert a message in MIME format so it can be forwarded.
646 This function is called if `rmail-enable-mime' or
647 `rmail-enable-mime-composing' is non-nil.
648 It is called with one argument FORWARD-BUFFER, which is a
649 buffer containing the message to forward. The current buffer
650 is the outgoing mail buffer.")
653 (defvar rmail-insert-mime-resent-message-function nil
654 "Function to insert a message in MIME format so it can be resent.
655 This function is called if `rmail-enable-mime' is non-nil.
656 It is called with one argument FORWARD-BUFFER, which is a
657 buffer containing the message to forward. The current buffer
658 is the outgoing mail buffer.")
661 (defvar rmail-search-mime-message-function nil
662 "Function to check if a regexp matches a MIME message.
663 This function is called if `rmail-enable-mime' is non-nil.
664 It is called with two arguments MSG and REGEXP, where
665 MSG is the message number, REGEXP is the regular expression.")
668 (defvar rmail-search-mime-header-function nil
669 "Function to check if a regexp matches a header of MIME message.
670 This function is called if `rmail-enable-mime' is non-nil.
671 It is called with three arguments MSG, REGEXP, and LIMIT, where
672 MSG is the message number,
673 REGEXP is the regular expression,
674 LIMIT is the position specifying the end of header.")
677 (defvar rmail-mime-feature 'rmail-mime
678 "Feature to require to load MIME support in Rmail.
679 When starting Rmail, if `rmail-enable-mime' is non-nil,
680 this feature is required with `require'.
682 The default value is `rmail-mime'. This feature is provided by
683 the rmail-mime package available at <http://www.m17n.org/rmail-mime/>.")
686 (defvar rmail-decode-mime-charset t
687 "*Non-nil means a message is decoded by MIME's charset specification.
688 If this variable is nil, or the message has not MIME specification,
689 the message is decoded as normal way.
691 If the variable `rmail-enable-mime' is non-nil, this variables is
692 ignored, and all the decoding work is done by a feature specified by
693 the variable `rmail-mime-feature'.")
696 (defvar rmail-mime-charset-pattern
697 (concat "^content-type:[ \t]*text/plain;"
698 "\\(?:[ \t\n]*\\(?:format\\|delsp\\)=\"?[-a-z0-9]+\"?;\\)*"
699 "[ \t\n]*charset=\"?\\([^ \t\n\";]+\\)\"?")
700 "Regexp to match MIME-charset specification in a header of message.
701 The first parenthesized expression should match the MIME-charset name.")
704 ;;; Regexp matching the delimiter of messages in UNIX mail format
705 ;;; (UNIX From lines), minus the initial ^. Note that if you change
706 ;;; this expression, you must change the code in rmail-nuke-pinhead-header
707 ;;; that knows the exact ordering of the \\( \\) subexpressions.
708 (defvar rmail-unix-mail-delimiter
709 (let ((time-zone-regexp
710 (concat "\\([A-Z]?[A-Z]?[A-Z][A-Z]\\( DST\\)?"
711 "\\|[-+]?[0-9][0-9][0-9][0-9]"
717 ;; Many things can happen to an RFC 822 mailbox before it is put into
718 ;; a `From' line. The leading phrase can be stripped, e.g.
719 ;; `Joe <@w.x:joe@y.z>' -> `<@w.x:joe@y.z>'. The <> can be stripped, e.g.
720 ;; `<@x.y:joe@y.z>' -> `@x.y:joe@y.z'. Everything starting with a CRLF
721 ;; can be removed, e.g.
722 ;; From: joe@y.z (Joe K
724 ;; can yield `From joe@y.z (Joe K Fri Mar 22 08:11:15 1996', and
727 ;; can yield `From Joe User Fri Mar 22 08:11:15 1996'.
728 ;; The mailbox can be removed or be replaced by white space, e.g.
729 ;; From: "Joe User"{space}{tab}
731 ;; can yield `From {space}{tab} Fri Mar 22 08:11:15 1996',
732 ;; where {space} and {tab} represent the Ascii space and tab characters.
733 ;; We want to match the results of any of these manglings.
734 ;; The following regexp rejects names whose first characters are
735 ;; obviously bogus, but after that anything goes.
736 "\\([^\0-\b\n-\r\^?].*\\)? "
738 ;; The time the message was sent.
739 "\\([^\0-\r \^?]+\\) +" ; day of the week
740 "\\([^\0-\r \^?]+\\) +" ; month
741 "\\([0-3]?[0-9]\\) +" ; day of month
742 "\\([0-2][0-9]:[0-5][0-9]\\(:[0-6][0-9]\\)?\\) *" ; time of day
744 ;; Perhaps a time zone, specified by an abbreviation, or by a
749 " \\([0-9][0-9]+\\) *"
751 ;; On some systems the time zone can appear after the year, too.
755 "\\(remote from .*\\)?"
760 (defvar rmail-font-lock-keywords
761 ;; These are all matched case-insensitively.
763 (let* ((cite-chars "[>|}]")
765 (cite-suffix (concat cite-prefix "0-9_.@-`'\"")))
766 (list '("^\\(From\\|Sender\\|Resent-From\\):"
767 . 'rmail-header-name)
768 '("^Reply-To:.*$" . 'rmail-header-name)
769 '("^Subject:" . 'rmail-header-name)
770 '("^X-Spam-Status:" . 'rmail-header-name)
771 '("^\\(To\\|Apparently-To\\|Cc\\|Newsgroups\\):"
772 . 'rmail-header-name)
773 ;; Use MATCH-ANCHORED to effectively anchor the regexp left side.
775 (,(concat "\\=[ \t]*"
776 "\\(\\(\\([" cite-prefix "]+[" cite-suffix "]*\\)?"
777 "\\(" cite-chars "[ \t]*\\)\\)+\\)"
779 (beginning-of-line) (end-of-line)
780 (1 font-lock-comment-delimiter-face nil t)
781 (5 font-lock-comment-face nil t)))
782 '("^\\(X-[a-z0-9-]+\\|In-reply-to\\|Date\\):.*\\(\n[ \t]+.*\\)*$"
783 . 'rmail-header-name))))
784 "Additional expressions to highlight in Rmail mode.")
786 ;; Perform BODY in the summary buffer
787 ;; in such a way that its cursor is properly updated in its own window.
788 (defmacro rmail-select-summary (&rest body)
789 `(let ((total rmail-total-messages))
790 (if (rmail-summary-displayed)
791 (let ((window (selected-window)))
795 (pop-to-buffer rmail-summary-buffer)
796 ;; rmail-total-messages is a buffer-local var
797 ;; in the rmail buffer.
798 ;; This way we make it available for the body
799 ;; even tho the rmail buffer is not current.
800 (let ((rmail-total-messages total))
802 (select-window window))))
804 (set-buffer rmail-summary-buffer)
805 (let ((rmail-total-messages total))
807 (rmail-maybe-display-summary)))
809 ;;;; *** Rmail Mode ***
811 ;; This variable is dynamically bound. The defvar is here to placate
812 ;; the byte compiler.
814 (defvar rmail-enable-multibyte nil)
817 (defun rmail-require-mime-maybe ()
818 "Require `rmail-mime-feature' if that is non-nil.
819 Signal an error and set `rmail-mime-feature' to nil if the feature
821 (when rmail-enable-mime
823 (require rmail-mime-feature)
827 (format "Although MIME support is requested
828 by setting `rmail-enable-mime' to non-nil, the required feature
829 `%s' (the value of `rmail-mime-feature')
830 is not available in the current session.
831 So, the MIME support is turned off for the moment."
834 (setq rmail-enable-mime nil)))))
838 (defun rmail (&optional file-name-arg)
839 "Read and edit incoming mail.
840 Moves messages into file named by `rmail-file-name' (a babyl format file)
841 and edits that file in RMAIL Mode.
842 Type \\[describe-mode] once editing that file, for a list of RMAIL commands.
844 May be called with file name as argument; then performs rmail editing on
845 that file, but does not copy any new mail into the file.
846 Interactively, if you supply a prefix argument, then you
847 have a chance to specify a file name with the minibuffer.
849 If `rmail-display-summary' is non-nil, make a summary for this RMAIL file."
850 (interactive (if current-prefix-arg
851 (list (read-file-name "Run rmail on RMAIL file: "))))
852 (rmail-require-mime-maybe)
853 (let* ((file-name (expand-file-name (or file-name-arg rmail-file-name)))
854 ;; Use find-buffer-visiting, not get-file-buffer, for those users
855 ;; who have find-file-visit-truename set to t.
856 (existed (find-buffer-visiting file-name))
857 run-mail-hook mail-buf msg-shown)
858 ;; Determine if an existing mail file has been changed behind the
860 (if (and existed (not (verify-visited-file-modtime existed)))
861 ;; The mail file has been changed. Revisit it and reset the
862 ;; message state variables when in rmail mode.
864 (find-file file-name)
865 (when (and (verify-visited-file-modtime existed)
866 (eq major-mode 'rmail-mode))
867 (rmail-set-message-counters)))
868 ;; The mail file is either unchanged or not visited. Visit it.
870 (let ((enable-local-variables nil))
871 (find-file-noselect file-name))))
872 ;; Insure that the collection and view buffers are in sync and
873 ;; insure that a message is not being edited.
874 (if (eq major-mode 'rmail-mode)
875 (rmail-swap-buffers-maybe))
876 (if (eq major-mode 'rmail-edit-mode)
877 (error "Exit Rmail Edit mode before getting new mail"))
878 (or (and existed (> (buffer-size) 0))
879 (setq run-mail-hook t))
880 ;; Insure that the Rmail file is in mbox format, the buffer is in
881 ;; Rmail mode and has been scanned to find all the messages
882 ;; (setting the global message variables in the process).
883 (rmail-convert-file-maybe)
884 (unless (eq major-mode 'rmail-mode)
886 (goto-char (point-max))
887 (rmail-maybe-set-message-counters)
888 (setq mail-buf rmail-buffer)
889 ;; Show the first unread message and process summary mode.
891 ;; Only get new mail when there is not a file name argument.
892 (unless file-name-arg
893 (rmail-get-new-mail))
895 (set-buffer mail-buf)
896 (rmail-show-message-maybe (rmail-first-unseen-message))
897 (if rmail-display-summary (rmail-summary))
898 (rmail-construct-io-menu)
900 (run-hooks 'rmail-mode-hook))))))
902 (defun rmail-convert-file-maybe ()
903 "Determine if the file needs to be converted to mbox format."
905 (goto-char (point-min))
906 ;; Detect previous Babyl format files.
907 (cond ((looking-at "BABYL OPTIONS:")
908 ;; The file is Babyl version 5. Use unrmail to convert
910 (rmail-convert-babyl-to-mbox))
911 ((looking-at "Version: 5\n")
912 ;; Losing babyl file made by old version of Rmail. Fix the
913 ;; babyl file header and use unrmail to convert to mbox
915 (let ((buffer-read-only nil))
916 (insert "BABYL OPTIONS: -*- rmail -*-\n")
917 (rmail-convert-babyl-to-mbox)))
918 ((equal (point-min) (point-max))
919 (message "Empty Rmail file."))
920 ((looking-at "From "))
921 (t (error "Invalid mbox file"))))
923 (defun rmail-error-bad-format (&optional msgnum)
924 "Report that the buffer is not in the mbox file format.
925 MSGNUM, if present, indicates the malformed message."
927 (error "Message %d is not a valid RFC2822 message" msgnum)
928 (error "Message is not a valid RFC2822 message")))
930 (defun rmail-convert-babyl-to-mbox ()
931 "Convert the mail file from Babyl version 5 to mbox.
932 This function also reinitializes local variables used by Rmail."
933 (let ((old-file (make-temp-file "rmail"))
934 (new-file (make-temp-file "rmail")))
937 (kill-all-local-variables)
938 (write-region (point-min) (point-max) old-file)
939 (unrmail old-file new-file)
940 (message "Replacing BABYL format with mbox format...")
941 (let ((inhibit-read-only t))
943 (insert-file-contents-literally new-file)
945 (rmail-perm-variables)
947 (goto-char (point-max))
948 (rmail-set-message-counters))
949 (message "Replacing BABYL format with mbox format...done"))
950 (delete-file old-file)
951 (delete-file new-file))))
953 (defun rmail-get-coding-system ()
954 "Return a suitable coding system to use for the current mail message.
955 The buffer is expected to be narrowed to just the header of the message."
956 (let ((content-type-header (mail-fetch-field "content-type"))
959 (setq separator (search-forward "\n\n")))
960 (if (and content-type-header
961 (string-match rmail-mime-charset-pattern content-type-header))
962 (substring content-type-header (match-beginning 1) (match-end 1))
965 ;;; Set up Rmail mode keymaps
967 (defvar rmail-mode-map nil)
970 (setq rmail-mode-map (make-keymap))
971 (suppress-keymap rmail-mode-map)
972 (define-key rmail-mode-map "a" 'rmail-add-label)
973 (define-key rmail-mode-map "b" 'rmail-bury)
974 (define-key rmail-mode-map "c" 'rmail-continue)
975 (define-key rmail-mode-map "d" 'rmail-delete-forward)
976 (define-key rmail-mode-map "\C-d" 'rmail-delete-backward)
977 (define-key rmail-mode-map "e" 'rmail-edit-current-message)
978 (define-key rmail-mode-map "f" 'rmail-forward)
979 (define-key rmail-mode-map "g" 'rmail-get-new-mail)
980 (define-key rmail-mode-map "h" 'rmail-summary)
981 (define-key rmail-mode-map "i" 'rmail-input)
982 (define-key rmail-mode-map "j" 'rmail-show-message-maybe)
983 (define-key rmail-mode-map "k" 'rmail-kill-label)
984 (define-key rmail-mode-map "l" 'rmail-summary-by-labels)
985 (define-key rmail-mode-map "\e\C-h" 'rmail-summary)
986 (define-key rmail-mode-map "\e\C-l" 'rmail-summary-by-labels)
987 (define-key rmail-mode-map "\e\C-r" 'rmail-summary-by-recipients)
988 (define-key rmail-mode-map "\e\C-s" 'rmail-summary-by-regexp)
989 (define-key rmail-mode-map "\e\C-t" 'rmail-summary-by-topic)
990 (define-key rmail-mode-map "m" 'rmail-mail)
991 (define-key rmail-mode-map "\em" 'rmail-retry-failure)
992 (define-key rmail-mode-map "n" 'rmail-next-undeleted-message)
993 (define-key rmail-mode-map "\en" 'rmail-next-message)
994 (define-key rmail-mode-map "\e\C-n" 'rmail-next-labeled-message)
995 (define-key rmail-mode-map "o" 'rmail-output)
996 (define-key rmail-mode-map "\C-o" 'rmail-output-as-seen)
997 (define-key rmail-mode-map "p" 'rmail-previous-undeleted-message)
998 (define-key rmail-mode-map "\ep" 'rmail-previous-message)
999 (define-key rmail-mode-map "\e\C-p" 'rmail-previous-labeled-message)
1000 (define-key rmail-mode-map "q" 'rmail-quit)
1001 (define-key rmail-mode-map "r" 'rmail-reply)
1002 ;; I find I can't live without the default M-r command -- rms.
1003 ;; (define-key rmail-mode-map "\er" 'rmail-search-backwards)
1004 (define-key rmail-mode-map "s" 'rmail-expunge-and-save)
1005 (define-key rmail-mode-map "\es" 'rmail-search)
1006 (define-key rmail-mode-map "t" 'rmail-toggle-header)
1007 (define-key rmail-mode-map "u" 'rmail-undelete-previous-message)
1008 (define-key rmail-mode-map "w" 'rmail-output-body-to-file)
1009 (define-key rmail-mode-map "\C-c\C-w" 'rmail-widen)
1010 (define-key rmail-mode-map "x" 'rmail-expunge)
1011 (define-key rmail-mode-map "." 'rmail-beginning-of-message)
1012 (define-key rmail-mode-map "/" 'rmail-end-of-message)
1013 (define-key rmail-mode-map "<" 'rmail-first-message)
1014 (define-key rmail-mode-map ">" 'rmail-last-message)
1015 (define-key rmail-mode-map " " 'scroll-up)
1016 (define-key rmail-mode-map "\177" 'scroll-down)
1017 (define-key rmail-mode-map "?" 'describe-mode)
1018 (define-key rmail-mode-map "\C-c\C-s\C-d" 'rmail-sort-by-date)
1019 (define-key rmail-mode-map "\C-c\C-s\C-s" 'rmail-sort-by-subject)
1020 (define-key rmail-mode-map "\C-c\C-s\C-a" 'rmail-sort-by-author)
1021 (define-key rmail-mode-map "\C-c\C-s\C-r" 'rmail-sort-by-recipient)
1022 (define-key rmail-mode-map "\C-c\C-s\C-c" 'rmail-sort-by-correspondent)
1023 (define-key rmail-mode-map "\C-c\C-s\C-l" 'rmail-sort-by-lines)
1024 (define-key rmail-mode-map "\C-c\C-s\C-k" 'rmail-sort-by-labels)
1025 (define-key rmail-mode-map "\C-c\C-n" 'rmail-next-same-subject)
1026 (define-key rmail-mode-map "\C-c\C-p" 'rmail-previous-same-subject)
1029 (define-key rmail-mode-map [menu-bar] (make-sparse-keymap))
1031 (define-key rmail-mode-map [menu-bar classify]
1032 (cons "Classify" (make-sparse-keymap "Classify")))
1034 (define-key rmail-mode-map [menu-bar classify input-menu]
1037 (define-key rmail-mode-map [menu-bar classify output-menu]
1040 (define-key rmail-mode-map [menu-bar classify output-body]
1041 '("Output body to file..." . rmail-output-body-to-file))
1043 (define-key rmail-mode-map [menu-bar classify output-inbox]
1044 '("Output..." . rmail-output))
1046 (define-key rmail-mode-map [menu-bar classify output]
1047 '("Output as seen..." . rmail-output-as-seen))
1049 (define-key rmail-mode-map [menu-bar classify kill-label]
1050 '("Kill Label..." . rmail-kill-label))
1052 (define-key rmail-mode-map [menu-bar classify add-label]
1053 '("Add Label..." . rmail-add-label))
1055 (define-key rmail-mode-map [menu-bar summary]
1056 (cons "Summary" (make-sparse-keymap "Summary")))
1058 (define-key rmail-mode-map [menu-bar summary senders]
1059 '("By Senders..." . rmail-summary-by-senders))
1061 (define-key rmail-mode-map [menu-bar summary labels]
1062 '("By Labels..." . rmail-summary-by-labels))
1064 (define-key rmail-mode-map [menu-bar summary recipients]
1065 '("By Recipients..." . rmail-summary-by-recipients))
1067 (define-key rmail-mode-map [menu-bar summary topic]
1068 '("By Topic..." . rmail-summary-by-topic))
1070 (define-key rmail-mode-map [menu-bar summary regexp]
1071 '("By Regexp..." . rmail-summary-by-regexp))
1073 (define-key rmail-mode-map [menu-bar summary all]
1074 '("All" . rmail-summary))
1076 (define-key rmail-mode-map [menu-bar mail]
1077 (cons "Mail" (make-sparse-keymap "Mail")))
1079 (define-key rmail-mode-map [menu-bar mail rmail-get-new-mail]
1080 '("Get New Mail" . rmail-get-new-mail))
1082 (define-key rmail-mode-map [menu-bar mail lambda]
1085 (define-key rmail-mode-map [menu-bar mail continue]
1086 '("Continue" . rmail-continue))
1088 (define-key rmail-mode-map [menu-bar mail resend]
1089 '("Re-send..." . rmail-resend))
1091 (define-key rmail-mode-map [menu-bar mail forward]
1092 '("Forward" . rmail-forward))
1094 (define-key rmail-mode-map [menu-bar mail retry]
1095 '("Retry" . rmail-retry-failure))
1097 (define-key rmail-mode-map [menu-bar mail reply]
1098 '("Reply" . rmail-reply))
1100 (define-key rmail-mode-map [menu-bar mail mail]
1101 '("Mail" . rmail-mail))
1103 (define-key rmail-mode-map [menu-bar delete]
1104 (cons "Delete" (make-sparse-keymap "Delete")))
1106 (define-key rmail-mode-map [menu-bar delete expunge/save]
1107 '("Expunge/Save" . rmail-expunge-and-save))
1109 (define-key rmail-mode-map [menu-bar delete expunge]
1110 '("Expunge" . rmail-expunge))
1112 (define-key rmail-mode-map [menu-bar delete undelete]
1113 '("Undelete" . rmail-undelete-previous-message))
1115 (define-key rmail-mode-map [menu-bar delete delete]
1116 '("Delete" . rmail-delete-forward))
1118 (define-key rmail-mode-map [menu-bar move]
1119 (cons "Move" (make-sparse-keymap "Move")))
1121 (define-key rmail-mode-map [menu-bar move search-back]
1122 '("Search Back..." . rmail-search-backwards))
1124 (define-key rmail-mode-map [menu-bar move search]
1125 '("Search..." . rmail-search))
1127 (define-key rmail-mode-map [menu-bar move previous]
1128 '("Previous Nondeleted" . rmail-previous-undeleted-message))
1130 (define-key rmail-mode-map [menu-bar move next]
1131 '("Next Nondeleted" . rmail-next-undeleted-message))
1133 (define-key rmail-mode-map [menu-bar move last]
1134 '("Last" . rmail-last-message))
1136 (define-key rmail-mode-map [menu-bar move first]
1137 '("First" . rmail-first-message))
1139 (define-key rmail-mode-map [menu-bar move previous]
1140 '("Previous" . rmail-previous-message))
1142 (define-key rmail-mode-map [menu-bar move next]
1143 '("Next" . rmail-next-message))
1146 (defvar rmail-tool-bar-map
1147 (let ((map (make-sparse-keymap)))
1148 (tool-bar-local-item-from-menu 'rmail-get-new-mail "mail/inbox"
1150 (tool-bar-local-item-from-menu 'rmail-next-undeleted-message "right-arrow"
1152 (tool-bar-local-item-from-menu 'rmail-previous-undeleted-message "left-arrow"
1154 (tool-bar-local-item-from-menu 'rmail-search "search"
1156 (tool-bar-local-item-from-menu 'rmail-input "open"
1158 (tool-bar-local-item-from-menu 'rmail-mail "mail/compose"
1160 (tool-bar-local-item-from-menu 'rmail-reply "mail/reply-all"
1162 (tool-bar-local-item-from-menu 'rmail-forward "mail/forward"
1164 (tool-bar-local-item-from-menu 'rmail-delete-forward "close"
1166 (tool-bar-local-item-from-menu 'rmail-output "mail/move"
1168 (tool-bar-local-item-from-menu 'rmail-output-body-to-file "mail/save"
1170 (tool-bar-local-item-from-menu 'rmail-expunge "delete"
1176 ;; Rmail mode is suitable only for specially formatted data.
1177 (put 'rmail-mode 'mode-class 'special)
1179 (defun rmail-mode-kill-summary ()
1180 (if rmail-summary-buffer (kill-buffer rmail-summary-buffer)))
1183 (defun rmail-mode ()
1184 "Rmail Mode is used by \\<rmail-mode-map>\\[rmail] for editing Rmail files.
1185 All normal editing commands are turned off.
1186 Instead, these commands are available:
1188 \\[rmail-beginning-of-message] Move point to front of this message.
1189 \\[rmail-end-of-message] Move point to bottom of this message.
1190 \\[scroll-up] Scroll to next screen of this message.
1191 \\[scroll-down] Scroll to previous screen of this message.
1192 \\[rmail-next-undeleted-message] Move to Next non-deleted message.
1193 \\[rmail-previous-undeleted-message] Move to Previous non-deleted message.
1194 \\[rmail-next-message] Move to Next message whether deleted or not.
1195 \\[rmail-previous-message] Move to Previous message whether deleted or not.
1196 \\[rmail-first-message] Move to the first message in Rmail file.
1197 \\[rmail-last-message] Move to the last message in Rmail file.
1198 \\[rmail-show-message-maybe] Jump to message specified by numeric position in file.
1199 \\[rmail-search] Search for string and show message it is found in.
1200 \\[rmail-delete-forward] Delete this message, move to next nondeleted.
1201 \\[rmail-delete-backward] Delete this message, move to previous nondeleted.
1202 \\[rmail-undelete-previous-message] Undelete message. Tries current message, then earlier messages
1203 till a deleted message is found.
1204 \\[rmail-edit-current-message] Edit the current message. \\[rmail-cease-edit] to return to Rmail.
1205 \\[rmail-expunge] Expunge deleted messages.
1206 \\[rmail-expunge-and-save] Expunge and save the file.
1207 \\[rmail-quit] Quit Rmail: expunge, save, then switch to another buffer.
1208 \\[save-buffer] Save without expunging.
1209 \\[rmail-get-new-mail] Move new mail from system spool directory into this file.
1210 \\[rmail-mail] Mail a message (same as \\[mail-other-window]).
1211 \\[rmail-continue] Continue composing outgoing message started before.
1212 \\[rmail-reply] Reply to this message. Like \\[rmail-mail] but initializes some fields.
1213 \\[rmail-retry-failure] Send this message again. Used on a mailer failure message.
1214 \\[rmail-forward] Forward this message to another user.
1215 \\[rmail-output] Output (append) this message to another mail file.
1216 \\[rmail-output-as-seen] Output (append) this message to file as it's displayed.
1217 \\[rmail-output-body-to-file] Save message body to a file. Default filename comes from Subject line.
1218 \\[rmail-input] Input Rmail file. Run Rmail on that file.
1219 \\[rmail-add-label] Add label to message. It will be displayed in the mode line.
1220 \\[rmail-kill-label] Kill label. Remove a label from current message.
1221 \\[rmail-next-labeled-message] Move to Next message with specified label
1222 (label defaults to last one specified).
1223 Standard labels: filed, unseen, answered, forwarded, deleted.
1224 Any other label is present only if you add it with \\[rmail-add-label].
1225 \\[rmail-previous-labeled-message] Move to Previous message with specified label
1226 \\[rmail-summary] Show headers buffer, with a one line summary of each message.
1227 \\[rmail-summary-by-labels] Summarize only messages with particular label(s).
1228 \\[rmail-summary-by-recipients] Summarize only messages with particular recipient(s).
1229 \\[rmail-summary-by-regexp] Summarize only messages with particular regexp(s).
1230 \\[rmail-summary-by-topic] Summarize only messages with subject line regexp(s).
1231 \\[rmail-toggle-header] Toggle display of complete header."
1233 (let ((finding-rmail-file (not (eq major-mode 'rmail-mode))))
1235 (when (and finding-rmail-file
1236 (null coding-system-for-read)
1237 default-enable-multibyte-characters)
1238 (let ((rmail-enable-multibyte t))
1239 (rmail-require-mime-maybe)
1240 (rmail-convert-file-maybe)
1241 (goto-char (point-max))
1242 (set-buffer-multibyte t)))
1243 (rmail-set-message-counters)
1244 (rmail-show-message-maybe rmail-total-messages)
1245 (when finding-rmail-file
1246 (when rmail-display-summary
1248 (rmail-construct-io-menu))
1249 (run-mode-hooks 'rmail-mode-hook)))
1251 (defun rmail-mode-2 ()
1252 (kill-all-local-variables)
1254 (rmail-perm-variables)
1257 (defun rmail-mode-1 ()
1258 (setq major-mode 'rmail-mode)
1259 (setq mode-name "RMAIL")
1260 (setq buffer-read-only t)
1261 ;; No need to auto save RMAIL files in normal circumstances
1262 ;; because they contain no info except attribute changes
1263 ;; and deletion of messages.
1264 ;; The one exception is when messages are copied into another mbox buffer.
1265 ;; rmail-output enables auto save when you do that.
1266 (setq buffer-auto-save-file-name nil)
1267 (use-local-map rmail-mode-map)
1268 (set-syntax-table text-mode-syntax-table)
1269 (setq local-abbrev-table text-mode-abbrev-table)
1270 ;; Functions to support buffer swapping:
1271 (add-hook 'write-region-annotate-functions
1272 'rmail-write-region-annotate nil t)
1273 (add-hook 'kill-buffer-hook 'rmail-mode-kill-buffer-hook nil t)
1274 (add-hook 'change-major-mode-hook 'rmail-change-major-mode-hook nil t))
1276 (defun rmail-generate-viewer-buffer ()
1277 "Return a reusable buffer suitable for viewing messages.
1278 Create the buffer if necessary."
1279 (let* ((suffix (file-name-nondirectory (or buffer-file-name (buffer-name))))
1280 (name (format " *message-viewer %s*" suffix))
1281 (buf (get-buffer name)))
1283 (generate-new-buffer name))))
1285 (defun rmail-change-major-mode-hook ()
1286 ;; Bring the actual Rmail messages back into the main buffer.
1287 (when (rmail-buffers-swapped-p)
1288 (setq rmail-buffer-swapped nil)
1289 (let ((modp (buffer-modified-p)))
1290 (buffer-swap-text rmail-view-buffer)
1291 (set-buffer-modified-p modp))))
1293 (defun rmail-buffers-swapped-p ()
1294 "Return non-nil if the message collection is in `rmail-view-buffer'."
1295 ;; This is analogous to tar-data-swapped-p in tar-mode.el.
1296 (and (buffer-live-p rmail-view-buffer)
1297 rmail-buffer-swapped))
1299 (defun rmail-swap-buffers-maybe ()
1300 "Determine if the Rmail buffer is showing a message.
1301 If so restore the actual mbox message collection."
1302 (with-current-buffer rmail-buffer
1303 (when (rmail-buffers-swapped-p)
1304 (let ((modp (buffer-modified-p)))
1305 (buffer-swap-text rmail-view-buffer)
1306 (set-buffer-modified-p modp))
1307 (setq rmail-buffer-swapped nil))))
1309 (defun rmail-mode-kill-buffer-hook ()
1310 (if (buffer-live-p rmail-view-buffer) (kill-buffer rmail-view-buffer)))
1312 ;; Set up the permanent locals associated with an Rmail file.
1313 (defun rmail-perm-variables ()
1314 (make-local-variable 'rmail-last-regexp)
1315 (make-local-variable 'rmail-deleted-vector)
1316 (make-local-variable 'rmail-buffer)
1317 (setq rmail-buffer (current-buffer))
1318 (set-buffer-multibyte nil)
1319 (make-local-variable 'rmail-view-buffer)
1321 (setq rmail-view-buffer (rmail-generate-viewer-buffer))
1322 (set-buffer rmail-view-buffer)
1323 (setq buffer-undo-list t)
1324 (set-buffer-multibyte t))
1325 (make-local-variable 'rmail-summary-buffer)
1326 (make-local-variable 'rmail-summary-vector)
1327 (make-local-variable 'rmail-current-message)
1328 (make-local-variable 'rmail-total-messages)
1329 (setq rmail-total-messages 0)
1330 (make-local-variable 'rmail-overlay-list)
1331 (setq rmail-overlay-list nil)
1332 (make-local-variable 'rmail-message-vector)
1333 (make-local-variable 'rmail-msgref-vector)
1334 (make-local-variable 'rmail-inbox-list)
1335 ;; Provide default set of inboxes for primary mail file ~/RMAIL.
1336 (and (null rmail-inbox-list)
1337 (or (equal buffer-file-name (expand-file-name rmail-file-name))
1338 (equal buffer-file-truename
1339 (abbreviate-file-name (file-truename rmail-file-name))))
1340 (setq rmail-inbox-list
1341 (or rmail-primary-inbox-list
1342 (list (or (getenv "MAIL")
1343 (concat rmail-spool-directory
1344 (user-login-name)))))))
1345 (set (make-local-variable 'tool-bar-map) rmail-tool-bar-map))
1347 ;; Set up the non-permanent locals associated with Rmail mode.
1348 (defun rmail-variables ()
1349 ;; Turn off undo. We turn it back on in rmail-edit.
1350 (setq buffer-undo-list t)
1351 ;; Don't let a local variables list in a message cause confusion.
1352 (make-local-variable 'local-enable-local-variables)
1353 (setq local-enable-local-variables nil)
1354 (make-local-variable 'revert-buffer-function)
1355 (setq revert-buffer-function 'rmail-revert)
1356 (make-local-variable 'font-lock-defaults)
1357 (setq font-lock-defaults
1358 '(rmail-font-lock-keywords
1360 (font-lock-maximum-size . nil)
1361 (font-lock-fontify-buffer-function . rmail-fontify-buffer-function)
1362 (font-lock-unfontify-buffer-function . rmail-unfontify-buffer-function)
1363 (font-lock-inhibit-thing-lock . (lazy-lock-mode fast-lock-mode))))
1364 (make-local-variable 'require-final-newline)
1365 (setq require-final-newline nil)
1366 (make-local-variable 'version-control)
1367 (setq version-control 'never)
1368 (make-local-variable 'kill-buffer-hook)
1369 (add-hook 'kill-buffer-hook 'rmail-mode-kill-summary)
1370 (make-local-variable 'file-precious-flag)
1371 (setq file-precious-flag t)
1372 (make-local-variable 'desktop-save-buffer)
1373 (setq desktop-save-buffer t))
1375 ;; Handle M-x revert-buffer done in an rmail-mode buffer.
1376 (defun rmail-revert (arg noconfirm)
1377 (set-buffer rmail-buffer)
1378 (let* ((revert-buffer-function (default-value 'revert-buffer-function))
1379 (rmail-enable-multibyte enable-multibyte-characters)
1380 ;; See similar code in `rmail'.
1381 (coding-system-for-read (and rmail-enable-multibyte 'raw-text)))
1382 ;; Call our caller again, but this time it does the default thing.
1383 (when (revert-buffer arg noconfirm)
1384 ;; If the user said "yes", and we changed something,
1385 ;; reparse the messages.
1386 (set-buffer rmail-buffer)
1388 ;; Convert all or part to Babyl file if possible.
1389 (rmail-convert-file-maybe)
1390 ;; We have read the file as raw-text, so the buffer is set to
1391 ;; unibyte. Make it multibyte if necessary.
1392 (if (and rmail-enable-multibyte
1393 (not enable-multibyte-characters))
1394 (set-buffer-multibyte t))
1395 (goto-char (point-max))
1396 (rmail-set-message-counters)
1397 (rmail-show-message-maybe rmail-total-messages)
1398 (run-hooks 'rmail-mode-hook))))
1400 (defun rmail-expunge-and-save ()
1401 "Expunge and save RMAIL file."
1403 (set-buffer rmail-buffer)
1405 (rmail-swap-buffers-maybe)
1407 (if (rmail-summary-exists)
1408 (rmail-select-summary (set-buffer-modified-p nil))
1409 (rmail-show-message)))
1411 (defun rmail-quit ()
1413 Hook `rmail-quit-hook' is run after expunging."
1415 (set-buffer rmail-buffer)
1417 (rmail-swap-buffers-maybe)
1419 (when (boundp 'rmail-quit-hook)
1420 (run-hooks 'rmail-quit-hook))
1421 ;; Don't switch to the summary buffer even if it was recently visible.
1422 (when rmail-summary-buffer
1423 (replace-buffer-in-windows rmail-summary-buffer)
1424 (bury-buffer rmail-summary-buffer))
1425 (if rmail-enable-mime
1426 (let ((obuf rmail-buffer)
1427 (ovbuf rmail-view-buffer))
1428 (set-buffer rmail-view-buffer)
1430 (replace-buffer-in-windows ovbuf)
1431 (replace-buffer-in-windows obuf)
1433 (let ((obuf (current-buffer)))
1435 (replace-buffer-in-windows obuf))))
1437 (defun rmail-bury ()
1438 "Bury current Rmail buffer and its summary buffer."
1440 ;; This let var was called rmail-buffer, but that interfered
1441 ;; with the buffer-local var used in summary buffers.
1442 (let ((buffer-to-bury (current-buffer)))
1443 (if (rmail-summary-exists)
1445 (while (setq window (get-buffer-window rmail-summary-buffer))
1446 (quit-window nil window))
1447 (bury-buffer rmail-summary-buffer)))
1450 (defun rmail-duplicate-message ()
1451 "Create a duplicated copy of the current message.
1452 The duplicate copy goes into the Rmail file just after the
1456 (let ((buffer-read-only nil)
1457 (number rmail-current-message)
1458 (string (buffer-substring (rmail-msgbeg rmail-current-message)
1459 (rmail-msgend rmail-current-message))))
1460 (goto-char (rmail-msgend rmail-current-message))
1462 (rmail-forget-messages)
1463 (rmail-show-message-maybe number)
1464 (message "Message duplicated")))
1467 (defun rmail-input (filename)
1468 "Run Rmail on file FILENAME."
1469 (interactive "FRun rmail on RMAIL file: ")
1472 ;; This used to scan subdirectories recursively, but someone pointed out
1473 ;; that if the user wants that, person can put all the files in one dir.
1474 ;; And the recursive scan was slow. So I took it out.
1476 (defun rmail-find-all-files (start)
1477 "Return list of file in dir START that match `rmail-secondary-file-regexp'."
1478 (if (file-accessible-directory-p start)
1480 (let* ((case-fold-search t)
1481 (files (directory-files start t rmail-secondary-file-regexp)))
1482 ;; Sort here instead of in directory-files
1483 ;; because this list is usually much shorter.
1484 (sort files 'string<))))
1486 (defun rmail-list-to-menu (menu-name l action &optional full-name)
1487 (let ((menu (make-sparse-keymap menu-name)))
1494 (car item) (cdr item) action
1496 (concat full-name "/"
1502 (list 'lambda () '(interactive)
1506 (concat full-name "/" item)
1508 rmail-secondary-file-directory)))))
1509 (define-key menu (vector (intern name))
1510 (cons name command))))
1514 ;; This command is always "disabled" when it appears in a menu.
1515 (put 'rmail-disable-menu 'menu-enable ''nil)
1517 (defun rmail-construct-io-menu ()
1518 (let ((files (rmail-find-all-files rmail-secondary-file-directory)))
1521 (define-key rmail-mode-map [menu-bar classify input-menu]
1522 (cons "Input Rmail File"
1523 (rmail-list-to-menu "Input Rmail File"
1526 (define-key rmail-mode-map [menu-bar classify output-menu]
1527 (cons "Output Rmail File"
1528 (rmail-list-to-menu "Output Rmail File"
1532 (define-key rmail-mode-map [menu-bar classify input-menu]
1533 '("Input Rmail File" . rmail-disable-menu))
1534 (define-key rmail-mode-map [menu-bar classify output-menu]
1535 '("Output Rmail File" . rmail-disable-menu)))))
1538 ;;;; *** Rmail input ***
1540 (declare-function rmail-spam-filter "rmail-spam-filter" (msg))
1541 (declare-function rmail-summary-goto-msg "rmailsum" (&optional n nowarn skip-rmail))
1542 (declare-function rmail-summary-mark-undeleted "rmailsum" (n))
1543 (declare-function rmail-summary-mark-deleted "rmailsum" (&optional n undel))
1544 (declare-function rfc822-addresses "rfc822" (header-text))
1545 (declare-function mail-abbrev-make-syntax-table "mailabbrev.el" ())
1546 (declare-function mail-sendmail-delimit-header "sendmail" ())
1547 (declare-function mail-header-end "sendmail" ())
1549 ;; RLK feature not added in this version:
1550 ;; argument specifies inbox file or files in various ways.
1552 (defun rmail-get-new-mail (&optional file-name)
1553 "Move any new mail from this RMAIL file's inbox files.
1554 The inbox files can be specified with the file's Mail: option. The
1555 variable `rmail-primary-inbox-list' specifies the inboxes for your
1556 primary RMAIL file if it has no Mail: option. By default, this is
1557 your /usr/spool/mail/$USER.
1559 You can also specify the file to get new mail from. In this case, the
1560 file of new mail is not changed or deleted. Noninteractively, you can
1561 pass the inbox file name as an argument. Interactively, a prefix
1562 argument causes us to read a file name and use that file as the inbox.
1564 If the variable `rmail-preserve-inbox' is non-nil, new mail will
1565 always be left in inbox files rather than deleted.
1567 This function runs `rmail-get-new-mail-hook' before saving the updated file.
1568 It returns t if it got any new messages."
1570 (list (if current-prefix-arg
1571 (read-file-name "Get new mail from file: "))))
1572 (run-hooks 'rmail-before-get-new-mail-hook)
1573 ;; If the disk file has been changed from under us,
1574 ;; revert to it before we get new mail.
1575 (or (verify-visited-file-modtime (current-buffer))
1576 (find-file (buffer-file-name)))
1577 (set-buffer rmail-buffer)
1578 (rmail-swap-buffers-maybe)
1579 (rmail-maybe-set-message-counters)
1581 ;; Get rid of all undo records for this buffer.
1582 (or (eq buffer-undo-list t)
1583 (setq buffer-undo-list nil))
1584 (let ((all-files (if file-name (list file-name) rmail-inbox-list))
1585 (rmail-enable-multibyte (default-value 'enable-multibyte-characters))
1589 (let ((opoint (point))
1590 ;; If buffer has not changed yet, and has not been
1591 ;; saved yet, don't replace the old backup file now.
1592 (make-backup-files (and make-backup-files (buffer-modified-p)))
1593 (buffer-read-only nil)
1594 ;; Don't make undo records while getting mail.
1595 (buffer-undo-list t)
1596 delete-files success files file-last-names)
1597 ;; Pull files off all-files onto files as long as there is
1598 ;; no name conflict. A conflict happens when two inbox
1599 ;; file names have the same last component.
1600 (while (and all-files
1601 (not (member (file-name-nondirectory (car all-files))
1603 (setq files (cons (car all-files) files)
1605 (cons (file-name-nondirectory (car all-files)) files))
1606 (setq all-files (cdr all-files)))
1607 ;; Put them back in their original order.
1608 (setq files (nreverse files))
1609 (goto-char (point-max))
1610 (skip-chars-backward " \t\n") ; just in case of brain damage
1611 (delete-region (point) (point-max)) ; caused by require-final-newline
1612 (setq found (rmail-get-new-mail-1 file-name files delete-files))))
1614 ;; Don't leave the buffer screwed up if we get a disk-full error.
1615 (or found (rmail-show-message-maybe))))
1617 (defun rmail-get-new-mail-1 (file-name files delete-files)
1618 "Return t if new messages are detected without error, nil otherwise."
1621 (let ((new-messages 0)
1622 (spam-filter-p (and (featurep 'rmail-spam-filter)
1623 rmail-use-spam-filter))
1625 result success suffix)
1626 (narrow-to-region (point) (point))
1627 ;; Read in the contents of the inbox files, renaming them as
1628 ;; necessary, and adding to the list of files to delete
1631 (rmail-insert-inbox-text files nil)
1632 (setq delete-files (rmail-insert-inbox-text files t)))
1633 ;; Scan the new text and convert each message to
1634 ;; Rmail/mbox format.
1635 (goto-char (point-min))
1636 (skip-chars-forward " \n")
1637 (narrow-to-region (point) (point-max))
1639 (setq new-messages (rmail-add-mbox-headers)
1641 ;; Try to delete the garbage just inserted.
1642 (or success (delete-region (point-min) (point-max)))
1643 ;; If we could not convert the file's inboxes, rename the
1644 ;; files we tried to read so we won't over and over again.
1645 (if (and (not file-name) (not success))
1646 (let ((delfiles delete-files)
1649 (while (file-exists-p (format "RMAILOSE.%d" count))
1650 (setq count (1+ count)))
1651 (rename-file (car delfiles) (format "RMAILOSE.%d" count))
1652 (setq delfiles (cdr delfiles))))))
1653 ;; Determine if there are messages.
1654 (unless (zerop new-messages)
1655 ;; There are. Process them.
1656 (goto-char (point-min))
1657 (rmail-count-new-messages)
1658 (run-hooks 'rmail-get-new-mail-hook)
1660 ;; Delete the old files, now that the Rmail file is saved.
1663 ;; First, try deleting.
1665 (delete-file (car delete-files))
1667 ;; If we can't delete it, truncate it.
1668 (write-region (point) (point) (car delete-files))))
1670 (setq delete-files (cdr delete-files)))
1671 (if (zerop new-messages)
1672 (when (or file-name rmail-inbox-list)
1673 (message "(No new mail has arrived)"))
1674 ;; Generate the spam message.
1675 (setq blurb (if spam-filter-p
1676 (rmail-get-new-mail-filter-spam new-messages)
1678 (if (rmail-summary-exists)
1679 (rmail-select-summary (rmail-update-summary)))
1680 (setq suffix (if (= 1 new-messages) "" "s"))
1681 (message "%d new message%s read%s" new-messages suffix blurb)
1683 (if rsf-beep (beep t))
1684 (sleep-for rsf-sleep-after-message))
1686 ;; Establish the return value and move to the first new
1687 ;; message unless we have other unseen messages before it.
1688 (setq result (> new-messages 0))
1690 (rmail-show-message-maybe (rmail-first-unseen-message)))
1691 (run-hooks 'rmail-after-get-new-mail-hook)
1694 (defun rmail-get-new-mail-filter-spam (new-message-count)
1695 "Process new messages for spam."
1696 (let* ((old-messages (- rmail-total-messages new-message-count))
1697 (rsf-number-of-spam 0)
1698 (rsf-scanned-message-number (1+ old-messages))
1699 ;; save deletion flags of old messages: vector starts at zero
1700 ;; (is one longer that no of messages), therefore take 1+
1702 (save-deleted (substring rmail-deleted-vector 0 (1+ old-messages)))
1704 ;; set all messages to undeleted
1705 (setq rmail-deleted-vector (make-string (1+ rmail-total-messages) ?\ ))
1706 (while (<= rsf-scanned-message-number rmail-total-messages)
1708 (if (not (rmail-spam-filter rsf-scanned-message-number))
1709 (progn (setq rsf-number-of-spam (1+ rsf-number-of-spam))))
1710 (setq rsf-scanned-message-number (1+ rsf-scanned-message-number))))
1711 (if (> rsf-number-of-spam 0)
1713 (when (rmail-expunge-confirmed)
1714 (rmail-only-expunge t))))
1715 (setq rmail-deleted-vector
1716 (concat save-deleted
1717 (make-string (- rmail-total-messages old-messages) ?\ )))
1718 ;; Generate a return value message based on the number of spam
1721 ((zerop rsf-number-of-spam) "")
1722 ((= 1 new-message-count) ", and appears to be spam")
1723 ((= rsf-number-of-spam new-message-count) ", and all appear to be spam")
1724 ((> rsf-number-of-spam 1)
1725 (format ", and %d appear to be spam" rsf-number-of-spam))
1726 (t ", and 1 appears to be spam"))))
1728 (defun rmail-parse-url (file)
1729 "Parse the supplied URL. Return (list MAILBOX-NAME REMOTE PASSWORD GOT-PASSWORD)
1730 WHERE MAILBOX-NAME is the name of the mailbox suitable as argument to the
1731 actual version of `movemail', REMOTE is non-nil if MAILBOX-NAME refers to
1732 a remote mailbox, PASSWORD is the password if it should be
1733 supplied as a separate argument to `movemail' or nil otherwise, GOT-PASSWORD
1734 is non-nil if the user has supplied the password interactively.
1737 ((string-match "^\\([^:]+\\)://\\(\\([^:@]+\\)\\(:\\([^@]+\\)\\)?@\\)?.*" file)
1738 (let (got-password supplied-password
1739 (proto (match-string 1 file))
1740 (user (match-string 3 file))
1741 (pass (match-string 5 file))
1742 (host (substring file (or (match-end 2)
1743 (+ 3 (match-end 1))))))
1746 (when rmail-remote-password-required
1747 (setq got-password (not (rmail-have-password)))
1748 (setq supplied-password (rmail-get-remote-password
1749 (string-equal proto "imap"))))
1750 ;; The password is embedded. Strip it out since movemail
1751 ;; does not really like it, in spite of the movemail spec.
1752 (setq file (concat proto "://" user "@" host)))
1754 (if (rmail-movemail-variant-p 'emacs)
1755 (if (string-equal proto "pop")
1756 (list (concat "po:" user ":" host)
1758 (or pass supplied-password)
1760 (error "Emacs movemail does not support %s protocol" proto))
1762 (or (string-equal proto "pop") (string-equal proto "imap"))
1763 (or supplied-password pass)
1766 ((string-match "^po:\\([^:]+\\)\\(:\\(.*\\)\\)?" file)
1767 (let (got-password supplied-password
1769 (user (match-string 1 file))
1770 (host (match-string 3 file)))
1772 (when rmail-remote-password-required
1773 (setq got-password (not (rmail-have-password)))
1774 (setq supplied-password (rmail-get-remote-password nil)))
1776 (list file "pop" supplied-password got-password)))
1779 (list file nil nil nil))))
1781 (defun rmail-insert-inbox-text (files renamep)
1782 ;; Detect a locked file now, so that we avoid moving mail
1783 ;; out of the real inbox file. (That could scare people.)
1784 (or (memq (file-locked-p buffer-file-name) '(nil t))
1785 (error "RMAIL file %s is locked"
1786 (file-name-nondirectory buffer-file-name)))
1787 (let (file tofile delete-files movemail pormail got-password password)
1789 ;; Handle remote mailbox names specially; don't expand as filenames
1790 ;; in case the userid contains a directory separator.
1791 (setq file (car files))
1792 (let ((url-data (rmail-parse-url file)))
1793 (setq file (nth 0 url-data))
1794 (setq pormail (nth 1 url-data))
1795 (setq password (nth 2 url-data))
1796 (setq got-password (nth 3 url-data)))
1800 (setq file (file-truename
1801 (substitute-in-file-name (expand-file-name file)))))
1802 (setq tofile (expand-file-name
1803 ;; Generate name to move to from inbox name,
1804 ;; in case of multiple inboxes that need moving.
1806 (file-name-nondirectory
1807 (if (memq system-type '(windows-nt cygwin ms-dos))
1808 ;; cannot have colons in file name
1809 (replace-regexp-in-string ":" "-" file)
1811 ;; Use the directory of this rmail file
1812 ;; because it's a nuisance to use the homedir
1813 ;; if that is on a full disk and this rmail
1815 (file-name-directory
1816 (expand-file-name buffer-file-name))))
1817 ;; Always use movemail to rename the file,
1818 ;; since there can be mailboxes in various directories.
1820 ;; On some systems, /usr/spool/mail/foo is a directory
1821 ;; and the actual inbox is /usr/spool/mail/foo/foo.
1822 (if (file-directory-p file)
1823 (setq file (expand-file-name (user-login-name)
1826 (message "Getting mail from the remote server ..."))
1827 ((and (file-exists-p tofile)
1828 (/= 0 (nth 7 (file-attributes tofile))))
1829 (message "Getting mail from %s..." tofile))
1830 ((and (file-exists-p file)
1831 (/= 0 (nth 7 (file-attributes file))))
1832 (message "Getting mail from %s..." file)))
1833 ;; Set TOFILE if have not already done so, and
1834 ;; rename or copy the file FILE to TOFILE if and as appropriate.
1835 (cond ((not renamep)
1837 ((or (file-exists-p tofile) (and (not pormail)
1838 (not (file-exists-p file))))
1842 (let ((errors (current-buffer)))
1843 (buffer-disable-undo errors)
1846 (list (or rmail-movemail-program "movemail") nil errors nil)
1847 (if rmail-preserve-inbox
1850 (if (rmail-movemail-variant-p 'mailutils)
1851 (append (list "--emacs") rmail-movemail-flags)
1852 rmail-movemail-flags)
1854 (if password (list password) nil))))
1855 (apply 'call-process args))
1856 (if (not (buffer-modified-p errors))
1857 ;; No output => movemail won
1860 (subst-char-in-region (point-min) (point-max)
1862 (goto-char (point-max))
1863 (skip-chars-backward " \t")
1864 (delete-region (point) (point-max))
1865 (goto-char (point-min))
1866 (if (looking-at "movemail: ")
1867 (delete-region (point-min) (match-end 0)))
1869 ;; If we just read the password, most likely it is
1870 ;; wrong. Otherwise, see if there is a specific
1871 ;; reason to think that the problem is a wrong passwd.
1872 (if (or got-password
1873 (re-search-forward rmail-remote-password-error
1875 (rmail-set-remote-password nil))
1877 ;; If using Mailutils, remove initial error code
1879 (when (rmail-movemail-variant-p 'mailutils)
1880 (goto-char (point-min))
1881 (when (looking-at "[A-Z][A-Z0-9_]*:")
1882 (delete-region (point-min) (match-end 0))))
1884 (message "movemail: %s"
1885 (buffer-substring (point-min)
1891 ;; At this point, TOFILE contains the name to read:
1892 ;; Either the alternate name (if we renamed)
1893 ;; or the actual inbox (if not renaming).
1894 (if (file-exists-p tofile)
1895 (let ((coding-system-for-read 'no-conversion)
1897 (goto-char (point-max))
1898 (setq size (nth 1 (insert-file-contents tofile)))
1899 ;; Determine if a pair of newline message separators need
1900 ;; to be added to the new collection of messages. This is
1901 ;; the case for all new message collections added to a
1902 ;; non-empty mail file.
1903 (unless (zerop size)
1905 (let ((start (point-min)))
1907 (unless (eq start (point-min))
1910 (setq size (+ 2 size))))))
1911 (goto-char (point-max))
1912 (or (= (preceding-char) ?\n)
1915 (if (not (and rmail-preserve-inbox (string= file tofile)))
1916 (setq delete-files (cons tofile delete-files)))))
1918 (setq files (cdr files)))
1921 ;; Decode the region specified by FROM and TO by CODING.
1922 ;; If CODING is nil or an invalid coding system, decode by `undecided'.
1923 (defun rmail-decode-region (from to coding &optional destination)
1924 (if (or (not coding) (not (coding-system-p coding)))
1925 (setq coding 'undecided))
1926 ;; Use -dos decoding, to remove ^M characters left from base64 or
1927 ;; rogue qp-encoded text.
1928 (decode-coding-region
1929 from to (coding-system-change-eol-conversion coding 1) destination)
1930 ;; Don't reveal the fact we used -dos decoding, as users generally
1931 ;; will not expect the RMAIL buffer to use DOS EOL format.
1932 (setq buffer-file-coding-system
1933 (setq last-coding-system-used
1934 (coding-system-change-eol-conversion coding 0))))
1936 (defun rmail-add-mbox-headers ()
1937 "Validate the RFC2822 format for the new messages.
1938 Point should be at the first new message.
1939 An error is signalled if the new messages are not RFC2822
1941 Unless an Rmail attribute header already exists, add it to the
1942 new messages. Return the number of new messages."
1949 ;; Detect an empty inbox file.
1950 (unless (= start (point-max))
1951 ;; Scan the new messages to establish a count and to insure that
1952 ;; an attribute header is present.
1953 (while (looking-at "From ")
1954 ;; Determine if a new attribute header needs to be added to
1956 (if (search-forward "\n\n" nil t)
1958 (setq count (1+ count))
1959 (narrow-to-region start (point))
1960 (unless (mail-fetch-field rmail-attribute-header)
1962 (insert rmail-attribute-header ": " value "\n"))
1964 (rmail-error-bad-format))
1965 ;; Move to the next message.
1966 (if (search-forward "\n\nFrom " nil 'move)
1968 (setq start (point))))
1971 (defun rmail-get-header (name &optional msgnum)
1972 "Return the value of message header NAME, nil if it has none.
1973 MSGNUM specifies the message number to get it from.
1974 If MSGNUM is nil, use the current message."
1975 (with-current-buffer rmail-buffer
1976 (or msgnum (setq msgnum rmail-current-message))
1979 (setq msgbeg (rmail-msgbeg msgnum))
1980 ;; All access to the buffer's local variables is now finished...
1982 ;; ... so it is ok to go to a different buffer.
1983 (if (rmail-buffers-swapped-p) (set-buffer rmail-view-buffer))
1988 (setq end (search-forward "\n\n" nil t))
1991 (narrow-to-region msgbeg end)
1992 (mail-fetch-field name))
1993 (rmail-error-bad-format msgnum)))))))))
1995 (defun rmail-set-header (name &optional msgnum value)
1996 "Store VALUE in message header NAME, nil if it has none.
1997 MSGNUM specifies the message number to operate on.
1998 If MSGNUM is nil, use the current message."
1999 (with-current-buffer rmail-buffer
2000 (or msgnum (setq msgnum rmail-current-message))
2003 (setq msgbeg (rmail-msgbeg msgnum))
2004 ;; All access to the buffer's local variables is now finished...
2006 ;; ... so it is ok to go to a different buffer.
2007 (if (rmail-buffers-swapped-p) (set-buffer rmail-view-buffer))
2012 (setq end (search-forward "\n\n" nil t))
2013 (if end (setq end (1- end)))
2016 (narrow-to-region msgbeg end)
2018 (if (re-search-forward (concat "^"
2023 (delete-region (point) (line-end-position))
2026 (insert name ": " value "\n")))
2027 (rmail-error-bad-format msgnum)))))))))
2029 ;;;; *** Rmail Attributes and Keywords ***
2031 (defun rmail-get-attr-names (&optional msg)
2032 "Return the message attributes in a comma separated string.
2033 MSG specifies the message number to get it from.
2034 If MSG is nil, use the current message."
2035 (let ((value (rmail-get-header rmail-attribute-header msg))
2037 (dotimes (index (length value))
2038 (setq temp (and (not (= ?- (aref value index)))
2039 (nth 1 (aref rmail-attr-array index)))
2042 ((and temp result) (format "%s, %s" result temp))
2047 (defun rmail-get-keywords (&optional msg)
2048 "Return the message keywords in a comma separated string.
2049 MSG, if non-nil, identifies the message number to use.
2050 If nil, that means the current message."
2051 (rmail-get-header rmail-keyword-header msg))
2053 (defun rmail-get-labels (&optional msg)
2054 "Return a string with the labels (attributes and keywords) of msg MSG.
2055 It is put in comma-separated form.
2056 MSG, if non-nil, identifies the message number to use.
2057 If nil, that means the current message."
2058 (let (blurb attr-names keywords)
2059 ;; Combine the message attributes and keywords
2060 ;; into a comma-separated list.
2061 (setq attr-names (rmail-get-attr-names rmail-current-message)
2062 keywords (rmail-get-keywords rmail-current-message))
2063 (if (string= keywords "")
2064 (setq keywords nil))
2066 ((and attr-names keywords) (concat " " attr-names ", " keywords))
2067 (attr-names (concat " " attr-names))
2068 (keywords (concat " " keywords))
2071 (defun rmail-display-labels ()
2072 "Update the current messages's attributes and keywords in mode line."
2073 (let ((blurb (rmail-get-labels)))
2074 (setq mode-line-process
2076 rmail-current-message rmail-total-messages blurb))
2077 ;; If rmail-enable-mime is non-nil, we may have to update
2078 ;; `mode-line-process' of rmail-view-buffer too.
2079 (if (and rmail-enable-mime
2080 (not (eq (current-buffer) rmail-view-buffer))
2081 (buffer-live-p rmail-view-buffer))
2082 (let ((mlp mode-line-process))
2083 (with-current-buffer rmail-view-buffer
2084 (setq mode-line-process mlp))))))
2086 (defun rmail-get-attr-value (attr state)
2087 "Return the character value for ATTR.
2088 ATTR is a (numeric) index, an offset into the mbox attribute
2089 header value. STATE is one of nil, t, or a character value."
2091 ((numberp state) state)
2093 (t (nth 0 (aref rmail-attr-array attr)))))
2095 (defun rmail-set-attribute (attr state &optional msgnum)
2096 "Turn an attribute of a message on or off according to STATE.
2097 STATE is either nil or the character (numeric) value associated
2098 with the state (nil represents off and non-nil represents on).
2099 ATTR is the index of the attribute. MSGNUM is message number to
2100 change; nil means current message."
2101 (with-current-buffer rmail-buffer
2102 (let ((value (rmail-get-attr-value attr state))
2103 (inhibit-read-only t)
2107 (or msgnum (setq msgnum rmail-current-message))
2109 ;; The "deleted" attribute is also stored in a special vector
2110 ;; so update that too.
2111 (if (= attr rmail-deleted-attr-index)
2112 (rmail-set-message-deleted-p msgnum state))
2113 (setq msgbeg (rmail-msgbeg msgnum))
2115 ;; All access to the buffer's local variables is now finished...
2118 ;; ... so it is ok to go to a different buffer.
2119 (if (rmail-buffers-swapped-p) (set-buffer rmail-view-buffer))
2123 ;; Determine if the current state is the desired state.
2126 (setq limit (search-forward "\n\n" nil t)))
2127 (if (search-forward (concat rmail-attribute-header ": ") limit t)
2128 ;; If this message already records attributes,
2129 ;; just change the value for this one.
2130 (let ((missing (- (+ (point) attr) (line-end-position))))
2131 ;; Position point at this attribute,
2132 ;; adding attributes if necessary.
2136 (insert-char ?- missing)
2138 (forward-char attr))
2139 ;; Change this attribute.
2140 (when (/= value (char-after))
2144 ;; Otherwise add a header line to record the attributes
2145 ;; and set all but this one to no.
2146 (let ((header-value "--------"))
2147 (aset header-value attr value)
2148 (goto-char (if limit (- limit 1) (point-max)))
2149 (setq altered (/= value ?-))
2150 (insert rmail-attribute-header ": " header-value "\n"))))))
2151 (if (= msgnum rmail-current-message)
2152 (rmail-display-labels))))
2153 ;; If we made a significant change in an attribute,
2154 ;; mark rmail-buffer modified, so it will be (1) saved
2155 ;; and (2) displayed in the mode line.
2157 (set-buffer-modified-p t)))))
2159 (defun rmail-message-attr-p (msg attrs)
2160 "Return t if the attributes header for message MSG matches regexp ATTRS.
2161 This function assumes the Rmail buffer is unswapped."
2164 (let ((start (rmail-msgbeg msg))
2168 (setq limit (search-forward "\n\n" (rmail-msgend msg) t))
2171 (search-forward (concat rmail-attribute-header ": ") limit t)
2172 (looking-at attrs))))))
2174 (defun rmail-message-unseen-p (msgnum)
2175 "Test the unseen attribute for message MSGNUM.
2176 Return non-nil if the unseen attribute is set, nil otherwise."
2177 (rmail-message-attr-p msgnum "......U"))
2179 ;; Return t if the attributes/keywords line of msg number MSG
2180 ;; contains a match for the regexp LABELS.
2181 (defun rmail-message-labels-p (msg labels)
2182 (string-match labels (rmail-get-labels msg)))
2184 ;;;; *** Rmail Message Selection And Support ***
2186 (defun rmail-msgend (n)
2187 (marker-position (aref rmail-message-vector (1+ n))))
2189 (defun rmail-msgbeg (n)
2190 (marker-position (aref rmail-message-vector n)))
2192 (defun rmail-apply-in-message (msgnum function &rest args)
2193 "Call FUNCTION on ARGS while narrowed to message MSGNUM.
2194 Point is at the start of the message.
2195 This returns what the call to FUNCTION returns.
2196 If MSGNUM is nil, use the current message."
2197 (with-current-buffer rmail-buffer
2198 (or msgnum (setq msgnum rmail-current-message))
2200 (let (msgbeg msgend)
2201 (setq msgbeg (rmail-msgbeg msgnum))
2202 (setq msgend (rmail-msgend msgnum))
2203 ;; All access to the rmail-buffer's local variables is now finished...
2205 ;; ... so it is ok to go to a different buffer.
2206 (if (rmail-buffers-swapped-p) (set-buffer rmail-view-buffer))
2212 (narrow-to-region msgbeg msgend)
2213 (apply function args)))))))))
2215 (defun rmail-widen-to-current-msgbeg (function)
2216 "Call FUNCTION with point at start of internal data of current message.
2217 Assumes that bounds were previously narrowed to display the message in Rmail.
2218 The bounds are widened enough to move point where desired, then narrowed
2221 FUNCTION may not change the visible text of the message, but it may
2222 change the invisible header text."
2226 (narrow-to-region (rmail-msgbeg rmail-current-message)
2228 (goto-char (point-min))
2230 ;; Note: we don't use save-restriction because that does not work right
2231 ;; if changes are made outside the saved restriction
2232 ;; before that restriction is restored.
2233 (narrow-to-region (rmail-msgbeg rmail-current-message)
2234 (rmail-msgend rmail-current-message)))))
2236 ;; Manage the message vectors and counters.
2238 (defun rmail-forget-messages ()
2240 (if (vectorp rmail-message-vector)
2242 (v rmail-message-vector)
2245 (move-marker (aref v i) nil)
2247 (setq rmail-message-vector nil)
2248 (setq rmail-msgref-vector nil)
2249 (setq rmail-deleted-vector nil)))
2251 (defun rmail-maybe-set-message-counters ()
2252 (if (not (and rmail-deleted-vector
2253 rmail-message-vector
2254 rmail-current-message
2255 rmail-total-messages))
2256 (rmail-set-message-counters)))
2258 (defun rmail-count-new-messages (&optional nomsg)
2259 "Count the number of new messages.
2260 The buffer should be narrowed to include only the new messages.
2261 Output a helpful message unless NOMSG is non-nil."
2262 (let* ((case-fold-search nil)
2266 (or nomsg (message "Counting new messages..."))
2267 (goto-char (point-max))
2268 ;; Put at the end of messages-head
2269 ;; the entry for message N+1, which marks
2270 ;; the end of message N. (N = number of messages).
2271 (setq messages-head (list (point-marker)))
2272 (rmail-set-message-counters-counter (point-min))
2273 (setq rmail-current-message (1+ rmail-total-messages))
2274 (setq rmail-total-messages
2275 (+ rmail-total-messages total-messages))
2276 (setq rmail-message-vector
2277 (vconcat rmail-message-vector (cdr messages-head)))
2278 (aset rmail-message-vector
2279 rmail-current-message (car messages-head))
2280 (setq rmail-deleted-vector
2281 (concat rmail-deleted-vector deleted-head))
2282 (setq rmail-summary-vector
2283 (vconcat rmail-summary-vector (make-vector total-messages nil)))
2284 (setq rmail-msgref-vector
2285 (vconcat rmail-msgref-vector (make-vector total-messages nil)))
2286 ;; Fill in the new elements of rmail-msgref-vector.
2287 (let ((i (1+ (- rmail-total-messages total-messages))))
2288 (while (<= i rmail-total-messages)
2289 (aset rmail-msgref-vector i (list i))
2291 (goto-char (point-min))
2292 (or nomsg (message "Counting new messages...done (%d)" total-messages))))
2294 (defun rmail-set-message-counters ()
2295 (rmail-forget-messages)
2299 (let* ((point-save (point))
2301 (messages-after-point)
2302 (case-fold-search nil)
2305 ;; Determine how many messages follow point.
2306 (message "Counting messages...")
2307 (goto-char (point-max))
2308 ;; Put at the end of messages-head
2309 ;; the entry for message N+1, which marks
2310 ;; the end of message N. (N = number of messages).
2311 (setq messages-head (list (point-marker)))
2312 (rmail-set-message-counters-counter (min (point) point-save))
2313 (setq messages-after-point total-messages)
2315 ;; Determine how many precede point.
2316 (rmail-set-message-counters-counter)
2317 (setq rmail-total-messages total-messages)
2318 (setq rmail-current-message
2320 (max 1 (- total-messages messages-after-point))))
2321 (setq rmail-message-vector
2322 (apply 'vector (cons (point-min-marker) messages-head))
2323 rmail-deleted-vector (concat "0" deleted-head)
2324 rmail-summary-vector (make-vector rmail-total-messages nil)
2325 rmail-msgref-vector (make-vector (1+ rmail-total-messages) nil))
2327 (while (<= i rmail-total-messages)
2328 (aset rmail-msgref-vector i (list i))
2331 (while (<= i rmail-total-messages)
2332 (rmail-set-message-deleted-p i (rmail-message-attr-p i ".D"))
2334 (message "Counting messages...done")))))
2337 (defsubst rmail-collect-deleted (message-end)
2338 "Collect the message deletion flags for each message.
2339 MESSAGE-END is the buffer position corresponding to the end of
2340 the message. Point is at the beginning of the message."
2341 ;; NOTE: This piece of code will be executed on a per-message basis.
2342 ;; In the face of thousands of messages, it has to be as fast as
2343 ;; possible, hence some brute force constant use is employed in
2344 ;; addition to inlining.
2347 (cons (if (and (search-forward (concat rmail-attribute-header ": ") message-end t)
2350 ?\ ) deleted-head))))
2352 (defun rmail-set-message-counters-counter (&optional stop)
2353 ;; Collect the start position for each message into 'messages-head.
2354 (let ((start (point)))
2355 (while (search-backward "\n\nFrom " stop t)
2357 (rmail-collect-deleted start)
2358 (setq messages-head (cons (point-marker) messages-head)
2359 total-messages (1+ total-messages)
2361 ;; Show progress after every 20 messages or so.
2362 (if (zerop (% total-messages 20))
2363 (message "Counting messages...%d" total-messages)))
2364 ;; Handle the first message, maybe.
2367 (goto-char (point-min)))
2368 (unless (not (looking-at "From "))
2369 (rmail-collect-deleted start)
2370 (setq messages-head (cons (point-marker) messages-head)
2371 total-messages (1+ total-messages)))))
2373 ;; Display a message.
2375 ;;;; *** Rmail Message Formatting and Header Manipulation ***
2377 (defun rmail-toggle-header (&optional arg)
2378 "Show original message header if pruned header currently shown, or vice versa.
2379 With argument ARG, show the message header pruned if ARG is greater than zero;
2380 otherwise, show it in full."
2382 (setq rmail-header-style
2384 ((and (numberp arg) (> arg 0)) 'normal)
2385 ((eq rmail-header-style 'full) 'normal)
2387 (rmail-show-message-maybe))
2389 (defun rmail-beginning-of-message ()
2390 "Show current message starting from the beginning."
2392 (let ((rmail-show-message-hook
2393 (list (function (lambda ()
2394 (goto-char (point-min)))))))
2395 (rmail-show-message-maybe rmail-current-message)))
2397 (defun rmail-end-of-message ()
2398 "Show bottom of current message."
2400 (let ((rmail-show-message-hook
2401 (list (function (lambda ()
2402 (goto-char (point-max))
2403 (recenter (1- (window-height))))))))
2404 (rmail-show-message-maybe rmail-current-message)))
2406 (defun rmail-unknown-mail-followup-to ()
2407 "Handle a \"Mail-Followup-To\" header field with an unknown mailing list.
2408 Ask the user whether to add that list name to `mail-mailing-lists'."
2410 (let ((mail-followup-to (mail-fetch-field "mail-followup-to" nil t)))
2411 (when mail-followup-to
2414 (mail-strip-quoted-names mail-followup-to)
2415 ",[[:space:]]+" t)))
2416 (dolist (addr addresses)
2417 (when (and (not (member addr mail-mailing-lists))
2419 ;; taken from rmailsum.el
2421 (or rmail-user-mail-address-regexp
2423 (regexp-quote (user-login-name))
2426 (or user-mail-address
2427 (concat (user-login-name) "@"
2428 (or mail-host-address
2433 (format "Add `%s' to `mail-mailing-lists'? "
2435 (customize-save-variable 'mail-mailing-lists
2436 (cons addr mail-mailing-lists)))))))))
2438 (defun rmail-widen ()
2439 "Display the entire mailbox file."
2441 (rmail-swap-buffers-maybe)
2444 (defun rmail-show-message-maybe (&optional n no-summary)
2445 "Show message number N (prefix argument), counting from start of file.
2446 If summary buffer is currently displayed, update current message there also."
2448 (or (eq major-mode 'rmail-mode)
2449 (switch-to-buffer rmail-buffer))
2450 (rmail-swap-buffers-maybe)
2451 (rmail-maybe-set-message-counters)
2453 (let ((msgnum (or n rmail-current-message))
2455 (if (zerop rmail-total-messages)
2457 (with-current-buffer rmail-view-buffer
2459 (setq blurb "No mail.")))
2460 (setq blurb (rmail-show-message msgnum))
2461 (when mail-mailing-lists
2462 (rmail-unknown-mail-followup-to))
2463 (if transient-mark-mode (deactivate-mark))
2464 ;; If there is a summary buffer, try to move to this message
2465 ;; in that buffer. But don't complain if this message
2466 ;; is not mentioned in the summary.
2467 ;; Don't do this at all if we were called on behalf
2468 ;; of cursor motion in the summary buffer.
2469 (and (rmail-summary-exists) (not no-summary)
2470 (let ((curr-msg rmail-current-message))
2471 (rmail-select-summary
2472 (rmail-summary-goto-msg curr-msg t t))))
2473 (with-current-buffer rmail-buffer
2478 (defun rmail-is-text-p ()
2479 "Return t if the region contains a text message, nil otherwise."
2481 (let ((text-regexp "\\(text\\|message\\)/")
2482 (content-type-header (mail-fetch-field "content-type")))
2483 ;; The message is text if either there is no content type header
2484 ;; (a default of "text/plain; charset=US-ASCII" is assumed) or
2485 ;; the base content type is either text or message.
2486 (or (not content-type-header)
2487 (string-match text-regexp content-type-header)))))
2489 (defun rmail-show-message (&optional msg)
2490 "Show message MSG using a special view buffer.
2491 Return text to display in the minibuffer if MSG is out of
2492 range (displaying a reasonable choice as well), nil otherwise.
2493 The current mail message becomes the message displayed."
2494 (let ((mbox-buf rmail-buffer)
2495 (view-buf rmail-view-buffer)
2496 blurb beg end body-start coding-system character-coding is-text-message)
2498 (setq msg rmail-current-message))
2501 rmail-current-message 1
2502 blurb "No previous message"))
2503 ((> msg rmail-total-messages)
2504 (setq msg rmail-total-messages
2505 rmail-current-message rmail-total-messages
2506 blurb "No following message"))
2507 (t (setq rmail-current-message msg)))
2508 (with-current-buffer rmail-buffer
2509 ;; Mark the message as seen, bracket the message in the mail
2510 ;; buffer and determine the coding system the transfer encoding.
2511 (rmail-set-attribute rmail-unseen-attr-index nil)
2512 (rmail-swap-buffers-maybe)
2513 (setq beg (rmail-msgbeg msg)
2514 end (rmail-msgend msg))
2515 (narrow-to-region beg end)
2517 (setq body-start (search-forward "\n\n" nil t))
2518 (narrow-to-region beg (point))
2520 (setq character-coding (mail-fetch-field "content-transfer-encoding")
2521 is-text-message (rmail-is-text-p)
2522 coding-system (rmail-get-coding-system))
2523 (if character-coding
2524 (setq character-coding (downcase character-coding)))
2525 (narrow-to-region beg end)
2526 ;; Decode the message body into an empty view buffer using a
2527 ;; unibyte temporary buffer where the character decoding takes
2529 (with-current-buffer rmail-view-buffer
2531 (if (null character-coding)
2532 ;; Do it directly since that is fast.
2533 (rmail-decode-region body-start end coding-system view-buf)
2534 ;; Can this be done directly, skipping the temp buffer?
2536 (set-buffer-multibyte nil)
2537 (insert-buffer-substring mbox-buf body-start end)
2539 ((string= character-coding "quoted-printable")
2540 (mail-unquote-printable-region (point-min) (point-max)))
2541 ((and (string= character-coding "base64") is-text-message)
2542 (base64-decode-region (point-min) (point-max)))
2543 ((eq character-coding 'uuencode)
2544 (error "Not supported yet"))
2546 (rmail-decode-region (point-min) (point-max)
2547 coding-system view-buf)))
2548 ;; Copy the headers to the front of the message view buffer.
2549 (with-current-buffer rmail-view-buffer
2550 (goto-char (point-min)))
2551 (rmail-copy-headers beg end)
2552 ;; Add the separator (blank line) between headers and body;
2553 ;; highlight the message, activate any URL like text and add
2554 ;; special highlighting for and quoted material.
2555 (with-current-buffer rmail-view-buffer
2557 (goto-char (point-min))
2558 (rmail-highlight-headers)
2559 ;(rmail-activate-urls)
2560 ;(rmail-process-quoted-material)
2562 ;; Update the mode-line with message status information and swap
2563 ;; the view buffer/mail buffer contents.
2564 (rmail-display-labels)
2565 (let ((modp (buffer-modified-p)))
2566 (buffer-swap-text rmail-view-buffer)
2567 (set-buffer-modified-p modp))
2568 (setq rmail-buffer-swapped t)
2569 (run-hooks 'rmail-show-message-hook))
2572 (defun rmail-copy-headers (beg end &optional ignored-headers)
2573 "Copy displayed header fields to the message viewer buffer.
2574 BEG and END marks the start and end positions of the message in
2575 the mbox buffer. If the optional argument IGNORED-HEADERS is
2576 non-nil, ignore all header fields whose names match that regexp.
2577 Otherwise, if `rmail-displayed-headers' is non-nil, copy only
2578 those header fields whose names match that regexp. Otherwise,
2579 copy all header fields whose names do not match
2580 `rmail-ignored-headers' (unless they also match
2581 `rmail-nonignored-headers')."
2582 (let ((header-start-regexp "\n[^ \t]")
2584 (with-current-buffer rmail-buffer
2585 (when (search-forward "\n\n" nil t)
2588 ;; Put point right after the From header line.
2589 (narrow-to-region beg (point))
2590 (goto-char (point-min))
2591 (unless (re-search-forward header-start-regexp nil t)
2592 (rmail-error-bad-format))
2595 ;; Handle the case where all headers should be copied.
2596 ((eq rmail-header-style 'full)
2597 (prepend-to-buffer rmail-view-buffer beg (point-max)))
2598 ;; Handle the case where the headers matching the diplayed
2599 ;; headers regexp should be copied.
2600 ((and rmail-displayed-headers (null ignored-headers))
2603 (setq lim (if (re-search-forward header-start-regexp nil t)
2604 (1+ (match-beginning 0))
2606 (when (looking-at rmail-displayed-headers)
2607 (append-to-buffer rmail-view-buffer (point) lim))
2609 ;; Handle the ignored headers.
2610 ((or ignored-headers (setq ignored-headers rmail-ignored-headers))
2611 (while (and ignored-headers (not (eobp)))
2613 (setq lim (if (re-search-forward header-start-regexp nil t)
2614 (1+ (match-beginning 0))
2616 (if (and (looking-at ignored-headers)
2617 (not (looking-at rmail-nonignored-headers)))
2619 (append-to-buffer rmail-view-buffer (point) lim)
2621 (t (error "No headers selected for display!"))))))))
2623 ;; Find all occurrences of certain fields, and highlight them.
2624 (defun rmail-highlight-headers ()
2625 ;; Do this only if the system supports faces.
2626 (if (and (fboundp 'internal-find-face)
2627 rmail-highlighted-headers)
2629 (search-forward "\n\n" nil 'move)
2631 (narrow-to-region (point-min) (point))
2632 (let ((case-fold-search t)
2633 (inhibit-read-only t)
2634 ;; Highlight with boldface if that is available.
2635 ;; Otherwise use the `highlight' face.
2636 (face (or 'rmail-highlight
2637 (if (face-differs-from-default-p 'bold)
2639 ;; List of overlays to reuse.
2640 (overlays rmail-overlay-list))
2641 (goto-char (point-min))
2642 (while (re-search-forward rmail-highlighted-headers nil t)
2643 (skip-chars-forward " \t")
2646 (while (progn (forward-line 1)
2647 (looking-at "[ \t]")))
2648 ;; Back up over newline, then trailing spaces or tabs
2650 (while (member (preceding-char) '(? ?\t))
2653 ;; Reuse an overlay we already have.
2655 (setq overlay (car overlays)
2656 overlays (cdr overlays))
2657 (overlay-put overlay 'face face)
2658 (move-overlay overlay beg (point)))
2659 ;; Make a new overlay and add it to
2660 ;; rmail-overlay-list.
2661 (setq overlay (make-overlay beg (point)))
2662 (overlay-put overlay 'face face)
2663 (setq rmail-overlay-list
2664 (cons overlay rmail-overlay-list))))))))))
2666 (defun rmail-auto-file ()
2667 "Automatically move a message into a sub-folder based on criteria.
2668 Called when a new message is displayed."
2669 (if (or (zerop rmail-total-messages)
2670 (rmail-message-attr-p rmail-current-message "...F")
2671 (not (string= (buffer-file-name)
2672 (expand-file-name rmail-file-name))))
2673 ;; Do nothing if the message has already been filed or if there
2676 ;; Find out some basics (common fields)
2677 (let ((from (mail-fetch-field "from"))
2678 (subj (mail-fetch-field "subject"))
2679 (to (concat (mail-fetch-field "to") "," (mail-fetch-field "cc")))
2680 (d rmail-automatic-folder-directives)
2681 (directive-loop nil)
2684 (setq folder (car (car d))
2685 directive-loop (cdr (car d)))
2686 (while (and (car directive-loop)
2688 ((string= (car directive-loop) "from") from)
2689 ((string= (car directive-loop) "to") to)
2690 ((string= (car directive-loop) "subject") subj)
2691 (t (mail-fetch-field (car directive-loop))))))
2692 (and f (string-match (car (cdr directive-loop)) f))))
2693 (setq directive-loop (cdr (cdr directive-loop))))
2694 ;; If there are no directives left, then it was a complete match.
2695 (if (null directive-loop)
2697 (rmail-delete-forward)
2698 (if (string= "/dev/null" folder)
2699 (rmail-delete-message)
2700 (rmail-output folder 1 t)
2702 (setq d (cdr d))))))
2704 ;; Simple message motion commands.
2706 (defun rmail-next-message (n)
2707 "Show following message whether deleted or not.
2708 With prefix arg N, moves forward N messages, or backward if N is negative."
2710 (set-buffer rmail-buffer)
2711 (rmail-maybe-set-message-counters)
2712 (rmail-show-message-maybe (+ rmail-current-message n)))
2714 (defun rmail-previous-message (n)
2715 "Show previous message whether deleted or not.
2716 With prefix arg N, moves backward N messages, or forward if N is negative."
2718 (rmail-next-message (- n)))
2720 (defun rmail-next-undeleted-message (n)
2721 "Show following non-deleted message.
2722 With prefix arg N, moves forward N non-deleted messages,
2723 or backward if N is negative.
2725 Returns t if a new message is being shown, nil otherwise."
2727 (set-buffer rmail-buffer)
2728 (rmail-maybe-set-message-counters)
2729 (let ((lastwin rmail-current-message)
2730 (current rmail-current-message))
2731 (while (and (> n 0) (< current rmail-total-messages))
2732 (setq current (1+ current))
2733 (if (not (rmail-message-deleted-p current))
2734 (setq lastwin current n (1- n))))
2735 (while (and (< n 0) (> current 1))
2736 (setq current (1- current))
2737 (if (not (rmail-message-deleted-p current))
2738 (setq lastwin current n (1+ n))))
2739 (if (/= lastwin rmail-current-message)
2740 (progn (rmail-show-message-maybe lastwin)
2743 (message "No previous nondeleted message"))
2745 (message "No following nondeleted message"))
2748 (defun rmail-previous-undeleted-message (n)
2749 "Show previous non-deleted message.
2750 With prefix argument N, moves backward N non-deleted messages,
2751 or forward if N is negative."
2753 (rmail-next-undeleted-message (- n)))
2755 (defun rmail-first-message ()
2756 "Show first message in file."
2758 (rmail-maybe-set-message-counters)
2759 (rmail-show-message-maybe (< 1 rmail-total-messages)))
2761 (defun rmail-last-message ()
2762 "Show last message in file."
2764 (rmail-maybe-set-message-counters)
2765 (rmail-show-message-maybe rmail-total-messages))
2767 (defun rmail-what-message ()
2768 "For debugging Rmail: find the message number that point is in."
2769 (let ((where (point))
2771 (high rmail-total-messages)
2772 (mid (/ rmail-total-messages 2)))
2773 (while (> (- high low) 1)
2774 (if (>= where (rmail-msgbeg mid))
2777 (setq mid (+ low (/ (- high low) 2))))
2778 (if (>= where (rmail-msgbeg high)) high low)))
2780 ;; Searching in Rmail file.
2782 (defun rmail-search-message (msg regexp)
2783 "Return non-nil, if for message number MSG, regexp REGEXP matches."
2784 ;; This is adequate because its only caller, rmail-search,
2785 ;; unswaps the buffers.
2786 (goto-char (rmail-msgbeg msg))
2787 (if rmail-enable-mime
2788 (funcall rmail-search-mime-message-function msg regexp)
2789 (re-search-forward regexp (rmail-msgend msg) t)))
2791 (defvar rmail-search-last-regexp nil)
2792 (defun rmail-search (regexp &optional n)
2793 "Show message containing next match for REGEXP (but not the current msg).
2794 Prefix argument gives repeat count; negative argument means search
2795 backwards (through earlier messages).
2796 Interactively, empty argument means use same regexp used last time."
2798 (let* ((reversep (< (prefix-numeric-value current-prefix-arg) 0))
2800 (concat (if reversep "Reverse " "") "Rmail search (regexp"))
2804 (if rmail-search-last-regexp
2805 (concat ", default "
2806 rmail-search-last-regexp "): ")
2808 (setq regexp (read-string prompt))
2809 (cond ((not (equal regexp ""))
2810 (setq rmail-search-last-regexp regexp))
2811 ((not rmail-search-last-regexp)
2812 (error "No previous Rmail search string")))
2813 (list rmail-search-last-regexp
2814 (prefix-numeric-value current-prefix-arg))))
2816 (message "%sRmail search for %s..."
2817 (if (< n 0) "Reverse " "")
2819 (set-buffer rmail-buffer)
2820 (let ((orig-message rmail-current-message)
2821 (msg rmail-current-message)
2823 (opoint (if (rmail-buffers-swapped-p) (point)))
2825 (rmail-swap-buffers-maybe)
2826 (rmail-maybe-set-message-counters)
2830 ;; Check messages one by one, advancing message number up or
2831 ;; down but searching forward through each message.
2833 (while (and (null found) (> msg 1))
2835 found (rmail-search-message msg regexp)))
2836 (while (and (null found) (< msg rmail-total-messages))
2838 found (rmail-search-message msg regexp))))
2839 (setq n (+ n (if reversep 1 -1))))
2842 (rmail-show-message-maybe msg)
2843 ;; Search forward (if this is a normal search) or backward
2844 ;; (if this is a reverse search) through this message to
2845 ;; position point. This search may fail because REGEXP
2846 ;; was found in the hidden portion of this message. In
2847 ;; that case, move point to the beginning of visible
2851 (goto-char (point-max))
2852 (re-search-backward regexp nil 'move))
2853 (goto-char (point-min))
2854 (re-search-forward regexp nil t))
2855 (message "%sRmail search for %s...done"
2856 (if reversep "Reverse " "")
2858 (rmail-show-message-maybe orig-message)
2859 (if opoint (goto-char opoint))
2861 (message "Search failed: %s" regexp)))))
2863 (defun rmail-search-backwards (regexp &optional n)
2864 "Show message containing previous match for REGEXP.
2865 Prefix argument gives repeat count; negative argument means search
2866 forward (through later messages).
2867 Interactively, empty argument means use same regexp used last time."
2869 (let* ((reversep (>= (prefix-numeric-value current-prefix-arg) 0))
2871 (concat (if reversep "Reverse " "") "Rmail search (regexp"))
2875 (if rmail-search-last-regexp
2876 (concat ", default "
2877 rmail-search-last-regexp "): ")
2879 (setq regexp (read-string prompt))
2880 (cond ((not (equal regexp ""))
2881 (setq rmail-search-last-regexp regexp))
2882 ((not rmail-search-last-regexp)
2883 (error "No previous Rmail search string")))
2884 (list rmail-search-last-regexp
2885 (prefix-numeric-value current-prefix-arg))))
2886 (rmail-search regexp (- (or n 1))))
2888 ;; Scan for attributes, and compare subjects.
2890 (defun rmail-first-unseen-message ()
2891 "Return message number of first message which has `unseen' attribute."
2892 (rmail-maybe-set-message-counters)
2897 (while (and (not found) (<= current rmail-total-messages))
2898 (if (rmail-message-attr-p current "......U")
2899 (setq found current))
2900 (setq current (1+ current))))
2903 (defun rmail-simplified-subject (&optional msgnum)
2904 "Return the simplified subject of message MSGNUM (or current message).
2905 Simplifying the subject means stripping leading and trailing whitespace,
2906 and typical reply prefixes such as Re:."
2907 (let ((subject (or (rmail-get-header "Subject" msgnum) "")))
2908 (if (string-match "\\`[ \t]+" subject)
2909 (setq subject (substring subject (match-end 0))))
2910 (if (string-match rmail-reply-regexp subject)
2911 (setq subject (substring subject (match-end 0))))
2912 (if (string-match "[ \t]+\\'" subject)
2913 (setq subject (substring subject 0 (match-beginning 0))))
2916 (defun rmail-simplified-subject-regexp ()
2917 "Return a regular expression matching the current simplified subject.
2918 The idea is to match it against simplified subjects of other messages."
2919 (let ((subject (rmail-simplified-subject)))
2920 (setq subject (regexp-quote subject))
2921 ;; Hide commas so it will work ok if parsed as a comma-separated list
2924 (replace-regexp-in-string "," "\054" subject t t))
2925 (concat "\\`" subject "\\'")))
2927 (defun rmail-next-same-subject (n)
2928 "Go to the next mail message having the same subject header.
2929 With prefix argument N, do this N times.
2930 If N is negative, go backwards instead."
2932 (let ((subject (rmail-simplified-subject))
2934 (i rmail-current-message)
2936 (while (and (/= n 0)
2938 (< i rmail-total-messages)
2941 (while (and (not done)
2943 (< i rmail-total-messages)
2945 (setq i (if forward (1+ i) (1- i)))
2946 (setq done (string-equal subject (rmail-simplified-subject i))))
2947 (if done (setq found i)))
2948 (setq n (if forward (1- n) (1+ n))))
2950 (rmail-show-message-maybe found)
2951 (error "No %s message with same subject"
2952 (if forward "following" "previous")))))
2954 (defun rmail-previous-same-subject (n)
2955 "Go to the previous mail message having the same subject header.
2956 With prefix argument N, do this N times.
2957 If N is negative, go forwards instead."
2959 (rmail-next-same-subject (- n)))
2961 ;;;; *** Rmail Message Deletion Commands ***
2963 (defun rmail-message-deleted-p (n)
2964 (= (aref rmail-deleted-vector n) ?D))
2966 (defun rmail-set-message-deleted-p (n state)
2967 (aset rmail-deleted-vector n (if state ?D ?\ )))
2969 (defun rmail-delete-message ()
2970 "Delete this message and stay on it."
2972 (rmail-set-attribute rmail-deleted-attr-index t)
2973 (run-hooks 'rmail-delete-message-hook))
2975 (defun rmail-undelete-previous-message ()
2976 "Back up to deleted message, select it, and undelete it."
2978 (set-buffer rmail-buffer)
2979 (let ((msg rmail-current-message))
2980 (while (and (> msg 0)
2981 (not (rmail-message-deleted-p msg)))
2982 (setq msg (1- msg)))
2984 (error "No previous deleted message")
2985 (if (/= msg rmail-current-message)
2986 (rmail-show-message-maybe msg))
2987 (rmail-set-attribute rmail-deleted-attr-index nil)
2988 (if (rmail-summary-exists)
2990 (set-buffer rmail-summary-buffer)
2991 (rmail-summary-mark-undeleted msg)))
2992 (rmail-maybe-display-summary))))
2994 (defun rmail-delete-forward (&optional backward)
2995 "Delete this message and move to next nondeleted one.
2996 Deleted messages stay in the file until the \\[rmail-expunge] command is given.
2997 With prefix argument, delete and move backward.
2999 Returns t if a new message is displayed after the delete, or nil otherwise."
3001 (rmail-set-attribute rmail-deleted-attr-index t)
3002 (run-hooks 'rmail-delete-message-hook)
3003 (let ((del-msg rmail-current-message))
3004 (if (rmail-summary-exists)
3005 (rmail-select-summary
3006 (rmail-summary-mark-deleted del-msg)))
3007 (prog1 (rmail-next-undeleted-message (if backward -1 1))
3008 (rmail-maybe-display-summary))))
3010 (defun rmail-delete-backward ()
3011 "Delete this message and move to previous nondeleted one.
3012 Deleted messages stay in the file until the \\[rmail-expunge] command is given."
3014 (rmail-delete-forward t))
3018 ;; Compute the message number a given message would have after expunging.
3019 ;; The present number of the message is OLDNUM.
3020 ;; DELETEDVEC should be rmail-deleted-vector.
3021 ;; The value is nil for a message that would be deleted.
3022 (defun rmail-msg-number-after-expunge (deletedvec oldnum)
3023 (if (or (null oldnum) (= (aref deletedvec oldnum) ?D))
3028 (if (/= (aref deletedvec i) ?D)
3029 (setq newnum (1+ newnum)))
3033 (defun rmail-expunge-confirmed ()
3034 "Return t if deleted message should be expunged. If necessary, ask the user.
3035 See also user-option `rmail-confirm-expunge'."
3036 (set-buffer rmail-buffer)
3037 (or (not (stringp rmail-deleted-vector))
3038 (not (string-match "D" rmail-deleted-vector))
3039 (null rmail-confirm-expunge)
3040 (funcall rmail-confirm-expunge
3041 "Erase deleted messages from Rmail file? ")))
3043 (defun rmail-only-expunge (&optional dont-show)
3044 "Actually erase all deleted messages in the file."
3046 (rmail-swap-buffers-maybe)
3047 (set-buffer rmail-buffer)
3048 (message "Expunging deleted messages...")
3049 ;; Discard all undo records for this buffer.
3050 (or (eq buffer-undo-list t)
3051 (setq buffer-undo-list nil))
3052 (rmail-maybe-set-message-counters)
3053 (let* ((omax (- (buffer-size) (point-max)))
3054 (omin (- (buffer-size) (point-min)))
3055 (opoint (if (and (> rmail-current-message 0)
3056 (rmail-message-deleted-p rmail-current-message))
3058 (if rmail-enable-mime
3059 (with-current-buffer rmail-view-buffer
3060 (- (point)(point-min)))
3061 (- (point) (point-min)))))
3062 (messages-head (cons (aref rmail-message-vector 0) nil))
3063 (messages-tail messages-head)
3064 ;; Don't make any undo records for the expunging.
3065 (buffer-undo-list t)
3070 (goto-char (point-min))
3074 (new-msgref (list (list 0)))
3075 (buffer-read-only nil)
3076 (total rmail-total-messages)
3077 (new-message-number rmail-current-message)
3078 (messages rmail-message-vector)
3079 (deleted rmail-deleted-vector)
3080 (summary rmail-summary-vector))
3081 (setq rmail-total-messages nil
3082 rmail-current-message nil
3083 rmail-message-vector nil
3084 rmail-deleted-vector nil
3085 rmail-summary-vector nil)
3087 (while (<= number total)
3088 (if (= (aref deleted number) ?D)
3090 (delete-region (aref messages number)
3091 (aref messages (1+ number)))
3092 (move-marker (aref messages number) nil)
3093 (if (> new-message-number counter)
3094 (setq new-message-number (1- new-message-number))))
3095 (setq counter (1+ counter))
3097 (setcdr messages-tail
3098 (cons (aref messages number) nil)))
3100 (cons (if (= counter number) (aref summary (1- number)))
3103 (cons (aref rmail-msgref-vector number)
3105 (setcar (car new-msgref) counter))
3106 (if (zerop (% (setq number (1+ number)) 20))
3107 (message "Expunging deleted messages...%d" number)))
3109 (setcdr messages-tail
3110 (cons (aref messages number) nil)))
3111 (setq rmail-current-message new-message-number
3112 rmail-total-messages counter
3113 rmail-message-vector (apply 'vector messages-head)
3114 rmail-deleted-vector (make-string (1+ counter) ?\ )
3115 rmail-summary-vector (vconcat (nreverse new-summary))
3116 rmail-msgref-vector (apply 'vector (nreverse new-msgref))
3118 (message "Expunging deleted messages...done")
3120 (narrow-to-region (- (buffer-size) omin) (- (buffer-size) omax)))
3122 (rmail-show-message-maybe (min rmail-current-message rmail-total-messages)))
3123 (if rmail-enable-mime
3124 (goto-char (+ (point-min) opoint))
3125 (goto-char (+ (point) opoint))))))
3127 (defun rmail-expunge (&optional dont-show)
3128 "Erase deleted messages from Rmail file and summary buffer."
3130 (when (rmail-expunge-confirmed)
3131 (let ((old-total rmail-total-messages)
3132 (opoint (with-current-buffer rmail-buffer
3133 (when (rmail-buffers-swapped-p)
3135 (rmail-only-expunge dont-show)
3136 (if (rmail-summary-exists)
3137 (rmail-select-summary (rmail-update-summary))
3138 (rmail-show-message rmail-current-message)
3139 (if (and (eq old-total rmail-total-messages) opoint)
3140 (goto-char opoint))))))
3142 ;;;; *** Rmail Mailing Commands ***
3144 (defun rmail-start-mail (&optional noerase to subject in-reply-to cc
3145 replybuffer sendactions same-window others)
3148 (setq yank-action (list 'insert-buffer replybuffer)))
3149 (setq others (cons (cons "cc" cc) others))
3150 (setq others (cons (cons "in-reply-to" in-reply-to) others))
3152 (compose-mail to subject others
3154 yank-action sendactions)
3155 (if rmail-mail-new-frame
3157 (compose-mail to subject others
3158 noerase 'switch-to-buffer-other-frame
3159 yank-action sendactions)
3160 ;; This is not a standard frame parameter;
3161 ;; nothing except sendmail.el looks at it.
3162 (modify-frame-parameters (selected-frame)
3163 '((mail-dedicated-frame . t))))
3164 (compose-mail to subject others
3165 noerase 'switch-to-buffer-other-window
3166 yank-action sendactions)))))
3168 (defun rmail-mail ()
3169 "Send mail in another window.
3170 While composing the message, use \\[mail-yank-original] to yank the
3171 original message into it."
3173 (rmail-start-mail nil nil nil nil nil rmail-view-buffer))
3175 (defun rmail-continue ()
3176 "Continue composing outgoing message previously being composed."
3178 (rmail-start-mail t))
3180 (defun rmail-reply (just-sender)
3181 "Reply to the current message.
3182 Normally include CC: to all other recipients of original message;
3183 prefix argument means ignore them. While composing the reply,
3184 use \\[mail-yank-original] to yank the original message into it."
3186 (let (from reply-to cc subject date to message-id references
3187 resent-to resent-cc resent-reply-to
3188 (msgnum rmail-current-message))
3192 (if (rmail-buffers-swapped-p)
3194 (goto-char (point-min))
3195 (search-forward "\n\n" nil 'move))
3196 (goto-char (rmail-msgbeg rmail-current-message))
3200 (search-forward "\n\n"
3201 (rmail-msgend rmail-current-message)
3203 (setq from (mail-fetch-field "from")
3204 reply-to (or (mail-fetch-field "mail-reply-to" nil t)
3205 (mail-fetch-field "reply-to" nil t)
3207 subject (mail-fetch-field "subject")
3208 date (mail-fetch-field "date")
3209 message-id (mail-fetch-field "message-id")
3210 references (mail-fetch-field "references" nil nil t)
3211 resent-reply-to (mail-fetch-field "resent-reply-to" nil t)
3212 resent-cc (and (not just-sender)
3213 (mail-fetch-field "resent-cc" nil t))
3214 resent-to (or (mail-fetch-field "resent-to" nil t) "")
3215 ;;; resent-subject (mail-fetch-field "resent-subject")
3216 ;;; resent-date (mail-fetch-field "resent-date")
3217 ;;; resent-message-id (mail-fetch-field "resent-message-id")
3220 (if (mail-fetch-field "mail-followup-to" nil t)
3221 ;; If this header field is present, use it instead of
3222 ;; the To and CC fields.
3223 (setq to (mail-fetch-field "mail-followup-to" nil t))
3224 (setq cc (or (mail-fetch-field "cc" nil t) "")
3225 to (or (mail-fetch-field "to" nil t) ""))))))
3227 ;; Merge the resent-to and resent-cc into the to and cc.
3228 (if (and resent-to (not (equal resent-to "")))
3229 (if (not (equal to ""))
3230 (setq to (concat to ", " resent-to))
3231 (setq to resent-to)))
3232 (if (and resent-cc (not (equal resent-cc "")))
3233 (if (not (equal cc ""))
3234 (setq cc (concat cc ", " resent-cc))
3235 (setq cc resent-cc)))
3236 ;; Add `Re: ' to subject if not there already.
3237 (and (stringp subject)
3239 (concat rmail-reply-prefix
3240 (if (let ((case-fold-search t))
3241 (string-match rmail-reply-regexp subject))
3242 (substring subject (match-end 0))
3246 ;; Using mail-strip-quoted-names is undesirable with newer mailers
3247 ;; since they can handle the names unstripped.
3248 ;; I don't know whether there are other mailers that still
3249 ;; need the names to be stripped.
3250 ;;; (mail-strip-quoted-names reply-to)
3251 ;; Remove unwanted names from reply-to, since Mail-Followup-To
3252 ;; header causes all the names in it to wind up in reply-to, not
3253 ;; in cc. But if what's left is an empty list, use the original.
3254 (let* ((reply-to-list (rmail-dont-reply-to reply-to)))
3255 (if (string= reply-to-list "") reply-to reply-to-list))
3257 (rmail-make-in-reply-to-field from date message-id)
3260 ;; mail-strip-quoted-names is NOT necessary for rmail-dont-reply-to
3262 (let* ((cc-list (rmail-dont-reply-to
3263 (mail-strip-quoted-names
3264 (if (null cc) to (concat to ", " cc))))))
3265 (if (string= cc-list "") nil cc-list)))
3267 (list (list 'rmail-mark-message
3269 (with-current-buffer rmail-buffer
3270 (aref rmail-msgref-vector msgnum))
3271 rmail-answered-attr-index))
3273 (list (cons "References" (concat (mapconcat 'identity references " ")
3274 " " message-id))))))
3276 (defun rmail-mark-message (buffer msgnum-list attribute)
3277 "Give BUFFER's message number in MSGNUM-LIST the attribute ATTRIBUTE.
3278 This is use in the send-actions for message buffers.
3279 MSGNUM-LIST is a list of the form (MSGNUM)
3280 which is an element of rmail-msgref-vector."
3283 (if (car msgnum-list)
3284 (rmail-set-attribute attribute t (car msgnum-list)))))
3286 (defun rmail-make-in-reply-to-field (from date message-id)
3293 (let ((tem (car (rfc822-addresses from))))
3297 (regexp-quote (if (string-match "@[^@]*\\'" tem)
3299 (match-beginning 0))
3302 ;; missing From, or Message-ID is sufficiently informative
3304 (concat message-id " (" tem ")"))
3305 ;; Copy TEM, discarding text properties.
3306 (setq tem (copy-sequence tem))
3307 (set-text-properties 0 (length tem) nil tem)
3308 (setq tem (copy-sequence tem))
3309 ;; Use prin1 to fake RFC822 quoting
3310 (let ((field (prin1-to-string tem)))
3312 (concat field "'s message of " date)
3314 ((let* ((foo "[^][\000-\037()<>@,;:\\\" ]+")
3315 (bar "[^][\000-\037()<>@,;:\\\"]+"))
3316 ;; These strings both match all non-ASCII characters.
3317 (or (string-match (concat "\\`[ \t]*\\(" bar
3318 "\\)\\(<" foo "@" foo ">\\)?[ \t]*\\'")
3319 ;; "Unix Loser <Foo@bar.edu>" => "Unix Loser"
3321 (string-match (concat "\\`[ \t]*<" foo "@" foo ">[ \t]*(\\("
3322 bar "\\))[ \t]*\\'")
3323 ;; "<Bugs@bar.edu>" (Losing Unix) => "Losing Unix"
3325 (let ((start (match-beginning 1))
3326 (end (match-end 1)))
3327 ;; Trim whitespace which above regexp match allows
3328 (while (and (< start end)
3329 (memq (aref from start) '(?\t ?\ )))
3330 (setq start (1+ start)))
3331 (while (and (< start end)
3332 (memq (aref from (1- end)) '(?\t ?\ )))
3333 (setq end (1- end)))
3334 (let ((field (substring from start end)))
3335 (if date (setq field (concat "message from " field " on " date)))
3337 ;; "<AA259@bar.edu> (message from Unix Loser on 1-Apr-89)"
3338 (concat message-id " (" field ")")
3341 ;; If we can't kludge it simply, do it correctly
3342 (let ((mail-use-rfc822 t))
3343 (rmail-make-in-reply-to-field from date message-id)))))
3345 (defun rmail-forward (resend)
3346 "Forward the current message to another user.
3347 With prefix argument, \"resend\" the message instead of forwarding it;
3348 see the documentation of `rmail-resend'."
3351 (call-interactively 'rmail-resend)
3352 (let ((forward-buffer rmail-buffer)
3353 (msgnum rmail-current-message)
3354 (subject (concat "["
3355 (let ((from (or (mail-fetch-field "From")
3356 (mail-fetch-field ">From"))))
3358 (concat (mail-strip-quoted-names from) ": ")
3360 (or (mail-fetch-field "Subject") "")
3362 (if (rmail-start-mail
3363 nil nil subject nil nil nil
3364 (list (list 'rmail-mark-message
3366 (with-current-buffer rmail-buffer
3367 (aref rmail-msgref-vector msgnum))
3368 rmail-forwarded-attr-index))
3369 ;; If only one window, use it for the mail buffer.
3370 ;; Otherwise, use another window for the mail buffer
3371 ;; so that the Rmail buffer remains visible
3372 ;; and sending the mail will get back to it.
3373 (and (not rmail-mail-new-frame) (one-window-p t)))
3374 ;; The mail buffer is now current.
3376 ;; Insert after header separator--before signature if any.
3377 (goto-char (mail-text-start))
3378 (if (or rmail-enable-mime rmail-enable-mime-composing)
3379 (funcall rmail-insert-mime-forwarded-message-function
3381 (insert "------- Start of forwarded message -------\n")
3382 ;; Quote lines with `- ' if they start with `-'.
3383 (let ((beg (point)) end)
3384 (setq end (point-marker))
3385 (set-marker-insertion-type end t)
3386 (insert-buffer-substring forward-buffer)
3388 (while (re-search-forward "^-" end t)
3393 (skip-chars-backward "\n")
3396 (delete-region (point) end)
3397 (set-marker end nil))
3398 (insert "------- End of forwarded message -------\n"))
3401 (defun rmail-resend (address &optional from comment mail-alias-file)
3402 "Resend current message to ADDRESSES.
3403 ADDRESSES should be a single address, a string consisting of several
3404 addresses separated by commas, or a list of addresses.
3406 Optional FROM is the address to resend the message from, and
3407 defaults from the value of `user-mail-address'.
3408 Optional COMMENT is a string to insert as a comment in the resent message.
3409 Optional ALIAS-FILE is alternate aliases file to be used by sendmail,
3410 typically for purposes of moderating a list."
3411 (interactive "sResend to: ")
3413 (require 'mailalias)
3414 (unless (or (eq rmail-view-buffer (current-buffer))
3415 (eq rmail-buffer (current-buffer)))
3416 (error "Not an Rmail buffer"))
3417 (if (not from) (setq from user-mail-address))
3418 (let ((tembuf (generate-new-buffer " sendmail temp"))
3419 (case-fold-search nil)
3420 (mail-personal-alias-file
3421 (or mail-alias-file mail-personal-alias-file))
3422 (mailbuf rmail-buffer))
3424 (with-current-buffer tembuf
3425 ;;>> Copy message into temp buffer
3426 (if rmail-enable-mime
3427 (funcall rmail-insert-mime-resent-message-function mailbuf)
3428 (insert-buffer-substring mailbuf))
3429 (goto-char (point-min))
3430 ;; Delete any Sender field, since that's not specifiable.
3431 ; Only delete Sender fields in the actual header.
3432 (re-search-forward "^$" nil 'move)
3433 ; Using "while" here rather than "if" because some buggy mail
3434 ; software may have inserted multiple Sender fields.
3435 (while (re-search-backward "^Sender:" nil t)
3439 (while (looking-at "[ \t]")
3441 (delete-region beg (point))))
3442 ; Go back to the beginning of the buffer so the Resent- fields
3443 ; are inserted there.
3444 (goto-char (point-min))
3445 ;;>> Insert resent-from:
3446 (insert "Resent-From: " from "\n")
3447 (insert "Resent-Date: " (mail-rfc822-date) "\n")
3448 ;;>> Insert resent-to: and bcc if need be.
3449 (let ((before (point)))
3451 (insert "Resent-Bcc: " (user-login-name) "\n"))
3452 (insert "Resent-To: " (if (stringp address)
3454 (mapconcat 'identity address ",\n\t"))
3456 ;; Expand abbrevs in the recipients.
3458 (if (featurep 'mailabbrev)
3459 (let ((end (point-marker))
3460 (local-abbrev-table mail-abbrevs)
3461 (old-syntax-table (syntax-table)))
3462 (if (and (not (vectorp mail-abbrevs))
3463 (file-exists-p mail-personal-alias-file))
3464 (build-mail-abbrevs))
3465 (unless mail-abbrev-syntax-table
3466 (mail-abbrev-make-syntax-table))
3467 (set-syntax-table mail-abbrev-syntax-table)
3469 (while (and (< (point) end)
3470 (progn (forward-word 1)
3473 (set-syntax-table old-syntax-table))
3474 (expand-mail-aliases before (point)))))
3475 ;;>> Set up comment, if any.
3476 (if (and (sequencep comment) (not (zerop (length comment))))
3477 (let ((before (point))
3480 (or (eolp) (insert "\n"))
3481 (setq after (point))
3483 (while (< (point) after)
3484 (insert "Resent-Comment: ")
3486 ;; Don't expand aliases in the destination fields
3487 ;; of the original message.
3489 (funcall send-mail-function)))
3490 (kill-buffer tembuf))
3491 (with-current-buffer rmail-buffer
3492 (rmail-set-attribute rmail-resent-attr-index t rmail-current-message))))
3494 (defvar mail-unsent-separator
3495 (concat "^ *---+ +Unsent message follows +---+ *$\\|"
3496 "^ *---+ +Returned message +---+ *$\\|"
3497 "^ *---+ *Returned mail follows *---+ *$\\|"
3498 "^Start of returned message$\\|"
3499 "^---+ Below this line is a copy of the message.$\\|"
3500 "^ *---+ +Original message +---+ *$\\|"
3501 "^ *--+ +begin message +--+ *$\\|"
3502 "^ *---+ +Original message follows +---+ *$\\|"
3503 "^ *---+ +Your message follows +---+ *$\\|"
3504 "^|? *---+ +Message text follows: +---+ *|?$\\|"
3505 "^ *---+ +This is a copy of \\w+ message, including all the headers.*---+ *$")
3506 "A regexp that matches the separator before the text of a failed message.")
3508 (defvar mail-mime-unsent-header "^Content-Type: message/rfc822 *$"
3509 "A regexp that matches the header of a MIME body part with a failed message.")
3511 (defun rmail-retry-failure ()
3512 "Edit a mail message which is based on the contents of the current message.
3513 For a message rejected by the mail system, extract the interesting headers and
3514 the body of the original message.
3515 If the failed message is a MIME multipart message, it is searched for a
3516 body part with a header which matches the variable `mail-mime-unsent-header'.
3517 Otherwise, the variable `mail-unsent-separator' should match the string that
3518 delimits the returned original message.
3519 The variable `rmail-retry-ignored-headers' is a regular expression
3520 specifying headers which should not be copied into the new message."
3522 (require 'mail-utils)
3523 (let ((rmail-this-buffer (current-buffer))
3524 (msgnum rmail-current-message)
3525 bounce-start bounce-end bounce-indent resending
3526 ;; Fetch any content-type header in current message
3527 ;; Must search thru the whole unpruned header.
3531 (mail-fetch-field "Content-Type") ))))
3533 (goto-char (point-min))
3534 (let ((case-fold-search t))
3535 (if (and content-type
3537 ";[\n\t ]*boundary=\"?\\([-0-9a-z'()+_,./:=? ]+\\)\"?"
3539 ;; Handle a MIME multipart bounce message.
3542 (substring content-type (match-beginning 1)
3544 (unless (re-search-forward mail-mime-unsent-header nil t)
3545 (error "Cannot find beginning of header in failed message"))
3546 (unless (search-forward "\n\n" nil t)
3547 (error "Cannot find start of Mime data in failed message"))
3548 (setq bounce-start (point))
3549 (if (search-forward codestring nil t)
3550 (setq bounce-end (match-beginning 0))
3551 (setq bounce-end (point-max))))
3553 (or (re-search-forward mail-unsent-separator nil t)
3554 (error "Cannot parse this as a failure message"))
3555 (skip-chars-forward "\n")
3556 ;; Support a style of failure message in which the original
3557 ;; message is indented, and included within lines saying
3558 ;; `Start of returned message' and `End of returned message'.
3559 (if (looking-at " +Received:")
3561 (setq bounce-start (point))
3562 (skip-chars-forward " ")
3563 (setq bounce-indent (- (current-column)))
3564 (goto-char (point-max))
3565 (re-search-backward "^End of returned message$" nil t)
3566 (setq bounce-end (point)))
3567 ;; One message contained a few random lines before
3568 ;; the old message header. The first line of the
3569 ;; message started with two hyphens. A blank line
3570 ;; followed these random lines. The same line
3571 ;; beginning with two hyphens was possibly marking
3572 ;; the end of the message.
3573 (if (looking-at "^--")
3574 (let ((boundary (buffer-substring-no-properties
3576 (progn (end-of-line) (point)))))
3577 (search-forward "\n\n")
3578 (skip-chars-forward "\n")
3579 (setq bounce-start (point))
3580 (goto-char (point-max))
3581 (search-backward (concat "\n\n" boundary) bounce-start t)
3582 (setq bounce-end (point)))
3583 (setq bounce-start (point)
3584 bounce-end (point-max)))
3585 (unless (search-forward "\n\n" nil t)
3586 (error "Cannot find end of header in failed message"))))))
3587 ;; We have found the message that bounced, within the current message.
3588 ;; Now start sending new message; default header fields from original.
3589 ;; Turn off the usual actions for initializing the message body
3590 ;; because we want to get only the text from the failure message.
3591 (let (mail-signature mail-setup-hook)
3592 (if (rmail-start-mail nil nil nil nil nil rmail-this-buffer
3593 (list (list 'rmail-mark-message
3595 (aref rmail-msgref-vector msgnum)
3596 rmail-retried-attr-index)))
3597 ;; Insert original text as initial text of new draft message.
3598 ;; Bind inhibit-read-only since the header delimiter
3599 ;; of the previous message was probably read-only.
3600 (let ((inhibit-read-only t)
3601 rmail-displayed-headers
3602 rmail-ignored-headers)
3604 (insert-buffer-substring rmail-this-buffer
3605 bounce-start bounce-end)
3606 (goto-char (point-min))
3608 (indent-rigidly (point-min) (point-max) bounce-indent))
3609 (mail-sendmail-delimit-header)
3611 (narrow-to-region (point-min) (mail-header-end))
3612 (setq resending (mail-fetch-field "resent-to"))
3615 (insert "Resent-Bcc: " (user-login-name) "\n")
3616 (insert "BCC: " (user-login-name) "\n"))))
3617 (goto-char (point-min))
3618 (mail-position-on-field (if resending "Resent-To" "To") t))))))
3620 (defun rmail-summary-exists ()
3621 "Non-nil if in an RMAIL buffer and an associated summary buffer exists.
3622 In fact, the non-nil value returned is the summary buffer itself."
3623 (and rmail-summary-buffer (buffer-name rmail-summary-buffer)
3624 rmail-summary-buffer))
3626 (defun rmail-summary-displayed ()
3627 "t if in RMAIL buffer and an associated summary buffer is displayed."
3628 (and rmail-summary-buffer (get-buffer-window rmail-summary-buffer)))
3630 (defcustom rmail-redisplay-summary nil
3631 "*Non-nil means Rmail should show the summary when it changes.
3632 This has an effect only if a summary buffer exists."
3634 :group 'rmail-summary)
3636 (defcustom rmail-summary-window-size nil
3637 "*Non-nil means specify the height for an Rmail summary window."
3638 :type '(choice (const :tag "Disabled" nil) integer)
3639 :group 'rmail-summary)
3641 ;; Put the summary buffer back on the screen, if user wants that.
3642 (defun rmail-maybe-display-summary ()
3643 (let ((selected (selected-window))
3645 ;; If requested, make sure the summary is displayed.
3646 (and rmail-summary-buffer (buffer-name rmail-summary-buffer)
3647 rmail-redisplay-summary
3648 (if (get-buffer-window rmail-summary-buffer 0)
3649 ;; It's already in some frame; show that one.
3650 (let ((frame (window-frame
3651 (get-buffer-window rmail-summary-buffer 0))))
3652 (make-frame-visible frame)
3653 (raise-frame frame))
3654 (display-buffer rmail-summary-buffer)))
3655 ;; If requested, set the height of the summary window.
3656 (and rmail-summary-buffer (buffer-name rmail-summary-buffer)
3657 rmail-summary-window-size
3658 (setq window (get-buffer-window rmail-summary-buffer))
3659 ;; Don't try to change the size if just one window in frame.
3660 (not (eq window (frame-root-window (window-frame window))))
3663 (select-window window)
3664 (enlarge-window (- rmail-summary-window-size (window-height))))
3665 (select-window selected)))))
3667 ;;;; *** Rmail Local Fontification ***
3669 (defun rmail-fontify-buffer-function ()
3670 ;; This function's symbol is bound to font-lock-fontify-buffer-function.
3671 (add-hook 'rmail-show-message-hook 'rmail-fontify-message nil t)
3672 ;; If we're already showing a message, fontify it now.
3673 (if rmail-current-message (rmail-fontify-message))
3674 ;; Prevent Font Lock mode from kicking in.
3675 (setq font-lock-fontified t))
3677 (defun rmail-unfontify-buffer-function ()
3678 ;; This function's symbol is bound to font-lock-fontify-unbuffer-function.
3679 (let ((modified (buffer-modified-p))
3680 (buffer-undo-list t) (inhibit-read-only t)
3681 before-change-functions after-change-functions
3682 buffer-file-name buffer-file-truename)
3685 (remove-hook 'rmail-show-message-hook 'rmail-fontify-message t)
3686 (remove-text-properties (point-min) (point-max) '(rmail-fontified nil))
3687 (font-lock-default-unfontify-buffer)
3688 (and (not modified) (buffer-modified-p) (set-buffer-modified-p nil)))))
3690 (defun rmail-fontify-message ()
3691 ;; Fontify the current message if it is not already fontified.
3692 (if (text-property-any (point-min) (point-max) 'rmail-fontified nil)
3693 (let ((modified (buffer-modified-p))
3694 (buffer-undo-list t) (inhibit-read-only t)
3695 before-change-functions after-change-functions
3696 buffer-file-name buffer-file-truename)
3699 (add-text-properties (point-min) (point-max) '(rmail-fontified t))
3700 (font-lock-fontify-region (point-min) (point-max))
3701 (and (not modified) (buffer-modified-p) (set-buffer-modified-p nil)))))))
3703 ;;; Speedbar support for RMAIL files.
3704 (eval-when-compile (require 'speedbar))
3706 (defvar rmail-speedbar-match-folder-regexp "^[A-Z0-9]+\\(\\.[A-Z0-9]+\\)?$"
3707 "*This regex is used to match folder names to be displayed in speedbar.
3708 Enabling this will permit speedbar to display your folders for easy
3709 browsing, and moving of messages.")
3711 (defvar rmail-speedbar-last-user nil
3712 "The last user to be displayed in the speedbar.")
3714 (defvar rmail-speedbar-key-map nil
3715 "Keymap used when in rmail display mode.")
3717 (defun rmail-install-speedbar-variables ()
3718 "Install those variables used by speedbar to enhance rmail."
3719 (if rmail-speedbar-key-map
3721 (setq rmail-speedbar-key-map (speedbar-make-specialized-keymap))
3723 (define-key rmail-speedbar-key-map "e" 'speedbar-edit-line)
3724 (define-key rmail-speedbar-key-map "r" 'speedbar-edit-line)
3725 (define-key rmail-speedbar-key-map "\C-m" 'speedbar-edit-line)
3726 (define-key rmail-speedbar-key-map "M"
3727 'rmail-speedbar-move-message-to-folder-on-line)))
3729 (defvar rmail-speedbar-menu-items
3730 '(["Read Folder" speedbar-edit-line t]
3731 ["Move message to folder" rmail-speedbar-move-message-to-folder-on-line
3732 (save-excursion (beginning-of-line)
3733 (looking-at "<M> "))])
3734 "Additional menu-items to add to speedbar frame.")
3736 ;; Make sure our special speedbar major mode is loaded
3737 (if (featurep 'speedbar)
3738 (rmail-install-speedbar-variables)
3739 (add-hook 'speedbar-load-hook 'rmail-install-speedbar-variables))
3741 (defun rmail-speedbar-buttons (buffer)
3742 "Create buttons for BUFFER containing rmail messages.
3743 Click on the address under Reply to: to reply to this person.
3744 Under Folders: Click a name to read it, or on the <M> to move the
3745 current message into that RMAIL folder."
3749 (goto-char (point-min))
3750 (if (not (re-search-forward "^Reply-To: " nil t))
3751 (if (not (re-search-forward "^From:? " nil t))
3755 (setq from (buffer-substring (point) (save-excursion
3758 (goto-char (point-min))
3759 (if (and (looking-at "Reply to:")
3760 (equal from rmail-speedbar-last-user))
3762 (setq rmail-speedbar-last-user from)
3764 (insert "Reply To:\n")
3766 (speedbar-insert-button from 'speedbar-directory-face 'highlight
3767 'rmail-speedbar-button 'rmail-reply))
3768 (insert "Folders:\n")
3769 (let* ((case-fold-search nil)
3770 (df (directory-files (save-excursion (set-buffer buffer)
3772 nil rmail-speedbar-match-folder-regexp)))
3774 (speedbar-insert-button "<M>" 'speedbar-button-face 'highlight
3775 'rmail-speedbar-move-message (car df))
3776 (speedbar-insert-button (car df) 'speedbar-file-face 'highlight
3777 'rmail-speedbar-find-file nil t)
3778 (setq df (cdr df)))))))
3780 (defun rmail-speedbar-button (text token indent)
3781 "Execute an rmail command specified by TEXT.
3782 The command used is TOKEN. INDENT is not used."
3783 (speedbar-with-attached-buffer
3786 (defun rmail-speedbar-find-file (text token indent)
3787 "Load in the rmail file TEXT.
3788 TOKEN and INDENT are not used."
3789 (speedbar-with-attached-buffer
3790 (message "Loading in RMAIL file %s..." text)
3793 (defun rmail-speedbar-move-message-to-folder-on-line ()
3794 "If the current line is a folder, move current message to it."
3798 (if (re-search-forward "<M> " (save-excursion (end-of-line) (point)) t)
3801 (speedbar-do-function-pointer)))))
3803 (defun rmail-speedbar-move-message (text token indent)
3804 "From button TEXT, copy current message to the rmail file specified by TOKEN.
3805 TEXT and INDENT are not used."
3806 (speedbar-with-attached-buffer
3807 (message "Moving message to %s" token)
3808 (rmail-output token)))
3810 ; Functions for setting, getting and encoding the POP password.
3811 ; The password is encoded to prevent it from being easily accessible
3812 ; to "prying eyes." Obviously, this encoding isn't "real security,"
3813 ; nor is it meant to be.
3816 (defun rmail-set-remote-password (password)
3817 "Set PASSWORD to be used for retrieving mail from a POP or IMAP server."
3818 (interactive "sPassword: ")
3820 (setq rmail-encoded-remote-password
3821 (rmail-encode-string password (emacs-pid)))
3822 (setq rmail-remote-password nil)
3823 (setq rmail-encoded-remote-password nil)))
3825 (defun rmail-get-remote-password (imap)
3826 "Get the password for retrieving mail from a POP or IMAP server. If none
3827 has been set, then prompt the user for one."
3828 (when (not rmail-encoded-remote-password)
3829 (if (not rmail-remote-password)
3830 (setq rmail-remote-password
3831 (read-passwd (if imap
3833 "POP password: "))))
3834 (rmail-set-remote-password rmail-remote-password)
3835 (setq rmail-remote-password nil))
3836 (rmail-encode-string rmail-encoded-remote-password (emacs-pid)))
3838 (defun rmail-have-password ()
3839 (or rmail-remote-password rmail-encoded-remote-password))
3841 (defun rmail-encode-string (string mask)
3842 "Encode STRING with integer MASK, by taking the exclusive OR of the
3843 lowest byte in the mask with the first character of string, the
3844 second-lowest-byte with the second character of the string, etc.,
3845 restarting at the lowest byte of the mask whenever it runs out.
3846 Returns the encoded string. Calling the function again with an
3847 encoded string (and the same mask) will decode the string."
3848 (setq mask (abs mask)) ; doesn't work if negative
3849 (let* ((string-vector (string-to-vector string)) (i 0)
3850 (len (length string-vector)) (curmask mask) charmask)
3853 (setq curmask mask))
3854 (setq charmask (% curmask 256))
3855 (setq curmask (lsh curmask -8))
3856 (aset string-vector i (logxor charmask (aref string-vector i)))
3858 (concat string-vector)))
3860 ;;;; Desktop support
3862 (defun rmail-restore-desktop-buffer (desktop-buffer-file-name
3864 desktop-buffer-misc)
3865 "Restore an rmail buffer specified in a desktop file."
3866 (condition-case error
3868 (rmail-input desktop-buffer-file-name)
3869 (if (eq major-mode 'rmail-mode)
3873 (kill-buffer (current-buffer))
3876 (add-to-list 'desktop-buffer-mode-handlers
3877 '(rmail-mode . rmail-restore-desktop-buffer))
3879 ;; Used in `write-region-annotate-functions' to write rmail files.
3880 (defun rmail-write-region-annotate (start end)
3881 (when (and (null start) (rmail-buffers-swapped-p))
3882 (set-buffer rmail-view-buffer)
3888 ;; arch-tag: 65d257d3-c281-4a65-9c38-e61af95af2f0
3889 ;;; rmail.el ends here