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.
43 (defconst rmail-attribute-header "X-RMAIL-ATTRIBUTES"
44 "The header that stores the Rmail attribute data.")
46 (defconst rmail-keyword-header "X-RMAIL-KEYWORDS"
47 "The header that stores the Rmail keyword data.")
51 (defconst rmail-answered-attr-index 0
52 "The index for the `answered' attribute.")
54 (defconst rmail-deleted-attr-index 1
55 "The index for the `deleted' attribute.")
57 (defconst rmail-edited-attr-index 2
58 "The index for the `edited' attribute.")
60 (defconst rmail-filed-attr-index 3
61 "The index for the `filed' attribute.")
63 (defconst rmail-retried-attr-index 4
64 "The index for the `retried' attribute.")
66 (defconst rmail-forwarded-attr-index 5
67 "The index for the `forwarded' attribute.")
69 (defconst rmail-unseen-attr-index 6
70 "The index for the `unseen' attribute.")
72 (defconst rmail-resent-attr-index 7
73 "The index for the `resent' attribute.")
75 (defconst rmail-attr-array
84 "An array that provides a mapping between an attribute index,
85 its character representation and its display representation.")
88 (defvar font-lock-fontified)
89 (defvar mail-abbrev-syntax-table)
91 (defvar messages-head)
92 (defvar rmail-use-spam-filter)
94 (defvar rsf-sleep-after-message)
95 (defvar total-messages)
98 (defvar rmail-header-style 'normal
99 "The current header display style choice, one of
100 'normal (selected headers) or 'full (all headers).")
102 ;; rmail-spool-directory and rmail-file-name are defined in paths.el.
105 "Mail reader for Emacs."
108 (defgroup rmail-retrieve nil
109 "Rmail retrieval options."
113 (defgroup rmail-files nil
118 (defgroup rmail-headers nil
119 "Rmail header options."
123 (defgroup rmail-reply nil
124 "Rmail reply options."
128 (defgroup rmail-summary nil
129 "Rmail summary options."
131 :prefix "rmail-summary-"
134 (defgroup rmail-output nil
135 "Output message to a file."
136 :prefix "rmail-output-"
140 (defgroup rmail-edit nil
142 :prefix "rmail-edit-"
145 (defgroup rmail-obsolete nil
146 "Rmail obsolete customization variables."
149 (defcustom rmail-movemail-program nil
150 "If non-nil, the file name of the `movemail' program."
151 :group 'rmail-retrieve
152 :type '(choice (const nil) string))
154 (defcustom rmail-pop-password nil
155 "Password to use when reading mail from POP server.
156 Please use `rmail-remote-password' instead."
157 :type '(choice (string :tag "Password")
158 (const :tag "Not Required" nil))
159 :group 'rmail-obsolete)
161 (defcustom rmail-pop-password-required nil
162 "Non-nil if a password is required when reading mail from a POP server.
163 Please use rmail-remote-password-required instead."
165 :group 'rmail-obsolete)
167 (defcustom rmail-remote-password nil
168 "Password to use when reading mail from a remote server.
169 This setting is ignored for mailboxes whose URL already contains a password."
170 :type '(choice (string :tag "Password")
171 (const :tag "Not Required" nil))
172 :set-after '(rmail-pop-password)
173 :set #'(lambda (symbol value)
176 (boundp 'rmail-pop-password)
180 (setq rmail-pop-password nil))
181 :group 'rmail-retrieve
184 (defcustom rmail-remote-password-required nil
185 "Non-nil if a password is required when reading mail from a remote server."
187 :set-after '(rmail-pop-password-required)
188 :set #'(lambda (symbol value)
191 (boundp 'rmail-pop-password-required)
192 rmail-pop-password-required)
193 rmail-pop-password-required
195 (setq rmail-pop-password-required nil))
196 :group 'rmail-retrieve
199 (defcustom rmail-movemail-flags nil
200 "List of flags to pass to movemail.
201 Most commonly used to specify `-g' to enable GSS-API authentication
202 or `-k' to enable Kerberos authentication."
203 :type '(repeat string)
204 :group 'rmail-retrieve
207 (defvar rmail-remote-password-error "invalid usercode or password\\|
208 unknown user name or bad password\\|Authentication failed\\|MU_ERR_AUTH_FAILURE"
209 "Regular expression matching incorrect-password POP or IMAP server error
211 If you get an incorrect-password error that this expression does not match,
212 please report it with \\[report-emacs-bug].")
214 (defvar rmail-encoded-remote-password nil)
216 (defcustom rmail-preserve-inbox nil
217 "Non-nil means leave incoming mail in the user's inbox--don't delete it."
219 :group 'rmail-retrieve)
221 (defcustom rmail-movemail-search-path nil
222 "List of directories to search for movemail (in addition to `exec-path')."
223 :group 'rmail-retrieve
224 :type '(repeat (directory)))
226 (declare-function mail-position-on-field "sendmail" (field &optional soft))
227 (declare-function mail-text-start "sendmail" ())
228 (declare-function rmail-dont-reply-to "mail-utils" (destinations))
229 (declare-function rmail-update-summary "rmailsum" (&rest ignore))
231 (defun rmail-probe (prog)
232 "Determine what flavor of movemail PROG is.
233 We do this by executing it with `--version' and analyzing its output."
235 (let ((tbuf (current-buffer)))
236 (buffer-disable-undo tbuf)
237 (call-process prog nil tbuf nil "--version")
238 (if (not (buffer-modified-p tbuf))
239 ;; Should not happen...
241 (goto-char (point-min))
243 ((looking-at ".*movemail: invalid option")
244 'emacs) ;; Possibly...
245 ((looking-at "movemail (GNU Mailutils .*)")
251 (defun rmail-autodetect ()
252 "Determine the file name of the `movemail' program and return its flavor.
253 If `rmail-movemail-program' is non-nil, use it.
254 Otherwise, look for `movemail' in the directories in
255 `rmail-movemail-search-path', those in `exec-path', and `exec-directory'."
256 (if rmail-movemail-program
257 (rmail-probe rmail-movemail-program)
259 (dolist (dir (append rmail-movemail-search-path exec-path
260 (list exec-directory)))
261 (when (and dir (file-accessible-directory-p dir))
262 ;; Previously, this didn't have to work on Windows, because
263 ;; rmail-insert-inbox-text before r1.439 fell back to using
264 ;; (expand-file-name "movemail" exec-directory) and just
265 ;; assuming it would work.
266 ;; http://lists.gnu.org/archive/html/bug-gnu-emacs/2008-02/msg00087.html
267 (let ((progname (expand-file-name
269 (if (memq system-type '(ms-dos windows-nt))
271 (when (and (not (file-directory-p progname))
272 (file-executable-p progname))
273 (let ((x (rmail-probe progname)))
275 (setq rmail-movemail-program progname)
276 (throw 'scan x))))))))))
278 (defvar rmail-movemail-variant-in-use nil
279 "The movemail variant currently in use. Known variants are:
281 `emacs' Means any implementation, compatible with the native Emacs one.
283 `mailutils' Means GNU mailutils implementation, capable of handling full
284 mail URLs as the source mailbox.")
287 (defun rmail-movemail-variant-p (&rest variants)
288 "Return t if the current movemail variant is any of VARIANTS.
289 Currently known variants are 'emacs and 'mailutils."
290 (when (not rmail-movemail-variant-in-use)
292 (setq rmail-movemail-variant-in-use (rmail-autodetect)))
293 (not (null (member rmail-movemail-variant-in-use variants))))
295 ;; Call for effect, to set rmail-movemail-program (if not set by the
296 ;; user), and rmail-movemail-variant-in-use. Used by various functions.
297 ;; I'm not sure if M-x rmail is the only entry point to this package.
298 ;; If so, this can be moved there.
299 (rmail-movemail-variant-p)
302 (defcustom rmail-dont-reply-to-names nil
303 "A regexp specifying addresses to prune from a reply message.
304 A value of nil means exclude your own email address as an address
305 plus whatever is specified by `rmail-default-dont-reply-to-names'."
306 :type '(choice regexp (const :tag "Your Name" nil))
310 (defvar rmail-default-dont-reply-to-names "\\`info-"
311 "A regular expression specifying part of the default value of the
312 variable `rmail-dont-reply-to-names', for when the user does not set
313 `rmail-dont-reply-to-names' explicitly. (The other part of the default
314 value is the user's email address and name.)
315 It is useful to set this variable in the site customization file.")
318 (defcustom rmail-ignored-headers
319 (concat "^via:\\|^mail-from:\\|^origin:\\|^references:\\|^sender:"
320 "\\|^status:\\|^received:\\|^x400-originator:\\|^x400-recipients:"
321 "\\|^x400-received:\\|^x400-mts-identifier:\\|^x400-content-type:"
322 "\\|^\\(resent-\\|\\)message-id:\\|^summary-line:\\|^resent-date:"
323 "\\|^nntp-posting-host:\\|^path:\\|^x-char.*:\\|^x-face:\\|^face:"
324 "\\|^x-mailer:\\|^delivered-to:\\|^lines:"
325 "\\|^content-transfer-encoding:\\|^x-coding-system:"
326 "\\|^return-path:\\|^errors-to:\\|^return-receipt-to:"
327 "\\|^precedence:\\|^mime-version:"
328 "\\|^list-owner:\\|^list-help:\\|^list-post:\\|^list-subscribe:"
329 "\\|^list-id:\\|^list-unsubscribe:\\|^list-archive:"
330 "\\|^content-length:\\|^nntp-posting-date:\\|^user-agent"
331 "\\|^importance:\\|^envelope-to:\\|^delivery-date\\|^openpgp:"
332 "\\|^mbox-line:\\|^cancel-lock:"
333 "\\|^DomainKey-Signature:\\|^dkim-signature:"
334 "\\|^resent-face:\\|^resent-x.*:\\|^resent-organization:\\|^resent-openpgp:"
336 "Regexp to match header fields that Rmail should normally hide.
337 \(See also `rmail-nonignored-headers', which overrides this regexp.)
338 This variable is used for reformatting the message header,
339 which normally happens once for each message,
340 when you view the message for the first time in Rmail.
341 To make a change in this variable take effect
342 for a message that you have already viewed,
343 go to that message and type \\[rmail-toggle-header] twice."
345 :group 'rmail-headers)
347 (defcustom rmail-nonignored-headers "^x-spam-status:"
348 "Regexp to match X header fields that Rmail should show.
349 This regexp overrides `rmail-ignored-headers'; if both this regexp
350 and that one match a certain header field, Rmail shows the field.
351 If this is nil, ignore all header fields in `rmail-ignored-headers'.
353 This variable is used for reformatting the message header,
354 which normally happens once for each message,
355 when you view the message for the first time in Rmail.
356 To make a change in this variable take effect
357 for a message that you have already viewed,
358 go to that message and type \\[rmail-toggle-header] twice."
359 :type '(choice (const nil) (regexp))
360 :group 'rmail-headers)
363 (defcustom rmail-displayed-headers nil
364 "Regexp to match Header fields that Rmail should display.
365 If nil, display all header fields except those matched by
366 `rmail-ignored-headers'."
367 :type '(choice regexp (const :tag "All"))
368 :group 'rmail-headers)
371 (defcustom rmail-retry-ignored-headers "^x-authentication-warning:"
372 "Headers that should be stripped when retrying a failed message."
373 :type '(choice regexp (const nil :tag "None"))
374 :group 'rmail-headers)
377 (defcustom rmail-highlighted-headers "^From:\\|^Subject:"
378 "Regexp to match Header fields that Rmail should normally highlight.
379 A value of nil means don't highlight."
381 :group 'rmail-headers)
383 (defface rmail-highlight
384 '((t (:inherit highlight)))
385 "Face to use for highlighting the most important header fields."
386 :group 'rmail-headers
389 (defface rmail-header-name
390 '((t (:inherit font-lock-function-name-face)))
391 "Face to use for highlighting the header names."
392 :group 'rmail-headers
395 (defcustom rmail-delete-after-output nil
396 "Non-nil means automatically delete a message that is copied to a file."
401 (defcustom rmail-primary-inbox-list nil
402 "List of files which are inboxes for user's primary mail file `~/RMAIL'.
403 nil means the default, which is (\"/usr/spool/mail/$USER\")
404 \(the name varies depending on the operating system,
405 and the value of the environment variable MAIL overrides it)."
406 ;; Don't use backquote here, because we don't want to need it
408 :type (list 'choice '(const :tag "Default" nil)
409 (list 'repeat ':value (list (or (getenv "MAIL")
410 (concat "/var/spool/mail/"
413 :group 'rmail-retrieve
416 (defcustom rmail-mail-new-frame nil
417 "Non-nil means Rmail makes a new frame for composing outgoing mail.
418 This is handy if you want to preserve the window configuration of
419 the frame where you have the RMAIL buffer displayed."
424 (defcustom rmail-secondary-file-directory "~/"
425 "Directory for additional secondary Rmail files."
429 (defcustom rmail-secondary-file-regexp "\\.xmail$"
430 "Regexp for which files are secondary Rmail files."
434 (defcustom rmail-confirm-expunge 'y-or-n-p
435 "Whether and how to ask for confirmation before expunging deleted messages."
436 :type '(choice (const :tag "No confirmation" nil)
437 (const :tag "Confirm with y-or-n-p" y-or-n-p)
438 (const :tag "Confirm with yes-or-no-p" yes-or-no-p))
443 (defvar rmail-mode-hook nil
444 "List of functions to call when Rmail is invoked.")
446 (defvar rmail-get-new-mail-hook nil
447 "List of functions to call when Rmail has retrieved new mail.")
450 (defcustom rmail-show-message-hook nil
451 "List of functions to call when Rmail displays a message."
453 :options '(goto-address)
456 (defvar rmail-quit-hook nil
457 "List of functions to call when quitting out of Rmail.")
459 (defvar rmail-delete-message-hook nil
460 "List of functions to call when Rmail deletes a message.
461 When the hooks are called, the message has been marked deleted but is
462 still the current message in the Rmail buffer.")
464 ;; These may be altered by site-init.el to match the format of mmdf files
465 ;; delimiting used on a given host (delim1 and delim2 from the config
468 (defvar rmail-mmdf-delim1 "^\001\001\001\001\n"
469 "Regexp marking the start of an mmdf message.")
470 (defvar rmail-mmdf-delim2 "^\001\001\001\001\n"
471 "Regexp marking the end of an mmdf message.")
473 (defcustom rmail-message-filter nil
474 "If non-nil, a filter function for new messages in RMAIL.
475 Called with region narrowed to the message, including headers,
476 before obeying `rmail-ignored-headers'."
477 :group 'rmail-headers
478 :type '(choice (const nil) function))
480 (defcustom rmail-automatic-folder-directives nil
481 "List of directives specifying where to put a message.
482 Each element of the list is of the form:
484 (FOLDERNAME FIELD REGEXP [ FIELD REGEXP ] ... )
486 Where FOLDERNAME is the name of a folder to put the message.
487 If any of the field regexp's are nil, then it is ignored.
489 If FOLDERNAME is \"/dev/null\", it is deleted.
490 If FOLDERNAME is nil then it is deleted, and skipped.
492 FIELD is the plain text name of a field in the message, such as
493 \"subject\" or \"from\". A FIELD of \"to\" will automatically include
494 all text from the \"cc\" field as well.
496 REGEXP is an expression to match in the preceeding specified FIELD.
497 FIELD/REGEXP pairs continue in the list.
500 (\"/dev/null\" \"from\" \"@spam.com\") ; delete all mail from spam.com
501 (\"RMS\" \"from\" \"rms@\") ; save all mail from RMS."
504 :type '(repeat (sexp :tag "Directive")))
506 (defvar rmail-reply-prefix "Re: "
507 "String to prepend to Subject line when replying to a message.")
509 ;; Some mailers use "Re(2):" or "Re^2:" or "Re: Re:" or "Re[2]:".
510 ;; This pattern should catch all the common variants.
511 ;; rms: I deleted the change to delete tags in square brackets
512 ;; because they mess up RT tags.
513 (defvar rmail-reply-regexp "\\`\\(Re\\(([0-9]+)\\|\\[[0-9]+\\]\\|\\^[0-9]+\\)?: *\\)*"
514 "Regexp to delete from Subject line before inserting `rmail-reply-prefix'.")
516 (defcustom rmail-display-summary nil
517 "If non-nil, Rmail always displays the summary buffer."
518 :group 'rmail-summary
521 (defvar rmail-inbox-list nil)
522 (put 'rmail-inbox-list 'permanent-local t)
524 (defvar rmail-buffer nil
525 "The RMAIL buffer related to the current buffer.
526 In an RMAIL buffer, this holds the RMAIL buffer itself.
527 In a summary buffer, this holds the RMAIL buffer it is a summary for.")
528 (put 'rmail-buffer 'permanent-local t)
530 ;; Message counters and markers. Deleted flags.
532 (defvar rmail-current-message nil)
533 (put 'rmail-current-message 'permanent-local t)
535 (defvar rmail-total-messages nil)
536 (put 'rmail-total-messages 'permanent-local t)
538 (defvar rmail-message-vector nil)
539 (put 'rmail-message-vector 'permanent-local t)
541 (defvar rmail-deleted-vector nil)
542 (put 'rmail-deleted-vector 'permanent-local t)
544 (defvar rmail-msgref-vector nil
545 "In an Rmail buffer, a vector whose Nth element is a list (N).
546 When expunging renumbers messages, these lists are modified
547 by substituting the new message number into the existing list.")
548 (put 'rmail-msgref-vector 'permanent-local t)
550 (defvar rmail-overlay-list nil)
551 (put 'rmail-overlay-list 'permanent-local t)
553 ;; These are used by autoloaded rmail-summary.
555 (defvar rmail-summary-buffer nil)
556 (put 'rmail-summary-buffer 'permanent-local t)
557 (defvar rmail-summary-vector nil)
558 (put 'rmail-summary-vector 'permanent-local t)
560 ;; Rmail buffer swapping variables.
562 (defvar rmail-buffer-swapped nil
563 "If non-nil, `rmail-buffer' is swapped with `rmail-view-buffer'.")
564 (make-variable-buffer-local 'rmail-buffer-swapped)
565 (put 'rmail-buffer-swapped 'permanent-local t)
567 (defvar rmail-view-buffer nil
568 "Buffer which holds RMAIL message for MIME displaying.")
569 (make-variable-buffer-local 'rmail-view-buffer)
570 (put 'rmail-view-buffer 'permanent-local t)
572 ;; `Sticky' default variables.
574 ;; Last individual label specified to a or k.
575 (defvar rmail-last-label nil)
577 ;; Last set of values specified to C-M-n, C-M-p, C-M-s or C-M-l.
578 (defvar rmail-last-multi-labels nil)
580 (defvar rmail-last-regexp nil)
581 (put 'rmail-last-regexp 'permanent-local t)
583 (defcustom rmail-default-file "~/xmail"
584 "Default file name for \\[rmail-output]."
587 (defcustom rmail-default-body-file "~/mailout"
588 "Default file name for \\[rmail-output-body-to-file]."
593 ;; Mule and MIME related variables.
596 (defvar rmail-file-coding-system nil
597 "Coding system used in RMAIL file.
599 This is set to nil by default.")
601 (defcustom rmail-enable-mime nil
602 "If non-nil, RMAIL uses MIME features.
603 If the value is t, RMAIL automatically shows MIME decoded message.
604 If the value is neither t nor nil, RMAIL does not show MIME decoded message
605 until a user explicitly requires it.
607 Even if the value is non-nil, you can't use MIME features
608 unless the feature specified by `rmail-mime-feature' is available."
609 :type '(choice (const :tag "on" t)
610 (const :tag "off" nil)
611 (other :tag "when asked" ask))
614 (defvar rmail-enable-mime-composing nil
615 "*If non-nil, RMAIL uses `rmail-insert-mime-forwarded-message-function' to forward.")
618 (defvar rmail-show-mime-function nil
619 "Function to show MIME decoded message of RMAIL file.
620 This function is called when `rmail-enable-mime' is non-nil.
621 It is called with no argument.")
624 (defvar rmail-insert-mime-forwarded-message-function nil
625 "Function to insert a message in MIME format so it can be forwarded.
626 This function is called if `rmail-enable-mime' or
627 `rmail-enable-mime-composing' is non-nil.
628 It is called with one argument FORWARD-BUFFER, which is a
629 buffer containing the message to forward. The current buffer
630 is the outgoing mail buffer.")
632 (defvar rmail-insert-mime-resent-message-function nil
633 "Function to insert a message in MIME format so it can be resent.
634 This function is called by `rmail-resend' if `rmail-enable-mime' is non-nil.
635 It is called with one argument FORWARD-BUFFER, which is a
636 buffer containing the message to forward. The current buffer
637 is the outgoing mail buffer.")
639 ;; FIXME one might want to pass a LIMIT, as per
640 ;; rmail-search-mime-header-function.
641 (defvar rmail-search-mime-message-function nil
642 "Function to check if a regexp matches a MIME message.
643 This function is called by `rmail-search-message' if
644 `rmail-enable-mime' is non-nil. It is called (with point at the
645 start of the message) with two arguments MSG and REGEXP, where
646 MSG is the message number, REGEXP is the regular expression.")
648 (defvar rmail-search-mime-header-function nil
649 "Function to check if a regexp matches a header of MIME message.
650 This function is called by `rmail-message-regexp-p-1' if
651 `rmail-enable-mime' is non-nil. It is called (with point at the
652 start of the header) with three arguments MSG, REGEXP, and LIMIT,
653 where MSG is the message number, REGEXP is the regular
654 expression, LIMIT is the position specifying the end of header.")
656 (defvar rmail-mime-feature 'rmail-mime
657 "Feature to require to load MIME support in Rmail.
658 When starting Rmail, if `rmail-enable-mime' is non-nil,
659 this feature is required with `require'.
661 The default value is `rmail-mime'. This feature is provided by
662 the rmail-mime package available at <http://www.m17n.org/rmail-mime/>.")
664 ;; FIXME this is unused.
665 (defvar rmail-decode-mime-charset t
666 "*Non-nil means a message is decoded by MIME's charset specification.
667 If this variable is nil, or the message has not MIME specification,
668 the message is decoded as normal way.
670 If the variable `rmail-enable-mime' is non-nil, this variable is
671 ignored, and all the decoding work is done by a feature specified by
672 the variable `rmail-mime-feature'.")
674 (defvar rmail-mime-charset-pattern
675 (concat "^content-type:[ \t]*text/plain;"
676 "\\(?:[ \t\n]*\\(?:format\\|delsp\\)=\"?[-a-z0-9]+\"?;\\)*"
677 "[ \t\n]*charset=\"?\\([^ \t\n\";]+\\)\"?")
678 "Regexp to match MIME-charset specification in a header of message.
679 The first parenthesized expression should match the MIME-charset name.")
682 (defvar rmail-unix-mail-delimiter
683 (let ((time-zone-regexp
684 (concat "\\([A-Z]?[A-Z]?[A-Z][A-Z]\\( DST\\)?"
685 "\\|[-+]?[0-9][0-9][0-9][0-9]"
691 ;; Many things can happen to an RFC 822 mailbox before it is put into
692 ;; a `From' line. The leading phrase can be stripped, e.g.
693 ;; `Joe <@w.x:joe@y.z>' -> `<@w.x:joe@y.z>'. The <> can be stripped, e.g.
694 ;; `<@x.y:joe@y.z>' -> `@x.y:joe@y.z'. Everything starting with a CRLF
695 ;; can be removed, e.g.
696 ;; From: joe@y.z (Joe K
698 ;; can yield `From joe@y.z (Joe K Fri Mar 22 08:11:15 1996', and
701 ;; can yield `From Joe User Fri Mar 22 08:11:15 1996'.
702 ;; The mailbox can be removed or be replaced by white space, e.g.
703 ;; From: "Joe User"{space}{tab}
705 ;; can yield `From {space}{tab} Fri Mar 22 08:11:15 1996',
706 ;; where {space} and {tab} represent the Ascii space and tab characters.
707 ;; We want to match the results of any of these manglings.
708 ;; The following regexp rejects names whose first characters are
709 ;; obviously bogus, but after that anything goes.
710 "\\([^\0-\b\n-\r\^?].*\\)? "
712 ;; The time the message was sent.
713 "\\([^\0-\r \^?]+\\) +" ; day of the week
714 "\\([^\0-\r \^?]+\\) +" ; month
715 "\\([0-3]?[0-9]\\) +" ; day of month
716 "\\([0-2][0-9]:[0-5][0-9]\\(:[0-6][0-9]\\)?\\) *" ; time of day
718 ;; Perhaps a time zone, specified by an abbreviation, or by a
723 " \\([0-9][0-9]+\\) *"
725 ;; On some systems the time zone can appear after the year, too.
729 "\\(remote from .*\\)?"
732 "Regexp matching the delimiter of messages in UNIX mail format
733 \(UNIX From lines), minus the initial ^. Note that if you change
734 this expression, you must change the code in rmail-nuke-pinhead-header
735 that knows the exact ordering of the \\( \\) subexpressions.")
737 (defvar rmail-font-lock-keywords
738 ;; These are all matched case-insensitively.
740 (let* ((cite-chars "[>|}]")
742 (cite-suffix (concat cite-prefix "0-9_.@-`'\"")))
743 (list '("^\\(From\\|Sender\\|Resent-From\\):"
744 . 'rmail-header-name)
745 '("^Reply-To:.*$" . 'rmail-header-name)
746 '("^Subject:" . 'rmail-header-name)
747 '("^X-Spam-Status:" . 'rmail-header-name)
748 '("^\\(To\\|Apparently-To\\|Cc\\|Newsgroups\\):"
749 . 'rmail-header-name)
750 ;; Use MATCH-ANCHORED to effectively anchor the regexp left side.
752 (,(concat "\\=[ \t]*"
753 "\\(\\(\\([" cite-prefix "]+[" cite-suffix "]*\\)?"
754 "\\(" cite-chars "[ \t]*\\)\\)+\\)"
756 (beginning-of-line) (end-of-line)
757 (1 font-lock-comment-delimiter-face nil t)
758 (5 font-lock-comment-face nil t)))
759 '("^\\(X-[a-z0-9-]+\\|In-reply-to\\|Date\\):.*\\(\n[ \t]+.*\\)*$"
760 . 'rmail-header-name))))
761 "Additional expressions to highlight in Rmail mode.")
763 ;; Perform BODY in the summary buffer
764 ;; in such a way that its cursor is properly updated in its own window.
765 (defmacro rmail-select-summary (&rest body)
766 `(let ((total rmail-total-messages))
767 (if (rmail-summary-displayed)
768 (let ((window (selected-window)))
772 (pop-to-buffer rmail-summary-buffer)
773 ;; rmail-total-messages is a buffer-local var
774 ;; in the rmail buffer.
775 ;; This way we make it available for the body
776 ;; even tho the rmail buffer is not current.
777 (let ((rmail-total-messages total))
779 (select-window window))))
780 (with-current-buffer rmail-summary-buffer
781 (let ((rmail-total-messages total))
783 (rmail-maybe-display-summary)))
785 ;;;; *** Rmail Mode ***
787 ;; This variable is dynamically bound. The defvar is here to placate
788 ;; the byte compiler.
790 (defvar rmail-enable-multibyte nil)
793 (defun rmail-require-mime-maybe ()
794 "Require `rmail-mime-feature' if that is non-nil.
795 Signal an error and set `rmail-mime-feature' to nil if the feature
797 (when rmail-enable-mime
799 (require rmail-mime-feature)
803 (format "Although MIME support is requested
804 by setting `rmail-enable-mime' to non-nil, the required feature
805 `%s' (the value of `rmail-mime-feature')
806 is not available in the current session.
807 So, the MIME support is turned off for the moment."
810 (setq rmail-enable-mime nil)))))
814 (defun rmail (&optional file-name-arg)
815 "Read and edit incoming mail.
816 Moves messages into file named by `rmail-file-name' and edits that
818 Type \\[describe-mode] once editing that file, for a list of RMAIL commands.
820 May be called with file name as argument; then performs rmail editing on
821 that file, but does not copy any new mail into the file.
822 Interactively, if you supply a prefix argument, then you
823 have a chance to specify a file name with the minibuffer.
825 If `rmail-display-summary' is non-nil, make a summary for this RMAIL file."
826 (interactive (if current-prefix-arg
827 (list (read-file-name "Run rmail on RMAIL file: "))))
828 (rmail-require-mime-maybe)
829 (let* ((file-name (expand-file-name (or file-name-arg rmail-file-name)))
830 ;; Use find-buffer-visiting, not get-file-buffer, for those users
831 ;; who have find-file-visit-truename set to t.
832 (existed (find-buffer-visiting file-name))
833 run-mail-hook mail-buf msg-shown)
834 ;; Determine if an existing mail file has been changed behind the
836 (if (and existed (not (verify-visited-file-modtime existed)))
837 ;; The mail file has been changed. Revisit it and reset the
838 ;; message state variables when in rmail mode.
840 (find-file file-name)
841 (when (and (verify-visited-file-modtime existed)
842 (eq major-mode 'rmail-mode))
843 (rmail-set-message-counters)))
844 ;; The mail file is either unchanged or not visited. Visit it.
846 (let ((enable-local-variables nil))
847 (find-file-noselect file-name))))
848 ;; Ensure that the collection and view buffers are in sync and
849 ;; ensure that a message is not being edited.
850 (if (eq major-mode 'rmail-mode)
851 (rmail-swap-buffers-maybe))
852 (if (eq major-mode 'rmail-edit-mode)
853 (error "Exit Rmail Edit mode before getting new mail"))
854 (or (and existed (> (buffer-size) 0))
855 (setq run-mail-hook t))
856 ;; Ensure that the Rmail file is in mbox format, the buffer is in
857 ;; Rmail mode and has been scanned to find all the messages
858 ;; (setting the global message variables in the process).
859 (rmail-convert-file-maybe)
860 (unless (eq major-mode 'rmail-mode)
862 (goto-char (point-max))
863 (rmail-maybe-set-message-counters)
864 (setq mail-buf rmail-buffer)
865 ;; Show the first unread message and process summary mode.
867 ;; Only get new mail when there is not a file name argument.
868 (unless file-name-arg
869 (rmail-get-new-mail))
871 (set-buffer mail-buf)
872 (rmail-show-message-maybe (rmail-first-unseen-message))
873 (if rmail-display-summary (rmail-summary))
874 (rmail-construct-io-menu)
876 (run-hooks 'rmail-mode-hook))))))
878 (defun rmail-convert-file-maybe ()
879 "Determine if the file needs to be converted to mbox format."
881 (goto-char (point-min))
882 ;; Detect previous Babyl format files.
883 (cond ((looking-at "BABYL OPTIONS:")
884 ;; The file is Babyl version 5. Use unrmail to convert
886 (rmail-convert-babyl-to-mbox))
887 ((looking-at "Version: 5\n")
888 ;; Losing babyl file made by old version of Rmail. Fix the
889 ;; babyl file header and use unrmail to convert to mbox
891 (let ((buffer-read-only nil))
892 (insert "BABYL OPTIONS: -*- rmail -*-\n")
893 (rmail-convert-babyl-to-mbox)))
894 ((equal (point-min) (point-max))
895 (message "Empty Rmail file."))
896 ((looking-at "From "))
897 (t (error "Invalid mbox file"))))
899 (defun rmail-error-bad-format (&optional msgnum)
900 "Report that the buffer is not in the mbox file format.
901 MSGNUM, if present, indicates the malformed message."
903 (error "Message %d is not a valid RFC2822 message" msgnum)
904 (error "Message is not a valid RFC2822 message")))
906 (defun rmail-convert-babyl-to-mbox ()
907 "Convert the mail file from Babyl version 5 to mbox.
908 This function also reinitializes local variables used by Rmail."
909 (unless (y-or-n-p "Babyl mail file detected. Rmail now uses mbox format for mail files.
910 Convert Babyl mail file to mbox format? ")
912 (let ((old-file (make-temp-file "rmail"))
913 (new-file (make-temp-file "rmail")))
916 (kill-all-local-variables)
917 (write-region (point-min) (point-max) old-file)
918 (unrmail old-file new-file)
919 (message "Replacing BABYL format with mbox format...")
920 (let ((inhibit-read-only t)
921 (coding-system-for-read 'raw-text)
922 (buffer-undo-list t))
924 (insert-file-contents new-file)
925 ;; Rmail buffers need to be saved with Unix EOLs, or else
926 ;; the format will not be recognized.
927 (set-buffer-file-coding-system 'raw-text-unix)
929 (rmail-perm-variables)
931 (goto-char (point-max))
932 (rmail-set-message-counters))
933 (message "Replacing BABYL format with mbox format...done"))
934 (delete-file old-file)
935 (delete-file new-file))))
937 (defun rmail-get-coding-system ()
938 "Return a suitable coding system to use for the current mail message.
939 The buffer is expected to be narrowed to just the header of the message."
941 (goto-char (point-min))
942 (if (re-search-forward rmail-mime-charset-pattern nil t)
943 (coding-system-from-name (match-string 1))
946 ;;; Set up Rmail mode keymaps
948 (defvar rmail-mode-map
949 (let ((map (make-keymap)))
950 (suppress-keymap map)
951 (define-key map "a" 'rmail-add-label)
952 (define-key map "b" 'rmail-bury)
953 (define-key map "c" 'rmail-continue)
954 (define-key map "d" 'rmail-delete-forward)
955 (define-key map "\C-d" 'rmail-delete-backward)
956 (define-key map "e" 'rmail-edit-current-message)
957 (define-key map "f" 'rmail-forward)
958 (define-key map "g" 'rmail-get-new-mail)
959 (define-key map "h" 'rmail-summary)
960 (define-key map "i" 'rmail-input)
961 (define-key map "j" 'rmail-show-message-maybe)
962 (define-key map "k" 'rmail-kill-label)
963 (define-key map "l" 'rmail-summary-by-labels)
964 (define-key map "\e\C-h" 'rmail-summary)
965 (define-key map "\e\C-l" 'rmail-summary-by-labels)
966 (define-key map "\e\C-r" 'rmail-summary-by-recipients)
967 (define-key map "\e\C-s" 'rmail-summary-by-regexp)
968 (define-key map "\e\C-t" 'rmail-summary-by-topic)
969 (define-key map "m" 'rmail-mail)
970 (define-key map "\em" 'rmail-retry-failure)
971 (define-key map "n" 'rmail-next-undeleted-message)
972 (define-key map "\en" 'rmail-next-message)
973 (define-key map "\e\C-n" 'rmail-next-labeled-message)
974 (define-key map "o" 'rmail-output)
975 (define-key map "\C-o" 'rmail-output-as-seen)
976 (define-key map "p" 'rmail-previous-undeleted-message)
977 (define-key map "\ep" 'rmail-previous-message)
978 (define-key map "\e\C-p" 'rmail-previous-labeled-message)
979 (define-key map "q" 'rmail-quit)
980 (define-key map "r" 'rmail-reply)
981 ;; I find I can't live without the default M-r command -- rms.
982 ;; (define-key rmail-mode-map "\er" 'rmail-search-backwards)
983 (define-key map "s" 'rmail-expunge-and-save)
984 (define-key map "\es" 'rmail-search)
985 (define-key map "t" 'rmail-toggle-header)
986 (define-key map "u" 'rmail-undelete-previous-message)
987 (define-key map "w" 'rmail-output-body-to-file)
988 (define-key map "\C-c\C-w" 'rmail-widen)
989 (define-key map "x" 'rmail-expunge)
990 (define-key map "." 'rmail-beginning-of-message)
991 (define-key map "/" 'rmail-end-of-message)
992 (define-key map "<" 'rmail-first-message)
993 (define-key map ">" 'rmail-last-message)
994 (define-key map " " 'scroll-up)
995 (define-key map "\177" 'scroll-down)
996 (define-key map "?" 'describe-mode)
997 (define-key map "\C-c\C-s\C-d" 'rmail-sort-by-date)
998 (define-key map "\C-c\C-s\C-s" 'rmail-sort-by-subject)
999 (define-key map "\C-c\C-s\C-a" 'rmail-sort-by-author)
1000 (define-key map "\C-c\C-s\C-r" 'rmail-sort-by-recipient)
1001 (define-key map "\C-c\C-s\C-c" 'rmail-sort-by-correspondent)
1002 (define-key map "\C-c\C-s\C-l" 'rmail-sort-by-lines)
1003 (define-key map "\C-c\C-s\C-k" 'rmail-sort-by-labels)
1004 (define-key map "\C-c\C-n" 'rmail-next-same-subject)
1005 (define-key map "\C-c\C-p" 'rmail-previous-same-subject)
1008 (define-key map [menu-bar] (make-sparse-keymap))
1010 (define-key map [menu-bar classify]
1011 (cons "Classify" (make-sparse-keymap "Classify")))
1013 (define-key map [menu-bar classify input-menu]
1016 (define-key map [menu-bar classify output-menu]
1019 (define-key map [menu-bar classify output-body]
1020 '("Output body to file..." . rmail-output-body-to-file))
1022 (define-key map [menu-bar classify output-inbox]
1023 '("Output..." . rmail-output))
1025 (define-key map [menu-bar classify output]
1026 '("Output as seen..." . rmail-output-as-seen))
1028 (define-key map [menu-bar classify kill-label]
1029 '("Kill Label..." . rmail-kill-label))
1031 (define-key map [menu-bar classify add-label]
1032 '("Add Label..." . rmail-add-label))
1034 (define-key map [menu-bar summary]
1035 (cons "Summary" (make-sparse-keymap "Summary")))
1037 (define-key map [menu-bar summary senders]
1038 '("By Senders..." . rmail-summary-by-senders))
1040 (define-key map [menu-bar summary labels]
1041 '("By Labels..." . rmail-summary-by-labels))
1043 (define-key map [menu-bar summary recipients]
1044 '("By Recipients..." . rmail-summary-by-recipients))
1046 (define-key map [menu-bar summary topic]
1047 '("By Topic..." . rmail-summary-by-topic))
1049 (define-key map [menu-bar summary regexp]
1050 '("By Regexp..." . rmail-summary-by-regexp))
1052 (define-key map [menu-bar summary all]
1053 '("All" . rmail-summary))
1055 (define-key map [menu-bar mail]
1056 (cons "Mail" (make-sparse-keymap "Mail")))
1058 (define-key map [menu-bar mail rmail-get-new-mail]
1059 '("Get New Mail" . rmail-get-new-mail))
1061 (define-key map [menu-bar mail lambda]
1064 (define-key map [menu-bar mail continue]
1065 '("Continue" . rmail-continue))
1067 (define-key map [menu-bar mail resend]
1068 '("Re-send..." . rmail-resend))
1070 (define-key map [menu-bar mail forward]
1071 '("Forward" . rmail-forward))
1073 (define-key map [menu-bar mail retry]
1074 '("Retry" . rmail-retry-failure))
1076 (define-key map [menu-bar mail reply]
1077 '("Reply" . rmail-reply))
1079 (define-key map [menu-bar mail mail]
1080 '("Mail" . rmail-mail))
1082 (define-key map [menu-bar delete]
1083 (cons "Delete" (make-sparse-keymap "Delete")))
1085 (define-key map [menu-bar delete expunge/save]
1086 '("Expunge/Save" . rmail-expunge-and-save))
1088 (define-key map [menu-bar delete expunge]
1089 '("Expunge" . rmail-expunge))
1091 (define-key map [menu-bar delete undelete]
1092 '("Undelete" . rmail-undelete-previous-message))
1094 (define-key map [menu-bar delete delete]
1095 '("Delete" . rmail-delete-forward))
1097 (define-key map [menu-bar move]
1098 (cons "Move" (make-sparse-keymap "Move")))
1100 (define-key map [menu-bar move search-back]
1101 '("Search Back..." . rmail-search-backwards))
1103 (define-key map [menu-bar move search]
1104 '("Search..." . rmail-search))
1106 (define-key map [menu-bar move previous]
1107 '("Previous Nondeleted" . rmail-previous-undeleted-message))
1109 (define-key map [menu-bar move next]
1110 '("Next Nondeleted" . rmail-next-undeleted-message))
1112 (define-key map [menu-bar move last]
1113 '("Last" . rmail-last-message))
1115 (define-key map [menu-bar move first]
1116 '("First" . rmail-first-message))
1118 (define-key map [menu-bar move previous]
1119 '("Previous" . rmail-previous-message))
1121 (define-key map [menu-bar move next]
1122 '("Next" . rmail-next-message))
1127 (defvar rmail-tool-bar-map
1128 (let ((map (make-sparse-keymap)))
1129 (tool-bar-local-item-from-menu 'rmail-get-new-mail "mail/inbox"
1131 (tool-bar-local-item-from-menu 'rmail-next-undeleted-message "right-arrow"
1133 (tool-bar-local-item-from-menu 'rmail-previous-undeleted-message "left-arrow"
1135 (tool-bar-local-item-from-menu 'rmail-search "search"
1137 (tool-bar-local-item-from-menu 'rmail-input "open"
1139 (tool-bar-local-item-from-menu 'rmail-mail "mail/compose"
1141 (tool-bar-local-item-from-menu 'rmail-reply "mail/reply-all"
1143 (tool-bar-local-item-from-menu 'rmail-forward "mail/forward"
1145 (tool-bar-local-item-from-menu 'rmail-delete-forward "close"
1147 (tool-bar-local-item-from-menu 'rmail-output "mail/move"
1149 (tool-bar-local-item-from-menu 'rmail-output-body-to-file "mail/save"
1151 (tool-bar-local-item-from-menu 'rmail-expunge "delete"
1157 ;; Rmail mode is suitable only for specially formatted data.
1158 (put 'rmail-mode 'mode-class 'special)
1160 (defun rmail-mode-kill-summary ()
1161 (if rmail-summary-buffer (kill-buffer rmail-summary-buffer)))
1164 (defun rmail-mode ()
1165 "Rmail Mode is used by \\<rmail-mode-map>\\[rmail] for editing Rmail files.
1166 All normal editing commands are turned off.
1167 Instead, these commands are available:
1169 \\[rmail-beginning-of-message] Move point to front of this message.
1170 \\[rmail-end-of-message] Move point to bottom of this message.
1171 \\[scroll-up] Scroll to next screen of this message.
1172 \\[scroll-down] Scroll to previous screen of this message.
1173 \\[rmail-next-undeleted-message] Move to Next non-deleted message.
1174 \\[rmail-previous-undeleted-message] Move to Previous non-deleted message.
1175 \\[rmail-next-message] Move to Next message whether deleted or not.
1176 \\[rmail-previous-message] Move to Previous message whether deleted or not.
1177 \\[rmail-first-message] Move to the first message in Rmail file.
1178 \\[rmail-last-message] Move to the last message in Rmail file.
1179 \\[rmail-show-message-maybe] Jump to message specified by numeric position in file.
1180 \\[rmail-search] Search for string and show message it is found in.
1181 \\[rmail-delete-forward] Delete this message, move to next nondeleted.
1182 \\[rmail-delete-backward] Delete this message, move to previous nondeleted.
1183 \\[rmail-undelete-previous-message] Undelete message. Tries current message, then earlier messages
1184 till a deleted message is found.
1185 \\[rmail-edit-current-message] Edit the current message. \\[rmail-cease-edit] to return to Rmail.
1186 \\[rmail-expunge] Expunge deleted messages.
1187 \\[rmail-expunge-and-save] Expunge and save the file.
1188 \\[rmail-quit] Quit Rmail: expunge, save, then switch to another buffer.
1189 \\[save-buffer] Save without expunging.
1190 \\[rmail-get-new-mail] Move new mail from system spool directory into this file.
1191 \\[rmail-mail] Mail a message (same as \\[mail-other-window]).
1192 \\[rmail-continue] Continue composing outgoing message started before.
1193 \\[rmail-reply] Reply to this message. Like \\[rmail-mail] but initializes some fields.
1194 \\[rmail-retry-failure] Send this message again. Used on a mailer failure message.
1195 \\[rmail-forward] Forward this message to another user.
1196 \\[rmail-output] Output (append) this message to another mail file.
1197 \\[rmail-output-as-seen] Output (append) this message to file as it's displayed.
1198 \\[rmail-output-body-to-file] Save message body to a file. Default filename comes from Subject line.
1199 \\[rmail-input] Input Rmail file. Run Rmail on that file.
1200 \\[rmail-add-label] Add label to message. It will be displayed in the mode line.
1201 \\[rmail-kill-label] Kill label. Remove a label from current message.
1202 \\[rmail-next-labeled-message] Move to Next message with specified label
1203 (label defaults to last one specified).
1204 Standard labels: filed, unseen, answered, forwarded, deleted.
1205 Any other label is present only if you add it with \\[rmail-add-label].
1206 \\[rmail-previous-labeled-message] Move to Previous message with specified label
1207 \\[rmail-summary] Show headers buffer, with a one line summary of each message.
1208 \\[rmail-summary-by-labels] Summarize only messages with particular label(s).
1209 \\[rmail-summary-by-recipients] Summarize only messages with particular recipient(s).
1210 \\[rmail-summary-by-regexp] Summarize only messages with particular regexp(s).
1211 \\[rmail-summary-by-topic] Summarize only messages with subject line regexp(s).
1212 \\[rmail-toggle-header] Toggle display of complete header."
1214 (let ((finding-rmail-file (not (eq major-mode 'rmail-mode))))
1216 (when (and finding-rmail-file
1217 (null coding-system-for-read)
1218 default-enable-multibyte-characters)
1219 (let ((rmail-enable-multibyte t))
1220 (rmail-require-mime-maybe)
1221 (rmail-convert-file-maybe)
1222 (goto-char (point-max))
1223 (set-buffer-multibyte t)))
1224 (rmail-set-message-counters)
1225 (rmail-show-message-maybe rmail-total-messages)
1226 (when finding-rmail-file
1227 (when rmail-display-summary
1229 (rmail-construct-io-menu))
1230 (run-mode-hooks 'rmail-mode-hook)))
1232 (defun rmail-mode-2 ()
1233 (kill-all-local-variables)
1235 (rmail-perm-variables)
1238 (defun rmail-mode-1 ()
1239 (setq major-mode 'rmail-mode)
1240 (setq mode-name "RMAIL")
1241 (setq buffer-read-only t)
1242 ;; No need to auto save RMAIL files in normal circumstances
1243 ;; because they contain no info except attribute changes
1244 ;; and deletion of messages.
1245 ;; The one exception is when messages are copied into another mbox buffer.
1246 ;; rmail-output enables auto save when you do that.
1247 (setq buffer-auto-save-file-name nil)
1248 (use-local-map rmail-mode-map)
1249 (set-syntax-table text-mode-syntax-table)
1250 (setq local-abbrev-table text-mode-abbrev-table)
1251 ;; Functions to support buffer swapping:
1252 (add-hook 'write-region-annotate-functions
1253 'rmail-write-region-annotate nil t)
1254 (add-hook 'kill-buffer-hook 'rmail-mode-kill-buffer-hook nil t)
1255 (add-hook 'change-major-mode-hook 'rmail-change-major-mode-hook nil t))
1257 (defun rmail-generate-viewer-buffer ()
1258 "Return a reusable buffer suitable for viewing messages.
1259 Create the buffer if necessary."
1260 (let* ((suffix (file-name-nondirectory (or buffer-file-name (buffer-name))))
1261 (name (format " *message-viewer %s*" suffix))
1262 (buf (get-buffer name)))
1264 (generate-new-buffer name))))
1266 (defun rmail-swap-buffers ()
1267 "Swap text between current buffer and `rmail-view-buffer'.
1268 This function preserves the current buffer's modified flag, and also
1269 sets the current buffer's `buffer-file-coding-system' to that of
1270 `rmail-view-buffer'."
1271 (let ((modp (buffer-modified-p))
1273 (with-current-buffer rmail-view-buffer
1274 buffer-file-coding-system)))
1275 (buffer-swap-text rmail-view-buffer)
1276 (setq buffer-file-coding-system coding)
1277 (restore-buffer-modified-p modp)))
1279 (defun rmail-buffers-swapped-p ()
1280 "Return non-nil if the message collection is in `rmail-view-buffer'."
1281 ;; This is analogous to tar-data-swapped-p in tar-mode.el.
1282 (and (buffer-live-p rmail-view-buffer)
1283 rmail-buffer-swapped))
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 (rmail-swap-buffers)
1289 (setq rmail-buffer-swapped nil)))
1291 (defun rmail-swap-buffers-maybe ()
1292 "Determine if the Rmail buffer is showing a message.
1293 If so restore the actual mbox message collection."
1294 (with-current-buffer rmail-buffer
1295 (when (rmail-buffers-swapped-p)
1296 (rmail-swap-buffers)
1297 (setq rmail-buffer-swapped nil))))
1299 (defun rmail-mode-kill-buffer-hook ()
1300 (if (buffer-live-p rmail-view-buffer) (kill-buffer rmail-view-buffer)))
1302 ;; Set up the permanent locals associated with an Rmail file.
1303 (defun rmail-perm-variables ()
1304 (make-local-variable 'rmail-last-regexp)
1305 (make-local-variable 'rmail-deleted-vector)
1306 (make-local-variable 'rmail-buffer)
1307 (setq rmail-buffer (current-buffer))
1308 (set-buffer-multibyte nil)
1309 (with-current-buffer (setq rmail-view-buffer (rmail-generate-viewer-buffer))
1310 (setq buffer-undo-list t)
1311 (set-buffer-multibyte t)
1312 ;; Force C-x C-s write Unix EOLs.
1313 (set-buffer-file-coding-system 'undecided-unix))
1314 (make-local-variable 'rmail-summary-buffer)
1315 (make-local-variable 'rmail-summary-vector)
1316 (make-local-variable 'rmail-current-message)
1317 (make-local-variable 'rmail-total-messages)
1318 (setq rmail-total-messages 0)
1319 (make-local-variable 'rmail-overlay-list)
1320 (setq rmail-overlay-list nil)
1321 (make-local-variable 'rmail-message-vector)
1322 (make-local-variable 'rmail-msgref-vector)
1323 (make-local-variable 'rmail-inbox-list)
1324 ;; Provide default set of inboxes for primary mail file ~/RMAIL.
1325 (and (null rmail-inbox-list)
1326 (or (equal buffer-file-name (expand-file-name rmail-file-name))
1327 (equal buffer-file-truename
1328 (abbreviate-file-name (file-truename rmail-file-name))))
1329 (setq rmail-inbox-list
1330 (or rmail-primary-inbox-list
1331 (list (or (getenv "MAIL")
1332 (concat rmail-spool-directory
1333 (user-login-name)))))))
1334 (set (make-local-variable 'tool-bar-map) rmail-tool-bar-map))
1336 ;; Set up the non-permanent locals associated with Rmail mode.
1337 (defun rmail-variables ()
1338 ;; Turn off undo. We turn it back on in rmail-edit.
1339 (setq buffer-undo-list t)
1340 ;; Don't let a local variables list in a message cause confusion.
1341 (make-local-variable 'local-enable-local-variables)
1342 (setq local-enable-local-variables nil)
1343 (make-local-variable 'revert-buffer-function)
1344 (setq revert-buffer-function 'rmail-revert)
1345 (make-local-variable 'font-lock-defaults)
1346 (setq font-lock-defaults
1347 '(rmail-font-lock-keywords
1349 (font-lock-maximum-size . nil)
1350 (font-lock-fontify-buffer-function . rmail-fontify-buffer-function)
1351 (font-lock-unfontify-buffer-function . rmail-unfontify-buffer-function)
1352 (font-lock-inhibit-thing-lock . (lazy-lock-mode fast-lock-mode))))
1353 (make-local-variable 'require-final-newline)
1354 (setq require-final-newline nil)
1355 (make-local-variable 'version-control)
1356 (setq version-control 'never)
1357 (make-local-variable 'kill-buffer-hook)
1358 (add-hook 'kill-buffer-hook 'rmail-mode-kill-summary)
1359 (make-local-variable 'file-precious-flag)
1360 (setq file-precious-flag t)
1361 (make-local-variable 'desktop-save-buffer)
1362 (setq desktop-save-buffer t))
1364 ;; Handle M-x revert-buffer done in an rmail-mode buffer.
1365 (defun rmail-revert (arg noconfirm)
1366 (set-buffer rmail-buffer)
1367 (let* ((revert-buffer-function (default-value 'revert-buffer-function))
1368 (rmail-enable-multibyte enable-multibyte-characters)
1369 ;; See similar code in `rmail'.
1370 (coding-system-for-read (and rmail-enable-multibyte 'raw-text)))
1371 ;; Call our caller again, but this time it does the default thing.
1372 (when (revert-buffer arg noconfirm)
1373 ;; If the user said "yes", and we changed something,
1374 ;; reparse the messages.
1375 (set-buffer rmail-buffer)
1377 ;; Convert all or part to Babyl file if possible.
1378 (rmail-convert-file-maybe)
1379 ;; We have read the file as raw-text, so the buffer is set to
1380 ;; unibyte. Make it multibyte if necessary.
1381 (if (and rmail-enable-multibyte
1382 (not enable-multibyte-characters))
1383 (set-buffer-multibyte t))
1384 (goto-char (point-max))
1385 (rmail-set-message-counters)
1386 (rmail-show-message-maybe rmail-total-messages)
1387 (run-hooks 'rmail-mode-hook))))
1389 (defun rmail-expunge-and-save ()
1390 "Expunge and save RMAIL file."
1392 (set-buffer rmail-buffer)
1394 ;; No need to swap buffers: rmail-write-region-annotate takes care of it.
1395 ;; (rmail-swap-buffers-maybe)
1397 (if (rmail-summary-exists)
1398 (rmail-select-summary (set-buffer-modified-p nil)))
1399 (rmail-show-message))
1401 (defun rmail-quit ()
1403 Hook `rmail-quit-hook' is run after expunging."
1405 (set-buffer rmail-buffer)
1407 (rmail-swap-buffers-maybe)
1409 (when (boundp 'rmail-quit-hook)
1410 (run-hooks 'rmail-quit-hook))
1411 ;; Don't switch to the summary buffer even if it was recently visible.
1412 (when rmail-summary-buffer
1413 (replace-buffer-in-windows rmail-summary-buffer)
1414 (bury-buffer rmail-summary-buffer))
1415 (if rmail-enable-mime
1416 (let ((obuf rmail-buffer)
1417 (ovbuf rmail-view-buffer))
1418 (set-buffer rmail-view-buffer)
1420 (replace-buffer-in-windows ovbuf)
1421 (replace-buffer-in-windows obuf)
1423 (let ((obuf (current-buffer)))
1425 (replace-buffer-in-windows obuf))))
1427 (defun rmail-bury ()
1428 "Bury current Rmail buffer and its summary buffer."
1430 ;; This let var was called rmail-buffer, but that interfered
1431 ;; with the buffer-local var used in summary buffers.
1432 (let ((buffer-to-bury (current-buffer)))
1433 (if (rmail-summary-exists)
1435 (while (setq window (get-buffer-window rmail-summary-buffer))
1436 (quit-window nil window))
1437 (bury-buffer rmail-summary-buffer)))
1440 (defun rmail-duplicate-message ()
1441 "Create a duplicated copy of the current message.
1442 The duplicate copy goes into the Rmail file just after the
1445 ;; If we are in a summary buffer, switch to the Rmail buffer.
1446 (set-buffer rmail-buffer)
1447 (let ((buff (current-buffer))
1448 (n rmail-current-message)
1449 (beg (rmail-msgbeg rmail-current-message))
1450 (end (rmail-msgend rmail-current-message)))
1451 (if (rmail-buffers-swapped-p) (set-buffer rmail-view-buffer))
1453 (let ((buffer-read-only nil)
1454 (string (buffer-substring-no-properties beg end)))
1458 (rmail-swap-buffers-maybe)
1459 (goto-char (point-max))
1460 (rmail-set-message-counters)
1461 (set-buffer-modified-p t)
1462 (rmail-show-message n))
1463 (if (rmail-summary-exists)
1464 (rmail-select-summary (rmail-update-summary)))
1465 (message "Message duplicated"))
1468 (defun rmail-input (filename)
1469 "Run Rmail on file FILENAME."
1470 (interactive "FRun rmail on RMAIL file: ")
1473 ;; This used to scan subdirectories recursively, but someone pointed out
1474 ;; that if the user wants that, person can put all the files in one dir.
1475 ;; And the recursive scan was slow. So I took it out.
1477 (defun rmail-find-all-files (start)
1478 "Return list of file in dir START that match `rmail-secondary-file-regexp'."
1479 (if (file-accessible-directory-p start)
1481 (let* ((case-fold-search t)
1482 (files (directory-files start t rmail-secondary-file-regexp)))
1483 ;; Sort here instead of in directory-files
1484 ;; because this list is usually much shorter.
1485 (sort files 'string<))))
1487 (defun rmail-list-to-menu (menu-name l action &optional full-name)
1488 (let ((menu (make-sparse-keymap menu-name)))
1495 (car item) (cdr item) action
1497 (concat full-name "/"
1503 (list 'lambda () '(interactive)
1507 (concat full-name "/" item)
1509 rmail-secondary-file-directory)))))
1510 (define-key menu (vector (intern name))
1511 (cons name command))))
1515 ;; This command is always "disabled" when it appears in a menu.
1516 (put 'rmail-disable-menu 'menu-enable ''nil)
1518 (defun rmail-construct-io-menu ()
1519 (let ((files (rmail-find-all-files rmail-secondary-file-directory)))
1522 (define-key rmail-mode-map [menu-bar classify input-menu]
1523 (cons "Input Rmail File"
1524 (rmail-list-to-menu "Input Rmail File"
1527 (define-key rmail-mode-map [menu-bar classify output-menu]
1528 (cons "Output Rmail File"
1529 (rmail-list-to-menu "Output Rmail File"
1533 (define-key rmail-mode-map [menu-bar classify input-menu]
1534 '("Input Rmail File" . rmail-disable-menu))
1535 (define-key rmail-mode-map [menu-bar classify output-menu]
1536 '("Output Rmail File" . rmail-disable-menu)))))
1539 ;;;; *** Rmail input ***
1541 (declare-function rmail-spam-filter "rmail-spam-filter" (msg))
1542 (declare-function rmail-summary-goto-msg "rmailsum" (&optional n nowarn skip-rmail))
1543 (declare-function rmail-summary-mark-undeleted "rmailsum" (n))
1544 (declare-function rmail-summary-mark-deleted "rmailsum" (&optional n undel))
1545 (declare-function rfc822-addresses "rfc822" (header-text))
1546 (declare-function mail-abbrev-make-syntax-table "mailabbrev.el" ())
1547 (declare-function mail-sendmail-delimit-header "sendmail" ())
1548 (declare-function mail-header-end "sendmail" ())
1550 ;; RLK feature not added in this version:
1551 ;; argument specifies inbox file or files in various ways.
1553 (defun rmail-get-new-mail (&optional file-name)
1554 "Move any new mail from this RMAIL file's inbox files.
1555 The inbox files can be specified with the file's Mail: option. The
1556 variable `rmail-primary-inbox-list' specifies the inboxes for your
1557 primary RMAIL file if it has no Mail: option. By default, this is
1558 your /usr/spool/mail/$USER.
1560 You can also specify the file to get new mail from. In this case, the
1561 file of new mail is not changed or deleted. Noninteractively, you can
1562 pass the inbox file name as an argument. Interactively, a prefix
1563 argument causes us to read a file name and use that file as the inbox.
1565 If the variable `rmail-preserve-inbox' is non-nil, new mail will
1566 always be left in inbox files rather than deleted.
1568 This function runs `rmail-get-new-mail-hook' before saving the updated file.
1569 It returns t if it got any new messages."
1571 (list (if current-prefix-arg
1572 (read-file-name "Get new mail from file: "))))
1573 (run-hooks 'rmail-before-get-new-mail-hook)
1574 ;; If the disk file has been changed from under us,
1575 ;; revert to it before we get new mail.
1576 (or (verify-visited-file-modtime (current-buffer))
1577 (find-file (buffer-file-name)))
1578 (set-buffer rmail-buffer)
1579 (rmail-swap-buffers-maybe)
1580 (rmail-maybe-set-message-counters)
1582 ;; Get rid of all undo records for this buffer.
1583 (or (eq buffer-undo-list t)
1584 (setq buffer-undo-list nil))
1585 (let ((all-files (if file-name (list file-name) rmail-inbox-list))
1586 (rmail-enable-multibyte (default-value 'enable-multibyte-characters))
1590 ;; This loops if any members of the inbox list have the same
1591 ;; basename (see "name conflict" below).
1593 (let ((opoint (point))
1594 ;; If buffer has not changed yet, and has not been
1595 ;; saved yet, don't replace the old backup file now.
1596 (make-backup-files (and make-backup-files (buffer-modified-p)))
1597 (buffer-read-only nil)
1598 ;; Don't make undo records while getting mail.
1599 (buffer-undo-list t)
1600 delete-files success files file-last-names)
1601 ;; Pull files off all-files onto files as long as there is
1602 ;; no name conflict. A conflict happens when two inbox
1603 ;; file names have the same last component.
1604 ;; The reason this careful handling is necessary seems
1605 ;; to be that rmail-insert-inbox-text uses .newmail-BASENAME.
1606 (while (and all-files
1607 (not (member (file-name-nondirectory (car all-files))
1609 (setq files (cons (car all-files) files)
1611 (cons (file-name-nondirectory (car all-files)) files))
1612 (setq all-files (cdr all-files)))
1613 ;; Put them back in their original order.
1614 (setq files (nreverse files))
1615 (goto-char (point-max))
1616 (skip-chars-backward " \t\n") ; just in case of brain damage
1617 (delete-region (point) (point-max)) ; caused by require-final-newline
1619 (rmail-get-new-mail-1 file-name files delete-files)
1621 ;; Move to the first new message unless we have other unseen
1622 ;; messages before it.
1623 (if found (rmail-show-message-maybe (rmail-first-unseen-message)))
1624 (run-hooks 'rmail-after-get-new-mail-hook)
1626 ;; Don't leave the buffer screwed up if we get a disk-full error.
1627 (rmail-show-message-maybe))))
1629 (defun rmail-get-new-mail-1 (file-name files delete-files)
1630 "Return t if new messages are detected without error, nil otherwise."
1633 (let ((new-messages 0)
1634 (spam-filter-p (and (featurep 'rmail-spam-filter)
1635 rmail-use-spam-filter))
1637 result success suffix)
1638 (narrow-to-region (point) (point))
1639 ;; Read in the contents of the inbox files, renaming them as
1640 ;; necessary, and adding to the list of files to delete
1643 (rmail-insert-inbox-text files nil)
1644 (setq delete-files (rmail-insert-inbox-text files t)))
1645 ;; Scan the new text and convert each message to
1646 ;; Rmail/mbox format.
1647 (goto-char (point-min))
1648 (skip-chars-forward " \n")
1649 (narrow-to-region (point) (point-max))
1651 (setq new-messages (rmail-add-mbox-headers)
1653 ;; Try to delete the garbage just inserted.
1654 (or success (delete-region (point-min) (point-max)))
1655 ;; If we could not convert the file's inboxes, rename the
1656 ;; files we tried to read so we won't over and over again.
1657 (if (and (not file-name) (not success))
1658 (let ((delfiles delete-files)
1661 (while (file-exists-p (format "RMAILOSE.%d" count))
1662 (setq count (1+ count)))
1663 (rename-file (car delfiles) (format "RMAILOSE.%d" count))
1664 (setq delfiles (cdr delfiles))))))
1665 ;; Determine if there are messages.
1666 (unless (zerop new-messages)
1667 ;; There are. Process them.
1668 (goto-char (point-min))
1669 (rmail-count-new-messages)
1670 (run-hooks 'rmail-get-new-mail-hook)
1672 ;; Delete the old files, now that the Rmail file is saved.
1675 ;; First, try deleting.
1677 (delete-file (car delete-files))
1679 ;; If we can't delete it, truncate it.
1680 (write-region (point) (point) (car delete-files))))
1682 (setq delete-files (cdr delete-files)))
1683 (if (zerop new-messages)
1684 (when (or file-name rmail-inbox-list)
1685 (message "(No new mail has arrived)"))
1686 ;; Generate the spam message.
1687 (setq blurb (if spam-filter-p
1688 (rmail-get-new-mail-filter-spam new-messages)
1690 (if (rmail-summary-exists)
1691 (rmail-select-summary (rmail-update-summary)))
1692 (setq suffix (if (= 1 new-messages) "" "s"))
1693 (message "%d new message%s read%s" new-messages suffix blurb)
1695 (if rsf-beep (beep t))
1696 (sleep-for rsf-sleep-after-message))
1698 ;; Establish the return value.
1699 (setq result (> new-messages 0))
1702 (defun rmail-get-new-mail-filter-spam (new-message-count)
1703 "Process new messages for spam."
1704 (let* ((old-messages (- rmail-total-messages new-message-count))
1705 (rsf-number-of-spam 0)
1706 (rsf-scanned-message-number (1+ old-messages))
1707 ;; save deletion flags of old messages: vector starts at zero
1708 ;; (is one longer that no of messages), therefore take 1+
1710 (save-deleted (substring rmail-deleted-vector 0 (1+ old-messages)))
1712 ;; set all messages to undeleted
1713 (setq rmail-deleted-vector (make-string (1+ rmail-total-messages) ?\ ))
1714 (while (<= rsf-scanned-message-number rmail-total-messages)
1716 (if (not (rmail-spam-filter rsf-scanned-message-number))
1717 (progn (setq rsf-number-of-spam (1+ rsf-number-of-spam))))
1718 (setq rsf-scanned-message-number (1+ rsf-scanned-message-number))))
1719 (if (> rsf-number-of-spam 0)
1721 (when (rmail-expunge-confirmed)
1722 (rmail-only-expunge t))))
1723 (setq rmail-deleted-vector
1724 (concat save-deleted
1725 (make-string (- rmail-total-messages old-messages) ?\ )))
1726 ;; Generate a return value message based on the number of spam
1729 ((zerop rsf-number-of-spam) "")
1730 ((= 1 new-message-count) ", and appears to be spam")
1731 ((= rsf-number-of-spam new-message-count) ", and all appear to be spam")
1732 ((> rsf-number-of-spam 1)
1733 (format ", and %d appear to be spam" rsf-number-of-spam))
1734 (t ", and 1 appears to be spam"))))
1736 (defun rmail-parse-url (file)
1737 "Parse the supplied URL. Return (list MAILBOX-NAME REMOTE PASSWORD GOT-PASSWORD)
1738 WHERE MAILBOX-NAME is the name of the mailbox suitable as argument to the
1739 actual version of `movemail', REMOTE is non-nil if MAILBOX-NAME refers to
1740 a remote mailbox, PASSWORD is the password if it should be
1741 supplied as a separate argument to `movemail' or nil otherwise, GOT-PASSWORD
1742 is non-nil if the user has supplied the password interactively.
1745 ((string-match "^\\([^:]+\\)://\\(\\([^:@]+\\)\\(:\\([^@]+\\)\\)?@\\)?.*" file)
1746 (let (got-password supplied-password
1747 (proto (match-string 1 file))
1748 (user (match-string 3 file))
1749 (pass (match-string 5 file))
1750 (host (substring file (or (match-end 2)
1751 (+ 3 (match-end 1))))))
1754 (when rmail-remote-password-required
1755 (setq got-password (not (rmail-have-password)))
1756 (setq supplied-password (rmail-get-remote-password
1757 (string-equal proto "imap"))))
1758 ;; The password is embedded. Strip it out since movemail
1759 ;; does not really like it, in spite of the movemail spec.
1760 (setq file (concat proto "://" user "@" host)))
1762 (if (rmail-movemail-variant-p 'emacs)
1763 (if (string-equal proto "pop")
1764 (list (concat "po:" user ":" host)
1766 (or pass supplied-password)
1768 (error "Emacs movemail does not support %s protocol" proto))
1770 (or (string-equal proto "pop") (string-equal proto "imap"))
1771 (or supplied-password pass)
1774 ((string-match "^po:\\([^:]+\\)\\(:\\(.*\\)\\)?" file)
1775 (let (got-password supplied-password
1777 (user (match-string 1 file))
1778 (host (match-string 3 file)))
1780 (when rmail-remote-password-required
1781 (setq got-password (not (rmail-have-password)))
1782 (setq supplied-password (rmail-get-remote-password nil)))
1784 (list file "pop" supplied-password got-password)))
1787 (list file nil nil nil))))
1789 (defun rmail-insert-inbox-text (files renamep)
1790 ;; Detect a locked file now, so that we avoid moving mail
1791 ;; out of the real inbox file. (That could scare people.)
1792 (or (memq (file-locked-p buffer-file-name) '(nil t))
1793 (error "RMAIL file %s is locked"
1794 (file-name-nondirectory buffer-file-name)))
1795 (let (file tofile delete-files movemail popmail got-password password)
1797 ;; Handle remote mailbox names specially; don't expand as filenames
1798 ;; in case the userid contains a directory separator.
1799 (setq file (car files))
1800 (let ((url-data (rmail-parse-url file)))
1801 (setq file (nth 0 url-data))
1802 (setq popmail (nth 1 url-data))
1803 (setq password (nth 2 url-data))
1804 (setq got-password (nth 3 url-data)))
1808 (setq file (file-truename
1809 (substitute-in-file-name (expand-file-name file)))))
1810 (setq tofile (expand-file-name
1811 ;; Generate name to move to from inbox name,
1812 ;; in case of multiple inboxes that need moving.
1814 (file-name-nondirectory
1815 (if (memq system-type '(windows-nt cygwin ms-dos))
1816 ;; cannot have colons in file name
1817 (replace-regexp-in-string ":" "-" file)
1819 ;; Use the directory of this rmail file
1820 ;; because it's a nuisance to use the homedir
1821 ;; if that is on a full disk and this rmail
1823 (file-name-directory
1824 (expand-file-name buffer-file-name))))
1825 ;; Always use movemail to rename the file,
1826 ;; since there can be mailboxes in various directories.
1828 ;; On some systems, /usr/spool/mail/foo is a directory
1829 ;; and the actual inbox is /usr/spool/mail/foo/foo.
1830 (if (file-directory-p file)
1831 (setq file (expand-file-name (user-login-name)
1834 (message "Getting mail from the remote server ..."))
1835 ((and (file-exists-p tofile)
1836 (/= 0 (nth 7 (file-attributes tofile))))
1837 (message "Getting mail from %s..." tofile))
1838 ((and (file-exists-p file)
1839 (/= 0 (nth 7 (file-attributes file))))
1840 (message "Getting mail from %s..." file)))
1841 ;; Set TOFILE if have not already done so, and
1842 ;; rename or copy the file FILE to TOFILE if and as appropriate.
1843 (cond ((not renamep)
1845 ((or (file-exists-p tofile) (and (not popmail)
1846 (not (file-exists-p file))))
1850 (let ((errors (current-buffer)))
1851 (buffer-disable-undo errors)
1854 (list (or rmail-movemail-program "movemail") nil errors nil)
1855 (if rmail-preserve-inbox
1858 (if (rmail-movemail-variant-p 'mailutils)
1859 (append (list "--emacs") rmail-movemail-flags)
1860 rmail-movemail-flags)
1862 (if password (list password) nil))))
1863 (apply 'call-process args))
1864 (if (not (buffer-modified-p errors))
1865 ;; No output => movemail won
1868 (subst-char-in-region (point-min) (point-max)
1870 (goto-char (point-max))
1871 (skip-chars-backward " \t")
1872 (delete-region (point) (point-max))
1873 (goto-char (point-min))
1874 (if (looking-at "movemail: ")
1875 (delete-region (point-min) (match-end 0)))
1877 ;; If we just read the password, most likely it is
1878 ;; wrong. Otherwise, see if there is a specific
1879 ;; reason to think that the problem is a wrong passwd.
1880 (if (or got-password
1881 (re-search-forward rmail-remote-password-error
1883 (rmail-set-remote-password nil))
1885 ;; If using Mailutils, remove initial error code
1887 (when (rmail-movemail-variant-p 'mailutils)
1888 (goto-char (point-min))
1889 (when (looking-at "[A-Z][A-Z0-9_]*:")
1890 (delete-region (point-min) (match-end 0))))
1892 (message "movemail: %s"
1893 (buffer-substring (point-min)
1899 ;; At this point, TOFILE contains the name to read:
1900 ;; Either the alternate name (if we renamed)
1901 ;; or the actual inbox (if not renaming).
1902 (if (file-exists-p tofile)
1903 (let ((coding-system-for-read 'no-conversion)
1905 (goto-char (point-max))
1906 (setq size (nth 1 (insert-file-contents tofile)))
1907 ;; Determine if a pair of newline message separators need
1908 ;; to be added to the new collection of messages. This is
1909 ;; the case for all new message collections added to a
1910 ;; non-empty mail file.
1911 (unless (zerop size)
1913 (let ((start (point-min)))
1915 (unless (eq start (point-min))
1918 (setq size (+ 2 size))))))
1919 (goto-char (point-max))
1920 (or (= (preceding-char) ?\n)
1923 (if (not (and rmail-preserve-inbox (string= file tofile)))
1924 (setq delete-files (cons tofile delete-files)))))
1926 (setq files (cdr files)))
1929 ;; Decode the region specified by FROM and TO by CODING.
1930 ;; If CODING is nil or an invalid coding system, decode by `undecided'.
1931 (defun rmail-decode-region (from to coding &optional destination)
1932 (if (or (not coding) (not (coding-system-p coding)))
1933 (setq coding 'undecided))
1934 ;; Use -dos decoding, to remove ^M characters left from base64 or
1935 ;; rogue qp-encoded text.
1936 (decode-coding-region
1937 from to (coding-system-change-eol-conversion coding 1) destination)
1938 ;; Don't reveal the fact we used -dos decoding, as users generally
1939 ;; will not expect the RMAIL buffer to use DOS EOL format.
1942 (setq buffer-file-coding-system
1943 (setq last-coding-system-used
1944 (coding-system-change-eol-conversion coding 0))))
1945 ((bufferp destination)
1946 (with-current-buffer destination
1947 (setq buffer-file-coding-system
1948 (setq last-coding-system-used
1949 (coding-system-change-eol-conversion coding 0)))))))
1951 (defun rmail-add-mbox-headers ()
1952 "Validate the RFC2822 format for the new messages.
1953 Point should be at the first new message.
1954 An error is signalled if the new messages are not RFC2822
1956 Unless an Rmail attribute header already exists, add it to the
1957 new messages. Return the number of new messages."
1964 ;; Detect an empty inbox file.
1965 (unless (= start (point-max))
1966 ;; Scan the new messages to establish a count and to ensure that
1967 ;; an attribute header is present.
1968 (while (looking-at "From ")
1969 ;; Determine if a new attribute header needs to be added to
1971 (if (search-forward "\n\n" nil t)
1973 (setq count (1+ count))
1974 (narrow-to-region start (point))
1975 (unless (mail-fetch-field rmail-attribute-header)
1977 (insert rmail-attribute-header ": " value "\n"))
1979 (rmail-error-bad-format))
1980 ;; Move to the next message.
1981 (if (search-forward "\n\nFrom " nil 'move)
1983 (setq start (point))))
1986 (defun rmail-get-header (name &optional msgnum)
1987 "Return the value of message header NAME, nil if it has none.
1988 MSGNUM specifies the message number to get it from.
1989 If MSGNUM is nil, use the current message."
1990 (with-current-buffer rmail-buffer
1991 (or msgnum (setq msgnum rmail-current-message))
1994 (setq msgbeg (rmail-msgbeg msgnum))
1995 ;; All access to the buffer's local variables is now finished...
1997 ;; ... so it is ok to go to a different buffer.
1998 (if (rmail-buffers-swapped-p) (set-buffer rmail-view-buffer))
2003 (setq end (search-forward "\n\n" nil t))
2006 (narrow-to-region msgbeg end)
2007 (mail-fetch-field name))
2008 (rmail-error-bad-format msgnum)))))))))
2010 (defun rmail-set-header (name &optional msgnum value)
2011 "Store VALUE in message header NAME, nil if it has none.
2012 MSGNUM specifies the message number to operate on.
2013 If MSGNUM is nil, use the current message."
2014 (with-current-buffer rmail-buffer
2015 (or msgnum (setq msgnum rmail-current-message))
2018 (setq msgbeg (rmail-msgbeg msgnum))
2019 ;; All access to the buffer's local variables is now finished...
2021 ;; ... so it is ok to go to a different buffer.
2022 (if (rmail-buffers-swapped-p) (set-buffer rmail-view-buffer))
2027 (setq end (search-forward "\n\n" nil t))
2028 (if end (setq end (1- end)))
2031 (narrow-to-region msgbeg end)
2033 (if (re-search-forward (concat "^"
2038 (delete-region (point) (line-end-position))
2041 (insert name ": " value "\n")))
2042 (rmail-error-bad-format msgnum)))))
2043 ;; Ensure header changes get saved.
2044 (if end (set-buffer-modified-p t))))))
2046 ;;;; *** Rmail Attributes and Keywords ***
2048 (defun rmail-get-attr-names (&optional msg)
2049 "Return the message attributes in a comma separated string.
2050 MSG specifies the message number to get it from.
2051 If MSG is nil, use the current message."
2052 (let ((value (rmail-get-header rmail-attribute-header msg))
2054 (dotimes (index (length value))
2055 (setq temp (and (not (= ?- (aref value index)))
2056 (nth 1 (aref rmail-attr-array index)))
2059 ((and temp result) (format "%s, %s" result temp))
2064 (defun rmail-get-keywords (&optional msg)
2065 "Return the message keywords in a comma separated string.
2066 MSG, if non-nil, identifies the message number to use.
2067 If nil, that means the current message."
2068 (rmail-get-header rmail-keyword-header msg))
2070 (defun rmail-get-labels (&optional msg)
2071 "Return a string with the labels (attributes and keywords) of msg MSG.
2072 It is put in comma-separated form.
2073 MSG, if non-nil, identifies the message number to use.
2074 If nil, that means the current message."
2075 (or msg (setq msg rmail-current-message))
2076 (let (blurb attr-names keywords)
2077 ;; Combine the message attributes and keywords
2078 ;; into a comma-separated list.
2079 (setq attr-names (rmail-get-attr-names msg)
2080 keywords (rmail-get-keywords msg))
2081 (if (string= keywords "")
2082 (setq keywords nil))
2084 ;; FIXME ? old rmail did not have spaces in the comma-separated lists.
2085 ((and attr-names keywords) (concat " " attr-names "; " keywords))
2086 (attr-names (concat " " attr-names))
2087 (keywords (concat " " keywords))
2090 (defun rmail-display-labels ()
2091 "Update the current messages's attributes and keywords in mode line."
2092 (let ((blurb (rmail-get-labels)))
2093 (setq mode-line-process
2095 rmail-current-message rmail-total-messages blurb))
2096 ;; If rmail-enable-mime is non-nil, we may have to update
2097 ;; `mode-line-process' of rmail-view-buffer too.
2098 (if (and rmail-enable-mime
2099 (not (eq (current-buffer) rmail-view-buffer))
2100 (buffer-live-p rmail-view-buffer))
2101 (let ((mlp mode-line-process))
2102 (with-current-buffer rmail-view-buffer
2103 (setq mode-line-process mlp))))))
2105 (defun rmail-get-attr-value (attr state)
2106 "Return the character value for ATTR.
2107 ATTR is a (numeric) index, an offset into the mbox attribute
2108 header value. STATE is one of nil, t, or a character value."
2110 ((numberp state) state)
2112 (t (nth 0 (aref rmail-attr-array attr)))))
2114 (defun rmail-set-attribute (attr state &optional msgnum)
2115 "Turn an attribute of a message on or off according to STATE.
2116 STATE is either nil or the character (numeric) value associated
2117 with the state (nil represents off and non-nil represents on).
2118 ATTR is the index of the attribute. MSGNUM is message number to
2119 change; nil means current message."
2120 (with-current-buffer rmail-buffer
2121 (let ((value (rmail-get-attr-value attr state))
2122 (inhibit-read-only t)
2126 (or msgnum (setq msgnum rmail-current-message))
2128 ;; The "deleted" attribute is also stored in a special vector
2129 ;; so update that too.
2130 (if (= attr rmail-deleted-attr-index)
2131 (rmail-set-message-deleted-p msgnum state))
2132 (setq msgbeg (rmail-msgbeg msgnum))
2134 ;; All access to the buffer's local variables is now finished...
2137 ;; ... so it is ok to go to a different buffer.
2138 (if (rmail-buffers-swapped-p) (set-buffer rmail-view-buffer))
2142 ;; Determine if the current state is the desired state.
2145 (setq limit (search-forward "\n\n" nil t)))
2146 (if (search-forward (concat rmail-attribute-header ": ") limit t)
2147 ;; If this message already records attributes,
2148 ;; just change the value for this one.
2149 (let ((missing (- (+ (point) attr) (line-end-position))))
2150 ;; Position point at this attribute,
2151 ;; adding attributes if necessary.
2155 (insert-char ?- missing)
2157 (forward-char attr))
2158 ;; Change this attribute.
2159 (when (/= value (char-after))
2163 ;; Otherwise add a header line to record the attributes
2164 ;; and set all but this one to no.
2165 (let ((header-value "--------"))
2166 (aset header-value attr value)
2167 (goto-char (if limit (- limit 1) (point-max)))
2168 (setq altered (/= value ?-))
2169 (insert rmail-attribute-header ": " header-value "\n"))))))
2170 (if (= msgnum rmail-current-message)
2171 (rmail-display-labels))))
2172 ;; If we made a significant change in an attribute,
2173 ;; mark rmail-buffer modified, so it will be (1) saved
2174 ;; and (2) displayed in the mode line.
2176 (set-buffer-modified-p t)))))
2178 (defun rmail-message-attr-p (msg attrs)
2179 "Return t if the attributes header for message MSG matches regexp ATTRS.
2180 This function assumes the Rmail buffer is unswapped."
2183 (let ((start (rmail-msgbeg msg))
2187 (setq limit (search-forward "\n\n" (rmail-msgend msg) t))
2190 (search-forward (concat rmail-attribute-header ": ") limit t)
2191 (looking-at attrs))))))
2193 (defun rmail-message-unseen-p (msgnum)
2194 "Test the unseen attribute for message MSGNUM.
2195 Return non-nil if the unseen attribute is set, nil otherwise."
2196 (rmail-message-attr-p msgnum "......U"))
2198 ;; Return t if the attributes/keywords line of msg number MSG
2199 ;; contains a match for the regexp LABELS.
2200 (defun rmail-message-labels-p (msg labels)
2201 (string-match labels (rmail-get-labels msg)))
2203 ;;;; *** Rmail Message Selection And Support ***
2205 (defun rmail-msgend (n)
2206 (marker-position (aref rmail-message-vector (1+ n))))
2208 (defun rmail-msgbeg (n)
2209 (marker-position (aref rmail-message-vector n)))
2211 (defun rmail-apply-in-message (msgnum function &rest args)
2212 "Call FUNCTION on ARGS while narrowed to message MSGNUM.
2213 Point is at the start of the message.
2214 This returns what the call to FUNCTION returns.
2215 If MSGNUM is nil, use the current message."
2216 (with-current-buffer rmail-buffer
2217 (or msgnum (setq msgnum rmail-current-message))
2219 (let (msgbeg msgend)
2220 (setq msgbeg (rmail-msgbeg msgnum))
2221 (setq msgend (rmail-msgend msgnum))
2222 ;; All access to the rmail-buffer's local variables is now finished...
2224 ;; ... so it is ok to go to a different buffer.
2225 (if (rmail-buffers-swapped-p) (set-buffer rmail-view-buffer))
2230 (narrow-to-region msgbeg msgend)
2231 (apply function args))))))))
2233 (defun rmail-widen-to-current-msgbeg (function)
2234 "Call FUNCTION with point at start of internal data of current message.
2235 Assumes that bounds were previously narrowed to display the message in Rmail.
2236 The bounds are widened enough to move point where desired, then narrowed
2239 FUNCTION may not change the visible text of the message, but it may
2240 change the invisible header text."
2244 (narrow-to-region (rmail-msgbeg rmail-current-message)
2246 (goto-char (point-min))
2248 ;; Note: we don't use save-restriction because that does not work right
2249 ;; if changes are made outside the saved restriction
2250 ;; before that restriction is restored.
2251 (narrow-to-region (rmail-msgbeg rmail-current-message)
2252 (rmail-msgend rmail-current-message)))))
2254 ;; Manage the message vectors and counters.
2256 (defun rmail-forget-messages ()
2258 (if (vectorp rmail-message-vector)
2260 (v rmail-message-vector)
2263 (move-marker (aref v i) nil)
2265 (setq rmail-message-vector nil)
2266 (setq rmail-msgref-vector nil)
2267 (setq rmail-deleted-vector nil)))
2269 (defun rmail-maybe-set-message-counters ()
2270 (if (not (and rmail-deleted-vector
2271 rmail-message-vector
2272 rmail-current-message
2273 rmail-total-messages))
2274 (rmail-set-message-counters)))
2276 (defun rmail-count-new-messages (&optional nomsg)
2277 "Count the number of new messages.
2278 The buffer should be narrowed to include only the new messages.
2279 Output a helpful message unless NOMSG is non-nil."
2280 (let* ((case-fold-search nil)
2284 (or nomsg (message "Counting new messages..."))
2285 (goto-char (point-max))
2286 ;; Put at the end of messages-head
2287 ;; the entry for message N+1, which marks
2288 ;; the end of message N. (N = number of messages).
2289 (setq messages-head (list (point-marker)))
2290 (rmail-set-message-counters-counter (point-min))
2291 (setq rmail-current-message (1+ rmail-total-messages))
2292 (setq rmail-total-messages
2293 (+ rmail-total-messages total-messages))
2294 (setq rmail-message-vector
2295 (vconcat rmail-message-vector (cdr messages-head)))
2296 (aset rmail-message-vector
2297 rmail-current-message (car messages-head))
2298 (setq rmail-deleted-vector
2299 (concat rmail-deleted-vector deleted-head))
2300 (setq rmail-summary-vector
2301 (vconcat rmail-summary-vector (make-vector total-messages nil)))
2302 (setq rmail-msgref-vector
2303 (vconcat rmail-msgref-vector (make-vector total-messages nil)))
2304 ;; Fill in the new elements of rmail-msgref-vector.
2305 (let ((i (1+ (- rmail-total-messages total-messages))))
2306 (while (<= i rmail-total-messages)
2307 (aset rmail-msgref-vector i (list i))
2309 (goto-char (point-min))
2310 (or nomsg (message "Counting new messages...done (%d)" total-messages))))
2312 (defun rmail-set-message-counters ()
2313 (rmail-forget-messages)
2317 (let* ((point-save (point))
2319 (messages-after-point)
2320 (case-fold-search nil)
2323 ;; Determine how many messages follow point.
2324 (message "Counting messages...")
2325 (goto-char (point-max))
2326 ;; Put at the end of messages-head
2327 ;; the entry for message N+1, which marks
2328 ;; the end of message N. (N = number of messages).
2329 (setq messages-head (list (point-marker)))
2330 (rmail-set-message-counters-counter (min (point) point-save))
2331 (setq messages-after-point total-messages)
2333 ;; Determine how many precede point.
2334 (rmail-set-message-counters-counter)
2335 (setq rmail-total-messages total-messages)
2336 (setq rmail-current-message
2338 (max 1 (- total-messages messages-after-point))))
2339 (setq rmail-message-vector
2340 (apply 'vector (cons (point-min-marker) messages-head))
2341 rmail-deleted-vector (concat "0" deleted-head)
2342 rmail-summary-vector (make-vector rmail-total-messages nil)
2343 rmail-msgref-vector (make-vector (1+ rmail-total-messages) nil))
2345 (while (<= i rmail-total-messages)
2346 (aset rmail-msgref-vector i (list i))
2349 (while (<= i rmail-total-messages)
2350 (rmail-set-message-deleted-p i (rmail-message-attr-p i ".D"))
2352 (message "Counting messages...done")))))
2355 (defsubst rmail-collect-deleted (message-end)
2356 "Collect the message deletion flags for each message.
2357 MESSAGE-END is the buffer position corresponding to the end of
2358 the message. Point is at the beginning of the message."
2359 ;; NOTE: This piece of code will be executed on a per-message basis.
2360 ;; In the face of thousands of messages, it has to be as fast as
2361 ;; possible, hence some brute force constant use is employed in
2362 ;; addition to inlining.
2365 (cons (if (and (search-forward (concat rmail-attribute-header ": ") message-end t)
2368 ?\ ) deleted-head))))
2370 (defun rmail-set-message-counters-counter (&optional stop)
2371 ;; Collect the start position for each message into 'messages-head.
2372 (let ((start (point)))
2373 (while (search-backward "\n\nFrom " stop t)
2375 (rmail-collect-deleted start)
2376 (setq messages-head (cons (point-marker) messages-head)
2377 total-messages (1+ total-messages)
2379 ;; Show progress after every 20 messages or so.
2380 (if (zerop (% total-messages 20))
2381 (message "Counting messages...%d" total-messages)))
2382 ;; Handle the first message, maybe.
2385 (goto-char (point-min)))
2386 (unless (not (looking-at "From "))
2387 (rmail-collect-deleted start)
2388 (setq messages-head (cons (point-marker) messages-head)
2389 total-messages (1+ total-messages)))))
2391 ;; Display a message.
2393 ;;;; *** Rmail Message Formatting and Header Manipulation ***
2395 ;; This is used outside of rmail.
2396 (defun rmail-msg-is-pruned ()
2397 "Return nil if the current message is showing full headers."
2398 (with-current-buffer (if (rmail-buffers-swapped-p) rmail-view-buffer
2400 (eq rmail-header-style 'normal)))
2402 (defun rmail-toggle-header (&optional arg)
2403 "Toggle between showing full and normal message headers.
2404 With optional integer ARG, show the normal message header if ARG
2405 is greater than zero; otherwise, show it in full."
2407 (let ((rmail-header-style
2409 (if (> arg 0) 'normal 'full)
2410 (if (rmail-msg-is-pruned) 'full 'normal))))
2411 (rmail-show-message-maybe)))
2413 (defun rmail-beginning-of-message ()
2414 "Show current message starting from the beginning."
2416 (let ((rmail-show-message-hook
2417 (list (function (lambda ()
2418 (goto-char (point-min)))))))
2419 (rmail-show-message-maybe rmail-current-message)))
2421 (defun rmail-end-of-message ()
2422 "Show bottom of current message."
2424 (let ((rmail-show-message-hook
2425 (list (function (lambda ()
2426 (goto-char (point-max))
2427 (recenter (1- (window-height))))))))
2428 (rmail-show-message-maybe rmail-current-message)))
2430 (defun rmail-unknown-mail-followup-to ()
2431 "Handle a \"Mail-Followup-To\" header field with an unknown mailing list.
2432 Ask the user whether to add that list name to `mail-mailing-lists'."
2434 (let ((mail-followup-to (mail-fetch-field "mail-followup-to" nil t)))
2435 (when mail-followup-to
2438 (mail-strip-quoted-names mail-followup-to)
2439 ",[[:space:]]+" t)))
2440 (dolist (addr addresses)
2441 (when (and (not (member addr mail-mailing-lists))
2443 ;; taken from rmailsum.el
2445 (or rmail-user-mail-address-regexp
2447 (regexp-quote (user-login-name))
2450 (or user-mail-address
2451 (concat (user-login-name) "@"
2452 (or mail-host-address
2457 (format "Add `%s' to `mail-mailing-lists'? "
2459 (customize-save-variable 'mail-mailing-lists
2460 (cons addr mail-mailing-lists)))))))))
2462 (defun rmail-widen ()
2463 "Display the entire mailbox file."
2465 (rmail-swap-buffers-maybe)
2468 (defun rmail-no-mail-p ()
2469 "Return nil if there is mail, else \"No mail.\"."
2470 (if (zerop rmail-total-messages)
2472 (with-current-buffer rmail-view-buffer
2476 (defun rmail-show-message-maybe (&optional n no-summary)
2477 "Show message number N (prefix argument), counting from start of file.
2478 If summary buffer is currently displayed, update current message there also.
2479 N defaults to the current message."
2481 (or (eq major-mode 'rmail-mode)
2482 (switch-to-buffer rmail-buffer))
2483 ;; FIXME: Why do we swap the raw data back in?
2484 (rmail-swap-buffers-maybe)
2485 (rmail-maybe-set-message-counters)
2487 (let ((blurb (rmail-show-message n)))
2488 (or (zerop rmail-total-messages)
2490 (when mail-mailing-lists
2491 (rmail-unknown-mail-followup-to))
2492 (if transient-mark-mode (deactivate-mark))
2493 ;; If there is a summary buffer, try to move to this message
2494 ;; in that buffer. But don't complain if this message is
2495 ;; not mentioned in the summary. Don't do this at all if we
2496 ;; were called on behalf of cursor motion in the summary
2498 (and (rmail-summary-exists) (not no-summary)
2499 (let ((curr-msg rmail-current-message))
2500 (rmail-select-summary
2501 (rmail-summary-goto-msg curr-msg t t))))
2502 (with-current-buffer rmail-buffer
2503 (rmail-auto-file))))
2507 (defun rmail-is-text-p ()
2508 "Return t if the region contains a text message, nil otherwise."
2510 (let ((text-regexp "\\(text\\|message\\)/")
2511 (content-type-header (mail-fetch-field "content-type")))
2512 ;; The message is text if either there is no content type header
2513 ;; (a default of "text/plain; charset=US-ASCII" is assumed) or
2514 ;; the base content type is either text or message.
2515 (or (not content-type-header)
2516 (string-match text-regexp content-type-header)))))
2518 (defun rmail-show-message (&optional msg)
2519 "Show message MSG (default: current message) using `rmail-view-buffer'.
2520 Return text to display in the minibuffer if MSG is out of
2521 range (displaying a reasonable choice as well), nil otherwise.
2522 The current mail message becomes the message displayed."
2523 (let ((mbox-buf rmail-buffer)
2524 (view-buf rmail-view-buffer)
2525 blurb beg end body-start coding-system character-coding
2526 is-text-message header-style)
2528 (setq msg rmail-current-message))
2529 (unless (setq blurb (rmail-no-mail-p))
2532 rmail-current-message 1
2533 blurb "No previous message"))
2534 ((> msg rmail-total-messages)
2535 (setq msg rmail-total-messages
2536 rmail-current-message rmail-total-messages
2537 blurb "No following message"))
2538 (t (setq rmail-current-message msg)))
2539 (with-current-buffer rmail-buffer
2540 (setq header-style rmail-header-style)
2541 ;; Mark the message as seen, bracket the message in the mail
2542 ;; buffer and determine the coding system the transfer encoding.
2543 (rmail-set-attribute rmail-unseen-attr-index nil)
2544 (rmail-swap-buffers-maybe)
2545 (setq beg (rmail-msgbeg msg)
2546 end (rmail-msgend msg))
2547 (narrow-to-region beg end)
2549 (setq body-start (search-forward "\n\n" nil t))
2550 (narrow-to-region beg (point))
2553 (if (re-search-forward "^X-Coding-System: *\\(.*\\)$" nil t)
2554 (setq coding-system (intern (match-string 1)))
2555 (setq coding-system (rmail-get-coding-system))))
2556 (setq character-coding (mail-fetch-field "content-transfer-encoding")
2557 is-text-message (rmail-is-text-p))
2558 (if character-coding
2559 (setq character-coding (downcase character-coding)))
2560 (narrow-to-region beg end)
2561 ;; Decode the message body into an empty view buffer using a
2562 ;; unibyte temporary buffer where the character decoding takes
2564 (with-current-buffer rmail-view-buffer
2565 ;; We give the view buffer a buffer-local value of
2566 ;; rmail-header-style based on the binding in effect when
2567 ;; this function is called; `rmail-toggle-headers' can
2568 ;; inspect this value to determine how to toggle.
2569 (set (make-local-variable 'rmail-header-style) header-style)
2571 (if (null character-coding)
2572 ;; Do it directly since that is fast.
2573 (rmail-decode-region body-start end coding-system view-buf)
2574 ;; Can this be done directly, skipping the temp buffer?
2576 (set-buffer-multibyte nil)
2577 (insert-buffer-substring mbox-buf body-start end)
2579 ((string= character-coding "quoted-printable")
2580 (mail-unquote-printable-region (point-min) (point-max)))
2581 ((and (string= character-coding "base64") is-text-message)
2582 (base64-decode-region (point-min) (point-max)))
2583 ((eq character-coding 'uuencode)
2584 (error "uuencoded messages are not supported yet"))
2586 (rmail-decode-region (point-min) (point-max)
2587 coding-system view-buf)))
2588 (with-current-buffer rmail-view-buffer
2589 ;; Unquote quoted From lines
2590 (goto-char (point-min))
2591 (while (re-search-forward "^>+From " nil t)
2595 (goto-char (point-min)))
2596 ;; Copy the headers to the front of the message view buffer.
2597 (rmail-copy-headers beg end)
2598 ;; Add the separator (blank line) between headers and body;
2599 ;; highlight the message, activate any URL like text and add
2600 ;; special highlighting for and quoted material.
2601 (with-current-buffer rmail-view-buffer
2603 (goto-char (point-min))
2604 (rmail-highlight-headers)
2605 ;(rmail-activate-urls)
2606 ;(rmail-process-quoted-material)
2608 ;; Update the mode-line with message status information and swap
2609 ;; the view buffer/mail buffer contents.
2610 (rmail-display-labels)
2611 (rmail-swap-buffers)
2612 (setq rmail-buffer-swapped t)
2613 (run-hooks 'rmail-show-message-hook)))
2616 (defun rmail-copy-headers (beg end &optional ignored-headers)
2617 "Copy displayed header fields to the message viewer buffer.
2618 BEG and END marks the start and end positions of the message in
2619 the mbox buffer. If the optional argument IGNORED-HEADERS is
2620 non-nil, ignore all header fields whose names match that regexp.
2621 Otherwise, if `rmail-displayed-headers' is non-nil, copy only
2622 those header fields whose names match that regexp. Otherwise,
2623 copy all header fields whose names do not match
2624 `rmail-ignored-headers' (unless they also match
2625 `rmail-nonignored-headers'). Moves point in the message viewer
2626 buffer to the end of the headers."
2627 (let ((header-start-regexp "\n[^ \t]")
2629 (with-current-buffer rmail-buffer
2630 (when (search-forward "\n\n" nil t)
2633 ;; Put point right after the From header line.
2634 (narrow-to-region beg (point))
2635 (goto-char (point-min))
2636 (unless (re-search-forward header-start-regexp nil t)
2637 (rmail-error-bad-format))
2640 ;; Handle the case where all headers should be copied.
2641 ((eq rmail-header-style 'full)
2642 (prepend-to-buffer rmail-view-buffer beg (point-max))
2643 ;; rmail-show-message expects this function to leave point
2644 ;; at the end of the headers.
2645 (with-current-buffer rmail-view-buffer
2646 (search-forward "\n\n" nil t)))
2647 ;; Handle the case where the headers matching the displayed
2648 ;; headers regexp should be copied.
2649 ((and rmail-displayed-headers (null ignored-headers))
2652 (setq lim (if (re-search-forward header-start-regexp nil t)
2653 (1+ (match-beginning 0))
2655 (when (looking-at rmail-displayed-headers)
2656 (append-to-buffer rmail-view-buffer (point) lim))
2658 ;; Handle the ignored headers.
2659 ((or ignored-headers (setq ignored-headers rmail-ignored-headers))
2660 (while (and ignored-headers (not (eobp)))
2662 (setq lim (if (re-search-forward header-start-regexp nil t)
2663 (1+ (match-beginning 0))
2665 (if (and (looking-at ignored-headers)
2666 (not (looking-at rmail-nonignored-headers)))
2668 (append-to-buffer rmail-view-buffer (point) lim)
2670 (t (error "No headers selected for display!"))))))))
2672 (defun rmail-redecode-body (coding)
2673 "Decode the body of the current message using coding system CODING.
2674 This is useful with mail messages that have malformed or missing
2677 This function assumes that the current message is already decoded
2678 and displayed in the RMAIL buffer, but the coding system used to
2679 decode it was incorrect. It then decodes the message again,
2680 using the coding system CODING."
2681 (interactive "zCoding system for re-decoding this message: ")
2682 (when (not rmail-enable-mime)
2683 (with-current-buffer rmail-buffer
2684 (rmail-swap-buffers-maybe)
2687 (let ((msgbeg (rmail-msgbeg rmail-current-message))
2688 (msgend (rmail-msgend rmail-current-message))
2689 (buffer-read-only nil)
2690 body-start x-coding-header old-coding)
2691 (narrow-to-region msgbeg msgend)
2692 (goto-char (point-min))
2693 (unless (setq body-start (search-forward "\n\n" (point-max) 1))
2694 (error "No message body"))
2697 ;; Narrow to headers
2698 (narrow-to-region (point-min) body-start)
2699 (setq x-coding-header (goto-char (point-min)))
2700 (if (not (re-search-forward "^X-Coding-System: *\\(.*\\)$" nil t))
2701 (setq old-coding (rmail-get-coding-system))
2702 (setq old-coding (intern (match-string 1)))
2703 (setq x-coding-header (point)))
2704 (check-coding-system old-coding)
2705 ;; Make sure the new coding system uses the same EOL
2706 ;; conversion, to prevent ^M characters from popping up
2707 ;; all over the place.
2708 (let ((eol-type (coding-system-eol-type old-coding)))
2709 (if (numberp eol-type)
2711 (coding-system-change-eol-conversion coding eol-type))))
2712 (when (not (coding-system-equal
2713 (coding-system-base old-coding)
2714 (coding-system-base coding)))
2715 ;; Rewrite the coding-system header.
2716 (goto-char x-coding-header)
2717 (if (> (point) (point-min))
2718 (delete-region (line-beginning-position) (point))
2722 (insert "X-Coding-System: "
2723 (symbol-name coding))))
2724 (rmail-show-message-maybe))))))
2726 ;; Find all occurrences of certain fields, and highlight them.
2727 (defun rmail-highlight-headers ()
2728 ;; Do this only if the system supports faces.
2729 (if (and (fboundp 'internal-find-face)
2730 rmail-highlighted-headers)
2732 (search-forward "\n\n" nil 'move)
2734 (narrow-to-region (point-min) (point))
2735 (let ((case-fold-search t)
2736 (inhibit-read-only t)
2737 ;; Highlight with boldface if that is available.
2738 ;; Otherwise use the `highlight' face.
2739 (face (or 'rmail-highlight
2740 (if (face-differs-from-default-p 'bold)
2742 ;; List of overlays to reuse.
2743 (overlays rmail-overlay-list))
2744 (goto-char (point-min))
2745 (while (re-search-forward rmail-highlighted-headers nil t)
2746 (skip-chars-forward " \t")
2749 (while (progn (forward-line 1)
2750 (looking-at "[ \t]")))
2751 ;; Back up over newline, then trailing spaces or tabs
2753 (while (member (preceding-char) '(? ?\t))
2756 ;; Reuse an overlay we already have.
2758 (setq overlay (car overlays)
2759 overlays (cdr overlays))
2760 (overlay-put overlay 'face face)
2761 (move-overlay overlay beg (point)))
2762 ;; Make a new overlay and add it to
2763 ;; rmail-overlay-list.
2764 (setq overlay (make-overlay beg (point)))
2765 (overlay-put overlay 'face face)
2766 (setq rmail-overlay-list
2767 (cons overlay rmail-overlay-list))))))))))
2769 (defun rmail-auto-file ()
2770 "Automatically move a message into a sub-folder based on criteria.
2771 Called when a new message is displayed."
2772 (if (or (zerop rmail-total-messages)
2773 (rmail-message-attr-p rmail-current-message "...F")
2774 (not (string= (buffer-file-name)
2775 (expand-file-name rmail-file-name))))
2776 ;; Do nothing if the message has already been filed or if there
2779 ;; Find out some basics (common fields)
2780 (let ((from (mail-fetch-field "from"))
2781 (subj (mail-fetch-field "subject"))
2782 (to (concat (mail-fetch-field "to") "," (mail-fetch-field "cc")))
2783 (d rmail-automatic-folder-directives)
2784 (directive-loop nil)
2787 (setq folder (car (car d))
2788 directive-loop (cdr (car d)))
2789 (while (and (car directive-loop)
2791 ((string= (car directive-loop) "from") from)
2792 ((string= (car directive-loop) "to") to)
2793 ((string= (car directive-loop) "subject") subj)
2794 (t (mail-fetch-field (car directive-loop))))))
2795 (and f (string-match (car (cdr directive-loop)) f))))
2796 (setq directive-loop (cdr (cdr directive-loop))))
2797 ;; If there are no directives left, then it was a complete match.
2798 (if (null directive-loop)
2800 (rmail-delete-forward)
2801 (if (string= "/dev/null" folder)
2802 (rmail-delete-message)
2803 (rmail-output folder 1 t)
2805 (setq d (cdr d))))))
2807 ;; Simple message motion commands.
2809 (defun rmail-next-message (n)
2810 "Show following message whether deleted or not.
2811 With prefix arg N, moves forward N messages, or backward if N is negative."
2813 (set-buffer rmail-buffer)
2814 (rmail-maybe-set-message-counters)
2815 (rmail-show-message-maybe (+ rmail-current-message n)))
2817 (defun rmail-previous-message (n)
2818 "Show previous message whether deleted or not.
2819 With prefix arg N, moves backward N messages, or forward if N is negative."
2821 (rmail-next-message (- n)))
2823 (defun rmail-next-undeleted-message (n)
2824 "Show following non-deleted message.
2825 With prefix arg N, moves forward N non-deleted messages,
2826 or backward if N is negative.
2828 Returns t if a new message is being shown, nil otherwise."
2830 (set-buffer rmail-buffer)
2831 (rmail-maybe-set-message-counters)
2832 (let ((lastwin rmail-current-message)
2833 (current rmail-current-message))
2834 (while (and (> n 0) (< current rmail-total-messages))
2835 (setq current (1+ current))
2836 (if (not (rmail-message-deleted-p current))
2837 (setq lastwin current n (1- n))))
2838 (while (and (< n 0) (> current 1))
2839 (setq current (1- current))
2840 (if (not (rmail-message-deleted-p current))
2841 (setq lastwin current n (1+ n))))
2842 (if (/= lastwin rmail-current-message)
2843 (progn (rmail-show-message-maybe lastwin)
2846 (message "No previous nondeleted message"))
2848 (message "No following nondeleted message"))
2851 (defun rmail-previous-undeleted-message (n)
2852 "Show previous non-deleted message.
2853 With prefix argument N, moves backward N non-deleted messages,
2854 or forward if N is negative."
2856 (rmail-next-undeleted-message (- n)))
2858 (defun rmail-first-message ()
2859 "Show first message in file."
2861 (rmail-maybe-set-message-counters)
2862 (rmail-show-message-maybe 1))
2864 (defun rmail-last-message ()
2865 "Show last message in file."
2867 (rmail-maybe-set-message-counters)
2868 (rmail-show-message-maybe rmail-total-messages))
2870 (defun rmail-what-message ()
2871 "For debugging Rmail: find the message number that point is in."
2872 (let* ((high rmail-total-messages)
2875 (where (with-current-buffer (if (rmail-buffers-swapped-p)
2879 (while (> (- high low) 1)
2880 (if (>= where (rmail-msgbeg mid))
2883 (setq mid (+ low (/ (- high low) 2))))
2884 (if (>= where (rmail-msgbeg high)) high low)))
2886 ;; Searching in Rmail file.
2888 (defun rmail-search-message (msg regexp)
2889 "Return non-nil, if for message number MSG, regexp REGEXP matches."
2890 ;; This is adequate because its only caller, rmail-search,
2891 ;; unswaps the buffers.
2892 (goto-char (rmail-msgbeg msg))
2893 (if rmail-enable-mime
2894 (if rmail-search-mime-message-function
2895 (funcall rmail-search-mime-message-function msg regexp)
2896 (error "You must set `rmail-search-mime-message-function'"))
2897 (re-search-forward regexp (rmail-msgend msg) t)))
2899 (defvar rmail-search-last-regexp nil)
2900 (defun rmail-search (regexp &optional n)
2901 "Show message containing next match for REGEXP (but not the current msg).
2902 Prefix argument gives repeat count; negative argument means search
2903 backwards (through earlier messages).
2904 Interactively, empty argument means use same regexp used last time."
2906 (let* ((reversep (< (prefix-numeric-value current-prefix-arg) 0))
2908 (concat (if reversep "Reverse " "") "Rmail search (regexp"))
2912 (if rmail-search-last-regexp
2913 (concat ", default "
2914 rmail-search-last-regexp "): ")
2916 (setq regexp (read-string prompt))
2917 (cond ((not (equal regexp ""))
2918 (setq rmail-search-last-regexp regexp))
2919 ((not rmail-search-last-regexp)
2920 (error "No previous Rmail search string")))
2921 (list rmail-search-last-regexp
2922 (prefix-numeric-value current-prefix-arg))))
2924 (message "%sRmail search for %s..."
2925 (if (< n 0) "Reverse " "")
2927 (set-buffer rmail-buffer)
2928 (let ((orig-message rmail-current-message)
2929 (msg rmail-current-message)
2931 (opoint (if (rmail-buffers-swapped-p) (point)))
2933 (rmail-swap-buffers-maybe)
2934 (rmail-maybe-set-message-counters)
2938 ;; Check messages one by one, advancing message number up or
2939 ;; down but searching forward through each message.
2941 (while (and (null found) (> msg 1))
2943 found (rmail-search-message msg regexp)))
2944 (while (and (null found) (< msg rmail-total-messages))
2946 found (rmail-search-message msg regexp))))
2947 (setq n (+ n (if reversep 1 -1))))
2950 (rmail-show-message-maybe msg)
2951 ;; Search forward (if this is a normal search) or backward
2952 ;; (if this is a reverse search) through this message to
2953 ;; position point. This search may fail because REGEXP
2954 ;; was found in the hidden portion of this message. In
2955 ;; that case, move point to the beginning of visible
2959 (goto-char (point-max))
2960 (re-search-backward regexp nil 'move))
2961 (goto-char (point-min))
2962 (re-search-forward regexp nil t))
2963 (message "%sRmail search for %s...done"
2964 (if reversep "Reverse " "")
2966 (rmail-show-message-maybe orig-message)
2967 (if opoint (goto-char opoint))
2969 (message "Search failed: %s" regexp)))))
2971 (defun rmail-search-backwards (regexp &optional n)
2972 "Show message containing previous match for REGEXP.
2973 Prefix argument gives repeat count; negative argument means search
2974 forward (through later messages).
2975 Interactively, empty argument means use same regexp used last time."
2977 (let* ((reversep (>= (prefix-numeric-value current-prefix-arg) 0))
2979 (concat (if reversep "Reverse " "") "Rmail search (regexp"))
2983 (if rmail-search-last-regexp
2984 (concat ", default "
2985 rmail-search-last-regexp "): ")
2987 (setq regexp (read-string prompt))
2988 (cond ((not (equal regexp ""))
2989 (setq rmail-search-last-regexp regexp))
2990 ((not rmail-search-last-regexp)
2991 (error "No previous Rmail search string")))
2992 (list rmail-search-last-regexp
2993 (prefix-numeric-value current-prefix-arg))))
2994 (rmail-search regexp (- (or n 1))))
2996 ;; Scan for attributes, and compare subjects.
2998 (defun rmail-first-unseen-message ()
2999 "Return message number of first message which has `unseen' attribute."
3000 (rmail-maybe-set-message-counters)
3005 (while (and (not found) (<= current rmail-total-messages))
3006 (if (rmail-message-attr-p current "......U")
3007 (setq found current))
3008 (setq current (1+ current))))
3011 (defun rmail-simplified-subject (&optional msgnum)
3012 "Return the simplified subject of message MSGNUM (or current message).
3013 Simplifying the subject means stripping leading and trailing whitespace,
3014 and typical reply prefixes such as Re:."
3015 (let ((subject (or (rmail-get-header "Subject" msgnum) "")))
3016 (if (string-match "\\`[ \t]+" subject)
3017 (setq subject (substring subject (match-end 0))))
3018 (if (string-match rmail-reply-regexp subject)
3019 (setq subject (substring subject (match-end 0))))
3020 (if (string-match "[ \t]+\\'" subject)
3021 (setq subject (substring subject 0 (match-beginning 0))))
3024 (defun rmail-simplified-subject-regexp ()
3025 "Return a regular expression matching the current simplified subject.
3026 The idea is to match it against simplified subjects of other messages."
3027 (let ((subject (rmail-simplified-subject)))
3028 (setq subject (regexp-quote subject))
3029 ;; Hide commas so it will work ok if parsed as a comma-separated list
3032 (replace-regexp-in-string "," "\054" subject t t))
3033 (concat "\\`" subject "\\'")))
3035 (defun rmail-next-same-subject (n)
3036 "Go to the next mail message having the same subject header.
3037 With prefix argument N, do this N times.
3038 If N is negative, go backwards instead."
3040 (let ((subject (rmail-simplified-subject))
3042 (i rmail-current-message)
3044 (while (and (/= n 0)
3046 (< i rmail-total-messages)
3049 (while (and (not done)
3051 (< i rmail-total-messages)
3053 (setq i (if forward (1+ i) (1- i)))
3054 (setq done (string-equal subject (rmail-simplified-subject i))))
3055 (if done (setq found i)))
3056 (setq n (if forward (1- n) (1+ n))))
3058 (rmail-show-message-maybe found)
3059 (error "No %s message with same subject"
3060 (if forward "following" "previous")))))
3062 (defun rmail-previous-same-subject (n)
3063 "Go to the previous mail message having the same subject header.
3064 With prefix argument N, do this N times.
3065 If N is negative, go forwards instead."
3067 (rmail-next-same-subject (- n)))
3069 ;;;; *** Rmail Message Deletion Commands ***
3071 (defun rmail-message-deleted-p (n)
3072 (= (aref rmail-deleted-vector n) ?D))
3074 (defun rmail-set-message-deleted-p (n state)
3075 (aset rmail-deleted-vector n (if state ?D ?\ )))
3077 (defun rmail-delete-message ()
3078 "Delete this message and stay on it."
3080 (rmail-set-attribute rmail-deleted-attr-index t)
3081 (run-hooks 'rmail-delete-message-hook))
3083 (defun rmail-undelete-previous-message ()
3084 "Back up to deleted message, select it, and undelete it."
3086 (set-buffer rmail-buffer)
3087 (let ((msg rmail-current-message))
3088 (while (and (> msg 0)
3089 (not (rmail-message-deleted-p msg)))
3090 (setq msg (1- msg)))
3092 (error "No previous deleted message")
3093 (if (/= msg rmail-current-message)
3094 (rmail-show-message-maybe msg))
3095 (rmail-set-attribute rmail-deleted-attr-index nil)
3096 (if (rmail-summary-exists)
3097 (with-current-buffer rmail-summary-buffer
3098 (rmail-summary-mark-undeleted msg)))
3099 (rmail-maybe-display-summary))))
3101 (defun rmail-delete-forward (&optional backward)
3102 "Delete this message and move to next nondeleted one.
3103 Deleted messages stay in the file until the \\[rmail-expunge] command is given.
3104 With prefix argument, delete and move backward.
3106 Returns t if a new message is displayed after the delete, or nil otherwise."
3108 (rmail-set-attribute rmail-deleted-attr-index t)
3109 (run-hooks 'rmail-delete-message-hook)
3110 (let ((del-msg rmail-current-message))
3111 (if (rmail-summary-exists)
3112 (rmail-select-summary
3113 (rmail-summary-mark-deleted del-msg)))
3114 (prog1 (rmail-next-undeleted-message (if backward -1 1))
3115 (rmail-maybe-display-summary))))
3117 (defun rmail-delete-backward ()
3118 "Delete this message and move to previous nondeleted one.
3119 Deleted messages stay in the file until the \\[rmail-expunge] command is given."
3121 (rmail-delete-forward t))
3125 ;; Compute the message number a given message would have after expunging.
3126 ;; The present number of the message is OLDNUM.
3127 ;; DELETEDVEC should be rmail-deleted-vector.
3128 ;; The value is nil for a message that would be deleted.
3129 (defun rmail-msg-number-after-expunge (deletedvec oldnum)
3130 (if (or (null oldnum) (= (aref deletedvec oldnum) ?D))
3135 (if (/= (aref deletedvec i) ?D)
3136 (setq newnum (1+ newnum)))
3140 (defun rmail-expunge-confirmed ()
3141 "Return t if deleted message should be expunged. If necessary, ask the user.
3142 See also user-option `rmail-confirm-expunge'."
3143 (set-buffer rmail-buffer)
3144 (or (not (stringp rmail-deleted-vector))
3145 (not (string-match "D" rmail-deleted-vector))
3146 (null rmail-confirm-expunge)
3147 (funcall rmail-confirm-expunge
3148 "Erase deleted messages from Rmail file? ")))
3150 (defun rmail-only-expunge (&optional dont-show)
3151 "Actually erase all deleted messages in the file."
3153 (rmail-swap-buffers-maybe)
3154 (set-buffer rmail-buffer)
3155 (message "Expunging deleted messages...")
3156 ;; Discard all undo records for this buffer.
3157 (or (eq buffer-undo-list t)
3158 (setq buffer-undo-list nil))
3159 (rmail-maybe-set-message-counters)
3160 (let* ((omax (- (buffer-size) (point-max)))
3161 (omin (- (buffer-size) (point-min)))
3162 (opoint (if (and (> rmail-current-message 0)
3163 (rmail-message-deleted-p rmail-current-message))
3165 (if rmail-enable-mime
3166 (with-current-buffer rmail-view-buffer
3167 (- (point)(point-min)))
3168 (- (point) (point-min)))))
3169 (messages-head (cons (aref rmail-message-vector 0) nil))
3170 (messages-tail messages-head)
3171 ;; Don't make any undo records for the expunging.
3172 (buffer-undo-list t)
3177 (goto-char (point-min))
3181 (new-msgref (list (list 0)))
3182 (buffer-read-only nil)
3183 (total rmail-total-messages)
3184 (new-message-number rmail-current-message)
3185 (messages rmail-message-vector)
3186 (deleted rmail-deleted-vector)
3187 (summary rmail-summary-vector))
3188 (setq rmail-total-messages nil
3189 rmail-current-message nil
3190 rmail-message-vector nil
3191 rmail-deleted-vector nil
3192 rmail-summary-vector nil)
3194 (while (<= number total)
3195 (if (= (aref deleted number) ?D)
3197 (delete-region (aref messages number)
3198 (aref messages (1+ number)))
3199 (move-marker (aref messages number) nil)
3200 (if (> new-message-number counter)
3201 (setq new-message-number (1- new-message-number))))
3202 (setq counter (1+ counter))
3204 (setcdr messages-tail
3205 (cons (aref messages number) nil)))
3207 (cons (if (= counter number) (aref summary (1- number)))
3210 (cons (aref rmail-msgref-vector number)
3212 (setcar (car new-msgref) counter))
3213 (if (zerop (% (setq number (1+ number)) 20))
3214 (message "Expunging deleted messages...%d" number)))
3216 (setcdr messages-tail
3217 (cons (aref messages number) nil)))
3218 (setq rmail-current-message new-message-number
3219 rmail-total-messages counter
3220 rmail-message-vector (apply 'vector messages-head)
3221 rmail-deleted-vector (make-string (1+ counter) ?\ )
3222 rmail-summary-vector (vconcat (nreverse new-summary))
3223 rmail-msgref-vector (apply 'vector (nreverse new-msgref))
3225 (message "Expunging deleted messages...done")
3227 (narrow-to-region (- (buffer-size) omin) (- (buffer-size) omax)))
3229 (rmail-show-message-maybe (min rmail-current-message rmail-total-messages)))
3230 (if rmail-enable-mime
3231 (goto-char (+ (point-min) opoint))
3232 (goto-char (+ (point) opoint))))))
3234 (defun rmail-expunge (&optional dont-show)
3235 "Erase deleted messages from Rmail file and summary buffer."
3237 (when (rmail-expunge-confirmed)
3238 (let ((old-total rmail-total-messages)
3239 (opoint (with-current-buffer rmail-buffer
3240 (when (rmail-buffers-swapped-p)
3242 (rmail-only-expunge dont-show)
3243 (if (rmail-summary-exists)
3244 (rmail-select-summary (rmail-update-summary))
3245 (rmail-show-message rmail-current-message)
3246 (if (and (eq old-total rmail-total-messages) opoint)
3247 (goto-char opoint))))))
3249 ;;;; *** Rmail Mailing Commands ***
3251 (defun rmail-start-mail (&optional noerase to subject in-reply-to cc
3252 replybuffer sendactions same-window others)
3255 (setq yank-action (list 'insert-buffer replybuffer)))
3256 (setq others (cons (cons "cc" cc) others))
3257 (setq others (cons (cons "in-reply-to" in-reply-to) others))
3259 (compose-mail to subject others
3261 yank-action sendactions)
3262 (if rmail-mail-new-frame
3264 (compose-mail to subject others
3265 noerase 'switch-to-buffer-other-frame
3266 yank-action sendactions)
3267 ;; This is not a standard frame parameter;
3268 ;; nothing except sendmail.el looks at it.
3269 (modify-frame-parameters (selected-frame)
3270 '((mail-dedicated-frame . t))))
3271 (compose-mail to subject others
3272 noerase 'switch-to-buffer-other-window
3273 yank-action sendactions)))))
3275 (defun rmail-mail ()
3276 "Send mail in another window.
3277 While composing the message, use \\[mail-yank-original] to yank the
3278 original message into it."
3280 (rmail-start-mail nil nil nil nil nil rmail-view-buffer))
3282 (defun rmail-continue ()
3283 "Continue composing outgoing message previously being composed."
3285 (rmail-start-mail t))
3287 (defun rmail-reply (just-sender)
3288 "Reply to the current message.
3289 Normally include CC: to all other recipients of original message;
3290 prefix argument means ignore them. While composing the reply,
3291 use \\[mail-yank-original] to yank the original message into it."
3293 (if (zerop rmail-current-message)
3294 (error "There is no message to reply to"))
3295 (let (from reply-to cc subject date to message-id references
3296 resent-to resent-cc resent-reply-to
3297 (msgnum rmail-current-message))
3301 (if (rmail-buffers-swapped-p)
3303 (goto-char (point-min))
3304 (search-forward "\n\n" nil 'move))
3305 (goto-char (rmail-msgbeg rmail-current-message))
3309 (search-forward "\n\n"
3310 (rmail-msgend rmail-current-message)
3312 (setq from (mail-fetch-field "from")
3313 reply-to (or (mail-fetch-field "mail-reply-to" nil t)
3314 (mail-fetch-field "reply-to" nil t)
3316 subject (mail-fetch-field "subject")
3317 date (mail-fetch-field "date")
3318 message-id (mail-fetch-field "message-id")
3319 references (mail-fetch-field "references" nil nil t)
3320 resent-reply-to (mail-fetch-field "resent-reply-to" nil t)
3321 ;; Bug#512. It's inappropriate to reply to these addresses.
3322 ;;; resent-cc (and (not just-sender)
3323 ;;; (mail-fetch-field "resent-cc" nil t))
3324 ;;; resent-to (or (mail-fetch-field "resent-to" nil t) "")
3325 ;;; resent-subject (mail-fetch-field "resent-subject")
3326 ;;; resent-date (mail-fetch-field "resent-date")
3327 ;;; resent-message-id (mail-fetch-field "resent-message-id")
3330 (if (mail-fetch-field "mail-followup-to" nil t)
3331 ;; If this header field is present, use it instead of
3332 ;; the To and CC fields.
3333 (setq to (mail-fetch-field "mail-followup-to" nil t))
3334 (setq cc (or (mail-fetch-field "cc" nil t) "")
3335 to (or (mail-fetch-field "to" nil t) ""))))))
3337 ;; Merge the resent-to and resent-cc into the to and cc.
3338 ;; Bug#512. It's inappropriate to reply to these addresses.
3339 ;;; (if (and resent-to (not (equal resent-to "")))
3340 ;;; (if (not (equal to ""))
3341 ;;; (setq to (concat to ", " resent-to))
3342 ;;; (setq to resent-to)))
3343 ;;; (if (and resent-cc (not (equal resent-cc "")))
3344 ;;; (if (not (equal cc ""))
3345 ;;; (setq cc (concat cc ", " resent-cc))
3346 ;;; (setq cc resent-cc)))
3347 ;; Add `Re: ' to subject if not there already.
3348 (and (stringp subject)
3350 (concat rmail-reply-prefix
3351 (if (let ((case-fold-search t))
3352 (string-match rmail-reply-regexp subject))
3353 (substring subject (match-end 0))
3357 ;; Using mail-strip-quoted-names is undesirable with newer mailers
3358 ;; since they can handle the names unstripped.
3359 ;; I don't know whether there are other mailers that still
3360 ;; need the names to be stripped.
3361 ;;; (mail-strip-quoted-names reply-to)
3362 ;; Remove unwanted names from reply-to, since Mail-Followup-To
3363 ;; header causes all the names in it to wind up in reply-to, not
3364 ;; in cc. But if what's left is an empty list, use the original.
3365 (let* ((reply-to-list (rmail-dont-reply-to reply-to)))
3366 (if (string= reply-to-list "") reply-to reply-to-list))
3368 (rmail-make-in-reply-to-field from date message-id)
3371 ;; mail-strip-quoted-names is NOT necessary for rmail-dont-reply-to
3373 (let* ((cc-list (rmail-dont-reply-to
3374 (mail-strip-quoted-names
3375 (if (null cc) to (concat to ", " cc))))))
3376 (if (string= cc-list "") nil cc-list)))
3377 (if (rmail-buffers-swapped-p)
3380 (list (list 'rmail-mark-message
3382 (with-current-buffer rmail-buffer
3383 (aref rmail-msgref-vector msgnum))
3384 rmail-answered-attr-index))
3386 (list (cons "References" (concat (mapconcat 'identity references " ")
3387 " " message-id))))))
3389 (defun rmail-mark-message (buffer msgnum-list attribute)
3390 "Give BUFFER's message number in MSGNUM-LIST the attribute ATTRIBUTE.
3391 This is use in the send-actions for message buffers.
3392 MSGNUM-LIST is a list of the form (MSGNUM)
3393 which is an element of rmail-msgref-vector."
3394 (with-current-buffer buffer
3395 (if (car msgnum-list)
3396 (rmail-set-attribute attribute t (car msgnum-list)))))
3398 (defun rmail-make-in-reply-to-field (from date message-id)
3405 (let ((tem (car (rfc822-addresses from))))
3409 (regexp-quote (if (string-match "@[^@]*\\'" tem)
3411 (match-beginning 0))
3414 ;; missing From, or Message-ID is sufficiently informative
3416 (concat message-id " (" tem ")"))
3417 ;; Copy TEM, discarding text properties.
3418 (setq tem (copy-sequence tem))
3419 (set-text-properties 0 (length tem) nil tem)
3420 (setq tem (copy-sequence tem))
3421 ;; Use prin1 to fake RFC822 quoting
3422 (let ((field (prin1-to-string tem)))
3424 (concat field "'s message of " date)
3426 ((let* ((foo "[^][\000-\037()<>@,;:\\\" ]+")
3427 (bar "[^][\000-\037()<>@,;:\\\"]+"))
3428 ;; These strings both match all non-ASCII characters.
3429 (or (string-match (concat "\\`[ \t]*\\(" bar
3430 "\\)\\(<" foo "@" foo ">\\)?[ \t]*\\'")
3431 ;; "Unix Loser <Foo@bar.edu>" => "Unix Loser"
3433 (string-match (concat "\\`[ \t]*<" foo "@" foo ">[ \t]*(\\("
3434 bar "\\))[ \t]*\\'")
3435 ;; "<Bugs@bar.edu>" (Losing Unix) => "Losing Unix"
3437 (let ((start (match-beginning 1))
3438 (end (match-end 1)))
3439 ;; Trim whitespace which above regexp match allows
3440 (while (and (< start end)
3441 (memq (aref from start) '(?\t ?\ )))
3442 (setq start (1+ start)))
3443 (while (and (< start end)
3444 (memq (aref from (1- end)) '(?\t ?\ )))
3445 (setq end (1- end)))
3446 (let ((field (substring from start end)))
3447 (if date (setq field (concat "message from " field " on " date)))
3449 ;; "<AA259@bar.edu> (message from Unix Loser on 1-Apr-89)"
3450 (concat message-id " (" field ")")
3453 ;; If we can't kludge it simply, do it correctly
3454 (let ((mail-use-rfc822 t))
3455 (rmail-make-in-reply-to-field from date message-id)))))
3457 (defun rmail-forward (resend)
3458 "Forward the current message to another user.
3459 With prefix argument, \"resend\" the message instead of forwarding it;
3460 see the documentation of `rmail-resend'."
3463 (call-interactively 'rmail-resend)
3464 (let ((forward-buffer rmail-buffer)
3465 (msgnum rmail-current-message)
3466 (subject (concat "["
3467 (let ((from (or (mail-fetch-field "From")
3468 (mail-fetch-field ">From"))))
3470 (concat (mail-strip-quoted-names from) ": ")
3472 (or (mail-fetch-field "Subject") "")
3474 (if (rmail-start-mail
3475 nil nil subject nil nil nil
3476 (list (list 'rmail-mark-message
3478 (with-current-buffer rmail-buffer
3479 (aref rmail-msgref-vector msgnum))
3480 rmail-forwarded-attr-index))
3481 ;; If only one window, use it for the mail buffer.
3482 ;; Otherwise, use another window for the mail buffer
3483 ;; so that the Rmail buffer remains visible
3484 ;; and sending the mail will get back to it.
3485 (and (not rmail-mail-new-frame) (one-window-p t)))
3486 ;; The mail buffer is now current.
3488 ;; Insert after header separator--before signature if any.
3489 (goto-char (mail-text-start))
3490 (if (or rmail-enable-mime rmail-enable-mime-composing)
3491 (funcall rmail-insert-mime-forwarded-message-function
3493 (insert "------- Start of forwarded message -------\n")
3494 ;; Quote lines with `- ' if they start with `-'.
3495 (let ((beg (point)) end)
3496 (setq end (point-marker))
3497 (set-marker-insertion-type end t)
3498 (insert-buffer-substring forward-buffer)
3500 (while (re-search-forward "^-" end t)
3505 (skip-chars-backward "\n")
3508 (delete-region (point) end)
3509 (set-marker end nil))
3510 (insert "------- End of forwarded message -------\n"))
3513 (defun rmail-resend (address &optional from comment mail-alias-file)
3514 "Resend current message to ADDRESSES.
3515 ADDRESSES should be a single address, a string consisting of several
3516 addresses separated by commas, or a list of addresses.
3518 Optional FROM is the address to resend the message from, and
3519 defaults from the value of `user-mail-address'.
3520 Optional COMMENT is a string to insert as a comment in the resent message.
3521 Optional ALIAS-FILE is alternate aliases file to be used by sendmail,
3522 typically for purposes of moderating a list."
3523 (interactive "sResend to: ")
3525 (require 'mailalias)
3526 (unless (or (eq rmail-view-buffer (current-buffer))
3527 (eq rmail-buffer (current-buffer)))
3528 (error "Not an Rmail buffer"))
3529 (if (not from) (setq from user-mail-address))
3530 (let ((tembuf (generate-new-buffer " sendmail temp"))
3531 (case-fold-search nil)
3532 (mail-personal-alias-file
3533 (or mail-alias-file mail-personal-alias-file))
3534 (mailbuf rmail-buffer))
3536 (with-current-buffer tembuf
3537 ;;>> Copy message into temp buffer
3538 (if rmail-enable-mime
3539 (if rmail-insert-mime-resent-message-function
3540 (funcall rmail-insert-mime-resent-message-function mailbuf)
3541 (error "You must set `rmail-insert-mime-resent-message-function'"))
3542 (insert-buffer-substring mailbuf))
3543 (goto-char (point-min))
3544 ;; Delete any Sender field, since that's not specifiable.
3545 ; Only delete Sender fields in the actual header.
3546 (re-search-forward "^$" nil 'move)
3547 ; Using "while" here rather than "if" because some buggy mail
3548 ; software may have inserted multiple Sender fields.
3549 (while (re-search-backward "^Sender:" nil t)
3553 (while (looking-at "[ \t]")
3555 (delete-region beg (point))))
3556 ; Go back to the beginning of the buffer so the Resent- fields
3557 ; are inserted there.
3558 (goto-char (point-min))
3559 ;;>> Insert resent-from:
3560 (insert "Resent-From: " from "\n")
3561 (insert "Resent-Date: " (mail-rfc822-date) "\n")
3562 ;;>> Insert resent-to: and bcc if need be.
3563 (let ((before (point)))
3565 (insert "Resent-Bcc: " (user-login-name) "\n"))
3566 (insert "Resent-To: " (if (stringp address)
3568 (mapconcat 'identity address ",\n\t"))
3570 ;; Expand abbrevs in the recipients.
3572 (if (featurep 'mailabbrev)
3573 (let ((end (point-marker))
3574 (local-abbrev-table mail-abbrevs)
3575 (old-syntax-table (syntax-table)))
3576 (if (and (not (vectorp mail-abbrevs))
3577 (file-exists-p mail-personal-alias-file))
3578 (build-mail-abbrevs))
3579 (unless mail-abbrev-syntax-table
3580 (mail-abbrev-make-syntax-table))
3581 (set-syntax-table mail-abbrev-syntax-table)
3583 (while (and (< (point) end)
3584 (progn (forward-word 1)
3587 (set-syntax-table old-syntax-table))
3588 (expand-mail-aliases before (point)))))
3589 ;;>> Set up comment, if any.
3590 (if (and (sequencep comment) (not (zerop (length comment))))
3591 (let ((before (point))
3594 (or (eolp) (insert "\n"))
3595 (setq after (point))
3597 (while (< (point) after)
3598 (insert "Resent-Comment: ")
3600 ;; Don't expand aliases in the destination fields
3601 ;; of the original message.
3603 (funcall send-mail-function)))
3604 (kill-buffer tembuf))
3605 (with-current-buffer rmail-buffer
3606 (rmail-set-attribute rmail-resent-attr-index t rmail-current-message))))
3608 (defvar mail-unsent-separator
3609 (concat "^ *---+ +Unsent message follows +---+ *$\\|"
3610 "^ *---+ +Returned message +---+ *$\\|"
3611 "^ *---+ *Returned mail follows *---+ *$\\|"
3612 "^Start of returned message$\\|"
3613 "^---+ Below this line is a copy of the message.$\\|"
3614 "^ *---+ +Original message +---+ *$\\|"
3615 "^ *--+ +begin message +--+ *$\\|"
3616 "^ *---+ +Original message follows +---+ *$\\|"
3617 "^ *---+ +Your message follows +---+ *$\\|"
3618 "^|? *---+ +Message text follows: +---+ *|?$\\|"
3619 "^ *---+ +This is a copy of \\w+ message, including all the headers.*---+ *$")
3620 "A regexp that matches the separator before the text of a failed message.")
3622 (defvar mail-mime-unsent-header "^Content-Type: message/rfc822 *$"
3623 "A regexp that matches the header of a MIME body part with a failed message.")
3625 (defun rmail-retry-failure ()
3626 "Edit a mail message which is based on the contents of the current message.
3627 For a message rejected by the mail system, extract the interesting headers and
3628 the body of the original message.
3629 If the failed message is a MIME multipart message, it is searched for a
3630 body part with a header which matches the variable `mail-mime-unsent-header'.
3631 Otherwise, the variable `mail-unsent-separator' should match the string that
3632 delimits the returned original message.
3633 The variable `rmail-retry-ignored-headers' is a regular expression
3634 specifying headers which should not be copied into the new message."
3636 (require 'mail-utils)
3637 (let ((rmail-this-buffer (current-buffer))
3638 (msgnum rmail-current-message)
3639 bounce-start bounce-end bounce-indent resending
3640 ;; Fetch any content-type header in current message
3641 ;; Must search thru the whole unpruned header.
3645 (mail-fetch-field "Content-Type") ))))
3647 (goto-char (point-min))
3648 (let ((case-fold-search t))
3649 (if (and content-type
3651 ";[\n\t ]*boundary=\"?\\([-0-9a-z'()+_,./:=? ]+\\)\"?"
3653 ;; Handle a MIME multipart bounce message.
3656 (substring content-type (match-beginning 1)
3658 (unless (re-search-forward mail-mime-unsent-header nil t)
3659 (error "Cannot find beginning of header in failed message"))
3660 (unless (search-forward "\n\n" nil t)
3661 (error "Cannot find start of Mime data in failed message"))
3662 (setq bounce-start (point))
3663 (if (search-forward codestring nil t)
3664 (setq bounce-end (match-beginning 0))
3665 (setq bounce-end (point-max))))
3667 (or (re-search-forward mail-unsent-separator nil t)
3668 (error "Cannot parse this as a failure message"))
3669 (skip-chars-forward "\n")
3670 ;; Support a style of failure message in which the original
3671 ;; message is indented, and included within lines saying
3672 ;; `Start of returned message' and `End of returned message'.
3673 (if (looking-at " +Received:")
3675 (setq bounce-start (point))
3676 (skip-chars-forward " ")
3677 (setq bounce-indent (- (current-column)))
3678 (goto-char (point-max))
3679 (re-search-backward "^End of returned message$" nil t)
3680 (setq bounce-end (point)))
3681 ;; One message contained a few random lines before
3682 ;; the old message header. The first line of the
3683 ;; message started with two hyphens. A blank line
3684 ;; followed these random lines. The same line
3685 ;; beginning with two hyphens was possibly marking
3686 ;; the end of the message.
3687 (if (looking-at "^--")
3688 (let ((boundary (buffer-substring-no-properties
3690 (progn (end-of-line) (point)))))
3691 (search-forward "\n\n")
3692 (skip-chars-forward "\n")
3693 (setq bounce-start (point))
3694 (goto-char (point-max))
3695 (search-backward (concat "\n\n" boundary) bounce-start t)
3696 (setq bounce-end (point)))
3697 (setq bounce-start (point)
3698 bounce-end (point-max)))
3699 (unless (search-forward "\n\n" nil t)
3700 (error "Cannot find end of header in failed message"))))))
3701 ;; We have found the message that bounced, within the current message.
3702 ;; Now start sending new message; default header fields from original.
3703 ;; Turn off the usual actions for initializing the message body
3704 ;; because we want to get only the text from the failure message.
3705 (let (mail-signature mail-setup-hook)
3706 (if (rmail-start-mail nil nil nil nil nil rmail-this-buffer
3707 (list (list 'rmail-mark-message
3709 (aref rmail-msgref-vector msgnum)
3710 rmail-retried-attr-index)))
3711 ;; Insert original text as initial text of new draft message.
3712 ;; Bind inhibit-read-only since the header delimiter
3713 ;; of the previous message was probably read-only.
3714 (let ((inhibit-read-only t)
3715 rmail-displayed-headers
3716 rmail-ignored-headers)
3718 (insert-buffer-substring rmail-this-buffer
3719 bounce-start bounce-end)
3720 (goto-char (point-min))
3722 (indent-rigidly (point-min) (point-max) bounce-indent))
3723 (mail-sendmail-delimit-header)
3725 (narrow-to-region (point-min) (mail-header-end))
3726 (setq resending (mail-fetch-field "resent-to"))
3729 (insert "Resent-Bcc: " (user-login-name) "\n")
3730 (insert "BCC: " (user-login-name) "\n"))))
3731 (goto-char (point-min))
3732 (mail-position-on-field (if resending "Resent-To" "To") t))))))
3734 (defun rmail-summary-exists ()
3735 "Non-nil if in an RMAIL buffer and an associated summary buffer exists.
3736 In fact, the non-nil value returned is the summary buffer itself."
3737 (and rmail-summary-buffer (buffer-name rmail-summary-buffer)
3738 rmail-summary-buffer))
3740 (defun rmail-summary-displayed ()
3741 "t if in RMAIL buffer and an associated summary buffer is displayed."
3742 (and rmail-summary-buffer (get-buffer-window rmail-summary-buffer)))
3744 (defcustom rmail-redisplay-summary nil
3745 "Non-nil means Rmail should show the summary when it changes.
3746 This has an effect only if a summary buffer exists."
3748 :group 'rmail-summary)
3750 (defcustom rmail-summary-window-size nil
3751 "Non-nil means specify the height for an Rmail summary window."
3752 :type '(choice (const :tag "Disabled" nil) integer)
3753 :group 'rmail-summary)
3755 ;; Put the summary buffer back on the screen, if user wants that.
3756 (defun rmail-maybe-display-summary ()
3757 (let ((selected (selected-window))
3759 ;; If requested, make sure the summary is displayed.
3760 (and rmail-summary-buffer (buffer-name rmail-summary-buffer)
3761 rmail-redisplay-summary
3762 (if (get-buffer-window rmail-summary-buffer 0)
3763 ;; It's already in some frame; show that one.
3764 (let ((frame (window-frame
3765 (get-buffer-window rmail-summary-buffer 0))))
3766 (make-frame-visible frame)
3767 (raise-frame frame))
3768 (display-buffer rmail-summary-buffer)))
3769 ;; If requested, set the height of the summary window.
3770 (and rmail-summary-buffer (buffer-name rmail-summary-buffer)
3771 rmail-summary-window-size
3772 (setq window (get-buffer-window rmail-summary-buffer))
3773 ;; Don't try to change the size if just one window in frame.
3774 (not (eq window (frame-root-window (window-frame window))))
3777 (select-window window)
3778 (enlarge-window (- rmail-summary-window-size (window-height))))
3779 (select-window selected)))))
3781 ;;;; *** Rmail Local Fontification ***
3783 (defun rmail-fontify-buffer-function ()
3784 ;; This function's symbol is bound to font-lock-fontify-buffer-function.
3785 (add-hook 'rmail-show-message-hook 'rmail-fontify-message nil t)
3786 ;; If we're already showing a message, fontify it now.
3787 (if rmail-current-message (rmail-fontify-message))
3788 ;; Prevent Font Lock mode from kicking in.
3789 (setq font-lock-fontified t))
3791 (defun rmail-unfontify-buffer-function ()
3792 ;; This function's symbol is bound to font-lock-fontify-unbuffer-function.
3793 (let ((modified (buffer-modified-p))
3794 (buffer-undo-list t) (inhibit-read-only t)
3795 before-change-functions after-change-functions
3796 buffer-file-name buffer-file-truename)
3799 (remove-hook 'rmail-show-message-hook 'rmail-fontify-message t)
3800 (remove-text-properties (point-min) (point-max) '(rmail-fontified nil))
3801 (font-lock-default-unfontify-buffer)
3802 (and (not modified) (buffer-modified-p)
3803 (restore-buffer-modified-p nil)))))
3805 (defun rmail-fontify-message ()
3806 ;; Fontify the current message if it is not already fontified.
3807 (if (text-property-any (point-min) (point-max) 'rmail-fontified nil)
3808 (let ((modified (buffer-modified-p))
3809 (buffer-undo-list t) (inhibit-read-only t)
3810 before-change-functions after-change-functions
3811 buffer-file-name buffer-file-truename)
3814 (add-text-properties (point-min) (point-max) '(rmail-fontified t))
3815 (font-lock-fontify-region (point-min) (point-max))
3816 (and (not modified) (buffer-modified-p)
3817 (restore-buffer-modified-p nil)))))))
3819 ;;; Speedbar support for RMAIL files.
3820 (eval-when-compile (require 'speedbar))
3822 (defvar rmail-speedbar-match-folder-regexp "^[A-Z0-9]+\\(\\.[A-Z0-9]+\\)?$"
3823 "*This regex is used to match folder names to be displayed in speedbar.
3824 Enabling this will permit speedbar to display your folders for easy
3825 browsing, and moving of messages.")
3827 (defvar rmail-speedbar-last-user nil
3828 "The last user to be displayed in the speedbar.")
3830 (defvar rmail-speedbar-key-map nil
3831 "Keymap used when in rmail display mode.")
3833 (defun rmail-install-speedbar-variables ()
3834 "Install those variables used by speedbar to enhance rmail."
3835 (if rmail-speedbar-key-map
3837 (setq rmail-speedbar-key-map (speedbar-make-specialized-keymap))
3839 (define-key rmail-speedbar-key-map "e" 'speedbar-edit-line)
3840 (define-key rmail-speedbar-key-map "r" 'speedbar-edit-line)
3841 (define-key rmail-speedbar-key-map "\C-m" 'speedbar-edit-line)
3842 (define-key rmail-speedbar-key-map "M"
3843 'rmail-speedbar-move-message-to-folder-on-line)))
3845 (defvar rmail-speedbar-menu-items
3846 '(["Read Folder" speedbar-edit-line t]
3847 ["Move message to folder" rmail-speedbar-move-message-to-folder-on-line
3848 (save-excursion (beginning-of-line)
3849 (looking-at "<M> "))])
3850 "Additional menu-items to add to speedbar frame.")
3852 ;; Make sure our special speedbar major mode is loaded
3853 (if (featurep 'speedbar)
3854 (rmail-install-speedbar-variables)
3855 (add-hook 'speedbar-load-hook 'rmail-install-speedbar-variables))
3857 (defun rmail-speedbar-buttons (buffer)
3858 "Create buttons for BUFFER containing rmail messages.
3859 Click on the address under Reply to: to reply to this person.
3860 Under Folders: Click a name to read it, or on the <M> to move the
3861 current message into that RMAIL folder."
3863 (with-current-buffer buffer
3864 (goto-char (point-min))
3865 (if (not (re-search-forward "^Reply-To: " nil t))
3866 (if (not (re-search-forward "^From:? " nil t))
3870 (setq from (buffer-substring (point) (line-end-position)))))
3871 (goto-char (point-min))
3872 (if (and (looking-at "Reply to:")
3873 (equal from rmail-speedbar-last-user))
3875 (setq rmail-speedbar-last-user from)
3877 (insert "Reply To:\n")
3879 (speedbar-insert-button from 'speedbar-directory-face 'highlight
3880 'rmail-speedbar-button 'rmail-reply))
3881 (insert "Folders:\n")
3882 (let* ((case-fold-search nil)
3883 (df (directory-files (with-current-buffer buffer
3885 nil rmail-speedbar-match-folder-regexp)))
3887 (speedbar-insert-button "<M>" 'speedbar-button-face 'highlight
3888 'rmail-speedbar-move-message (car df))
3889 (speedbar-insert-button (car df) 'speedbar-file-face 'highlight
3890 'rmail-speedbar-find-file nil t)
3891 (setq df (cdr df)))))))
3893 (defun rmail-speedbar-button (text token indent)
3894 "Execute an rmail command specified by TEXT.
3895 The command used is TOKEN. INDENT is not used."
3896 (speedbar-with-attached-buffer
3899 (defun rmail-speedbar-find-file (text token indent)
3900 "Load in the rmail file TEXT.
3901 TOKEN and INDENT are not used."
3902 (speedbar-with-attached-buffer
3903 (message "Loading in RMAIL file %s..." text)
3906 (defun rmail-speedbar-move-message-to-folder-on-line ()
3907 "If the current line is a folder, move current message to it."
3911 (if (re-search-forward "<M> " (line-end-position) t)
3914 (speedbar-do-function-pointer)))))
3916 (defun rmail-speedbar-move-message (text token indent)
3917 "From button TEXT, copy current message to the rmail file specified by TOKEN.
3918 TEXT and INDENT are not used."
3919 (speedbar-with-attached-buffer
3920 (message "Moving message to %s" token)
3921 (rmail-output token)))
3923 ; Functions for setting, getting and encoding the POP password.
3924 ; The password is encoded to prevent it from being easily accessible
3925 ; to "prying eyes." Obviously, this encoding isn't "real security,"
3926 ; nor is it meant to be.
3929 (defun rmail-set-remote-password (password)
3930 "Set PASSWORD to be used for retrieving mail from a POP or IMAP server."
3931 (interactive "sPassword: ")
3933 (setq rmail-encoded-remote-password
3934 (rmail-encode-string password (emacs-pid)))
3935 (setq rmail-remote-password nil)
3936 (setq rmail-encoded-remote-password nil)))
3938 (defun rmail-get-remote-password (imap)
3939 "Get the password for retrieving mail from a POP or IMAP server. If none
3940 has been set, then prompt the user for one."
3941 (when (not rmail-encoded-remote-password)
3942 (if (not rmail-remote-password)
3943 (setq rmail-remote-password
3944 (read-passwd (if imap
3946 "POP password: "))))
3947 (rmail-set-remote-password rmail-remote-password)
3948 (setq rmail-remote-password nil))
3949 (rmail-encode-string rmail-encoded-remote-password (emacs-pid)))
3951 (defun rmail-have-password ()
3952 (or rmail-remote-password rmail-encoded-remote-password))
3954 (defun rmail-encode-string (string mask)
3955 "Encode STRING with integer MASK, by taking the exclusive OR of the
3956 lowest byte in the mask with the first character of string, the
3957 second-lowest-byte with the second character of the string, etc.,
3958 restarting at the lowest byte of the mask whenever it runs out.
3959 Returns the encoded string. Calling the function again with an
3960 encoded string (and the same mask) will decode the string."
3961 (setq mask (abs mask)) ; doesn't work if negative
3962 (let* ((string-vector (string-to-vector string)) (i 0)
3963 (len (length string-vector)) (curmask mask) charmask)
3966 (setq curmask mask))
3967 (setq charmask (% curmask 256))
3968 (setq curmask (lsh curmask -8))
3969 (aset string-vector i (logxor charmask (aref string-vector i)))
3971 (concat string-vector)))
3973 ;;;; Desktop support
3975 (defun rmail-restore-desktop-buffer (desktop-buffer-file-name
3977 desktop-buffer-misc)
3978 "Restore an rmail buffer specified in a desktop file."
3979 (condition-case error
3981 (rmail-input desktop-buffer-file-name)
3982 (if (eq major-mode 'rmail-mode)
3986 (kill-buffer (current-buffer))
3989 (add-to-list 'desktop-buffer-mode-handlers
3990 '(rmail-mode . rmail-restore-desktop-buffer))
3992 ;; Used in `write-region-annotate-functions' to write rmail files.
3993 (defun rmail-write-region-annotate (start end)
3994 (when (and (null start) (rmail-buffers-swapped-p))
3995 (set-buffer rmail-view-buffer)
4001 ;; arch-tag: 65d257d3-c281-4a65-9c38-e61af95af2f0
4002 ;;; rmail.el ends here