Add 2010 to copyright years.
[bpt/emacs.git] / lisp / mail / rmail.el
1 ;;; rmail.el --- main code of "RMAIL" mail reader for Emacs
2
3 ;; Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 ;; Free Software Foundation, Inc.
6
7 ;; Maintainer: FSF
8 ;; Keywords: mail
9
10 ;; This file is part of GNU Emacs.
11
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.
16
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.
21
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/>.
24
25 ;;; Commentary:
26
27 ;;; Code:
28
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.
33
34 ;; Extended by Bob Weiner of Motorola
35 ;; New features include: rmail and rmail-summary buffers remain
36 ;; synchronized and key bindings basically operate the same way in both
37 ;; buffers, summary by topic or by regular expression, rmail-reply-prefix
38 ;; variable, and a bury rmail buffer (wipe) command.
39 ;;
40
41 (require 'mail-utils)
42
43 (defconst rmail-attribute-header "X-RMAIL-ATTRIBUTES"
44 "The header that stores the Rmail attribute data.")
45
46 (defconst rmail-keyword-header "X-RMAIL-KEYWORDS"
47 "The header that stores the Rmail keyword data.")
48
49 ;;; Attribute indexes
50
51 (defconst rmail-answered-attr-index 0
52 "The index for the `answered' attribute.")
53
54 (defconst rmail-deleted-attr-index 1
55 "The index for the `deleted' attribute.")
56
57 (defconst rmail-edited-attr-index 2
58 "The index for the `edited' attribute.")
59
60 (defconst rmail-filed-attr-index 3
61 "The index for the `filed' attribute.")
62
63 (defconst rmail-retried-attr-index 4
64 "The index for the `retried' attribute.")
65
66 (defconst rmail-forwarded-attr-index 5
67 "The index for the `forwarded' attribute.")
68
69 (defconst rmail-unseen-attr-index 6
70 "The index for the `unseen' attribute.")
71
72 (defconst rmail-resent-attr-index 7
73 "The index for the `resent' attribute.")
74
75 (defconst rmail-attr-array
76 '[(?A "answered")
77 (?D "deleted")
78 (?E "edited")
79 (?F "filed")
80 (?R "retried")
81 (?S "forwarded")
82 (?U "unseen")
83 (?r "resent")]
84 "An array that provides a mapping between an attribute index,
85 its character representation and its display representation.")
86
87 (defvar deleted-head)
88 (defvar font-lock-fontified)
89 (defvar mail-abbrev-syntax-table)
90 (defvar mail-abbrevs)
91 (defvar messages-head)
92 (defvar total-messages)
93 (defvar tool-bar-map)
94
95 (defvar rmail-header-style 'normal
96 "The current header display style choice, one of
97 'normal (selected headers) or 'full (all headers).")
98
99 ;; rmail-spool-directory and rmail-file-name are defined in paths.el.
100
101 (defgroup rmail nil
102 "Mail reader for Emacs."
103 :group 'mail)
104
105 (defgroup rmail-retrieve nil
106 "Rmail retrieval options."
107 :prefix "rmail-"
108 :group 'rmail)
109
110 (defgroup rmail-files nil
111 "Rmail files."
112 :prefix "rmail-"
113 :group 'rmail)
114
115 (defgroup rmail-headers nil
116 "Rmail header options."
117 :prefix "rmail-"
118 :group 'rmail)
119
120 (defgroup rmail-reply nil
121 "Rmail reply options."
122 :prefix "rmail-"
123 :group 'rmail)
124
125 (defgroup rmail-summary nil
126 "Rmail summary options."
127 :prefix "rmail-"
128 :prefix "rmail-summary-"
129 :group 'rmail)
130
131 (defgroup rmail-output nil
132 "Output message to a file."
133 :prefix "rmail-output-"
134 :prefix "rmail-"
135 :group 'rmail)
136
137 (defgroup rmail-edit nil
138 "Rmail editing."
139 :prefix "rmail-edit-"
140 :group 'rmail)
141
142 (defcustom rmail-movemail-program nil
143 "If non-nil, the file name of the `movemail' program."
144 :group 'rmail-retrieve
145 :type '(choice (const nil) string))
146
147 (define-obsolete-variable-alias 'rmail-pop-password
148 'rmail-remote-password "22.1")
149
150 (defcustom rmail-remote-password nil
151 "Password to use when reading mail from a remote server.
152 This setting is ignored for mailboxes whose URL already contains a password."
153 :type '(choice (string :tag "Password")
154 (const :tag "Not Required" nil))
155 :group 'rmail-retrieve
156 :version "22.1")
157
158 (define-obsolete-variable-alias 'rmail-pop-password-required
159 'rmail-remote-password-required "22.1")
160
161 (defcustom rmail-remote-password-required nil
162 "Non-nil if a password is required when reading mail from a remote server."
163 :type 'boolean
164 :group 'rmail-retrieve
165 :version "22.1")
166
167 (defcustom rmail-movemail-flags nil
168 "List of flags to pass to movemail.
169 Most commonly used to specify `-g' to enable GSS-API authentication
170 or `-k' to enable Kerberos authentication."
171 :type '(repeat string)
172 :group 'rmail-retrieve
173 :version "20.3")
174
175 (defvar rmail-remote-password-error "invalid usercode or password\\|
176 unknown user name or bad password\\|Authentication failed\\|MU_ERR_AUTH_FAILURE"
177 "Regular expression matching incorrect-password POP or IMAP server error
178 messages.
179 If you get an incorrect-password error that this expression does not match,
180 please report it with \\[report-emacs-bug].")
181
182 (defvar rmail-encoded-remote-password nil)
183
184 (defcustom rmail-preserve-inbox nil
185 "Non-nil means leave incoming mail in the user's inbox--don't delete it."
186 :type 'boolean
187 :group 'rmail-retrieve)
188
189 (defcustom rmail-movemail-search-path nil
190 "List of directories to search for movemail (in addition to `exec-path')."
191 :group 'rmail-retrieve
192 :type '(repeat (directory)))
193
194 (declare-function mail-position-on-field "sendmail" (field &optional soft))
195 (declare-function mail-text-start "sendmail" ())
196 (declare-function rmail-dont-reply-to "mail-utils" (destinations))
197 (declare-function rmail-update-summary "rmailsum" (&rest ignore))
198
199 (defun rmail-probe (prog)
200 "Determine what flavor of movemail PROG is.
201 We do this by executing it with `--version' and analyzing its output."
202 (with-temp-buffer
203 (let ((tbuf (current-buffer)))
204 (buffer-disable-undo tbuf)
205 (call-process prog nil tbuf nil "--version")
206 (if (not (buffer-modified-p tbuf))
207 ;; Should not happen...
208 nil
209 (goto-char (point-min))
210 (cond
211 ((looking-at ".*movemail: invalid option")
212 'emacs) ;; Possibly...
213 ((looking-at "movemail (GNU Mailutils .*)")
214 'mailutils)
215 (t
216 ;; FIXME:
217 'emacs))))))
218
219 (defun rmail-autodetect ()
220 "Determine the file name of the `movemail' program and return its flavor.
221 If `rmail-movemail-program' is non-nil, use it.
222 Otherwise, look for `movemail' in the directories in
223 `rmail-movemail-search-path', those in `exec-path', and `exec-directory'."
224 (if rmail-movemail-program
225 (rmail-probe rmail-movemail-program)
226 (catch 'scan
227 (dolist (dir (append rmail-movemail-search-path exec-path
228 (list exec-directory)))
229 (when (and dir (file-accessible-directory-p dir))
230 ;; Previously, this didn't have to work on Windows, because
231 ;; rmail-insert-inbox-text before r1.439 fell back to using
232 ;; (expand-file-name "movemail" exec-directory) and just
233 ;; assuming it would work.
234 ;; http://lists.gnu.org/archive/html/bug-gnu-emacs/2008-02/msg00087.html
235 (let ((progname (expand-file-name
236 (concat "movemail"
237 (if (memq system-type '(ms-dos windows-nt))
238 ".exe")) dir)))
239 (when (and (not (file-directory-p progname))
240 (file-executable-p progname))
241 (let ((x (rmail-probe progname)))
242 (when x
243 (setq rmail-movemail-program progname)
244 (throw 'scan x))))))))))
245
246 (defvar rmail-movemail-variant-in-use nil
247 "The movemail variant currently in use. Known variants are:
248
249 `emacs' Means any implementation, compatible with the native Emacs one.
250 This is the default;
251 `mailutils' Means GNU mailutils implementation, capable of handling full
252 mail URLs as the source mailbox.")
253
254 ;;;###autoload
255 (defun rmail-movemail-variant-p (&rest variants)
256 "Return t if the current movemail variant is any of VARIANTS.
257 Currently known variants are 'emacs and 'mailutils."
258 (when (not rmail-movemail-variant-in-use)
259 ;; Autodetect
260 (setq rmail-movemail-variant-in-use (rmail-autodetect)))
261 (not (null (member rmail-movemail-variant-in-use variants))))
262
263 ;; Call for effect, to set rmail-movemail-program (if not set by the
264 ;; user), and rmail-movemail-variant-in-use. Used by various functions.
265 ;; I'm not sure if M-x rmail is the only entry point to this package.
266 ;; If so, this can be moved there.
267 (rmail-movemail-variant-p)
268
269 ;;;###autoload
270 (defcustom rmail-user-mail-address-regexp nil
271 "Regexp matching user mail addresses.
272 If non-nil, this variable is used to identify the correspondent
273 when receiving new mail. If it matches the address of the sender,
274 the recipient is taken as correspondent of a mail.
275 If nil \(default value\), your `user-login-name' and `user-mail-address'
276 are used to exclude yourself as correspondent.
277
278 Usually you don't have to set this variable, except if you collect mails
279 sent by you under different user names.
280 Then it should be a regexp matching your mail addresses.
281
282 Setting this variable has an effect only before reading a mail."
283 :type '(choice (const :tag "None" nil) regexp)
284 :group 'rmail-retrieve
285 :version "21.1")
286
287 ;;;###autoload
288 (defcustom rmail-dont-reply-to-names nil
289 "A regexp specifying addresses to prune from a reply message.
290 If this is nil, it is set the first time you compose a reply, to
291 a value which excludes your own email address, plus whatever is
292 specified by `rmail-default-dont-reply-to-names'.
293
294 Matching addresses are excluded from the CC field in replies, and
295 also the To field, unless this would leave an empty To field."
296 :type '(choice regexp (const :tag "Your Name" nil))
297 :group 'rmail-reply)
298
299 ;;;###autoload
300 (defvar rmail-default-dont-reply-to-names (purecopy "\\`info-")
301 "Regexp specifying part of the default value of `rmail-dont-reply-to-names'.
302 This is used when the user does not set `rmail-dont-reply-to-names'
303 explicitly. (The other part of the default value is the user's
304 email address and name.) It is useful to set this variable in
305 the site customization file. The default value is conventionally
306 used for large mailing lists to broadcast announcements.")
307 ;; Is it really useful to set this site-wide?
308
309 ;;;###autoload
310 (defcustom rmail-ignored-headers
311 (purecopy
312 (concat "^via:\\|^mail-from:\\|^origin:\\|^references:\\|^sender:"
313 "\\|^status:\\|^received:\\|^x400-originator:\\|^x400-recipients:"
314 "\\|^x400-received:\\|^x400-mts-identifier:\\|^x400-content-type:"
315 "\\|^\\(resent-\\|\\)message-id:\\|^summary-line:\\|^resent-date:"
316 "\\|^nntp-posting-host:\\|^path:\\|^x-char.*:\\|^x-face:\\|^face:"
317 "\\|^x-mailer:\\|^delivered-to:\\|^lines:"
318 "\\|^content-transfer-encoding:\\|^x-coding-system:"
319 "\\|^return-path:\\|^errors-to:\\|^return-receipt-to:"
320 "\\|^precedence:\\|^mime-version:"
321 "\\|^list-owner:\\|^list-help:\\|^list-post:\\|^list-subscribe:"
322 "\\|^list-id:\\|^list-unsubscribe:\\|^list-archive:"
323 "\\|^content-length:\\|^nntp-posting-date:\\|^user-agent"
324 "\\|^importance:\\|^envelope-to:\\|^delivery-date\\|^openpgp:"
325 "\\|^mbox-line:\\|^cancel-lock:"
326 "\\|^DomainKey-Signature:\\|^dkim-signature:"
327 "\\|^resent-face:\\|^resent-x.*:\\|^resent-organization:\\|^resent-openpgp:"
328 "\\|^x-.*:"))
329 "Regexp to match header fields that Rmail should normally hide.
330 \(See also `rmail-nonignored-headers', which overrides this regexp.)
331 This variable is used for reformatting the message header,
332 which normally happens once for each message,
333 when you view the message for the first time in Rmail.
334 To make a change in this variable take effect
335 for a message that you have already viewed,
336 go to that message and type \\[rmail-toggle-header] twice."
337 :type 'regexp
338 :group 'rmail-headers)
339
340 (defcustom rmail-nonignored-headers "^x-spam-status:"
341 "Regexp to match X header fields that Rmail should show.
342 This regexp overrides `rmail-ignored-headers'; if both this regexp
343 and that one match a certain header field, Rmail shows the field.
344 If this is nil, ignore all header fields in `rmail-ignored-headers'.
345
346 This variable is used for reformatting the message header,
347 which normally happens once for each message,
348 when you view the message for the first time in Rmail.
349 To make a change in this variable take effect
350 for a message that you have already viewed,
351 go to that message and type \\[rmail-toggle-header] twice."
352 :type '(choice (const nil) (regexp))
353 :group 'rmail-headers)
354
355 ;;;###autoload
356 (defcustom rmail-displayed-headers nil
357 "Regexp to match Header fields that Rmail should display.
358 If nil, display all header fields except those matched by
359 `rmail-ignored-headers'."
360 :type '(choice regexp (const :tag "All"))
361 :group 'rmail-headers)
362
363 ;;;###autoload
364 (defcustom rmail-retry-ignored-headers (purecopy "^x-authentication-warning:\\|^x-detected-operating-system:\\|^x-spam[-a-z]*:\\|content-type:\\|content-transfer-encoding:\\|mime-version:")
365 "Headers that should be stripped when retrying a failed message."
366 :type '(choice regexp (const nil :tag "None"))
367 :group 'rmail-headers
368 :version "23.2") ; added x-detected-operating-system, x-spam
369
370 ;;;###autoload
371 (defcustom rmail-highlighted-headers (purecopy "^From:\\|^Subject:")
372 "Regexp to match Header fields that Rmail should normally highlight.
373 A value of nil means don't highlight. Uses the face `rmail-highlight'."
374 :type 'regexp
375 :group 'rmail-headers)
376
377 (defface rmail-highlight
378 '((t (:inherit highlight)))
379 "Face to use for highlighting the most important header fields.
380 The variable `rmail-highlighted-headers' specifies which headers."
381 :group 'rmail-headers
382 :version "22.1")
383
384 (defface rmail-header-name
385 '((t (:inherit font-lock-function-name-face)))
386 "Face to use for highlighting the header names.
387 The variable `rmail-font-lock-keywords' specifies which headers
388 get highlighted."
389 :group 'rmail-headers
390 :version "23.1")
391
392 (defcustom rmail-delete-after-output nil
393 "Non-nil means automatically delete a message that is copied to a file."
394 :type 'boolean
395 :group 'rmail-files)
396
397 ;;;###autoload
398 (defcustom rmail-primary-inbox-list nil
399 "List of files that are inboxes for your primary mail file `rmail-file-name'.
400 If this is nil, uses the environment variable MAIL. If that is
401 unset, uses a file named by the function `user-login-name' in the
402 directory `rmail-spool-directory' (whose value depends on the
403 operating system). For example, \"/var/mail/USER\"."
404 ;; Don't use backquote here, because we don't want to need it at load time.
405 ;; (That must be an old comment - it's dumped these days.)
406 :type (list 'choice '(const :tag "Default" nil)
407 (list 'repeat ':value (list (or (getenv "MAIL")
408 (concat rmail-spool-directory
409 (user-login-name))))
410 'file))
411 :group 'rmail-retrieve
412 :group 'rmail-files)
413
414 (defcustom rmail-mail-new-frame nil
415 "Non-nil means Rmail makes a new frame for composing outgoing mail.
416 This is handy if you want to preserve the window configuration of
417 the frame where you have the RMAIL buffer displayed."
418 :type 'boolean
419 :group 'rmail-reply)
420
421 ;;;###autoload
422 (defcustom rmail-secondary-file-directory (purecopy "~/")
423 "Directory for additional secondary Rmail files."
424 :type 'directory
425 :group 'rmail-files)
426 ;;;###autoload
427 (defcustom rmail-secondary-file-regexp (purecopy "\\.xmail$")
428 "Regexp for which files are secondary Rmail files."
429 :type 'regexp
430 :group 'rmail-files)
431
432 (defcustom rmail-confirm-expunge 'y-or-n-p
433 "Whether and how to ask for confirmation before expunging deleted messages.
434 The value, if non-nil is a function to call with a question (string)
435 as argument, to ask the user that question."
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))
439 :version "21.1"
440 :group 'rmail-files)
441 (put 'rmail-confirm-expunge 'risky-local-variable t)
442
443 ;;;###autoload
444 (defvar rmail-mode-hook nil
445 "List of functions to call when Rmail is invoked.")
446
447 (defvar rmail-get-new-mail-hook nil
448 "List of functions to call when Rmail has retrieved new mail.")
449
450 ;;;###autoload
451 (defcustom rmail-show-message-hook nil
452 "List of functions to call when Rmail displays a message."
453 :type 'hook
454 :options '(goto-address)
455 :group 'rmail)
456
457 (defvar rmail-quit-hook nil
458 "List of functions to call when quitting out of Rmail.")
459
460 (defvar rmail-delete-message-hook nil
461 "List of functions to call when Rmail deletes a message.
462 When the hooks are called, the message has been marked deleted but is
463 still the current message in the Rmail buffer.")
464
465 ;; These may be altered by site-init.el to match the format of mmdf files
466 ;; delimiting used on a given host (delim1 and delim2 from the config
467 ;; files).
468
469 (defvar rmail-mmdf-delim1 "^\001\001\001\001\n"
470 "Regexp marking the start of an mmdf message.")
471 (defvar rmail-mmdf-delim2 "^\001\001\001\001\n"
472 "Regexp marking the end of an mmdf message.")
473
474 ;; FIXME Post-mbox, this is now unused.
475 ;; In Emacs-22, this was called:
476 ;; i) the very first time a message was shown.
477 ;; ii) when toggling the headers to the normal state, every time.
478 ;; It's not clear what it should do now, since there is nothing that
479 ;; records when a message is shown for the first time (unseen is not
480 ;; necessarily the same thing).
481 (defcustom rmail-message-filter nil
482 "If non-nil, a filter function for new messages in RMAIL.
483 Called with region narrowed to the message, including headers,
484 before obeying `rmail-ignored-headers'."
485 :group 'rmail-headers
486 :type '(choice (const nil) function))
487
488 (defcustom rmail-automatic-folder-directives nil
489 "List of directives specifying where to put a message.
490 Each element of the list is of the form:
491
492 (FOLDERNAME FIELD REGEXP [ FIELD REGEXP ] ... )
493
494 Where FOLDERNAME is the name of a folder to put the message.
495 If any of the field regexp's are nil, then it is ignored.
496
497 If FOLDERNAME is \"/dev/null\", it is deleted.
498 If FOLDERNAME is nil then it is deleted, and skipped.
499
500 FIELD is the plain text name of a field in the message, such as
501 \"subject\" or \"from\". A FIELD of \"to\" will automatically include
502 all text from the \"cc\" field as well.
503
504 REGEXP is an expression to match in the preceeding specified FIELD.
505 FIELD/REGEXP pairs continue in the list.
506
507 examples:
508 (\"/dev/null\" \"from\" \"@spam.com\") ; delete all mail from spam.com
509 (\"RMS\" \"from\" \"rms@\") ; save all mail from RMS.
510
511 Note that this is only applied in the folder specifed by `rmail-file-name'."
512 :group 'rmail
513 :version "21.1"
514 :type '(repeat (sexp :tag "Directive")))
515
516 (defvar rmail-reply-prefix "Re: "
517 "String to prepend to Subject line when replying to a message.")
518
519 ;; Some mailers use "Re(2):" or "Re^2:" or "Re: Re:" or "Re[2]:".
520 ;; This pattern should catch all the common variants.
521 ;; rms: I deleted the change to delete tags in square brackets
522 ;; because they mess up RT tags.
523 (defvar rmail-reply-regexp "\\`\\(Re\\(([0-9]+)\\|\\[[0-9]+\\]\\|\\^[0-9]+\\)?: *\\)*"
524 "Regexp to delete from Subject line before inserting `rmail-reply-prefix'.")
525
526 (defcustom rmail-display-summary nil
527 "If non-nil, Rmail always displays the summary buffer."
528 :group 'rmail-summary
529 :type 'boolean)
530 \f
531 (defvar rmail-inbox-list nil)
532 (put 'rmail-inbox-list 'permanent-local t)
533
534 (defvar rmail-buffer nil
535 "The RMAIL buffer related to the current buffer.
536 In an RMAIL buffer, this holds the RMAIL buffer itself.
537 In a summary buffer, this holds the RMAIL buffer it is a summary for.")
538 (put 'rmail-buffer 'permanent-local t)
539
540 (defvar rmail-was-converted nil
541 "Non-nil in an Rmail buffer that was just converted from Babyl format.")
542 (put 'rmail-was-converted 'permanent-local t)
543
544 (defvar rmail-seriously-modified nil
545 "Non-nil in an Rmail buffer that has been modified in a major way.")
546 (put 'rmail-seriously-modified 'permanent-local t)
547
548 ;; Message counters and markers. Deleted flags.
549
550 (defvar rmail-current-message nil
551 "Integer specifying the message currently being displayed in this folder.")
552 (put 'rmail-current-message 'permanent-local t)
553
554 (defvar rmail-total-messages nil
555 "Integer specifying the total number of messages in this folder.
556 Includes deleted messages.")
557 (put 'rmail-total-messages 'permanent-local t)
558
559 (defvar rmail-message-vector nil
560 "Vector of markers specifying the start and end of each message.
561 Element N and N+1 specify the start and end of message N.")
562 (put 'rmail-message-vector 'permanent-local t)
563
564 (defvar rmail-deleted-vector nil
565 "A string of length `rmail-total-messages' plus one.
566 Character N is either a space or \"D\", according to whether
567 message N is deleted or not.")
568 (put 'rmail-deleted-vector 'permanent-local t)
569
570 (defvar rmail-msgref-vector nil
571 "In an Rmail buffer, a vector whose Nth element is a list (N).
572 When expunging renumbers messages, these lists are modified
573 by substituting the new message number into the existing list.")
574 (put 'rmail-msgref-vector 'permanent-local t)
575
576 (defvar rmail-overlay-list nil)
577 (put 'rmail-overlay-list 'permanent-local t)
578
579 ;; These are used by autoloaded rmail-summary.
580
581 (defvar rmail-summary-buffer nil)
582 (put 'rmail-summary-buffer 'permanent-local t)
583 (defvar rmail-summary-vector nil
584 "In an Rmail buffer, vector of (newline-terminated) strings.
585 Element N specifies the summary line for message N+1.")
586 (put 'rmail-summary-vector 'permanent-local t)
587
588 ;; Rmail buffer swapping variables.
589
590 (defvar rmail-buffer-swapped nil
591 "If non-nil, `rmail-buffer' is swapped with `rmail-view-buffer'.")
592 (make-variable-buffer-local 'rmail-buffer-swapped)
593 (put 'rmail-buffer-swapped 'permanent-local t)
594
595 (defvar rmail-view-buffer nil
596 "Buffer which holds RMAIL message for MIME displaying.")
597 (make-variable-buffer-local 'rmail-view-buffer)
598 (put 'rmail-view-buffer 'permanent-local t)
599 \f
600 ;; `Sticky' default variables.
601
602 ;; Last individual label specified to a or k.
603 (defvar rmail-last-label nil)
604
605 ;; Last set of values specified to C-M-n, C-M-p, C-M-s or C-M-l.
606 (defvar rmail-last-multi-labels nil)
607
608 (defvar rmail-last-regexp nil)
609 (put 'rmail-last-regexp 'permanent-local t)
610
611 (defcustom rmail-default-file "~/xmail"
612 "Default file name for \\[rmail-output]."
613 :type 'file
614 :group 'rmail-files)
615 (defcustom rmail-default-body-file "~/mailout"
616 "Default file name for \\[rmail-output-body-to-file]."
617 :type 'file
618 :group 'rmail-files
619 :version "20.3")
620
621 ;; Mule and MIME related variables.
622
623 ;;;###autoload
624 (defvar rmail-file-coding-system nil
625 "Coding system used in RMAIL file.
626
627 This is set to nil by default.")
628
629 (defcustom rmail-enable-mime nil
630 "If non-nil, RMAIL uses MIME features.
631 If the value is t, RMAIL automatically shows MIME decoded message.
632 If the value is neither t nor nil, RMAIL does not show MIME decoded message
633 until a user explicitly requires it.
634
635 Even if the value is non-nil, you can't use MIME features
636 unless the feature specified by `rmail-mime-feature' is available."
637 :type '(choice (const :tag "on" t)
638 (const :tag "off" nil)
639 (other :tag "when asked" ask))
640 :group 'rmail)
641
642 (defvar rmail-enable-mime-composing nil
643 "*If non-nil, RMAIL uses `rmail-insert-mime-forwarded-message-function' to forward.")
644
645 ;; FIXME unused.
646 (defvar rmail-show-mime-function nil
647 "Function to show MIME decoded message of RMAIL file.
648 This function is called when `rmail-enable-mime' is non-nil.
649 It is called with no argument.")
650
651 ;;;###autoload
652 (defvar rmail-insert-mime-forwarded-message-function nil
653 "Function to insert a message in MIME format so it can be forwarded.
654 This function is called if `rmail-enable-mime' or
655 `rmail-enable-mime-composing' is non-nil.
656 It is called with one argument FORWARD-BUFFER, which is a
657 buffer containing the message to forward. The current buffer
658 is the outgoing mail buffer.")
659
660 (defvar rmail-insert-mime-resent-message-function nil
661 "Function to insert a message in MIME format so it can be resent.
662 This function is called by `rmail-resend' if `rmail-enable-mime' is non-nil.
663 It is called with one argument FORWARD-BUFFER, which is a
664 buffer containing the message to forward. The current buffer
665 is the outgoing mail buffer.")
666
667 ;; FIXME one might want to pass a LIMIT, as per
668 ;; rmail-search-mime-header-function.
669 (defvar rmail-search-mime-message-function nil
670 "Function to check if a regexp matches a MIME message.
671 This function is called by `rmail-search-message' if
672 `rmail-enable-mime' is non-nil. It is called (with point at the
673 start of the message) with two arguments MSG and REGEXP, where
674 MSG is the message number, REGEXP is the regular expression.")
675
676 (defvar rmail-search-mime-header-function nil
677 "Function to check if a regexp matches a header of MIME message.
678 This function is called by `rmail-message-regexp-p-1' if
679 `rmail-enable-mime' is non-nil. It is called (with point at the
680 start of the header) with three arguments MSG, REGEXP, and LIMIT,
681 where MSG is the message number, REGEXP is the regular
682 expression, LIMIT is the position specifying the end of header.")
683
684 (defvar rmail-mime-feature 'rmail-mime
685 "Feature to require to load MIME support in Rmail.
686 When starting Rmail, if `rmail-enable-mime' is non-nil,
687 this feature is required with `require'.
688
689 The default value is `rmail-mime'. This feature is provided by
690 the rmail-mime package available at <http://www.m17n.org/rmail-mime/>.")
691
692 ;; FIXME this is unused.
693 (defvar rmail-decode-mime-charset t
694 "*Non-nil means a message is decoded by MIME's charset specification.
695 If this variable is nil, or the message has not MIME specification,
696 the message is decoded as normal way.
697
698 If the variable `rmail-enable-mime' is non-nil, this variable is
699 ignored, and all the decoding work is done by a feature specified by
700 the variable `rmail-mime-feature'.")
701
702 (defvar rmail-mime-charset-pattern
703 (concat "^content-type:[ \t]*text/plain;"
704 "\\(?:[ \t\n]*\\(?:format\\|delsp\\)=\"?[-a-z0-9]+\"?;\\)*"
705 "[ \t\n]*charset=\"?\\([^ \t\n\";]+\\)\"?")
706 "Regexp to match MIME-charset specification in a header of message.
707 The first parenthesized expression should match the MIME-charset name.")
708
709 \f
710 (defvar rmail-unix-mail-delimiter
711 (let ((time-zone-regexp
712 (concat "\\([A-Z]?[A-Z]?[A-Z][A-Z]\\( DST\\)?"
713 "\\|[-+]?[0-9][0-9][0-9][0-9]"
714 "\\|"
715 "\\) *")))
716 (concat
717 "From "
718
719 ;; Many things can happen to an RFC 822 mailbox before it is put into
720 ;; a `From' line. The leading phrase can be stripped, e.g.
721 ;; `Joe <@w.x:joe@y.z>' -> `<@w.x:joe@y.z>'. The <> can be stripped, e.g.
722 ;; `<@x.y:joe@y.z>' -> `@x.y:joe@y.z'. Everything starting with a CRLF
723 ;; can be removed, e.g.
724 ;; From: joe@y.z (Joe K
725 ;; User)
726 ;; can yield `From joe@y.z (Joe K Fri Mar 22 08:11:15 1996', and
727 ;; From: Joe User
728 ;; <joe@y.z>
729 ;; can yield `From Joe User Fri Mar 22 08:11:15 1996'.
730 ;; The mailbox can be removed or be replaced by white space, e.g.
731 ;; From: "Joe User"{space}{tab}
732 ;; <joe@y.z>
733 ;; can yield `From {space}{tab} Fri Mar 22 08:11:15 1996',
734 ;; where {space} and {tab} represent the Ascii space and tab characters.
735 ;; We want to match the results of any of these manglings.
736 ;; The following regexp rejects names whose first characters are
737 ;; obviously bogus, but after that anything goes.
738 "\\([^\0-\b\n-\r\^?].*\\)? "
739
740 ;; The time the message was sent.
741 "\\([^\0-\r \^?]+\\) +" ; day of the week
742 "\\([^\0-\r \^?]+\\) +" ; month
743 "\\([0-3]?[0-9]\\) +" ; day of month
744 "\\([0-2][0-9]:[0-5][0-9]\\(:[0-6][0-9]\\)?\\) *" ; time of day
745
746 ;; Perhaps a time zone, specified by an abbreviation, or by a
747 ;; numeric offset.
748 time-zone-regexp
749
750 ;; The year.
751 " \\([0-9][0-9]+\\) *"
752
753 ;; On some systems the time zone can appear after the year, too.
754 time-zone-regexp
755
756 ;; Old uucp cruft.
757 "\\(remote from .*\\)?"
758
759 "\n"))
760 "Regexp matching the delimiter of messages in UNIX mail format
761 \(UNIX From lines), minus the initial ^. Note that if you change
762 this expression, you must change the code in `rmail-nuke-pinhead-header'
763 that knows the exact ordering of the \\( \\) subexpressions.")
764
765 ;; FIXME the rmail-header-name headers ought to be customizable.
766 ;; It seems a bit arbitrary, for example, that all of the Date: line
767 ;; gets highlighted.
768 (defvar rmail-font-lock-keywords
769 ;; These are all matched case-insensitively.
770 (eval-when-compile
771 (let* ((cite-chars "[>|}]")
772 (cite-prefix "a-z")
773 (cite-suffix (concat cite-prefix "0-9_.@-`'\"")))
774 (list '("^\\(From\\|Sender\\|Resent-From\\):"
775 . 'rmail-header-name)
776 '("^\\(Mail-\\)?Reply-To:.*$" . 'rmail-header-name)
777 ;; FIXME Mail-Followup-To should probably be here too.
778 '("^Subject:" . 'rmail-header-name)
779 '("^X-Spam-Status:" . 'rmail-header-name)
780 '("^\\(To\\|Apparently-To\\|Cc\\|Newsgroups\\):"
781 . 'rmail-header-name)
782 ;; Use MATCH-ANCHORED to effectively anchor the regexp left side.
783 `(,cite-chars
784 (,(concat "\\=[ \t]*"
785 "\\(\\(\\([" cite-prefix "]+[" cite-suffix "]*\\)?"
786 "\\(" cite-chars "[ \t]*\\)\\)+\\)"
787 "\\(.*\\)")
788 (beginning-of-line) (end-of-line)
789 (1 font-lock-comment-delimiter-face nil t)
790 (5 font-lock-comment-face nil t)))
791 '("^\\(X-[a-z0-9-]+\\|In-reply-to\\|Date\\):.*\\(\n[ \t]+.*\\)*$"
792 . 'rmail-header-name))))
793 "Additional expressions to highlight in Rmail mode.")
794
795 ;; Rmail does not expect horizontal splitting. (Bug#2282)
796 (defun rmail-pop-to-buffer (&rest args)
797 "Like `pop-to-buffer', but with `split-width-threshold' set to nil."
798 (let (split-width-threshold)
799 (apply 'pop-to-buffer args)))
800
801 ;; Perform BODY in the summary buffer
802 ;; in such a way that its cursor is properly updated in its own window.
803 (defmacro rmail-select-summary (&rest body)
804 `(let ((total rmail-total-messages))
805 (if (rmail-summary-displayed)
806 (let ((window (selected-window)))
807 (save-excursion
808 (unwind-protect
809 (progn
810 (rmail-pop-to-buffer rmail-summary-buffer)
811 ;; rmail-total-messages is a buffer-local var
812 ;; in the rmail buffer.
813 ;; This way we make it available for the body
814 ;; even tho the rmail buffer is not current.
815 (let ((rmail-total-messages total))
816 ,@body))
817 (select-window window))))
818 (with-current-buffer rmail-summary-buffer
819 (let ((rmail-total-messages total))
820 ,@body)))
821 (rmail-maybe-display-summary)))
822 \f
823 ;;;; *** Rmail Mode ***
824
825 (defun rmail-require-mime-maybe ()
826 "Require `rmail-mime-feature' if that is non-nil.
827 Signal an error and set `rmail-mime-feature' to nil if the feature
828 isn't provided."
829 (when rmail-enable-mime
830 (condition-case err
831 (require rmail-mime-feature)
832 (error
833 (display-warning
834 'rmail
835 (format "Although MIME support is requested
836 by setting `rmail-enable-mime' to non-nil, the required feature
837 `%s' (the value of `rmail-mime-feature')
838 is not available in the current session.
839 So, the MIME support is turned off for the moment."
840 rmail-mime-feature)
841 :warning)
842 (setq rmail-enable-mime nil)))))
843
844
845 ;;;###autoload
846 (defun rmail (&optional file-name-arg)
847 "Read and edit incoming mail.
848 Moves messages into file named by `rmail-file-name' and edits that
849 file in RMAIL Mode.
850 Type \\[describe-mode] once editing that file, for a list of RMAIL commands.
851
852 May be called with file name as argument; then performs rmail editing on
853 that file, but does not copy any new mail into the file.
854 Interactively, if you supply a prefix argument, then you
855 have a chance to specify a file name with the minibuffer.
856
857 If `rmail-display-summary' is non-nil, make a summary for this RMAIL file."
858 (interactive (if current-prefix-arg
859 (list (read-file-name "Run rmail on RMAIL file: "))))
860 (rmail-require-mime-maybe)
861 (let* ((file-name (expand-file-name (or file-name-arg rmail-file-name)))
862 ;; Use find-buffer-visiting, not get-file-buffer, for those users
863 ;; who have find-file-visit-truename set to t.
864 (existed (find-buffer-visiting file-name))
865 run-mail-hook mail-buf msg-shown)
866 ;; Determine if an existing mail file has been changed behind the
867 ;; scene...
868 (if (and existed (not (verify-visited-file-modtime existed)))
869 ;; The mail file has been changed. Revisit it and reset the
870 ;; message state variables when in rmail mode.
871 (progn
872 (find-file file-name)
873 (when (and (verify-visited-file-modtime existed)
874 (eq major-mode 'rmail-mode))
875 (rmail-swap-buffers-maybe)
876 (rmail-set-message-counters)))
877 ;; The mail file is either unchanged or not visited. Visit it.
878 (switch-to-buffer
879 (let ((enable-local-variables nil)
880 ;; Force no-conversion by default, since that's what
881 ;; pre-mbox Rmail did with BABYL files (via
882 ;; auto-coding-regexp-alist).
883 (coding-system-for-read
884 (or coding-system-for-read 'no-conversion)))
885 (find-file-noselect file-name))))
886 ;; Ensure that the collection and view buffers are in sync and
887 ;; ensure that a message is not being edited.
888 (if (eq major-mode 'rmail-mode)
889 (rmail-swap-buffers-maybe))
890 (if (eq major-mode 'rmail-edit-mode)
891 (error "Exit Rmail Edit mode before getting new mail"))
892 (or (and existed (> (buffer-size) 0))
893 (setq run-mail-hook t))
894 ;; Ensure that the Rmail file is in mbox format, the buffer is in
895 ;; Rmail mode and has been scanned to find all the messages
896 ;; (setting the global message variables in the process).
897 (rmail-convert-file-maybe)
898 (unless (eq major-mode 'rmail-mode)
899 (rmail-mode-2))
900 (goto-char (point-max))
901 (rmail-maybe-set-message-counters)
902 (setq mail-buf rmail-buffer)
903 ;; Show the first unread message and process summary mode.
904 (unwind-protect
905 ;; Only get new mail when there is not a file name argument.
906 (unless file-name-arg
907 (setq msg-shown (rmail-get-new-mail)))
908 (progn
909 (set-buffer mail-buf)
910 (or msg-shown
911 (rmail-show-message (rmail-first-unseen-message)))
912 (if rmail-display-summary (rmail-summary))
913 (rmail-construct-io-menu)
914 (if run-mail-hook
915 (run-hooks 'rmail-mode-hook))))))
916
917 (defun rmail-convert-file-maybe ()
918 "Determine if the file needs to be converted to mbox format."
919 (widen)
920 (goto-char (point-min))
921 ;; Detect previous Babyl format files.
922 (let ((case-fold-search nil))
923 (cond ((looking-at "BABYL OPTIONS:")
924 ;; The file is Babyl version 5. Use unrmail to convert
925 ;; it.
926 (rmail-convert-babyl-to-mbox))
927 ((looking-at "Version: 5\n")
928 ;; Losing babyl file made by old version of Rmail. Fix the
929 ;; babyl file header and use unrmail to convert to mbox
930 ;; format.
931 (let ((buffer-read-only nil))
932 (insert "BABYL OPTIONS: -*- rmail -*-\n")
933 (rmail-convert-babyl-to-mbox)))
934 ((equal (point-min) (point-max))
935 (message "Empty Rmail file."))
936 ((looking-at "From "))
937 (t (error "Invalid mbox file")))))
938
939 (defun rmail-error-bad-format (&optional msgnum)
940 "Report that the buffer is not in the mbox file format.
941 MSGNUM, if present, indicates the malformed message."
942 (if msgnum
943 (error "Message %d is not a valid RFC2822 message" msgnum)
944 (error "Message is not a valid RFC2822 message")))
945
946 (defun rmail-convert-babyl-to-mbox ()
947 "Convert the mail file from Babyl version 5 to mbox.
948 This function also reinitializes local variables used by Rmail."
949 (let ((old-file (make-temp-file "rmail"))
950 (new-file (make-temp-file "rmail")))
951 (unwind-protect
952 (progn
953 (kill-all-local-variables)
954 (write-region (point-min) (point-max) old-file)
955 (unrmail old-file new-file)
956 (message "Replacing BABYL format with mbox format...")
957 (let ((inhibit-read-only t)
958 (coding-system-for-read 'raw-text)
959 (buffer-undo-list t))
960 (erase-buffer)
961 (insert-file-contents new-file)
962 ;; Rmail buffers need to be saved with Unix EOLs, or else
963 ;; the format will not be recognized.
964 (set-buffer-file-coding-system 'raw-text-unix)
965 (rmail-mode-1)
966 (rmail-perm-variables)
967 (rmail-variables)
968 (setq rmail-was-converted t)
969 (rmail-dont-modify-format)
970 (goto-char (point-max))
971 (rmail-set-message-counters))
972 (message "Replacing BABYL format with mbox format...done"))
973 (delete-file old-file)
974 (delete-file new-file))))
975
976 (defun rmail-get-coding-system ()
977 "Return a suitable coding system to use for the current mail message.
978 The buffer is expected to be narrowed to just the header of the message."
979 (save-excursion
980 (goto-char (point-min))
981 (if (re-search-forward rmail-mime-charset-pattern nil t)
982 (coding-system-from-name (match-string 1))
983 'undecided)))
984 \f
985 ;;; Set up Rmail mode keymaps
986
987 (defvar rmail-mode-map
988 (let ((map (make-keymap)))
989 (suppress-keymap map)
990 (define-key map "a" 'rmail-add-label)
991 (define-key map "b" 'rmail-bury)
992 (define-key map "c" 'rmail-continue)
993 (define-key map "d" 'rmail-delete-forward)
994 (define-key map "\C-d" 'rmail-delete-backward)
995 (define-key map "e" 'rmail-edit-current-message)
996 ;; If you change this, change the rmail-resend menu-item's :keys.
997 (define-key map "f" 'rmail-forward)
998 (define-key map "g" 'rmail-get-new-mail)
999 (define-key map "h" 'rmail-summary)
1000 (define-key map "i" 'rmail-input)
1001 (define-key map "j" 'rmail-show-message)
1002 (define-key map "k" 'rmail-kill-label)
1003 (define-key map "l" 'rmail-summary-by-labels)
1004 (define-key map "\e\C-h" 'rmail-summary)
1005 (define-key map "\e\C-l" 'rmail-summary-by-labels)
1006 (define-key map "\e\C-r" 'rmail-summary-by-recipients)
1007 (define-key map "\e\C-s" 'rmail-summary-by-regexp)
1008 (define-key map "\e\C-t" 'rmail-summary-by-topic)
1009 (define-key map "m" 'rmail-mail)
1010 (define-key map "\em" 'rmail-retry-failure)
1011 (define-key map "n" 'rmail-next-undeleted-message)
1012 (define-key map "\en" 'rmail-next-message)
1013 (define-key map "\e\C-n" 'rmail-next-labeled-message)
1014 (define-key map "o" 'rmail-output)
1015 (define-key map "\C-o" 'rmail-output-as-seen)
1016 (define-key map "p" 'rmail-previous-undeleted-message)
1017 (define-key map "\ep" 'rmail-previous-message)
1018 (define-key map "\e\C-p" 'rmail-previous-labeled-message)
1019 (define-key map "q" 'rmail-quit)
1020 (define-key map "r" 'rmail-reply)
1021 ;; I find I can't live without the default M-r command -- rms.
1022 ;; (define-key rmail-mode-map "\er" 'rmail-search-backwards)
1023 (define-key map "s" 'rmail-expunge-and-save)
1024 (define-key map "\es" 'rmail-search)
1025 (define-key map "t" 'rmail-toggle-header)
1026 (define-key map "u" 'rmail-undelete-previous-message)
1027 (define-key map "v" 'rmail-mime)
1028 (define-key map "w" 'rmail-output-body-to-file)
1029 (define-key map "\C-c\C-w" 'rmail-widen)
1030 (define-key map "x" 'rmail-expunge)
1031 (define-key map "." 'rmail-beginning-of-message)
1032 (define-key map "/" 'rmail-end-of-message)
1033 (define-key map "<" 'rmail-first-message)
1034 (define-key map ">" 'rmail-last-message)
1035 (define-key map " " 'scroll-up)
1036 (define-key map "\177" 'scroll-down)
1037 (define-key map "?" 'describe-mode)
1038 (define-key map "\C-c\C-s\C-d" 'rmail-sort-by-date)
1039 (define-key map "\C-c\C-s\C-s" 'rmail-sort-by-subject)
1040 (define-key map "\C-c\C-s\C-a" 'rmail-sort-by-author)
1041 (define-key map "\C-c\C-s\C-r" 'rmail-sort-by-recipient)
1042 (define-key map "\C-c\C-s\C-c" 'rmail-sort-by-correspondent)
1043 (define-key map "\C-c\C-s\C-l" 'rmail-sort-by-lines)
1044 (define-key map "\C-c\C-s\C-k" 'rmail-sort-by-labels)
1045 (define-key map "\C-c\C-n" 'rmail-next-same-subject)
1046 (define-key map "\C-c\C-p" 'rmail-previous-same-subject)
1047
1048 \f
1049 (define-key map [menu-bar] (make-sparse-keymap))
1050
1051 (define-key map [menu-bar classify]
1052 (cons "Classify" (make-sparse-keymap "Classify")))
1053
1054 (define-key map [menu-bar classify input-menu]
1055 nil)
1056
1057 (define-key map [menu-bar classify output-menu]
1058 nil)
1059
1060 (define-key map [menu-bar classify output-body]
1061 '("Output body to file..." . rmail-output-body-to-file))
1062
1063 (define-key map [menu-bar classify output-inbox]
1064 '("Output..." . rmail-output))
1065
1066 (define-key map [menu-bar classify output]
1067 '("Output as seen..." . rmail-output-as-seen))
1068
1069 (define-key map [menu-bar classify kill-label]
1070 '("Kill Label..." . rmail-kill-label))
1071
1072 (define-key map [menu-bar classify add-label]
1073 '("Add Label..." . rmail-add-label))
1074
1075 (define-key map [menu-bar summary]
1076 (cons "Summary" (make-sparse-keymap "Summary")))
1077
1078 (define-key map [menu-bar summary senders]
1079 '("By Senders..." . rmail-summary-by-senders))
1080
1081 (define-key map [menu-bar summary labels]
1082 '("By Labels..." . rmail-summary-by-labels))
1083
1084 (define-key map [menu-bar summary recipients]
1085 '("By Recipients..." . rmail-summary-by-recipients))
1086
1087 (define-key map [menu-bar summary topic]
1088 '("By Topic..." . rmail-summary-by-topic))
1089
1090 (define-key map [menu-bar summary regexp]
1091 '("By Regexp..." . rmail-summary-by-regexp))
1092
1093 (define-key map [menu-bar summary all]
1094 '("All" . rmail-summary))
1095
1096 (define-key map [menu-bar mail]
1097 (cons "Mail" (make-sparse-keymap "Mail")))
1098
1099 (define-key map [menu-bar mail rmail-get-new-mail]
1100 '("Get New Mail" . rmail-get-new-mail))
1101
1102 (define-key map [menu-bar mail lambda]
1103 '("----"))
1104
1105 (define-key map [menu-bar mail continue]
1106 '("Continue" . rmail-continue))
1107
1108 (define-key map [menu-bar mail resend]
1109 '(menu-item "Resend..." rmail-resend :keys "C-u f"))
1110
1111 (define-key map [menu-bar mail forward]
1112 '("Forward" . rmail-forward))
1113
1114 (define-key map [menu-bar mail retry]
1115 '("Retry" . rmail-retry-failure))
1116
1117 (define-key map [menu-bar mail reply]
1118 '("Reply" . rmail-reply))
1119
1120 (define-key map [menu-bar mail mail]
1121 '("Mail" . rmail-mail))
1122
1123 (define-key map [menu-bar delete]
1124 (cons "Delete" (make-sparse-keymap "Delete")))
1125
1126 (define-key map [menu-bar delete expunge/save]
1127 '("Expunge/Save" . rmail-expunge-and-save))
1128
1129 (define-key map [menu-bar delete expunge]
1130 '("Expunge" . rmail-expunge))
1131
1132 (define-key map [menu-bar delete undelete]
1133 '("Undelete" . rmail-undelete-previous-message))
1134
1135 (define-key map [menu-bar delete delete]
1136 '("Delete" . rmail-delete-forward))
1137
1138 (define-key map [menu-bar move]
1139 (cons "Move" (make-sparse-keymap "Move")))
1140
1141 (define-key map [menu-bar move search-back]
1142 '("Search Back..." . rmail-search-backwards))
1143
1144 (define-key map [menu-bar move search]
1145 '("Search..." . rmail-search))
1146
1147 (define-key map [menu-bar move previous]
1148 '("Previous Nondeleted" . rmail-previous-undeleted-message))
1149
1150 (define-key map [menu-bar move next]
1151 '("Next Nondeleted" . rmail-next-undeleted-message))
1152
1153 (define-key map [menu-bar move last]
1154 '("Last" . rmail-last-message))
1155
1156 (define-key map [menu-bar move first]
1157 '("First" . rmail-first-message))
1158
1159 (define-key map [menu-bar move previous]
1160 '("Previous" . rmail-previous-message))
1161
1162 (define-key map [menu-bar move next]
1163 '("Next" . rmail-next-message))
1164
1165 map)
1166 "Keymap used in Rmail mode.")
1167
1168 ;; Rmail toolbar
1169 (defvar rmail-tool-bar-map
1170 (let ((map (make-sparse-keymap)))
1171 (tool-bar-local-item-from-menu 'rmail-get-new-mail "mail/inbox"
1172 map rmail-mode-map)
1173 (tool-bar-local-item-from-menu 'rmail-next-undeleted-message "right-arrow"
1174 map rmail-mode-map)
1175 (tool-bar-local-item-from-menu 'rmail-previous-undeleted-message "left-arrow"
1176 map rmail-mode-map)
1177 (tool-bar-local-item-from-menu 'rmail-search "search"
1178 map rmail-mode-map)
1179 (tool-bar-local-item-from-menu 'rmail-input "open"
1180 map rmail-mode-map)
1181 (tool-bar-local-item-from-menu 'rmail-mail "mail/compose"
1182 map rmail-mode-map)
1183 (tool-bar-local-item-from-menu 'rmail-reply "mail/reply-all"
1184 map rmail-mode-map)
1185 (tool-bar-local-item-from-menu 'rmail-forward "mail/forward"
1186 map rmail-mode-map)
1187 (tool-bar-local-item-from-menu 'rmail-delete-forward "close"
1188 map rmail-mode-map)
1189 (tool-bar-local-item-from-menu 'rmail-output "mail/move"
1190 map rmail-mode-map)
1191 (tool-bar-local-item-from-menu 'rmail-output-body-to-file "mail/save"
1192 map rmail-mode-map)
1193 (tool-bar-local-item-from-menu 'rmail-expunge "delete"
1194 map rmail-mode-map)
1195 map))
1196
1197
1198 \f
1199 ;; Rmail mode is suitable only for specially formatted data.
1200 (put 'rmail-mode 'mode-class 'special)
1201
1202 (defun rmail-mode-kill-summary ()
1203 (if rmail-summary-buffer (kill-buffer rmail-summary-buffer)))
1204
1205 (defvar rmail-enable-multibyte) ; dynamically bound
1206
1207 ;;;###autoload
1208 (defun rmail-mode ()
1209 "Rmail Mode is used by \\<rmail-mode-map>\\[rmail] for editing Rmail files.
1210 All normal editing commands are turned off.
1211 Instead, these commands are available:
1212
1213 \\[rmail-beginning-of-message] Move point to front of this message.
1214 \\[rmail-end-of-message] Move point to bottom of this message.
1215 \\[scroll-up] Scroll to next screen of this message.
1216 \\[scroll-down] Scroll to previous screen of this message.
1217 \\[rmail-next-undeleted-message] Move to Next non-deleted message.
1218 \\[rmail-previous-undeleted-message] Move to Previous non-deleted message.
1219 \\[rmail-next-message] Move to Next message whether deleted or not.
1220 \\[rmail-previous-message] Move to Previous message whether deleted or not.
1221 \\[rmail-first-message] Move to the first message in Rmail file.
1222 \\[rmail-last-message] Move to the last message in Rmail file.
1223 \\[rmail-show-message] Jump to message specified by numeric position in file.
1224 \\[rmail-search] Search for string and show message it is found in.
1225 \\[rmail-delete-forward] Delete this message, move to next nondeleted.
1226 \\[rmail-delete-backward] Delete this message, move to previous nondeleted.
1227 \\[rmail-undelete-previous-message] Undelete message. Tries current message, then earlier messages
1228 till a deleted message is found.
1229 \\[rmail-edit-current-message] Edit the current message. \\[rmail-cease-edit] to return to Rmail.
1230 \\[rmail-expunge] Expunge deleted messages.
1231 \\[rmail-expunge-and-save] Expunge and save the file.
1232 \\[rmail-quit] Quit Rmail: expunge, save, then switch to another buffer.
1233 \\[save-buffer] Save without expunging.
1234 \\[rmail-get-new-mail] Move new mail from system spool directory into this file.
1235 \\[rmail-mail] Mail a message (same as \\[mail-other-window]).
1236 \\[rmail-continue] Continue composing outgoing message started before.
1237 \\[rmail-reply] Reply to this message. Like \\[rmail-mail] but initializes some fields.
1238 \\[rmail-retry-failure] Send this message again. Used on a mailer failure message.
1239 \\[rmail-forward] Forward this message to another user.
1240 \\[rmail-output] Output (append) this message to another mail file.
1241 \\[rmail-output-as-seen] Output (append) this message to file as it's displayed.
1242 \\[rmail-output-body-to-file] Save message body to a file. Default filename comes from Subject line.
1243 \\[rmail-input] Input Rmail file. Run Rmail on that file.
1244 \\[rmail-add-label] Add label to message. It will be displayed in the mode line.
1245 \\[rmail-kill-label] Kill label. Remove a label from current message.
1246 \\[rmail-next-labeled-message] Move to Next message with specified label
1247 (label defaults to last one specified).
1248 Standard labels: filed, unseen, answered, forwarded, deleted.
1249 Any other label is present only if you add it with \\[rmail-add-label].
1250 \\[rmail-previous-labeled-message] Move to Previous message with specified label
1251 \\[rmail-summary] Show headers buffer, with a one line summary of each message.
1252 \\[rmail-summary-by-labels] Summarize only messages with particular label(s).
1253 \\[rmail-summary-by-recipients] Summarize only messages with particular recipient(s).
1254 \\[rmail-summary-by-regexp] Summarize only messages with particular regexp(s).
1255 \\[rmail-summary-by-topic] Summarize only messages with subject line regexp(s).
1256 \\[rmail-toggle-header] Toggle display of complete header."
1257 (interactive)
1258 (let ((finding-rmail-file (not (eq major-mode 'rmail-mode))))
1259 (rmail-mode-2)
1260 (when (and finding-rmail-file
1261 (null coding-system-for-read)
1262 (default-value 'enable-multibyte-characters))
1263 (let ((rmail-enable-multibyte t))
1264 (rmail-require-mime-maybe)
1265 (rmail-convert-file-maybe)
1266 (goto-char (point-max))
1267 (set-buffer-multibyte t)))
1268 (rmail-set-message-counters)
1269 (rmail-show-message rmail-total-messages)
1270 (when finding-rmail-file
1271 (when rmail-display-summary
1272 (rmail-summary))
1273 (rmail-construct-io-menu))
1274 (run-mode-hooks 'rmail-mode-hook)))
1275
1276 (defun rmail-mode-2 ()
1277 (kill-all-local-variables)
1278 (rmail-mode-1)
1279 (rmail-perm-variables)
1280 (rmail-variables))
1281
1282 (defun rmail-mode-1 ()
1283 (setq major-mode 'rmail-mode)
1284 (setq mode-name "RMAIL")
1285 (setq buffer-read-only t)
1286 ;; No need to auto save RMAIL files in normal circumstances
1287 ;; because they contain no info except attribute changes
1288 ;; and deletion of messages.
1289 ;; The one exception is when messages are copied into another mbox buffer.
1290 ;; rmail-output enables auto save when you do that.
1291 (setq buffer-auto-save-file-name nil)
1292 (use-local-map rmail-mode-map)
1293 (set-syntax-table text-mode-syntax-table)
1294 (setq local-abbrev-table text-mode-abbrev-table)
1295 ;; Functions to support buffer swapping:
1296 (add-hook 'write-region-annotate-functions
1297 'rmail-write-region-annotate nil t)
1298 (add-hook 'kill-buffer-hook 'rmail-mode-kill-buffer-hook nil t)
1299 (add-hook 'change-major-mode-hook 'rmail-change-major-mode-hook nil t))
1300
1301 (defun rmail-generate-viewer-buffer ()
1302 "Return a reusable buffer suitable for viewing messages.
1303 Create the buffer if necessary."
1304 ;; We want to reuse any existing view buffer, so as not to create an
1305 ;; endless number of them. But we must avoid clashes if we visit
1306 ;; two different rmail files with the same basename (Bug#4593).
1307 (if (and (local-variable-p 'rmail-view-buffer)
1308 (buffer-live-p rmail-view-buffer))
1309 rmail-view-buffer
1310 (generate-new-buffer
1311 (format " *message-viewer %s*"
1312 (file-name-nondirectory (or buffer-file-name (buffer-name)))))))
1313
1314 (defun rmail-swap-buffers ()
1315 "Swap text between current buffer and `rmail-view-buffer'.
1316 This function preserves the current buffer's modified flag, and also
1317 sets the current buffer's `buffer-file-coding-system' to that of
1318 `rmail-view-buffer'."
1319 (let ((modp-this (buffer-modified-p))
1320 (modp-that
1321 (with-current-buffer rmail-view-buffer (buffer-modified-p)))
1322 (coding-this buffer-file-coding-system)
1323 (coding-that
1324 (with-current-buffer rmail-view-buffer
1325 buffer-file-coding-system)))
1326 (buffer-swap-text rmail-view-buffer)
1327 (setq buffer-file-coding-system coding-that)
1328 (with-current-buffer rmail-view-buffer
1329 (setq buffer-file-coding-system coding-this)
1330 (restore-buffer-modified-p modp-that))
1331 (restore-buffer-modified-p modp-this)))
1332
1333 (defun rmail-buffers-swapped-p ()
1334 "Return non-nil if the message collection is in `rmail-view-buffer'."
1335 ;; This is analogous to tar-data-swapped-p in tar-mode.el.
1336 (and (buffer-live-p rmail-view-buffer)
1337 rmail-buffer-swapped))
1338
1339 (defun rmail-change-major-mode-hook ()
1340 ;; Bring the actual Rmail messages back into the main buffer.
1341 (when (rmail-buffers-swapped-p)
1342 (rmail-swap-buffers)
1343 (setq rmail-buffer-swapped nil)))
1344
1345 (defun rmail-swap-buffers-maybe ()
1346 "Determine if the Rmail buffer is showing a message.
1347 If so restore the actual mbox message collection."
1348 (with-current-buffer rmail-buffer
1349 (when (rmail-buffers-swapped-p)
1350 (rmail-swap-buffers)
1351 (setq rmail-buffer-swapped nil))))
1352
1353 (defun rmail-modify-format ()
1354 "Warn if important modifications would change Rmail file's format."
1355 (with-current-buffer rmail-buffer
1356 (and rmail-was-converted
1357 ;; If it's already modified, don't warn again.
1358 (not rmail-seriously-modified)
1359 (not
1360 (yes-or-no-p
1361 (message "After this, %s would be saved in mbox format. Proceed? "
1362 (buffer-name))))
1363 (error "Aborted"))
1364 (setq rmail-seriously-modified t)))
1365
1366 (defun rmail-dont-modify-format ()
1367 (when (and rmail-was-converted (not rmail-seriously-modified))
1368 (set-buffer-modified-p nil)
1369 (message "Marking buffer unmodified to avoid rewriting Babyl file as mbox file")))
1370
1371 (defun rmail-mode-kill-buffer-hook ()
1372 (if (buffer-live-p rmail-view-buffer) (kill-buffer rmail-view-buffer)))
1373
1374 ;; Set up the permanent locals associated with an Rmail file.
1375 (defun rmail-perm-variables ()
1376 (make-local-variable 'rmail-last-regexp)
1377 (make-local-variable 'rmail-deleted-vector)
1378 (make-local-variable 'rmail-buffer)
1379 (make-local-variable 'rmail-was-converted)
1380 (setq rmail-was-converted nil)
1381 (make-local-variable 'rmail-seriously-modified)
1382 (setq rmail-seriously-modified nil)
1383 (setq rmail-buffer (current-buffer))
1384 (set-buffer-multibyte nil)
1385 (with-current-buffer (setq rmail-view-buffer (rmail-generate-viewer-buffer))
1386 (setq buffer-undo-list t)
1387 ;; Note that this does not erase the buffer. Should it?
1388 ;; It depends on how this is called. If somehow called with the
1389 ;; rmail buffers swapped, it would erase the message collection.
1390 (set (make-local-variable 'rmail-overlay-list) nil)
1391 (set-buffer-multibyte t)
1392 ;; Force C-x C-s write Unix EOLs.
1393 (set-buffer-file-coding-system 'undecided-unix))
1394 (make-local-variable 'rmail-summary-buffer)
1395 (make-local-variable 'rmail-summary-vector)
1396 (make-local-variable 'rmail-current-message)
1397 (make-local-variable 'rmail-total-messages)
1398 (setq rmail-total-messages 0)
1399 (make-local-variable 'rmail-message-vector)
1400 (make-local-variable 'rmail-msgref-vector)
1401 (make-local-variable 'rmail-inbox-list)
1402 ;; Provide default set of inboxes for primary mail file ~/RMAIL.
1403 (and (null rmail-inbox-list)
1404 (or (equal buffer-file-name (expand-file-name rmail-file-name))
1405 (equal buffer-file-truename
1406 (abbreviate-file-name (file-truename rmail-file-name))))
1407 (setq rmail-inbox-list
1408 (or rmail-primary-inbox-list
1409 (list (or (getenv "MAIL")
1410 ;; FIXME expand-file-name?
1411 (concat rmail-spool-directory
1412 (user-login-name)))))))
1413 (set (make-local-variable 'tool-bar-map) rmail-tool-bar-map))
1414
1415 ;; Set up the non-permanent locals associated with Rmail mode.
1416 (defun rmail-variables ()
1417 ;; Turn off undo. We turn it back on in rmail-edit.
1418 (setq buffer-undo-list t)
1419 ;; Don't let a local variables list in a message cause confusion.
1420 (make-local-variable 'local-enable-local-variables)
1421 (setq local-enable-local-variables nil)
1422 ;; Don't turn off auto-saving based on the size of the buffer
1423 ;; because that code does not understand buffer-swapping.
1424 (make-local-variable 'auto-save-include-big-deletions)
1425 (setq auto-save-include-big-deletions t)
1426 (make-local-variable 'revert-buffer-function)
1427 (setq revert-buffer-function 'rmail-revert)
1428 (make-local-variable 'font-lock-defaults)
1429 (setq font-lock-defaults
1430 '(rmail-font-lock-keywords
1431 t t nil nil
1432 (font-lock-maximum-size . nil)
1433 (font-lock-fontify-buffer-function . rmail-fontify-buffer-function)
1434 (font-lock-unfontify-buffer-function . rmail-unfontify-buffer-function)
1435 (font-lock-inhibit-thing-lock . (lazy-lock-mode fast-lock-mode))))
1436 (make-local-variable 'require-final-newline)
1437 (setq require-final-newline nil)
1438 (make-local-variable 'version-control)
1439 (setq version-control 'never)
1440 (make-local-variable 'kill-buffer-hook)
1441 (add-hook 'kill-buffer-hook 'rmail-mode-kill-summary)
1442 (make-local-variable 'file-precious-flag)
1443 (setq file-precious-flag t)
1444 (make-local-variable 'desktop-save-buffer)
1445 (setq desktop-save-buffer t))
1446 \f
1447 ;; Handle M-x revert-buffer done in an rmail-mode buffer.
1448 (defun rmail-revert (arg noconfirm)
1449 (set-buffer rmail-buffer)
1450 (let* ((revert-buffer-function (default-value 'revert-buffer-function))
1451 (rmail-enable-multibyte enable-multibyte-characters)
1452 ;; See similar code in `rmail'.
1453 ;; FIXME needs updating?
1454 (coding-system-for-read (and rmail-enable-multibyte 'raw-text))
1455 (before-revert-hook 'rmail-swap-buffers-maybe))
1456 ;; Call our caller again, but this time it does the default thing.
1457 (when (revert-buffer arg noconfirm)
1458 ;; If the user said "yes", and we changed something,
1459 ;; reparse the messages.
1460 (set-buffer rmail-buffer)
1461 (rmail-mode-2)
1462 ;; Convert all or part to Babyl file if possible.
1463 (rmail-convert-file-maybe)
1464 ;; We have read the file as raw-text, so the buffer is set to
1465 ;; unibyte. Make it multibyte if necessary.
1466 (if (and rmail-enable-multibyte
1467 (not enable-multibyte-characters))
1468 (set-buffer-multibyte t))
1469 (goto-char (point-max))
1470 (rmail-set-message-counters)
1471 (rmail-show-message rmail-total-messages)
1472 (run-hooks 'rmail-mode-hook))))
1473
1474 (defun rmail-expunge-and-save ()
1475 "Expunge and save RMAIL file."
1476 (interactive)
1477 (set-buffer rmail-buffer)
1478 (rmail-expunge)
1479 ;; No need to swap buffers: rmail-write-region-annotate takes care of it.
1480 ;; (rmail-swap-buffers-maybe)
1481 (save-buffer)
1482 (if (rmail-summary-exists)
1483 (rmail-select-summary (set-buffer-modified-p nil))))
1484
1485 (defun rmail-quit ()
1486 "Quit out of RMAIL.
1487 Hook `rmail-quit-hook' is run after expunging."
1488 (interactive)
1489 (set-buffer rmail-buffer)
1490 (rmail-expunge t)
1491 (save-buffer)
1492 (when (boundp 'rmail-quit-hook)
1493 (run-hooks 'rmail-quit-hook))
1494 ;; Don't switch to the summary buffer even if it was recently visible.
1495 (when rmail-summary-buffer
1496 (with-current-buffer rmail-summary-buffer
1497 (set-buffer-modified-p nil))
1498 (replace-buffer-in-windows rmail-summary-buffer)
1499 (bury-buffer rmail-summary-buffer))
1500 (if rmail-enable-mime
1501 (let ((obuf rmail-buffer)
1502 (ovbuf rmail-view-buffer))
1503 (set-buffer rmail-view-buffer)
1504 (quit-window)
1505 (replace-buffer-in-windows ovbuf)
1506 (replace-buffer-in-windows obuf)
1507 (bury-buffer obuf))
1508 (let ((obuf (current-buffer)))
1509 (quit-window)
1510 (replace-buffer-in-windows obuf))))
1511
1512 (defun rmail-bury ()
1513 "Bury current Rmail buffer and its summary buffer."
1514 (interactive)
1515 ;; This let var was called rmail-buffer, but that interfered
1516 ;; with the buffer-local var used in summary buffers.
1517 (let ((buffer-to-bury (current-buffer)))
1518 (if (rmail-summary-exists)
1519 (let (window)
1520 (while (setq window (get-buffer-window rmail-summary-buffer))
1521 (quit-window nil window))
1522 (bury-buffer rmail-summary-buffer)))
1523 (quit-window)))
1524 \f
1525 (defun rmail-duplicate-message ()
1526 "Create a duplicated copy of the current message.
1527 The duplicate copy goes into the Rmail file just after the original."
1528 ;; If we are in a summary buffer, switch to the Rmail buffer.
1529 ;; FIXME simpler to swap the contents, not the buffers?
1530 (set-buffer rmail-buffer)
1531 (rmail-modify-format)
1532 (let ((buff (current-buffer))
1533 (n rmail-current-message)
1534 (beg (rmail-msgbeg rmail-current-message))
1535 (end (rmail-msgend rmail-current-message)))
1536 (if (rmail-buffers-swapped-p) (set-buffer rmail-view-buffer))
1537 (widen)
1538 (let ((buffer-read-only nil)
1539 (string (buffer-substring-no-properties beg end)))
1540 (goto-char end)
1541 (insert string))
1542 (set-buffer buff)
1543 (rmail-swap-buffers-maybe)
1544 (goto-char (point-max))
1545 (rmail-set-message-counters)
1546 (set-buffer-modified-p t)
1547 (rmail-show-message-1 n))
1548 (if (rmail-summary-exists)
1549 (rmail-select-summary (rmail-update-summary)))
1550 (message "Message duplicated"))
1551 \f
1552 ;;;###autoload
1553 (defun rmail-input (filename)
1554 "Run Rmail on file FILENAME."
1555 (interactive "FRun rmail on RMAIL file: ")
1556 (rmail filename))
1557
1558 ;; This used to scan subdirectories recursively, but someone pointed out
1559 ;; that if the user wants that, person can put all the files in one dir.
1560 ;; And the recursive scan was slow. So I took it out.
1561 ;; rms, Sep 1996.
1562 (defun rmail-find-all-files (start)
1563 "Return list of file in dir START that match `rmail-secondary-file-regexp'."
1564 (if (file-accessible-directory-p start)
1565 ;; Don't sort here.
1566 (let* ((case-fold-search t)
1567 (files (directory-files start t rmail-secondary-file-regexp)))
1568 ;; Sort here instead of in directory-files
1569 ;; because this list is usually much shorter.
1570 (sort files 'string<))))
1571
1572 (defun rmail-list-to-menu (menu-name l action &optional full-name)
1573 (let ((menu (make-sparse-keymap menu-name))
1574 name)
1575 (mapc
1576 (lambda (item)
1577 (let (command)
1578 (if (consp item)
1579 (setq command
1580 (rmail-list-to-menu
1581 (car item) (cdr item) action
1582 (if full-name
1583 (concat full-name "/"
1584 (car item))
1585 (car item)))
1586 name (car item))
1587 (setq name item)
1588 (setq command
1589 (list 'lambda () '(interactive)
1590 (list action
1591 (expand-file-name
1592 (if full-name
1593 (concat full-name "/" item)
1594 item)
1595 rmail-secondary-file-directory)))))
1596 (define-key menu (vector (intern name))
1597 (cons name command))))
1598 (reverse l))
1599 menu))
1600
1601 ;; This command is always "disabled" when it appears in a menu.
1602 (put 'rmail-disable-menu 'menu-enable ''nil)
1603
1604 (defun rmail-construct-io-menu ()
1605 (let ((files (rmail-find-all-files rmail-secondary-file-directory)))
1606 (if files
1607 (progn
1608 (define-key rmail-mode-map [menu-bar classify input-menu]
1609 (cons "Input Rmail File"
1610 (rmail-list-to-menu "Input Rmail File"
1611 files
1612 'rmail-input)))
1613 (define-key rmail-mode-map [menu-bar classify output-menu]
1614 (cons "Output Rmail File"
1615 (rmail-list-to-menu "Output Rmail File"
1616 files
1617 'rmail-output))))
1618
1619 (define-key rmail-mode-map [menu-bar classify input-menu]
1620 '("Input Rmail File" . rmail-disable-menu))
1621 (define-key rmail-mode-map [menu-bar classify output-menu]
1622 '("Output Rmail File" . rmail-disable-menu)))))
1623
1624 \f
1625 ;;;; *** Rmail input ***
1626
1627 (declare-function rmail-summary-goto-msg "rmailsum" (&optional n nowarn skip-rmail))
1628 (declare-function rmail-summary-mark-undeleted "rmailsum" (n))
1629 (declare-function rmail-summary-mark-deleted "rmailsum" (&optional n undel))
1630 (declare-function rfc822-addresses "rfc822" (header-text))
1631 (declare-function mail-abbrev-make-syntax-table "mailabbrev.el" ())
1632 (declare-function mail-sendmail-delimit-header "sendmail" ())
1633 (declare-function mail-header-end "sendmail" ())
1634
1635 ;; RLK feature not added in this version:
1636 ;; argument specifies inbox file or files in various ways.
1637
1638 ;; In Babyl, the Mail: header in the preamble overrode rmail-inbox-list.
1639 ;; Mbox does not have this feature.
1640 (defun rmail-get-new-mail (&optional file-name)
1641 "Move any new mail from this Rmail file's inbox files.
1642 The buffer-local variable `rmail-inbox-list' specifies the list
1643 of inbox files. By default, this is nil, except for your primary
1644 Rmail file `rmail-file-name'. In this case, when you first visit
1645 the Rmail file it is initialized using either
1646 `rmail-primary-inbox-list', or the \"MAIL\" environment variable,
1647 or the function `user-login-name' and the directory
1648 `rmail-spool-directory' (whose value depends on the operating system).
1649
1650 The command `set-rmail-inbox-list' sets `rmail-inbox-list' to the
1651 value you specify.
1652
1653 You can also specify the file to get new mail from just for one
1654 instance of this command. In this case, the file of new mail is
1655 not changed or deleted. Noninteractively, you can pass the inbox
1656 file name as an argument. Interactively, a prefix argument
1657 causes us to read a file name and use that file as the inbox.
1658
1659 If the variable `rmail-preserve-inbox' is non-nil, new mail will
1660 always be left in inbox files rather than deleted.
1661
1662 Before doing anything, this runs `rmail-before-get-new-mail-hook'.
1663 Just before returning, it runs `rmail-after-get-new-mail-hook',
1664 whether or not there is new mail.
1665
1666 If there is new mail, it runs `rmail-get-new-mail-hook', saves
1667 the updated file, and shows the first unseen message (which might
1668 not be a new one). It returns non-nil if it got any new messages."
1669 (interactive
1670 (list (if current-prefix-arg
1671 (read-file-name "Get new mail from file: "))))
1672 (run-hooks 'rmail-before-get-new-mail-hook)
1673 ;; If the disk file has been changed from under us,
1674 ;; revert to it before we get new mail.
1675 (or (verify-visited-file-modtime (current-buffer))
1676 (find-file (buffer-file-name)))
1677 (set-buffer rmail-buffer)
1678 (rmail-modify-format)
1679 (rmail-swap-buffers-maybe)
1680 (rmail-maybe-set-message-counters)
1681 (widen)
1682 ;; Get rid of all undo records for this buffer.
1683 (or (eq buffer-undo-list t)
1684 (setq buffer-undo-list nil))
1685 (let ((all-files (if file-name (list file-name) rmail-inbox-list))
1686 (rmail-enable-multibyte (default-value 'enable-multibyte-characters))
1687 found)
1688 (unwind-protect
1689 (progn
1690 ;; This loops if any members of the inbox list have the same
1691 ;; basename (see "name conflict" below).
1692 (while all-files
1693 (let ((opoint (point))
1694 ;; If buffer has not changed yet, and has not been
1695 ;; saved yet, don't replace the old backup file now.
1696 (make-backup-files (and make-backup-files
1697 (buffer-modified-p)))
1698 (buffer-read-only nil)
1699 ;; Don't make undo records while getting mail.
1700 (buffer-undo-list t)
1701 delete-files success files file-last-names)
1702 ;; Pull files off all-files onto files as long as there is
1703 ;; no name conflict. A conflict happens when two inbox
1704 ;; file names have the same last component.
1705 ;; The reason this careful handling is necessary seems
1706 ;; to be that rmail-insert-inbox-text uses .newmail-BASENAME.
1707 (while (and all-files
1708 (not (member (file-name-nondirectory (car all-files))
1709 file-last-names)))
1710 (setq files (cons (car all-files) files)
1711 file-last-names
1712 (cons (file-name-nondirectory (car all-files)) files))
1713 (setq all-files (cdr all-files)))
1714 ;; Put them back in their original order.
1715 (setq files (nreverse files))
1716 ;; In case of brain damage caused by require-final-newline.
1717 (goto-char (point-max))
1718 (skip-chars-backward " \t\n")
1719 (delete-region (point) (point-max))
1720 (setq found (or
1721 (rmail-get-new-mail-1 file-name files delete-files)
1722 found))))
1723 ;; Move to the first new message unless we have other unseen
1724 ;; messages before it.
1725 (if found (rmail-show-message (rmail-first-unseen-message)))
1726 (run-hooks 'rmail-after-get-new-mail-hook)
1727 found)
1728 ;; Don't leave the buffer screwed up if we get a disk-full error.
1729 (rmail-show-message))))
1730
1731 (defvar rmail-use-spam-filter)
1732 (declare-function rmail-get-new-mail-filter-spam "rmail-spam-filter" (nnew))
1733
1734 (defun rmail-get-new-mail-1 (file-name files delete-files)
1735 "Return t if new messages are detected without error, nil otherwise."
1736 (save-excursion
1737 (save-restriction
1738 (let ((new-messages 0)
1739 (spam-filter-p (and (featurep 'rmail-spam-filter)
1740 rmail-use-spam-filter))
1741 (blurb "")
1742 result success suffix)
1743 (narrow-to-region (point) (point))
1744 ;; Read in the contents of the inbox files, renaming them as
1745 ;; necessary, and adding to the list of files to delete
1746 ;; eventually.
1747 (if file-name
1748 (rmail-insert-inbox-text files nil)
1749 (setq delete-files (rmail-insert-inbox-text files t)))
1750 ;; Scan the new text and convert each message to
1751 ;; Rmail/mbox format.
1752 (goto-char (point-min))
1753 (skip-chars-forward " \n")
1754 (narrow-to-region (point) (point-max))
1755 (unwind-protect
1756 (setq new-messages (rmail-add-mbox-headers)
1757 success t)
1758 ;; Try to delete the garbage just inserted.
1759 (or success (delete-region (point-min) (point-max)))
1760 ;; If we could not convert the file's inboxes, rename the
1761 ;; files we tried to read so we won't over and over again.
1762 (if (and (not file-name) (not success))
1763 (let ((delfiles delete-files)
1764 (count 0))
1765 (while delfiles
1766 (while (file-exists-p (format "RMAILOSE.%d" count))
1767 (setq count (1+ count)))
1768 (rename-file (car delfiles) (format "RMAILOSE.%d" count))
1769 (setq delfiles (cdr delfiles))))))
1770 ;; Determine if there are messages.
1771 (unless (zerop new-messages)
1772 ;; There are. Process them.
1773 (goto-char (point-min))
1774 (rmail-count-new-messages)
1775 (run-hooks 'rmail-get-new-mail-hook)
1776 (save-buffer))
1777 ;; Delete the old files, now that the Rmail file is saved.
1778 (while delete-files
1779 (condition-case ()
1780 ;; First, try deleting.
1781 (condition-case ()
1782 (delete-file (car delete-files))
1783 (file-error
1784 ;; If we can't delete it, truncate it.
1785 (write-region (point) (point) (car delete-files))))
1786 (file-error nil))
1787 (setq delete-files (cdr delete-files)))
1788 (if (zerop new-messages)
1789 (when (or file-name rmail-inbox-list)
1790 (message "(No new mail has arrived)"))
1791 (if spam-filter-p
1792 (setq blurb (rmail-get-new-mail-filter-spam new-messages))))
1793 (if (rmail-summary-exists)
1794 (rmail-select-summary (rmail-update-summary)))
1795 (setq suffix (if (= 1 new-messages) "" "s"))
1796 (message "%d new message%s read%s" new-messages suffix blurb)
1797 ;; Establish the return value.
1798 (setq result (> new-messages 0))
1799 result))))
1800
1801 (defun rmail-parse-url (file)
1802 "Parse the supplied URL. Return (list MAILBOX-NAME REMOTE PASSWORD GOT-PASSWORD)
1803 WHERE MAILBOX-NAME is the name of the mailbox suitable as argument to the
1804 actual version of `movemail', REMOTE is non-nil if MAILBOX-NAME refers to
1805 a remote mailbox, PASSWORD is the password if it should be
1806 supplied as a separate argument to `movemail' or nil otherwise, GOT-PASSWORD
1807 is non-nil if the user has supplied the password interactively.
1808 "
1809 (cond
1810 ((string-match "^\\([^:]+\\)://\\(\\([^:@]+\\)\\(:\\([^@]+\\)\\)?@\\)?.*" file)
1811 (let (got-password supplied-password
1812 (proto (match-string 1 file))
1813 (user (match-string 3 file))
1814 (pass (match-string 5 file))
1815 (host (substring file (or (match-end 2)
1816 (+ 3 (match-end 1))))))
1817
1818 (if (not pass)
1819 (when rmail-remote-password-required
1820 (setq got-password (not (rmail-have-password)))
1821 (setq supplied-password (rmail-get-remote-password
1822 (string-equal proto "imap"))))
1823 ;; The password is embedded. Strip it out since movemail
1824 ;; does not really like it, in spite of the movemail spec.
1825 (setq file (concat proto "://" user "@" host)))
1826
1827 (if (rmail-movemail-variant-p 'emacs)
1828 (if (string-equal proto "pop")
1829 (list (concat "po:" user ":" host)
1830 t
1831 (or pass supplied-password)
1832 got-password)
1833 (error "Emacs movemail does not support %s protocol" proto))
1834 (list file
1835 (or (string-equal proto "pop") (string-equal proto "imap"))
1836 (or supplied-password pass)
1837 got-password))))
1838
1839 ((string-match "^po:\\([^:]+\\)\\(:\\(.*\\)\\)?" file)
1840 (let (got-password supplied-password
1841 (proto "pop")
1842 (user (match-string 1 file))
1843 (host (match-string 3 file)))
1844
1845 (when rmail-remote-password-required
1846 (setq got-password (not (rmail-have-password)))
1847 (setq supplied-password (rmail-get-remote-password nil)))
1848
1849 (list file "pop" supplied-password got-password)))
1850
1851 (t
1852 (list file nil nil nil))))
1853
1854 (defun rmail-unrmail-new-mail (from-file)
1855 "Replace newly read mail in Babyl format with equivalent mbox format.
1856
1857 FROM-FILE is the Babyl file from which the new mail should be read."
1858 (let ((to-file (make-temp-file "rmail"))
1859 size)
1860 (unrmail from-file to-file)
1861 (let ((inhibit-read-only t)
1862 (coding-system-for-read 'raw-text)
1863 (buffer-undo-list t))
1864 (delete-region (point) (point-max))
1865 (setq size (nth 1 (insert-file-contents to-file)))
1866 (delete-file to-file)
1867 size)))
1868
1869 (defun rmail-unrmail-new-mail-maybe (file size)
1870 "If newly read mail from FILE is in Babyl format, convert it to mbox format.
1871
1872 SIZE is the original size of the newly read mail.
1873 Value is the size of the newly read mail after conversion."
1874 ;; Detect previous Babyl format files.
1875 (let ((case-fold-search nil)
1876 (old-file file)
1877 new-file)
1878 (cond ((looking-at "BABYL OPTIONS:")
1879 ;; The new mail is in Babyl version 5 format. Use unrmail
1880 ;; to convert it.
1881 (setq size (rmail-unrmail-new-mail old-file)))
1882 ((looking-at "Version: 5\n")
1883 ;; New mail is in Babyl format made by old version of
1884 ;; Rmail. Fix the babyl file header and use unrmail to
1885 ;; convert it.
1886 (let ((buffer-read-only nil)
1887 (write-region-annotate-functions nil)
1888 (write-region-post-annotation-function nil)
1889 (old-file (make-temp-file "rmail")))
1890 (insert "BABYL OPTIONS: -*- rmail -*-\n")
1891 (forward-line -1)
1892 (write-region (point) (point-max) old-file)
1893 (setq size (rmail-unrmail-new-mail old-file))
1894 (delete-file old-file))))
1895 size))
1896
1897 (defun rmail-insert-inbox-text (files renamep)
1898 ;; Detect a locked file now, so that we avoid moving mail
1899 ;; out of the real inbox file. (That could scare people.)
1900 (or (memq (file-locked-p buffer-file-name) '(nil t))
1901 (error "RMAIL file %s is locked"
1902 (file-name-nondirectory buffer-file-name)))
1903 (let (file tofile delete-files movemail popmail got-password password)
1904 (while files
1905 ;; Handle remote mailbox names specially; don't expand as filenames
1906 ;; in case the userid contains a directory separator.
1907 (setq file (car files))
1908 (let ((url-data (rmail-parse-url file)))
1909 (setq file (nth 0 url-data))
1910 (setq popmail (nth 1 url-data))
1911 (setq password (nth 2 url-data))
1912 (setq got-password (nth 3 url-data)))
1913
1914 (if popmail
1915 (setq renamep t)
1916 (setq file (file-truename
1917 (substitute-in-file-name (expand-file-name file)))))
1918 (setq tofile (expand-file-name
1919 ;; Generate name to move to from inbox name,
1920 ;; in case of multiple inboxes that need moving.
1921 (concat ".newmail-"
1922 (file-name-nondirectory
1923 (if (memq system-type '(windows-nt cygwin ms-dos))
1924 ;; cannot have colons in file name
1925 (replace-regexp-in-string ":" "-" file)
1926 file)))
1927 ;; Use the directory of this rmail file
1928 ;; because it's a nuisance to use the homedir
1929 ;; if that is on a full disk and this rmail
1930 ;; file isn't.
1931 (file-name-directory
1932 (expand-file-name buffer-file-name))))
1933 ;; Always use movemail to rename the file,
1934 ;; since there can be mailboxes in various directories.
1935 (when (not popmail)
1936 ;; On some systems, /usr/spool/mail/foo is a directory
1937 ;; and the actual inbox is /usr/spool/mail/foo/foo.
1938 (if (file-directory-p file)
1939 (setq file (expand-file-name (user-login-name)
1940 file))))
1941 (cond (popmail
1942 (message "Getting mail from the remote server ..."))
1943 ((and (file-exists-p tofile)
1944 (/= 0 (nth 7 (file-attributes tofile))))
1945 (message "Getting mail from %s..." tofile))
1946 ((and (file-exists-p file)
1947 (/= 0 (nth 7 (file-attributes file))))
1948 (message "Getting mail from %s..." file)))
1949 ;; Set TOFILE if have not already done so, and
1950 ;; rename or copy the file FILE to TOFILE if and as appropriate.
1951 (cond ((not renamep)
1952 (setq tofile file))
1953 ((or (file-exists-p tofile) (and (not popmail)
1954 (not (file-exists-p file))))
1955 nil)
1956 (t
1957 (with-temp-buffer
1958 (let ((errors (current-buffer)))
1959 (buffer-disable-undo errors)
1960 (let ((args
1961 (append
1962 (list (or rmail-movemail-program "movemail") nil errors nil)
1963 (if rmail-preserve-inbox
1964 (list "-p")
1965 nil)
1966 (if (rmail-movemail-variant-p 'mailutils)
1967 (append (list "--emacs") rmail-movemail-flags)
1968 rmail-movemail-flags)
1969 (list file tofile)
1970 (if password (list password) nil))))
1971 (apply 'call-process args))
1972 (if (not (buffer-modified-p errors))
1973 ;; No output => movemail won
1974 nil
1975 (set-buffer errors)
1976 (subst-char-in-region (point-min) (point-max)
1977 ?\n ?\s)
1978 (goto-char (point-max))
1979 (skip-chars-backward " \t")
1980 (delete-region (point) (point-max))
1981 (goto-char (point-min))
1982 (if (looking-at "movemail: ")
1983 (delete-region (point-min) (match-end 0)))
1984 (beep t)
1985 ;; If we just read the password, most likely it is
1986 ;; wrong. Otherwise, see if there is a specific
1987 ;; reason to think that the problem is a wrong passwd.
1988 (if (or got-password
1989 (re-search-forward rmail-remote-password-error
1990 nil t))
1991 (rmail-set-remote-password nil))
1992
1993 ;; If using Mailutils, remove initial error code
1994 ;; abbreviation
1995 (when (rmail-movemail-variant-p 'mailutils)
1996 (goto-char (point-min))
1997 (when (looking-at "[A-Z][A-Z0-9_]*:")
1998 (delete-region (point-min) (match-end 0))))
1999
2000 (message "movemail: %s"
2001 (buffer-substring (point-min)
2002 (point-max)))
2003
2004 (sit-for 3)
2005 nil)))))
2006
2007 ;; At this point, TOFILE contains the name to read:
2008 ;; Either the alternate name (if we renamed)
2009 ;; or the actual inbox (if not renaming).
2010 (if (file-exists-p tofile)
2011 (let ((coding-system-for-read 'no-conversion)
2012 size)
2013 (goto-char (point-max))
2014 (setq size
2015 ;; If new mail is in Babyl format, convert it to mbox.
2016 (rmail-unrmail-new-mail-maybe
2017 tofile
2018 (nth 1 (insert-file-contents tofile))))
2019 ;; Determine if a pair of newline message separators need
2020 ;; to be added to the new collection of messages. This is
2021 ;; the case for all new message collections added to a
2022 ;; non-empty mail file.
2023 (unless (zerop size)
2024 (save-restriction
2025 (let ((start (point-min)))
2026 (widen)
2027 (unless (eq start (point-min))
2028 (goto-char start)
2029 (insert "\n\n")
2030 (setq size (+ 2 size))))))
2031 (goto-char (point-max))
2032 (or (= (preceding-char) ?\n)
2033 (zerop size)
2034 (insert ?\n))
2035 (if (not (and rmail-preserve-inbox (string= file tofile)))
2036 (setq delete-files (cons tofile delete-files)))))
2037 (message "")
2038 (setq files (cdr files)))
2039 delete-files))
2040
2041 ;; Decode the region specified by FROM and TO by CODING.
2042 ;; If CODING is nil or an invalid coding system, decode by `undecided'.
2043 (defun rmail-decode-region (from to coding &optional destination)
2044 (if (or (not coding) (not (coding-system-p coding)))
2045 (setq coding 'undecided))
2046 ;; Use -dos decoding, to remove ^M characters left from base64 or
2047 ;; rogue qp-encoded text.
2048 (decode-coding-region
2049 from to (coding-system-change-eol-conversion coding 1) destination)
2050 ;; Don't reveal the fact we used -dos decoding, as users generally
2051 ;; will not expect the RMAIL buffer to use DOS EOL format.
2052 (cond
2053 ((null destination)
2054 (setq buffer-file-coding-system
2055 (setq last-coding-system-used
2056 (coding-system-change-eol-conversion coding 0))))
2057 ((bufferp destination)
2058 (with-current-buffer destination
2059 (setq buffer-file-coding-system
2060 (setq last-coding-system-used
2061 (coding-system-change-eol-conversion coding 0)))))))
2062
2063 (defun rmail-ensure-blank-line ()
2064 "Ensure a message ends in a blank line.
2065 Call with point at the end of the message."
2066 (unless (bolp)
2067 (insert "\n"))
2068 (unless (looking-back "\n\n")
2069 (insert "\n")))
2070
2071 (defun rmail-add-mbox-headers ()
2072 "Validate the RFC2822 format for the new messages.
2073 Point should be at the first new message.
2074 An error is signalled if the new messages are not RFC2822
2075 compliant.
2076 Unless an Rmail attribute header already exists, add it to the
2077 new messages. Return the number of new messages."
2078 (save-excursion
2079 (save-restriction
2080 (let ((count 0)
2081 (start (point))
2082 (value "------U-")
2083 (case-fold-search nil)
2084 (delim (concat "\n\n" rmail-unix-mail-delimiter))
2085 limit stop)
2086 ;; Detect an empty inbox file.
2087 (unless (= start (point-max))
2088 ;; Scan the new messages to establish a count and to ensure that
2089 ;; an attribute header is present.
2090 (if (looking-at rmail-unix-mail-delimiter)
2091 (while (not stop)
2092 ;; Determine if a new attribute header needs to be
2093 ;; added to the message.
2094 (if (search-forward "\n\n" nil t)
2095 (progn
2096 (setq count (1+ count))
2097 (narrow-to-region start (point))
2098 (unless (mail-fetch-field rmail-attribute-header)
2099 (backward-char 1)
2100 (insert rmail-attribute-header ": " value "\n"))
2101 (widen))
2102 (rmail-error-bad-format))
2103 ;; Move to the next message.
2104 (if (not (re-search-forward delim nil 'move))
2105 (setq stop t)
2106 (goto-char (match-beginning 0))
2107 (forward-char 2))
2108 (setq start (point)))
2109 (rmail-error-bad-format)))
2110 count))))
2111 \f
2112 (defun rmail-get-header-1 (name)
2113 "Subroutine of `rmail-get-header'.
2114 Narrow to header, call `mail-fetch-field' to find header NAME."
2115 (if (search-forward "\n\n" nil t)
2116 (progn
2117 (narrow-to-region (point-min) (point))
2118 (mail-fetch-field name))
2119 (rmail-error-bad-format)))
2120
2121 (defun rmail-get-header (name &optional msgnum)
2122 "Return the value of message header NAME, nil if it has none.
2123 MSGNUM specifies the message number to get it from.
2124 If MSGNUM is nil, use the current message."
2125 (rmail-apply-in-message msgnum 'rmail-get-header-1 name))
2126
2127 (defun rmail-set-header-1 (name value)
2128 "Subroutine of `rmail-set-header'.
2129 Narrow to header, set header NAME to VALUE, replacing existing if present.
2130 VALUE nil means to remove NAME altogether."
2131 (if (search-forward "\n\n" nil t)
2132 (progn
2133 (forward-char -1)
2134 (narrow-to-region (point-min) (point))
2135 (goto-char (point-min))
2136 (if (re-search-forward (concat "^" (regexp-quote name) ":") nil 'move)
2137 (if value
2138 (progn
2139 (delete-region (point) (line-end-position))
2140 (insert " " value))
2141 (delete-region (line-beginning-position)
2142 (line-beginning-position 2)))
2143 (if value (insert name ": " value "\n"))))
2144 (rmail-error-bad-format)))
2145
2146 (defun rmail-set-header (name &optional msgnum value)
2147 "Set message header NAME to VALUE in message number MSGNUM.
2148 If MSGNUM is nil, use the current message. NAME and VALUE are strings.
2149 VALUE may also be nil, meaning to remove the header."
2150 (rmail-apply-in-message msgnum 'rmail-set-header-1 name value)
2151 (with-current-buffer rmail-buffer
2152 ;; Ensure header changes get saved.
2153 ;; (Note replacing a header with an identical copy modifies.)
2154 (set-buffer-modified-p t)
2155 ;; However: don't save in mbox format over a Babyl file
2156 ;; merely because of this.
2157 (rmail-dont-modify-format)))
2158 \f
2159 ;;;; *** Rmail Attributes and Keywords ***
2160
2161 (defun rmail-get-attr-names (&optional msg)
2162 "Return the message attributes in a comma separated string.
2163 MSG specifies the message number to get it from.
2164 If MSG is nil, use the current message."
2165 (let ((value (rmail-get-header rmail-attribute-header msg))
2166 (nmax (length rmail-attr-array))
2167 result temp)
2168 (when value
2169 (if (> (length value) nmax)
2170 (message "Warning: corrupt attribute header in message")
2171 (dotimes (index (length value))
2172 (setq temp (and (not (= ?- (aref value index)))
2173 (nth 1 (aref rmail-attr-array index)))
2174 result
2175 (cond
2176 ((and temp result) (format "%s, %s" result temp))
2177 (temp temp)
2178 (t result)))))
2179 result)))
2180
2181 (defun rmail-get-keywords (&optional msg)
2182 "Return the message keywords in a comma separated string.
2183 MSG, if non-nil, identifies the message number to use.
2184 If nil, that means the current message."
2185 (rmail-get-header rmail-keyword-header msg))
2186
2187 (defun rmail-get-labels (&optional msg)
2188 "Return a string with the labels (attributes and keywords) of msg MSG.
2189 It is put in comma-separated form.
2190 MSG, if non-nil, identifies the message number to use.
2191 If nil, that means the current message."
2192 (or msg (setq msg rmail-current-message))
2193 (let (attr-names keywords)
2194 ;; Combine the message attributes and keywords
2195 ;; into a comma-separated list.
2196 (setq attr-names (rmail-get-attr-names msg)
2197 keywords (rmail-get-keywords msg))
2198 (if (string= keywords "")
2199 (setq keywords nil))
2200 (cond
2201 ;; FIXME ? old rmail did not have spaces in the comma-separated lists.
2202 ((and attr-names keywords) (concat " " attr-names "; " keywords))
2203 (attr-names (concat " " attr-names))
2204 (keywords (concat " " keywords))
2205 (t ""))))
2206
2207 (defun rmail-display-labels ()
2208 "Update the current messages's attributes and keywords in mode line."
2209 (let ((blurb (rmail-get-labels)))
2210 (setq mode-line-process
2211 (format " %d/%d%s"
2212 rmail-current-message rmail-total-messages blurb))
2213 ;; If rmail-enable-mime is non-nil, we may have to update
2214 ;; `mode-line-process' of rmail-view-buffer too.
2215 (if (and rmail-enable-mime
2216 (not (eq (current-buffer) rmail-view-buffer))
2217 (buffer-live-p rmail-view-buffer))
2218 (let ((mlp mode-line-process))
2219 (with-current-buffer rmail-view-buffer
2220 (setq mode-line-process mlp))))))
2221
2222 (defun rmail-get-attr-value (attr state)
2223 "Return the character value for ATTR.
2224 ATTR is a (numeric) index, an offset into the mbox attribute
2225 header value. STATE is one of nil, t, or a character value."
2226 (cond
2227 ((numberp state) state)
2228 ((not state) ?-)
2229 (t (nth 0 (aref rmail-attr-array attr)))))
2230
2231 (defun rmail-set-attribute-1 (attr state)
2232 "Subroutine of `rmail-set-attribute'.
2233 Set Rmail attribute ATTR to STATE in `rmail-attribute-header',
2234 creating the header if necessary. Returns non-nil if a
2235 significant attribute change was made."
2236 (let ((limit (search-forward "\n\n" nil t))
2237 (value (rmail-get-attr-value attr state))
2238 (inhibit-read-only t)
2239 altered)
2240 (goto-char (point-min))
2241 (if (search-forward (concat rmail-attribute-header ": ") limit t)
2242 ;; If this message already records attributes, just change the
2243 ;; value for this one.
2244 (let ((missing (- (+ (point) attr) (line-end-position))))
2245 ;; Position point at this attribute, adding attributes if necessary.
2246 (if (> missing 0)
2247 (progn
2248 (end-of-line)
2249 (insert-char ?- missing)
2250 (backward-char 1))
2251 (forward-char attr))
2252 ;; Change this attribute.
2253 (when (/= value (char-after))
2254 (setq altered t)
2255 (delete-char 1)
2256 (insert value)))
2257 ;; Otherwise add a header line to record the attributes and set
2258 ;; all but this one to no.
2259 (let ((header-value "--------"))
2260 (aset header-value attr value)
2261 (goto-char (if limit (1- limit) (point-max)))
2262 (setq altered (/= value ?-))
2263 (insert rmail-attribute-header ": " header-value "\n")))
2264 altered))
2265
2266 (defun rmail-set-attribute (attr state &optional msgnum)
2267 "Turn an attribute of a message on or off according to STATE.
2268 STATE is either nil or the character (numeric) value associated
2269 with the state (nil represents off and non-nil represents on).
2270 ATTR is either the index number of the attribute, or a string,
2271 both from `rmail-attr-array'. MSGNUM is message number to
2272 change; nil means current message."
2273 (let ((n 0)
2274 (nmax (length rmail-attr-array)))
2275 (while (and (stringp attr)
2276 (< n nmax))
2277 (if (string-equal attr (cadr (aref rmail-attr-array n)))
2278 (setq attr n))
2279 (setq n (1+ n))))
2280 (if (stringp attr)
2281 (error "Unknown attribute `%s'" attr))
2282 ;; Ask for confirmation before setting any attribute except `unseen'
2283 ;; if it would force a format change.
2284 (unless (= attr rmail-unseen-attr-index)
2285 (rmail-modify-format))
2286 (with-current-buffer rmail-buffer
2287 (or msgnum (setq msgnum rmail-current-message))
2288 (when (> msgnum 0)
2289 ;; The "deleted" attribute is also stored in a special vector so
2290 ;; update that too.
2291 (if (= attr rmail-deleted-attr-index)
2292 (rmail-set-message-deleted-p msgnum state))
2293 (if (prog1
2294 (rmail-apply-in-message msgnum 'rmail-set-attribute-1 attr state)
2295 (if (= msgnum rmail-current-message)
2296 (rmail-display-labels)))
2297 ;; Don't save in mbox format over a Babyl file
2298 ;; merely because of a change in `unseen' attribute.
2299 (if (= attr rmail-unseen-attr-index)
2300 (rmail-dont-modify-format)
2301 ;; Otherwise, if we modified the file text via the view buffer,
2302 ;; mark the main buffer modified too.
2303 (set-buffer-modified-p t))))))
2304
2305 (defun rmail-message-attr-p (msg attrs)
2306 "Return non-nil if message number MSG has attributes matching regexp ATTRS."
2307 (let ((value (rmail-get-header rmail-attribute-header msg)))
2308 (and value (string-match attrs value))))
2309
2310 (defun rmail-message-unseen-p (msgnum)
2311 "Return non-nil if message number MSGNUM has the unseen attribute."
2312 (rmail-message-attr-p msgnum "......U"))
2313
2314 ;; FIXME rmail-get-labels does some formatting (eg leading space, `;'
2315 ;; between attributes and labels), so this might not do what you want.
2316 ;; Eg see rmail-sort-by-labels. rmail-get-labels could have an
2317 ;; optional `noformat' argument.
2318 (defun rmail-message-labels-p (msg labels)
2319 "Return non-nil if message number MSG has labels matching regexp LABELS."
2320 (string-match labels (rmail-get-labels msg)))
2321 \f
2322 ;;;; *** Rmail Message Selection And Support ***
2323
2324 (defun rmail-msgend (n)
2325 "Return the start position for message number N."
2326 (marker-position (aref rmail-message-vector (1+ n))))
2327
2328 (defun rmail-msgbeg (n)
2329 "Return the end position for message number N."
2330 (marker-position (aref rmail-message-vector n)))
2331
2332 (defun rmail-apply-in-message (msgnum function &rest args)
2333 "Call FUNCTION on ARGS while narrowed to message MSGNUM.
2334 Point is at the start of the message.
2335 This returns what the call to FUNCTION returns.
2336 If MSGNUM is nil, use the current message."
2337 (with-current-buffer rmail-buffer
2338 (or msgnum (setq msgnum rmail-current-message))
2339 (when (> msgnum 0)
2340 (let (msgbeg msgend)
2341 (setq msgbeg (rmail-msgbeg msgnum))
2342 (setq msgend (rmail-msgend msgnum))
2343 ;; All access to the rmail-buffer's local variables is now finished...
2344 (save-excursion
2345 ;; ... so it is ok to go to a different buffer.
2346 (if (rmail-buffers-swapped-p) (set-buffer rmail-view-buffer))
2347 (save-excursion
2348 (save-restriction
2349 (widen)
2350 (goto-char msgbeg)
2351 (narrow-to-region msgbeg msgend)
2352 (apply function args))))))))
2353
2354 ;; Unused (save for commented out code in rmailedit.el).
2355 (defun rmail-widen-to-current-msgbeg (function)
2356 "Call FUNCTION with point at start of internal data of current message.
2357 Assumes that bounds were previously narrowed to display the message in Rmail.
2358 The bounds are widened enough to move point where desired, then narrowed
2359 again afterward.
2360
2361 FUNCTION may not change the visible text of the message, but it may
2362 change the invisible header text."
2363 (save-excursion
2364 (unwind-protect
2365 (progn
2366 (narrow-to-region (rmail-msgbeg rmail-current-message)
2367 (point-max))
2368 (goto-char (point-min))
2369 (funcall function))
2370 ;; Note: we don't use save-restriction because that does not work right
2371 ;; if changes are made outside the saved restriction
2372 ;; before that restriction is restored.
2373 (narrow-to-region (rmail-msgbeg rmail-current-message)
2374 (rmail-msgend rmail-current-message)))))
2375 \f
2376 ;; Manage the message vectors and counters.
2377
2378 (defun rmail-forget-messages ()
2379 (unwind-protect
2380 (if (vectorp rmail-message-vector)
2381 (let* ((v rmail-message-vector)
2382 (n (length v)))
2383 (dotimes (i n)
2384 (if (aref v i)
2385 (move-marker (aref v i) nil)))))
2386 (setq rmail-message-vector nil)
2387 (setq rmail-msgref-vector nil)
2388 (setq rmail-deleted-vector nil)))
2389
2390 (defun rmail-maybe-set-message-counters ()
2391 (if (not (and rmail-deleted-vector
2392 rmail-message-vector
2393 rmail-current-message
2394 rmail-total-messages))
2395 (rmail-set-message-counters)))
2396
2397 (defun rmail-count-new-messages (&optional nomsg)
2398 "Count the number of new messages.
2399 The buffer should be narrowed to include only the new messages.
2400 Output a helpful message unless NOMSG is non-nil."
2401 (let* ((case-fold-search nil)
2402 (total-messages 0)
2403 (messages-head nil)
2404 (deleted-head nil))
2405 (or nomsg (message "Counting new messages..."))
2406 (goto-char (point-max))
2407 ;; Put at the end of messages-head
2408 ;; the entry for message N+1, which marks
2409 ;; the end of message N. (N = number of messages).
2410 (setq messages-head (list (point-marker)))
2411 (rmail-set-message-counters-counter (point-min))
2412 (setq rmail-current-message (1+ rmail-total-messages))
2413 (setq rmail-total-messages
2414 (+ rmail-total-messages total-messages))
2415 (setq rmail-message-vector
2416 (vconcat rmail-message-vector (cdr messages-head)))
2417 (aset rmail-message-vector
2418 rmail-current-message (car messages-head))
2419 (setq rmail-deleted-vector
2420 (concat rmail-deleted-vector deleted-head))
2421 (setq rmail-summary-vector
2422 (vconcat rmail-summary-vector (make-vector total-messages nil)))
2423 (setq rmail-msgref-vector
2424 (vconcat rmail-msgref-vector (make-vector total-messages nil)))
2425 ;; Fill in the new elements of rmail-msgref-vector.
2426 (let ((i (1+ (- rmail-total-messages total-messages))))
2427 (while (<= i rmail-total-messages)
2428 (aset rmail-msgref-vector i (list i))
2429 (setq i (1+ i))))
2430 (goto-char (point-min))
2431 (or nomsg (message "Counting new messages...done (%d)" total-messages))))
2432
2433 (defun rmail-set-message-counters ()
2434 (rmail-forget-messages)
2435 (save-excursion
2436 (save-restriction
2437 (widen)
2438 (let* ((point-save (point))
2439 (total-messages 0)
2440 (messages-after-point)
2441 (case-fold-search nil)
2442 (messages-head nil)
2443 (deleted-head nil))
2444 ;; Determine how many messages follow point.
2445 (message "Counting messages...")
2446 (goto-char (point-max))
2447 ;; Put at the end of messages-head
2448 ;; the entry for message N+1, which marks
2449 ;; the end of message N. (N = number of messages).
2450 (setq messages-head (list (point-marker)))
2451 (setq messages-after-point
2452 (or (rmail-set-message-counters-counter (min (point) point-save))
2453 0))
2454
2455 (setq rmail-total-messages total-messages)
2456 (setq rmail-current-message
2457 (min total-messages
2458 (max 1 (- total-messages messages-after-point))))
2459
2460 ;; Make an element 0 in rmail-message-vector and rmail-deleted-vector
2461 ;; which will never be used.
2462 (push nil messages-head)
2463 (push ?0 deleted-head)
2464 (setq rmail-message-vector (apply 'vector messages-head)
2465 rmail-deleted-vector (concat deleted-head))
2466
2467 (setq rmail-summary-vector (make-vector rmail-total-messages nil)
2468 rmail-msgref-vector (make-vector (1+ rmail-total-messages) nil))
2469
2470 (let ((i 0))
2471 (while (<= i rmail-total-messages)
2472 (aset rmail-msgref-vector i (list i))
2473 (setq i (1+ i))))
2474 (let ((i 0))
2475 (while (<= i rmail-total-messages)
2476 (rmail-set-message-deleted-p i (rmail-message-attr-p i ".D"))
2477 (setq i (1+ i))))
2478 (message "Counting messages...done")))))
2479
2480
2481 (defsubst rmail-collect-deleted (message-end)
2482 "Collect the message deletion flags for each message.
2483 MESSAGE-END is the buffer position corresponding to the end of
2484 the message. Point is at the beginning of the message."
2485 ;; NOTE: This piece of code will be executed on a per-message basis.
2486 ;; In the face of thousands of messages, it has to be as fast as
2487 ;; possible, hence some brute force constant use is employed in
2488 ;; addition to inlining.
2489 (save-excursion
2490 (setq deleted-head
2491 (cons (if (and (search-forward (concat rmail-attribute-header ": ") message-end t)
2492 (looking-at "?D"))
2493 ?D
2494 ?\s) deleted-head))))
2495
2496 (defun rmail-set-message-counters-counter (&optional spot-to-find)
2497 "Collect the start positions of messages in list `messages-head'.
2498 Return the number of messages after the one containing SPOT-TO-FIND."
2499 (let ((start (point))
2500 messages-after-spot)
2501 (while (search-backward "\n\nFrom " nil t)
2502 (forward-char 2)
2503 (when (looking-at rmail-unix-mail-delimiter)
2504 (if (and (<= (point) spot-to-find)
2505 (null messages-after-spot))
2506 (setq messages-after-spot total-messages))
2507 (rmail-collect-deleted start)
2508 (setq messages-head (cons (point-marker) messages-head)
2509 total-messages (1+ total-messages)
2510 start (point))
2511 ;; Show progress after every 20 messages or so.
2512 (if (zerop (% total-messages 20))
2513 (message "Counting messages...%d" total-messages))))
2514 ;; Handle the first message, maybe.
2515 (goto-char (point-min))
2516 (unless (not (looking-at rmail-unix-mail-delimiter))
2517 (if (and (<= (point) spot-to-find)
2518 (null messages-after-spot))
2519 (setq messages-after-spot total-messages))
2520 (rmail-collect-deleted start)
2521 (setq messages-head (cons (point-marker) messages-head)
2522 total-messages (1+ total-messages)))
2523 messages-after-spot))
2524 \f
2525 ;; Display a message.
2526
2527 ;;;; *** Rmail Message Formatting and Header Manipulation ***
2528
2529 ;; This is used outside of rmail.
2530 (defun rmail-msg-is-pruned ()
2531 "Return nil if the current message is showing full headers."
2532 (with-current-buffer (if (rmail-buffers-swapped-p) rmail-view-buffer
2533 rmail-buffer)
2534 (eq rmail-header-style 'normal)))
2535
2536 (defun rmail-toggle-header (&optional arg)
2537 "Toggle between showing full and normal message headers.
2538 With optional integer ARG, show the normal message header if ARG
2539 is greater than zero; otherwise, show it in full."
2540 (interactive "P")
2541 (let ((rmail-header-style
2542 (if (numberp arg)
2543 (if (> arg 0) 'normal 'full)
2544 (if (rmail-msg-is-pruned) 'full 'normal))))
2545 (rmail-show-message)))
2546
2547 (defun rmail-beginning-of-message ()
2548 "Show current message starting from the beginning."
2549 (interactive)
2550 (let ((rmail-show-message-hook '((lambda () (goto-char (point-min)))))
2551 (rmail-header-style (with-current-buffer (if (rmail-buffers-swapped-p)
2552 rmail-view-buffer
2553 rmail-buffer)
2554 rmail-header-style)))
2555 (rmail-show-message rmail-current-message)))
2556
2557 (defun rmail-end-of-message ()
2558 "Show bottom of current message."
2559 (interactive)
2560 (let ((rmail-show-message-hook '((lambda ()
2561 (goto-char (point-max))
2562 (recenter (1- (window-height))))))
2563 (rmail-header-style (with-current-buffer (if (rmail-buffers-swapped-p)
2564 rmail-view-buffer
2565 rmail-buffer)
2566 rmail-header-style)))
2567 (rmail-show-message rmail-current-message)))
2568
2569 (defun rmail-unknown-mail-followup-to ()
2570 "Handle a \"Mail-Followup-To\" header field with an unknown mailing list.
2571 Ask the user whether to add that list name to `mail-mailing-lists'."
2572 ;; FIXME s-r not needed? Use rmail-get-header?
2573 ;; We have not narrowed to the headers at ths point?
2574 (save-restriction
2575 (let ((mail-followup-to (mail-fetch-field "mail-followup-to" nil t)))
2576 (when mail-followup-to
2577 (let ((addresses
2578 (split-string
2579 (mail-strip-quoted-names mail-followup-to)
2580 ",[[:space:]]+" t)))
2581 (dolist (addr addresses)
2582 (when (and (not (member addr mail-mailing-lists))
2583 (not
2584 ;; taken from rmailsum.el
2585 (string-match
2586 (or rmail-user-mail-address-regexp
2587 (concat "^\\("
2588 (regexp-quote (user-login-name))
2589 "\\($\\|@\\)\\|"
2590 (regexp-quote
2591 (or user-mail-address
2592 (concat (user-login-name) "@"
2593 (or mail-host-address
2594 (system-name)))))
2595 "\\>\\)"))
2596 addr))
2597 (y-or-n-p
2598 (format "Add `%s' to `mail-mailing-lists'? "
2599 addr)))
2600 (customize-save-variable 'mail-mailing-lists
2601 (cons addr mail-mailing-lists)))))))))
2602
2603 (defun rmail-widen ()
2604 "Display the entire mailbox file."
2605 (interactive)
2606 (rmail-swap-buffers-maybe)
2607 (widen))
2608 \f
2609 (defun rmail-no-mail-p ()
2610 "Return nil if there is mail, else \"No mail.\"."
2611 (if (zerop rmail-total-messages)
2612 (save-excursion
2613 (with-current-buffer rmail-view-buffer
2614 (erase-buffer)
2615 "No mail."))))
2616
2617 (defun rmail-show-message (&optional n no-summary)
2618 "Show message number N (prefix argument), counting from start of file.
2619 If summary buffer is currently displayed, update current message there also.
2620 N defaults to the current message."
2621 (interactive "p")
2622 (or (eq major-mode 'rmail-mode)
2623 (switch-to-buffer rmail-buffer))
2624 ;; FIXME: Why do we swap the raw data back in?
2625 (rmail-swap-buffers-maybe)
2626 (rmail-maybe-set-message-counters)
2627 (widen)
2628 (let ((blurb (rmail-show-message-1 n)))
2629 (or (zerop rmail-total-messages)
2630 (progn
2631 (when mail-mailing-lists
2632 (rmail-unknown-mail-followup-to))
2633 (if transient-mark-mode (deactivate-mark))
2634 ;; If there is a summary buffer, try to move to this message
2635 ;; in that buffer. But don't complain if this message is
2636 ;; not mentioned in the summary. Don't do this at all if we
2637 ;; were called on behalf of cursor motion in the summary
2638 ;; buffer.
2639 (and (rmail-summary-exists) (not no-summary)
2640 (let ((curr-msg rmail-current-message))
2641 (rmail-select-summary
2642 (rmail-summary-goto-msg curr-msg t t))))
2643 (with-current-buffer rmail-buffer
2644 (rmail-auto-file))))
2645 (if blurb
2646 (message blurb))))
2647
2648 (defun rmail-is-text-p ()
2649 "Return t if the region contains a text message, nil otherwise."
2650 (save-excursion
2651 (let ((text-regexp "\\(text\\|message\\)/")
2652 (content-type-header (mail-fetch-field "content-type")))
2653 ;; The message is text if either there is no content type header
2654 ;; (a default of "text/plain; charset=US-ASCII" is assumed) or
2655 ;; the base content type is either text or message.
2656 (or (not content-type-header)
2657 (string-match text-regexp content-type-header)))))
2658
2659 (defcustom rmail-show-message-verbose-min 200000
2660 "Message size at which to show progress messages for displaying it."
2661 :type 'integer
2662 :group 'rmail
2663 :version "23.1")
2664
2665 (defun rmail-show-message-1 (&optional msg)
2666 "Show message MSG (default: current message) using `rmail-view-buffer'.
2667 Return text to display in the minibuffer if MSG is out of
2668 range (displaying a reasonable choice as well), nil otherwise.
2669 The current mail message becomes the message displayed."
2670 (let ((mbox-buf rmail-buffer)
2671 (view-buf rmail-view-buffer)
2672 blurb beg end body-start coding-system character-coding
2673 is-text-message header-style)
2674 (if (not msg)
2675 (setq msg rmail-current-message))
2676 (unless (setq blurb (rmail-no-mail-p))
2677 (cond ((<= msg 0)
2678 (setq msg 1
2679 rmail-current-message 1
2680 blurb "No previous message"))
2681 ((> msg rmail-total-messages)
2682 (setq msg rmail-total-messages
2683 rmail-current-message rmail-total-messages
2684 blurb "No following message"))
2685 (t (setq rmail-current-message msg)))
2686 (with-current-buffer rmail-buffer
2687 (setq header-style rmail-header-style)
2688 ;; Mark the message as seen
2689 (rmail-set-attribute rmail-unseen-attr-index nil)
2690 ;; bracket the message in the mail
2691 ;; buffer and determine the coding system the transfer encoding.
2692 (rmail-swap-buffers-maybe)
2693 (setq beg (rmail-msgbeg msg)
2694 end (rmail-msgend msg))
2695 (when (> (- end beg) rmail-show-message-verbose-min)
2696 (message "Showing message %d" msg))
2697 (narrow-to-region beg end)
2698 (goto-char beg)
2699 (setq body-start (search-forward "\n\n" nil t))
2700 (narrow-to-region beg (point))
2701 (goto-char beg)
2702 (save-excursion
2703 (if (re-search-forward "^X-Coding-System: *\\(.*\\)$" nil t)
2704 (setq coding-system (intern (match-string 1)))
2705 (setq coding-system (rmail-get-coding-system))))
2706 (setq character-coding (mail-fetch-field "content-transfer-encoding")
2707 is-text-message (rmail-is-text-p))
2708 (if character-coding
2709 (setq character-coding (downcase character-coding)))
2710 (narrow-to-region beg end)
2711 ;; Decode the message body into an empty view buffer using a
2712 ;; unibyte temporary buffer where the character decoding takes
2713 ;; place.
2714 (with-current-buffer rmail-view-buffer
2715 ;; We give the view buffer a buffer-local value of
2716 ;; rmail-header-style based on the binding in effect when
2717 ;; this function is called; `rmail-toggle-headers' can
2718 ;; inspect this value to determine how to toggle.
2719 (set (make-local-variable 'rmail-header-style) header-style)
2720 (erase-buffer))
2721 (if (null character-coding)
2722 ;; Do it directly since that is fast.
2723 (rmail-decode-region body-start end coding-system view-buf)
2724 ;; Can this be done directly, skipping the temp buffer?
2725 (with-temp-buffer
2726 (set-buffer-multibyte nil)
2727 (insert-buffer-substring mbox-buf body-start end)
2728 (cond
2729 ((string= character-coding "quoted-printable")
2730 (mail-unquote-printable-region (point-min) (point-max)))
2731 ((and (string= character-coding "base64") is-text-message)
2732 (base64-decode-region (point-min) (point-max)))
2733 ((eq character-coding 'uuencode)
2734 (error "uuencoded messages are not supported yet"))
2735 (t))
2736 (rmail-decode-region (point-min) (point-max)
2737 coding-system view-buf)))
2738 (with-current-buffer rmail-view-buffer
2739 ;; Unquote quoted From lines
2740 (goto-char (point-min))
2741 (while (re-search-forward "^>+From " nil t)
2742 (beginning-of-line)
2743 (delete-char 1)
2744 (forward-line))
2745 (goto-char (point-min)))
2746 ;; Copy the headers to the front of the message view buffer.
2747 (rmail-copy-headers beg end)
2748 ;; Add the separator (blank line) between headers and body;
2749 ;; highlight the message, activate any URL like text and add
2750 ;; special highlighting for and quoted material.
2751 (with-current-buffer rmail-view-buffer
2752 (insert "\n")
2753 (goto-char (point-min))
2754 (rmail-highlight-headers)
2755 ;(rmail-activate-urls)
2756 ;(rmail-process-quoted-material)
2757 )
2758 ;; Update the mode-line with message status information and swap
2759 ;; the view buffer/mail buffer contents.
2760 (rmail-display-labels)
2761 (rmail-swap-buffers)
2762 (setq rmail-buffer-swapped t)
2763 (run-hooks 'rmail-show-message-hook)
2764 (when (> (- end beg) rmail-show-message-verbose-min)
2765 (message "Showing message %d...done" msg))))
2766 blurb))
2767
2768 (defun rmail-copy-headers (beg end &optional ignored-headers)
2769 "Copy displayed header fields to the message viewer buffer.
2770 BEG and END marks the start and end positions of the message in
2771 the mbox buffer. If the optional argument IGNORED-HEADERS is
2772 non-nil, ignore all header fields whose names match that regexp.
2773 Otherwise, if `rmail-displayed-headers' is non-nil, copy only
2774 those header fields whose names match that regexp. Otherwise,
2775 copy all header fields whose names do not match
2776 `rmail-ignored-headers' (unless they also match
2777 `rmail-nonignored-headers'). Moves point in the message viewer
2778 buffer to the end of the headers."
2779 (let ((header-start-regexp "\n[^ \t]")
2780 lim)
2781 (with-current-buffer rmail-buffer
2782 (when (search-forward "\n\n" nil t)
2783 (forward-char -1)
2784 (save-restriction
2785 ;; Put point right after the From header line.
2786 (narrow-to-region beg (point))
2787 (goto-char (point-min))
2788 (unless (re-search-forward header-start-regexp nil t)
2789 (rmail-error-bad-format))
2790 (forward-char -1)
2791 (cond
2792 ;; Handle the case where all headers should be copied.
2793 ((eq rmail-header-style 'full)
2794 (prepend-to-buffer rmail-view-buffer beg (point-max))
2795 ;; rmail-show-message-1 expects this function to leave point
2796 ;; at the end of the headers.
2797
2798 (let ((len (- (point-max) beg)))
2799 (with-current-buffer rmail-view-buffer
2800 (goto-char (1+ len)))))
2801
2802 ;; Handle the case where the headers matching the displayed
2803 ;; headers regexp should be copied.
2804 ((and rmail-displayed-headers (null ignored-headers))
2805 (while (not (eobp))
2806 (save-excursion
2807 (setq lim (if (re-search-forward header-start-regexp nil t)
2808 (1+ (match-beginning 0))
2809 (point-max))))
2810 (when (looking-at rmail-displayed-headers)
2811 (append-to-buffer rmail-view-buffer (point) lim))
2812 (goto-char lim)))
2813 ;; Handle the ignored headers.
2814 ((or ignored-headers (setq ignored-headers rmail-ignored-headers))
2815 (while (and ignored-headers (not (eobp)))
2816 (save-excursion
2817 (setq lim (if (re-search-forward header-start-regexp nil t)
2818 (1+ (match-beginning 0))
2819 (point-max))))
2820 (if (and (looking-at ignored-headers)
2821 (not (looking-at rmail-nonignored-headers)))
2822 (goto-char lim)
2823 (append-to-buffer rmail-view-buffer (point) lim)
2824 (goto-char lim))))
2825 (t (error "No headers selected for display!"))))))))
2826
2827 (defun rmail-redecode-body (coding)
2828 "Decode the body of the current message using coding system CODING.
2829 This is useful with mail messages that have malformed or missing
2830 charset= headers.
2831
2832 This function assumes that the current message is already decoded
2833 and displayed in the RMAIL buffer, but the coding system used to
2834 decode it was incorrect. It then decodes the message again,
2835 using the coding system CODING."
2836 (interactive "zCoding system for re-decoding this message: ")
2837 (when (not rmail-enable-mime)
2838 (with-current-buffer rmail-buffer
2839 (rmail-swap-buffers-maybe)
2840 (save-restriction
2841 (widen)
2842 (let ((msgbeg (rmail-msgbeg rmail-current-message))
2843 (msgend (rmail-msgend rmail-current-message))
2844 (buffer-read-only nil)
2845 body-start x-coding-header old-coding)
2846 (narrow-to-region msgbeg msgend)
2847 (goto-char (point-min))
2848 (unless (setq body-start (search-forward "\n\n" (point-max) 1))
2849 (error "No message body"))
2850
2851 (save-restriction
2852 ;; Narrow to headers
2853 (narrow-to-region (point-min) body-start)
2854 (setq x-coding-header (goto-char (point-min)))
2855 (if (not (re-search-forward "^X-Coding-System: *\\(.*\\)$" nil t))
2856 (setq old-coding (rmail-get-coding-system))
2857 (setq old-coding (intern (match-string 1)))
2858 (setq x-coding-header (point)))
2859 (check-coding-system old-coding)
2860 ;; Make sure the new coding system uses the same EOL
2861 ;; conversion, to prevent ^M characters from popping up
2862 ;; all over the place.
2863 (let ((eol-type (coding-system-eol-type old-coding)))
2864 (if (numberp eol-type)
2865 (setq coding
2866 (coding-system-change-eol-conversion coding eol-type))))
2867 (when (not (coding-system-equal
2868 (coding-system-base old-coding)
2869 (coding-system-base coding)))
2870 ;; Rewrite the coding-system header.
2871 (goto-char x-coding-header)
2872 (if (> (point) (point-min))
2873 (delete-region (line-beginning-position) (point))
2874 (forward-line)
2875 (insert "\n")
2876 (forward-line -1))
2877 (insert "X-Coding-System: "
2878 (symbol-name coding))))
2879 (rmail-show-message))))))
2880
2881 (defun rmail-highlight-headers ()
2882 "Highlight the headers specified by `rmail-highlighted-headers'.
2883 Uses the face `rmail-highlight'."
2884 (if rmail-highlighted-headers
2885 (save-excursion
2886 (search-forward "\n\n" nil 'move)
2887 (save-restriction
2888 (narrow-to-region (point-min) (point))
2889 (let ((case-fold-search t)
2890 (inhibit-read-only t)
2891 ;; List of overlays to reuse.
2892 (overlays rmail-overlay-list))
2893 (goto-char (point-min))
2894 (while (re-search-forward rmail-highlighted-headers nil t)
2895 (skip-chars-forward " \t")
2896 (let ((beg (point))
2897 overlay)
2898 (while (progn (forward-line 1)
2899 (looking-at "[ \t]")))
2900 ;; Back up over newline, then trailing spaces or tabs
2901 (forward-char -1)
2902 (while (member (preceding-char) '(? ?\t))
2903 (forward-char -1))
2904 (if overlays
2905 ;; Reuse an overlay we already have.
2906 (progn
2907 (setq overlay (car overlays)
2908 overlays (cdr overlays))
2909 (overlay-put overlay 'face 'rmail-highlight)
2910 (move-overlay overlay beg (point)))
2911 ;; Make a new overlay and add it to
2912 ;; rmail-overlay-list.
2913 (setq overlay (make-overlay beg (point)))
2914 (overlay-put overlay 'face 'rmail-highlight)
2915 (setq rmail-overlay-list
2916 (cons overlay rmail-overlay-list))))))))))
2917
2918 (defun rmail-auto-file ()
2919 "Automatically move a message into a sub-folder based on criteria.
2920 Called when a new message is displayed."
2921 (if (or (zerop rmail-total-messages)
2922 (rmail-message-attr-p rmail-current-message "...F")
2923 (not (string= (buffer-file-name)
2924 (expand-file-name rmail-file-name))))
2925 ;; Do nothing if the message has already been filed or if there
2926 ;; are no messages.
2927 nil
2928 ;; Find out some basics (common fields)
2929 (let ((from (mail-fetch-field "from"))
2930 (subj (mail-fetch-field "subject"))
2931 (to (concat (mail-fetch-field "to") "," (mail-fetch-field "cc")))
2932 (d rmail-automatic-folder-directives)
2933 (directive-loop nil)
2934 (folder nil))
2935 (while d
2936 (setq folder (car (car d))
2937 directive-loop (cdr (car d)))
2938 (while (and (car directive-loop)
2939 (let ((f (cond
2940 ((string= (car directive-loop) "from") from)
2941 ((string= (car directive-loop) "to") to)
2942 ((string= (car directive-loop) "subject") subj)
2943 (t (mail-fetch-field (car directive-loop))))))
2944 (and f (string-match (car (cdr directive-loop)) f))))
2945 (setq directive-loop (cdr (cdr directive-loop))))
2946 ;; If there are no directives left, then it was a complete match.
2947 (if (null directive-loop)
2948 (if (null folder)
2949 (rmail-delete-forward)
2950 (if (string= "/dev/null" folder)
2951 (rmail-delete-message)
2952 (rmail-output folder 1)
2953 (setq d nil))))
2954 (setq d (cdr d))))))
2955 \f
2956 ;; Simple message motion commands.
2957
2958 (defun rmail-next-message (n)
2959 "Show following message whether deleted or not.
2960 With prefix arg N, moves forward N messages, or backward if N is negative."
2961 (interactive "p")
2962 (set-buffer rmail-buffer)
2963 (rmail-maybe-set-message-counters)
2964 (rmail-show-message (+ rmail-current-message n)))
2965
2966 (defun rmail-previous-message (n)
2967 "Show previous message whether deleted or not.
2968 With prefix arg N, moves backward N messages, or forward if N is negative."
2969 (interactive "p")
2970 (rmail-next-message (- n)))
2971
2972 (defun rmail-next-undeleted-message (n)
2973 "Show following non-deleted message.
2974 With prefix arg N, moves forward N non-deleted messages,
2975 or backward if N is negative.
2976
2977 Returns t if a new message is being shown, nil otherwise."
2978 (interactive "p")
2979 (set-buffer rmail-buffer)
2980 (rmail-maybe-set-message-counters)
2981 (let ((lastwin rmail-current-message)
2982 (current rmail-current-message))
2983 (while (and (> n 0) (< current rmail-total-messages))
2984 (setq current (1+ current))
2985 (if (not (rmail-message-deleted-p current))
2986 (setq lastwin current n (1- n))))
2987 (while (and (< n 0) (> current 1))
2988 (setq current (1- current))
2989 (if (not (rmail-message-deleted-p current))
2990 (setq lastwin current n (1+ n))))
2991 (if (/= lastwin rmail-current-message)
2992 (progn (rmail-show-message lastwin)
2993 t)
2994 (if (< n 0)
2995 (message "No previous nondeleted message"))
2996 (if (> n 0)
2997 (message "No following nondeleted message"))
2998 nil)))
2999
3000 (defun rmail-previous-undeleted-message (n)
3001 "Show previous non-deleted message.
3002 With prefix argument N, moves backward N non-deleted messages,
3003 or forward if N is negative."
3004 (interactive "p")
3005 (rmail-next-undeleted-message (- n)))
3006
3007 (defun rmail-first-message ()
3008 "Show first message in file."
3009 (interactive)
3010 (rmail-maybe-set-message-counters)
3011 (rmail-show-message 1))
3012
3013 (defun rmail-last-message ()
3014 "Show last message in file."
3015 (interactive)
3016 (rmail-maybe-set-message-counters)
3017 (rmail-show-message rmail-total-messages))
3018
3019 (defun rmail-what-message ()
3020 "For debugging Rmail: find the message number that point is in."
3021 (let* ((high rmail-total-messages)
3022 (mid (/ high 2))
3023 (low 1)
3024 (where (with-current-buffer (if (rmail-buffers-swapped-p)
3025 rmail-view-buffer
3026 (current-buffer))
3027 (point))))
3028 (while (> (- high low) 1)
3029 (if (>= where (rmail-msgbeg mid))
3030 (setq low mid)
3031 (setq high mid))
3032 (setq mid (+ low (/ (- high low) 2))))
3033 (if (>= where (rmail-msgbeg high)) high low)))
3034 \f
3035 ;; Searching in Rmail file.
3036
3037 (defun rmail-search-message (msg regexp)
3038 "Return non-nil, if for message number MSG, regexp REGEXP matches."
3039 ;; This is adequate because its only caller, rmail-search,
3040 ;; unswaps the buffers.
3041 (goto-char (rmail-msgbeg msg))
3042 (if rmail-enable-mime
3043 (if rmail-search-mime-message-function
3044 (funcall rmail-search-mime-message-function msg regexp)
3045 (error "You must set `rmail-search-mime-message-function'"))
3046 (re-search-forward regexp (rmail-msgend msg) t)))
3047
3048 (defvar rmail-search-last-regexp nil)
3049 (defun rmail-search (regexp &optional n)
3050 "Show message containing next match for REGEXP (but not the current msg).
3051 Prefix argument gives repeat count; negative argument means search
3052 backwards (through earlier messages).
3053 Interactively, empty argument means use same regexp used last time."
3054 (interactive
3055 (let* ((reversep (< (prefix-numeric-value current-prefix-arg) 0))
3056 (prompt
3057 (concat (if reversep "Reverse " "") "Rmail search (regexp"))
3058 regexp)
3059 (setq prompt
3060 (concat prompt
3061 (if rmail-search-last-regexp
3062 (concat ", default "
3063 rmail-search-last-regexp "): ")
3064 "): ")))
3065 (setq regexp (read-string prompt))
3066 (cond ((not (equal regexp ""))
3067 (setq rmail-search-last-regexp regexp))
3068 ((not rmail-search-last-regexp)
3069 (error "No previous Rmail search string")))
3070 (list rmail-search-last-regexp
3071 (prefix-numeric-value current-prefix-arg))))
3072 (or n (setq n 1))
3073 (message "%sRmail search for %s..."
3074 (if (< n 0) "Reverse " "")
3075 regexp)
3076 (set-buffer rmail-buffer)
3077 (let ((orig-message rmail-current-message)
3078 (msg rmail-current-message)
3079 (reversep (< n 0))
3080 (opoint (if (rmail-buffers-swapped-p) (point)))
3081 found)
3082 (rmail-swap-buffers-maybe)
3083 (rmail-maybe-set-message-counters)
3084 (widen)
3085 (unwind-protect
3086 (while (/= n 0)
3087 ;; Check messages one by one, advancing message number up or
3088 ;; down but searching forward through each message.
3089 (if reversep
3090 (while (and (null found) (> msg 1))
3091 (setq msg (1- msg)
3092 found (rmail-search-message msg regexp)))
3093 (while (and (null found) (< msg rmail-total-messages))
3094 (setq msg (1+ msg)
3095 found (rmail-search-message msg regexp))))
3096 (setq n (+ n (if reversep 1 -1))))
3097 (if found
3098 (progn
3099 (rmail-show-message msg)
3100 ;; Search forward (if this is a normal search) or backward
3101 ;; (if this is a reverse search) through this message to
3102 ;; position point. This search may fail because REGEXP
3103 ;; was found in the hidden portion of this message. In
3104 ;; that case, move point to the beginning of visible
3105 ;; portion.
3106 (if reversep
3107 (progn
3108 (goto-char (point-max))
3109 (re-search-backward regexp nil 'move))
3110 (goto-char (point-min))
3111 (re-search-forward regexp nil t))
3112 (message "%sRmail search for %s...done"
3113 (if reversep "Reverse " "")
3114 regexp))
3115 (rmail-show-message orig-message)
3116 (if opoint (goto-char opoint))
3117 (ding)
3118 (message "Search failed: %s" regexp)))))
3119
3120 (defun rmail-search-backwards (regexp &optional n)
3121 "Show message containing previous match for REGEXP.
3122 Prefix argument gives repeat count; negative argument means search
3123 forward (through later messages).
3124 Interactively, empty argument means use same regexp used last time."
3125 (interactive
3126 (let* ((reversep (>= (prefix-numeric-value current-prefix-arg) 0))
3127 (prompt
3128 (concat (if reversep "Reverse " "") "Rmail search (regexp"))
3129 regexp)
3130 (setq prompt
3131 (concat prompt
3132 (if rmail-search-last-regexp
3133 (concat ", default "
3134 rmail-search-last-regexp "): ")
3135 "): ")))
3136 (setq regexp (read-string prompt))
3137 (cond ((not (equal regexp ""))
3138 (setq rmail-search-last-regexp regexp))
3139 ((not rmail-search-last-regexp)
3140 (error "No previous Rmail search string")))
3141 (list rmail-search-last-regexp
3142 (prefix-numeric-value current-prefix-arg))))
3143 (rmail-search regexp (- (or n 1))))
3144 \f
3145 ;; Scan for attributes, and compare subjects.
3146
3147 (defun rmail-first-unseen-message ()
3148 "Return message number of first message which has `unseen' attribute."
3149 (rmail-maybe-set-message-counters)
3150 (let ((current 1)
3151 found)
3152 (save-restriction
3153 (widen)
3154 (while (and (not found) (<= current rmail-total-messages))
3155 (if (rmail-message-attr-p current "......U")
3156 (setq found current))
3157 (setq current (1+ current))))
3158 found))
3159
3160 (defun rmail-simplified-subject (&optional msgnum)
3161 "Return the simplified subject of message MSGNUM (or current message).
3162 Simplifying the subject means stripping leading and trailing whitespace,
3163 and typical reply prefixes such as Re:."
3164 (let ((subject (or (rmail-get-header "Subject" msgnum) "")))
3165 (if (string-match "\\`[ \t]+" subject)
3166 (setq subject (substring subject (match-end 0))))
3167 (if (string-match rmail-reply-regexp subject)
3168 (setq subject (substring subject (match-end 0))))
3169 (if (string-match "[ \t]+\\'" subject)
3170 (setq subject (substring subject 0 (match-beginning 0))))
3171 ;; If Subject is long, mailers will break it into several lines at
3172 ;; arbitrary places, so normalize whitespace by replacing every
3173 ;; run of whitespace characters with a single space.
3174 (setq subject (replace-regexp-in-string "[ \t\n]+" " " subject))
3175 subject))
3176
3177 (defun rmail-simplified-subject-regexp ()
3178 "Return a regular expression matching the current simplified subject.
3179 The idea is to match it against simplified subjects of other messages."
3180 (let ((subject (rmail-simplified-subject)))
3181 (setq subject (regexp-quote subject))
3182 ;; Hide commas so it will work ok if parsed as a comma-separated list
3183 ;; of regexps.
3184 (setq subject
3185 (replace-regexp-in-string "," "\054" subject t t))
3186 (concat "\\`" subject "\\'")))
3187
3188 (defun rmail-next-same-subject (n)
3189 "Go to the next mail message having the same subject header.
3190 With prefix argument N, do this N times.
3191 If N is negative, go backwards instead."
3192 (interactive "p")
3193 (let ((subject (rmail-simplified-subject))
3194 (forward (> n 0))
3195 (i rmail-current-message)
3196 found)
3197 (while (and (/= n 0)
3198 (if forward
3199 (< i rmail-total-messages)
3200 (> i 1)))
3201 (let (done)
3202 (while (and (not done)
3203 (if forward
3204 (< i rmail-total-messages)
3205 (> i 1)))
3206 (setq i (if forward (1+ i) (1- i)))
3207 (setq done (string-equal subject (rmail-simplified-subject i))))
3208 (if done (setq found i)))
3209 (setq n (if forward (1- n) (1+ n))))
3210 (if found
3211 (rmail-show-message found)
3212 (error "No %s message with same subject"
3213 (if forward "following" "previous")))))
3214
3215 (defun rmail-previous-same-subject (n)
3216 "Go to the previous mail message having the same subject header.
3217 With prefix argument N, do this N times.
3218 If N is negative, go forwards instead."
3219 (interactive "p")
3220 (rmail-next-same-subject (- n)))
3221 \f
3222 ;;;; *** Rmail Message Deletion Commands ***
3223
3224 (defun rmail-message-deleted-p (n)
3225 "Return non-nil if message number N is deleted (in `rmail-deleted-vector')."
3226 (= (aref rmail-deleted-vector n) ?D))
3227
3228 (defun rmail-set-message-deleted-p (n state)
3229 "Set the deleted state of message number N (in `rmail-deleted-vector').
3230 STATE non-nil means mark as deleted."
3231 (aset rmail-deleted-vector n (if state ?D ?\s)))
3232
3233 (defun rmail-delete-message ()
3234 "Delete this message and stay on it."
3235 (interactive)
3236 (rmail-set-attribute rmail-deleted-attr-index t)
3237 (run-hooks 'rmail-delete-message-hook))
3238
3239 (defun rmail-undelete-previous-message ()
3240 "Back up to deleted message, select it, and undelete it."
3241 (interactive)
3242 (set-buffer rmail-buffer)
3243 (let ((msg rmail-current-message))
3244 (while (and (> msg 0)
3245 (not (rmail-message-deleted-p msg)))
3246 (setq msg (1- msg)))
3247 (if (= msg 0)
3248 (error "No previous deleted message")
3249 (if (/= msg rmail-current-message)
3250 (rmail-show-message msg))
3251 (rmail-set-attribute rmail-deleted-attr-index nil)
3252 (if (rmail-summary-exists)
3253 (with-current-buffer rmail-summary-buffer
3254 (rmail-summary-mark-undeleted msg)))
3255 (rmail-maybe-display-summary))))
3256
3257 (defun rmail-delete-forward (&optional backward)
3258 "Delete this message and move to next nondeleted one.
3259 Deleted messages stay in the file until the \\[rmail-expunge] command is given.
3260 With prefix argument, delete and move backward.
3261
3262 Returns t if a new message is displayed after the delete, or nil otherwise."
3263 (interactive "P")
3264 (rmail-set-attribute rmail-deleted-attr-index t)
3265 (run-hooks 'rmail-delete-message-hook)
3266 (let ((del-msg rmail-current-message))
3267 (if (rmail-summary-exists)
3268 (rmail-select-summary
3269 (rmail-summary-mark-deleted del-msg)))
3270 (prog1 (rmail-next-undeleted-message (if backward -1 1))
3271 (rmail-maybe-display-summary))))
3272
3273 (defun rmail-delete-backward ()
3274 "Delete this message and move to previous nondeleted one.
3275 Deleted messages stay in the file until the \\[rmail-expunge] command is given."
3276 (interactive)
3277 (rmail-delete-forward t))
3278 \f
3279 ;; Expunging.
3280
3281 ;; Compute the message number a given message would have after expunging.
3282 ;; The present number of the message is OLDNUM.
3283 ;; DELETEDVEC should be rmail-deleted-vector.
3284 ;; The value is nil for a message that would be deleted.
3285 (defun rmail-msg-number-after-expunge (deletedvec oldnum)
3286 (if (or (null oldnum) (= (aref deletedvec oldnum) ?D))
3287 nil
3288 (let ((i 0)
3289 (newnum 0))
3290 (while (< i oldnum)
3291 (if (/= (aref deletedvec i) ?D)
3292 (setq newnum (1+ newnum)))
3293 (setq i (1+ i)))
3294 newnum)))
3295
3296 (defun rmail-expunge-confirmed ()
3297 "Return t if expunge is needed and desirable.
3298 If `rmail-confirm-expunge' is non-nil, ask user to confirm."
3299 (set-buffer rmail-buffer)
3300 (and (stringp rmail-deleted-vector)
3301 (string-match "D" rmail-deleted-vector)
3302 (if rmail-confirm-expunge
3303 (funcall rmail-confirm-expunge
3304 "Erase deleted messages from Rmail file? ")
3305 t)))
3306
3307 (defun rmail-only-expunge (&optional dont-show)
3308 "Actually erase all deleted messages in the file."
3309 (interactive)
3310 (rmail-swap-buffers-maybe)
3311 (set-buffer rmail-buffer)
3312 (message "Expunging deleted messages...")
3313 ;; Discard all undo records for this buffer.
3314 (or (eq buffer-undo-list t)
3315 (setq buffer-undo-list nil))
3316 (rmail-maybe-set-message-counters)
3317 (let* ((omax (- (buffer-size) (point-max)))
3318 (omin (- (buffer-size) (point-min)))
3319 (opoint (if (and (> rmail-current-message 0)
3320 (rmail-message-deleted-p rmail-current-message))
3321 0
3322 (if rmail-enable-mime
3323 (with-current-buffer rmail-view-buffer
3324 (- (point)(point-min)))
3325 (- (point) (point-min)))))
3326 (messages-head (cons (aref rmail-message-vector 0) nil))
3327 (messages-tail messages-head)
3328 ;; Don't make any undo records for the expunging.
3329 (buffer-undo-list t)
3330 (win))
3331 (unwind-protect
3332 (save-excursion
3333 (widen)
3334 (goto-char (point-min))
3335 (let ((counter 0)
3336 (number 1)
3337 new-summary
3338 (new-msgref (list (list 0)))
3339 (buffer-read-only nil)
3340 (total rmail-total-messages)
3341 (new-message-number rmail-current-message)
3342 (messages rmail-message-vector)
3343 (deleted rmail-deleted-vector)
3344 (summary rmail-summary-vector))
3345 (setq rmail-total-messages nil
3346 rmail-current-message nil
3347 rmail-message-vector nil
3348 rmail-deleted-vector nil
3349 rmail-summary-vector nil)
3350
3351 (while (<= number total)
3352 (if (= (aref deleted number) ?D)
3353 (progn
3354 (delete-region (aref messages number)
3355 (aref messages (1+ number)))
3356 (move-marker (aref messages number) nil)
3357 (if (> new-message-number counter)
3358 (setq new-message-number (1- new-message-number))))
3359 (setq counter (1+ counter))
3360 (setq messages-tail
3361 (setcdr messages-tail
3362 (cons (aref messages number) nil)))
3363 (setq new-summary
3364 (cons (if (= counter number) (aref summary (1- number)))
3365 new-summary))
3366 (setq new-msgref
3367 (cons (aref rmail-msgref-vector number)
3368 new-msgref))
3369 (setcar (car new-msgref) counter))
3370 (if (zerop (% (setq number (1+ number)) 20))
3371 (message "Expunging deleted messages...%d" number)))
3372 (setq messages-tail
3373 (setcdr messages-tail
3374 (cons (aref messages number) nil)))
3375 (setq rmail-current-message new-message-number
3376 rmail-total-messages counter
3377 rmail-message-vector (apply 'vector messages-head)
3378 rmail-deleted-vector (make-string (1+ counter) ?\s)
3379 rmail-summary-vector (vconcat (nreverse new-summary))
3380 rmail-msgref-vector (apply 'vector (nreverse new-msgref))
3381 win t)))
3382 (message "Expunging deleted messages...done")
3383 (if (not win)
3384 (narrow-to-region (- (buffer-size) omin) (- (buffer-size) omax)))
3385 (if (not dont-show)
3386 (rmail-show-message (min rmail-current-message rmail-total-messages)))
3387 (if rmail-enable-mime
3388 (goto-char (+ (point-min) opoint))
3389 (goto-char (+ (point) opoint))))))
3390
3391 ;; The DONT-SHOW argument is new in 23. Does not seem very important.
3392 (defun rmail-expunge (&optional dont-show)
3393 "Erase deleted messages from Rmail file and summary buffer.
3394 This always shows a message (so as not to leave the Rmail buffer
3395 unswapped), and always updates any summary (so that it remains
3396 consistent with the Rmail buffer). If DONT-SHOW is non-nil, it
3397 does not pop any summary buffer."
3398 (interactive)
3399 (when (rmail-expunge-confirmed)
3400 (rmail-modify-format)
3401 (let ((was-deleted (rmail-message-deleted-p rmail-current-message))
3402 (was-swapped (rmail-buffers-swapped-p)))
3403 (rmail-only-expunge t)
3404 ;; We always update the summary buffer, so that the contents
3405 ;; remain consistent with the rmail buffer.
3406 ;; The only difference is, in the dont-show case, we use a
3407 ;; cut-down version of rmail-select-summary that does not pop
3408 ;; the summary buffer. It's only used by rmail-quit, which is
3409 ;; just going to bury any summary immediately after. If we made
3410 ;; rmail-quit bury the summary first, dont-show could be removed.
3411 ;; But the expunge might not be confirmed...
3412 (if (rmail-summary-exists)
3413 (if dont-show
3414 (let ((total rmail-total-messages))
3415 (with-current-buffer rmail-summary-buffer
3416 (let ((rmail-total-messages total))
3417 (rmail-update-summary))))
3418 (rmail-select-summary (rmail-update-summary))))
3419 ;; We always show a message, because (rmail-only-expunge t)
3420 ;; leaves the rmail buffer unswapped.
3421 ;; If we expunged the current message, a new one is current now,
3422 ;; so show it. If we weren't showing a message, show it.
3423 (if (or was-deleted (not was-swapped))
3424 (rmail-show-message-1 rmail-current-message)
3425 ;; We can just show the same message that was being shown before.
3426 (rmail-display-labels)
3427 (rmail-swap-buffers)
3428 (setq rmail-buffer-swapped t)))))
3429 \f
3430 ;;;; *** Rmail Mailing Commands ***
3431
3432 (defun rmail-start-mail (&optional noerase to subject in-reply-to cc
3433 replybuffer sendactions same-window others)
3434 (let (yank-action)
3435 (if replybuffer
3436 ;; The function used here must behave like insert-buffer wrt
3437 ;; point and mark (see doc of sc-cite-original).
3438 (setq yank-action (list 'insert-buffer replybuffer)))
3439 (setq others (cons (cons "cc" cc) others))
3440 (setq others (cons (cons "in-reply-to" in-reply-to) others))
3441 (if same-window
3442 (compose-mail to subject others
3443 noerase nil
3444 yank-action sendactions)
3445 (if rmail-mail-new-frame
3446 (prog1
3447 (compose-mail to subject others
3448 noerase 'switch-to-buffer-other-frame
3449 yank-action sendactions)
3450 ;; This is not a standard frame parameter;
3451 ;; nothing except sendmail.el looks at it.
3452 (modify-frame-parameters (selected-frame)
3453 '((mail-dedicated-frame . t))))
3454 (compose-mail to subject others
3455 noerase 'switch-to-buffer-other-window
3456 yank-action sendactions)))))
3457
3458 (defun rmail-mail ()
3459 "Send mail in another window.
3460 While composing the message, use \\[mail-yank-original] to yank the
3461 original message into it."
3462 (interactive)
3463 (rmail-start-mail nil nil nil nil nil rmail-view-buffer))
3464
3465 ;; FIXME should complain if there is nothing to continue.
3466 (defun rmail-continue ()
3467 "Continue composing outgoing message previously being composed."
3468 (interactive)
3469 (rmail-start-mail t))
3470
3471 (defun rmail-reply (just-sender)
3472 "Reply to the current message.
3473 Normally include CC: to all other recipients of original message;
3474 prefix argument means ignore them. While composing the reply,
3475 use \\[mail-yank-original] to yank the original message into it."
3476 (interactive "P")
3477 (if (zerop rmail-current-message)
3478 (error "There is no message to reply to"))
3479 (let (from reply-to cc subject date to message-id references
3480 resent-to resent-cc resent-reply-to
3481 (msgnum rmail-current-message))
3482 (rmail-apply-in-message
3483 rmail-current-message
3484 (lambda ()
3485 (search-forward "\n\n" nil 'move)
3486 (narrow-to-region (point-min) (point))
3487 (setq from (mail-fetch-field "from")
3488 reply-to (or (mail-fetch-field "mail-reply-to" nil t)
3489 (mail-fetch-field "reply-to" nil t)
3490 from)
3491 subject (mail-fetch-field "subject")
3492 date (mail-fetch-field "date")
3493 message-id (mail-fetch-field "message-id")
3494 references (mail-fetch-field "references" nil nil t)
3495 resent-reply-to (mail-fetch-field "resent-reply-to" nil t)
3496 ;; Bug#512. It's inappropriate to reply to these addresses.
3497 ;;; resent-cc (and (not just-sender)
3498 ;;; (mail-fetch-field "resent-cc" nil t))
3499 ;;; resent-to (or (mail-fetch-field "resent-to" nil t) "")
3500 ;;; resent-subject (mail-fetch-field "resent-subject")
3501 ;;; resent-date (mail-fetch-field "resent-date")
3502 ;;; resent-message-id (mail-fetch-field "resent-message-id")
3503 )
3504 (unless just-sender
3505 (if (mail-fetch-field "mail-followup-to" nil t)
3506 ;; If this header field is present, use it instead of the
3507 ;; To and CC fields.
3508 (setq to (mail-fetch-field "mail-followup-to" nil t))
3509 (setq cc (or (mail-fetch-field "cc" nil t) "")
3510 to (or (mail-fetch-field "to" nil t) ""))))))
3511 ;; Merge the resent-to and resent-cc into the to and cc.
3512 ;; Bug#512. It's inappropriate to reply to these addresses.
3513 ;;; (if (and resent-to (not (equal resent-to "")))
3514 ;;; (if (not (equal to ""))
3515 ;;; (setq to (concat to ", " resent-to))
3516 ;;; (setq to resent-to)))
3517 ;;; (if (and resent-cc (not (equal resent-cc "")))
3518 ;;; (if (not (equal cc ""))
3519 ;;; (setq cc (concat cc ", " resent-cc))
3520 ;;; (setq cc resent-cc)))
3521 ;; Add `Re: ' to subject if not there already.
3522 (and (stringp subject)
3523 (setq subject
3524 (concat rmail-reply-prefix
3525 (if (let ((case-fold-search t))
3526 (string-match rmail-reply-regexp subject))
3527 (substring subject (match-end 0))
3528 subject))))
3529 (rmail-start-mail
3530 nil
3531 ;; Using mail-strip-quoted-names is undesirable with newer mailers
3532 ;; since they can handle the names unstripped.
3533 ;; I don't know whether there are other mailers that still
3534 ;; need the names to be stripped.
3535 ;;; (mail-strip-quoted-names reply-to)
3536 ;; Remove unwanted names from reply-to, since Mail-Followup-To
3537 ;; header causes all the names in it to wind up in reply-to, not
3538 ;; in cc. But if what's left is an empty list, use the original.
3539 (let* ((reply-to-list (rmail-dont-reply-to reply-to)))
3540 (if (string= reply-to-list "") reply-to reply-to-list))
3541 subject
3542 (rmail-make-in-reply-to-field from date message-id)
3543 (if just-sender
3544 nil
3545 ;; mail-strip-quoted-names is NOT necessary for rmail-dont-reply-to
3546 ;; to do its job.
3547 (let* ((cc-list (rmail-dont-reply-to
3548 (mail-strip-quoted-names
3549 (if (null cc) to (concat to ", " cc))))))
3550 (if (string= cc-list "") nil cc-list)))
3551 (if (rmail-buffers-swapped-p)
3552 rmail-buffer
3553 rmail-view-buffer)
3554 (list (list 'rmail-mark-message
3555 rmail-buffer
3556 (with-current-buffer rmail-buffer
3557 (aref rmail-msgref-vector msgnum))
3558 rmail-answered-attr-index))
3559 nil
3560 (if (or references message-id)
3561 (list (cons "References" (if references
3562 (concat
3563 (mapconcat 'identity references " ")
3564 " " message-id)
3565 message-id)))))))
3566 \f
3567 (defun rmail-mark-message (buffer msgnum-list attribute)
3568 "Give BUFFER's message number in MSGNUM-LIST the attribute ATTRIBUTE.
3569 This is use in the send-actions for message buffers.
3570 MSGNUM-LIST is a list of the form (MSGNUM)
3571 which is an element of rmail-msgref-vector."
3572 (with-current-buffer buffer
3573 (if (car msgnum-list)
3574 (rmail-set-attribute attribute t (car msgnum-list)))))
3575
3576 (defun rmail-make-in-reply-to-field (from date message-id)
3577 (cond ((not from)
3578 (if message-id
3579 message-id
3580 nil))
3581 (mail-use-rfc822
3582 (require 'rfc822)
3583 (let ((tem (car (rfc822-addresses from))))
3584 (if message-id
3585 (if (or (not tem)
3586 (string-match
3587 (regexp-quote (if (string-match "@[^@]*\\'" tem)
3588 (substring tem 0
3589 (match-beginning 0))
3590 tem))
3591 message-id))
3592 ;; missing From, or Message-ID is sufficiently informative
3593 message-id
3594 (concat message-id " (" tem ")"))
3595 ;; Copy TEM, discarding text properties.
3596 (setq tem (copy-sequence tem))
3597 (set-text-properties 0 (length tem) nil tem)
3598 (setq tem (copy-sequence tem))
3599 ;; Use prin1 to fake RFC822 quoting
3600 (let ((field (prin1-to-string tem)))
3601 (if date
3602 (concat field "'s message of " date)
3603 field)))))
3604 ((let* ((foo "[^][\000-\037()<>@,;:\\\" ]+")
3605 (bar "[^][\000-\037()<>@,;:\\\"]+"))
3606 ;; These strings both match all non-ASCII characters.
3607 (or (string-match (concat "\\`[ \t]*\\(" bar
3608 "\\)\\(<" foo "@" foo ">\\)?[ \t]*\\'")
3609 ;; "Unix Loser <Foo@bar.edu>" => "Unix Loser"
3610 from)
3611 (string-match (concat "\\`[ \t]*<" foo "@" foo ">[ \t]*(\\("
3612 bar "\\))[ \t]*\\'")
3613 ;; "<Bugs@bar.edu>" (Losing Unix) => "Losing Unix"
3614 from)))
3615 (let ((start (match-beginning 1))
3616 (end (match-end 1)))
3617 ;; Trim whitespace which above regexp match allows
3618 (while (and (< start end)
3619 (memq (aref from start) '(?\t ?\s)))
3620 (setq start (1+ start)))
3621 (while (and (< start end)
3622 (memq (aref from (1- end)) '(?\t ?\s)))
3623 (setq end (1- end)))
3624 (let ((field (substring from start end)))
3625 (if date (setq field (concat "message from " field " on " date)))
3626 (if message-id
3627 ;; "<AA259@bar.edu> (message from Unix Loser on 1-Apr-89)"
3628 (concat message-id " (" field ")")
3629 field))))
3630 (t
3631 ;; If we can't kludge it simply, do it correctly
3632 (let ((mail-use-rfc822 t))
3633 (rmail-make-in-reply-to-field from date message-id)))))
3634 \f
3635 (defun rmail-forward (resend)
3636 "Forward the current message to another user.
3637 With prefix argument, \"resend\" the message instead of forwarding it;
3638 see the documentation of `rmail-resend'."
3639 (interactive "P")
3640 (if resend
3641 (call-interactively 'rmail-resend)
3642 (let ((forward-buffer rmail-buffer)
3643 (msgnum rmail-current-message)
3644 (subject (concat "["
3645 (let ((from (or (mail-fetch-field "From")
3646 (mail-fetch-field ">From"))))
3647 (if from
3648 (concat (mail-strip-quoted-names from) ": ")
3649 ""))
3650 (or (mail-fetch-field "Subject") "")
3651 "]")))
3652 (if (rmail-start-mail
3653 nil nil subject nil nil nil
3654 (list (list 'rmail-mark-message
3655 forward-buffer
3656 (with-current-buffer rmail-buffer
3657 (aref rmail-msgref-vector msgnum))
3658 rmail-forwarded-attr-index))
3659 ;; If only one window, use it for the mail buffer.
3660 ;; Otherwise, use another window for the mail buffer
3661 ;; so that the Rmail buffer remains visible
3662 ;; and sending the mail will get back to it.
3663 (and (not rmail-mail-new-frame) (one-window-p t)))
3664 ;; The mail buffer is now current.
3665 (save-excursion
3666 ;; Insert after header separator--before signature if any.
3667 (goto-char (mail-text-start))
3668 (if (or rmail-enable-mime rmail-enable-mime-composing)
3669 (funcall rmail-insert-mime-forwarded-message-function
3670 forward-buffer)
3671 (insert "------- Start of forwarded message -------\n")
3672 ;; Quote lines with `- ' if they start with `-'.
3673 (let ((beg (point)) end)
3674 (setq end (point-marker))
3675 (set-marker-insertion-type end t)
3676 (insert-buffer-substring forward-buffer)
3677 (goto-char beg)
3678 (while (re-search-forward "^-" end t)
3679 (beginning-of-line)
3680 (insert "- ")
3681 (forward-line 1))
3682 (goto-char end)
3683 (skip-chars-backward "\n")
3684 (if (< (point) end)
3685 (forward-char 1))
3686 (delete-region (point) end)
3687 (set-marker end nil))
3688 (insert "------- End of forwarded message -------\n"))
3689 (push-mark))))))
3690 \f
3691 (defun rmail-resend (address &optional from comment mail-alias-file)
3692 "Resend current message to ADDRESSES.
3693 ADDRESSES should be a single address, a string consisting of several
3694 addresses separated by commas, or a list of addresses.
3695
3696 Optional FROM is the address to resend the message from, and
3697 defaults from the value of `user-mail-address'.
3698 Optional COMMENT is a string to insert as a comment in the resent message.
3699 Optional ALIAS-FILE is alternate aliases file to be used by sendmail,
3700 typically for purposes of moderating a list."
3701 (interactive "sResend to: ")
3702 (require 'sendmail)
3703 (require 'mailalias)
3704 (unless (or (eq rmail-view-buffer (current-buffer))
3705 (eq rmail-buffer (current-buffer)))
3706 (error "Not an Rmail buffer"))
3707 (if (not from) (setq from user-mail-address))
3708 (let ((tembuf (generate-new-buffer " sendmail temp"))
3709 (case-fold-search nil)
3710 (mail-personal-alias-file
3711 (or mail-alias-file mail-personal-alias-file))
3712 (mailbuf rmail-buffer))
3713 (unwind-protect
3714 (with-current-buffer tembuf
3715 ;;>> Copy message into temp buffer
3716 (if rmail-enable-mime
3717 (if rmail-insert-mime-resent-message-function
3718 (funcall rmail-insert-mime-resent-message-function mailbuf)
3719 (error "You must set `rmail-insert-mime-resent-message-function'"))
3720 (insert-buffer-substring mailbuf))
3721 (goto-char (point-min))
3722 ;; Delete any Sender field, since that's not specifiable.
3723 ; Only delete Sender fields in the actual header.
3724 (re-search-forward "^$" nil 'move)
3725 ; Using "while" here rather than "if" because some buggy mail
3726 ; software may have inserted multiple Sender fields.
3727 (while (re-search-backward "^Sender:" nil t)
3728 (let (beg)
3729 (setq beg (point))
3730 (forward-line 1)
3731 (while (looking-at "[ \t]")
3732 (forward-line 1))
3733 (delete-region beg (point))))
3734 ; Go back to the beginning of the buffer so the Resent- fields
3735 ; are inserted there.
3736 (goto-char (point-min))
3737 ;;>> Insert resent-from:
3738 (insert "Resent-From: " from "\n")
3739 (insert "Resent-Date: " (mail-rfc822-date) "\n")
3740 ;;>> Insert resent-to: and bcc if need be.
3741 (let ((before (point)))
3742 (if mail-self-blind
3743 (insert "Resent-Bcc: " (user-login-name) "\n"))
3744 (insert "Resent-To: " (if (stringp address)
3745 address
3746 (mapconcat 'identity address ",\n\t"))
3747 "\n")
3748 ;; Expand abbrevs in the recipients.
3749 (save-excursion
3750 (if (featurep 'mailabbrev)
3751 (let ((end (point-marker))
3752 (local-abbrev-table mail-abbrevs)
3753 (old-syntax-table (syntax-table)))
3754 (if (and (not (vectorp mail-abbrevs))
3755 (file-exists-p mail-personal-alias-file))
3756 (build-mail-abbrevs))
3757 (unless mail-abbrev-syntax-table
3758 (mail-abbrev-make-syntax-table))
3759 (set-syntax-table mail-abbrev-syntax-table)
3760 (goto-char before)
3761 (while (and (< (point) end)
3762 (progn (forward-word 1)
3763 (<= (point) end)))
3764 (expand-abbrev))
3765 (set-syntax-table old-syntax-table))
3766 (expand-mail-aliases before (point)))))
3767 ;;>> Set up comment, if any.
3768 (if (and (sequencep comment) (not (zerop (length comment))))
3769 (let ((before (point))
3770 after)
3771 (insert comment)
3772 (or (eolp) (insert "\n"))
3773 (setq after (point))
3774 (goto-char before)
3775 (while (< (point) after)
3776 (insert "Resent-Comment: ")
3777 (forward-line 1))))
3778 ;; Don't expand aliases in the destination fields
3779 ;; of the original message.
3780 (let (mail-aliases)
3781 (funcall send-mail-function)))
3782 (kill-buffer tembuf))
3783 (with-current-buffer rmail-buffer
3784 (rmail-set-attribute rmail-resent-attr-index t rmail-current-message))))
3785 \f
3786 (defvar mail-unsent-separator
3787 (concat "^ *---+ +Unsent message follows +---+ *$\\|"
3788 "^ *---+ +Returned message +---+ *$\\|"
3789 "^ *---+ *Returned mail follows *---+ *$\\|"
3790 "^Start of returned message$\\|"
3791 "^---+ Below this line is a copy of the message.$\\|"
3792 "^ *---+ +Original message +---+ *$\\|"
3793 "^ *--+ +begin message +--+ *$\\|"
3794 "^ *---+ +Original message follows +---+ *$\\|"
3795 "^ *---+ +Your message follows +---+ *$\\|"
3796 "^|? *---+ +Message text follows: +---+ *|?$\\|"
3797 "^ *---+ +This is a copy of \\w+ message, including all the headers.*---+ *$")
3798 "A regexp that matches the separator before the text of a failed message.")
3799
3800 (defvar mail-mime-unsent-header "^Content-Type: message/rfc822 *$"
3801 "A regexp that matches the header of a MIME body part with a failed message.")
3802
3803 ;; This is a cut-down version of rmail-clear-headers from Emacs 22.
3804 ;; It doesn't have the same functionality, hence the name change.
3805 (defun rmail-delete-headers (regexp)
3806 "Delete any mail headers matching REGEXP.
3807 The message should be narrowed to just the headers."
3808 (when regexp
3809 (goto-char (point-min))
3810 (while (re-search-forward regexp nil t)
3811 (beginning-of-line)
3812 ;; This code from Emacs 22 doesn't seem right, since r-n-h is
3813 ;; just for display.
3814 ;;; (if (looking-at rmail-nonignored-headers)
3815 ;;; (forward-line 1)
3816 (delete-region (point)
3817 (save-excursion
3818 (if (re-search-forward "\n[^ \t]" nil t)
3819 (1- (point))
3820 (point-max)))))))
3821
3822 (defun rmail-retry-failure ()
3823 "Edit a mail message which is based on the contents of the current message.
3824 For a message rejected by the mail system, extract the interesting headers and
3825 the body of the original message.
3826 If the failed message is a MIME multipart message, it is searched for a
3827 body part with a header which matches the variable `mail-mime-unsent-header'.
3828 Otherwise, the variable `mail-unsent-separator' should match the string that
3829 delimits the returned original message.
3830 The variable `rmail-retry-ignored-headers' is a regular expression
3831 specifying headers which should not be copied into the new message."
3832 (interactive)
3833 (require 'mail-utils)
3834 (let ((rmail-this-buffer (current-buffer))
3835 (msgnum rmail-current-message)
3836 bounce-start bounce-end bounce-indent resending
3837 (content-type (rmail-get-header "Content-Type")))
3838 (save-excursion
3839 (goto-char (point-min))
3840 (let ((case-fold-search t))
3841 (if (and content-type
3842 (string-match
3843 ";[\n\t ]*boundary=\"?\\([-0-9a-z'()+_,./:=? ]+\\)\"?"
3844 content-type))
3845 ;; Handle a MIME multipart bounce message.
3846 (let ((codestring
3847 (concat "\n--"
3848 (substring content-type (match-beginning 1)
3849 (match-end 1)))))
3850 (unless (re-search-forward mail-mime-unsent-header nil t)
3851 (error "Cannot find beginning of header in failed message"))
3852 (unless (search-forward "\n\n" nil t)
3853 (error "Cannot find start of Mime data in failed message"))
3854 (setq bounce-start (point))
3855 (if (search-forward codestring nil t)
3856 (setq bounce-end (match-beginning 0))
3857 (setq bounce-end (point-max))))
3858 ;; Non-MIME bounce.
3859 (or (re-search-forward mail-unsent-separator nil t)
3860 (error "Cannot parse this as a failure message"))
3861 (skip-chars-forward "\n")
3862 ;; Support a style of failure message in which the original
3863 ;; message is indented, and included within lines saying
3864 ;; `Start of returned message' and `End of returned message'.
3865 (if (looking-at " +Received:")
3866 (progn
3867 (setq bounce-start (point))
3868 (skip-chars-forward " ")
3869 (setq bounce-indent (- (current-column)))
3870 (goto-char (point-max))
3871 (re-search-backward "^End of returned message$" nil t)
3872 (setq bounce-end (point)))
3873 ;; One message contained a few random lines before
3874 ;; the old message header. The first line of the
3875 ;; message started with two hyphens. A blank line
3876 ;; followed these random lines. The same line
3877 ;; beginning with two hyphens was possibly marking
3878 ;; the end of the message.
3879 (if (looking-at "^--")
3880 (let ((boundary (buffer-substring-no-properties
3881 (point)
3882 (progn (end-of-line) (point)))))
3883 (search-forward "\n\n")
3884 (skip-chars-forward "\n")
3885 (setq bounce-start (point))
3886 (goto-char (point-max))
3887 (search-backward (concat "\n\n" boundary) bounce-start t)
3888 (setq bounce-end (point)))
3889 (setq bounce-start (point)
3890 bounce-end (point-max)))
3891 (unless (search-forward "\n\n" nil t)
3892 (error "Cannot find end of header in failed message"))))))
3893 ;; We have found the message that bounced, within the current message.
3894 ;; Now start sending new message; default header fields from original.
3895 ;; Turn off the usual actions for initializing the message body
3896 ;; because we want to get only the text from the failure message.
3897 (let (mail-signature mail-setup-hook)
3898 (if (rmail-start-mail nil nil nil nil nil rmail-this-buffer
3899 (list (list 'rmail-mark-message
3900 rmail-this-buffer
3901 (aref rmail-msgref-vector msgnum)
3902 rmail-retried-attr-index)))
3903 ;; Insert original text as initial text of new draft message.
3904 ;; Bind inhibit-read-only since the header delimiter
3905 ;; of the previous message was probably read-only.
3906 (let ((inhibit-read-only t))
3907 (erase-buffer)
3908 (insert-buffer-substring rmail-this-buffer
3909 bounce-start bounce-end)
3910 (goto-char (point-min))
3911 (if bounce-indent
3912 (indent-rigidly (point-min) (point-max) bounce-indent))
3913 (mail-sendmail-delimit-header)
3914 (save-restriction
3915 (narrow-to-region (point-min) (mail-header-end))
3916 (rmail-delete-headers rmail-retry-ignored-headers)
3917 (rmail-delete-headers "^\\(sender\\|return-path\\|received\\):")
3918 (setq resending (mail-fetch-field "resent-to"))
3919 (if mail-self-blind
3920 (if resending
3921 (insert "Resent-Bcc: " (user-login-name) "\n")
3922 (insert "BCC: " (user-login-name) "\n"))))
3923 (goto-char (point-min))
3924 (mail-position-on-field (if resending "Resent-To" "To") t))))))
3925 \f
3926 (defun rmail-summary-exists ()
3927 "Non-nil if in an RMAIL buffer and an associated summary buffer exists.
3928 In fact, the non-nil value returned is the summary buffer itself."
3929 (and rmail-summary-buffer (buffer-name rmail-summary-buffer)
3930 rmail-summary-buffer))
3931
3932 (defun rmail-summary-displayed ()
3933 "t if in RMAIL buffer and an associated summary buffer is displayed."
3934 (and rmail-summary-buffer (get-buffer-window rmail-summary-buffer)))
3935
3936 (defcustom rmail-redisplay-summary nil
3937 "Non-nil means Rmail should show the summary when it changes.
3938 This has an effect only if a summary buffer exists."
3939 :type 'boolean
3940 :group 'rmail-summary)
3941
3942 (defcustom rmail-summary-window-size nil
3943 "Non-nil means specify the height for an Rmail summary window."
3944 :type '(choice (const :tag "Disabled" nil) integer)
3945 :group 'rmail-summary)
3946
3947 ;; Put the summary buffer back on the screen, if user wants that.
3948 (defun rmail-maybe-display-summary ()
3949 (let ((selected (selected-window))
3950 window)
3951 ;; If requested, make sure the summary is displayed.
3952 (and rmail-summary-buffer (buffer-name rmail-summary-buffer)
3953 rmail-redisplay-summary
3954 (if (get-buffer-window rmail-summary-buffer 0)
3955 ;; It's already in some frame; show that one.
3956 (let ((frame (window-frame
3957 (get-buffer-window rmail-summary-buffer 0))))
3958 (make-frame-visible frame)
3959 (raise-frame frame))
3960 (display-buffer rmail-summary-buffer)))
3961 ;; If requested, set the height of the summary window.
3962 (and rmail-summary-buffer (buffer-name rmail-summary-buffer)
3963 rmail-summary-window-size
3964 (setq window (get-buffer-window rmail-summary-buffer))
3965 ;; Don't try to change the size if just one window in frame.
3966 (not (eq window (frame-root-window (window-frame window))))
3967 (unwind-protect
3968 (progn
3969 (select-window window)
3970 (enlarge-window (- rmail-summary-window-size (window-height))))
3971 (select-window selected)))))
3972 \f
3973 ;;;; *** Rmail Local Fontification ***
3974
3975 (defun rmail-fontify-buffer-function ()
3976 ;; This function's symbol is bound to font-lock-fontify-buffer-function.
3977 (add-hook 'rmail-show-message-hook 'rmail-fontify-message nil t)
3978 ;; If we're already showing a message, fontify it now.
3979 (if rmail-current-message (rmail-fontify-message))
3980 ;; Prevent Font Lock mode from kicking in.
3981 (setq font-lock-fontified t))
3982
3983 (defun rmail-unfontify-buffer-function ()
3984 ;; This function's symbol is bound to font-lock-fontify-unbuffer-function.
3985 (let ((modified (buffer-modified-p))
3986 (buffer-undo-list t) (inhibit-read-only t)
3987 before-change-functions after-change-functions
3988 buffer-file-name buffer-file-truename)
3989 (save-restriction
3990 (widen)
3991 (remove-hook 'rmail-show-message-hook 'rmail-fontify-message t)
3992 (remove-text-properties (point-min) (point-max) '(rmail-fontified nil))
3993 (font-lock-default-unfontify-buffer)
3994 (and (not modified) (buffer-modified-p)
3995 (restore-buffer-modified-p nil)))))
3996
3997 (defun rmail-fontify-message ()
3998 ;; Fontify the current message if it is not already fontified.
3999 (if (text-property-any (point-min) (point-max) 'rmail-fontified nil)
4000 (let ((modified (buffer-modified-p))
4001 (buffer-undo-list t) (inhibit-read-only t)
4002 before-change-functions after-change-functions
4003 buffer-file-name buffer-file-truename)
4004 (save-excursion
4005 (save-match-data
4006 (add-text-properties (point-min) (point-max) '(rmail-fontified t))
4007 (font-lock-fontify-region (point-min) (point-max))
4008 (and (not modified) (buffer-modified-p)
4009 (restore-buffer-modified-p nil)))))))
4010 \f
4011 ;;; Speedbar support for RMAIL files.
4012 (eval-when-compile (require 'speedbar))
4013
4014 (defvar rmail-speedbar-match-folder-regexp "^[A-Z0-9]+\\(\\.[A-Z0-9]+\\)?$"
4015 "*This regex is used to match folder names to be displayed in speedbar.
4016 Enabling this will permit speedbar to display your folders for easy
4017 browsing, and moving of messages.")
4018
4019 (defvar rmail-speedbar-last-user nil
4020 "The last user to be displayed in the speedbar.")
4021
4022 (defvar rmail-speedbar-key-map nil
4023 "Keymap used when in rmail display mode.")
4024
4025 (defun rmail-install-speedbar-variables ()
4026 "Install those variables used by speedbar to enhance rmail."
4027 (if rmail-speedbar-key-map
4028 nil
4029 (setq rmail-speedbar-key-map (speedbar-make-specialized-keymap))
4030
4031 (define-key rmail-speedbar-key-map "e" 'speedbar-edit-line)
4032 (define-key rmail-speedbar-key-map "r" 'speedbar-edit-line)
4033 (define-key rmail-speedbar-key-map "\C-m" 'speedbar-edit-line)
4034 (define-key rmail-speedbar-key-map "M"
4035 'rmail-speedbar-move-message-to-folder-on-line)))
4036
4037 ;; Mouse-3.
4038 (defvar rmail-speedbar-menu-items
4039 '(["Read Folder" speedbar-edit-line t]
4040 ["Move message to folder" rmail-speedbar-move-message-to-folder-on-line
4041 (save-excursion (beginning-of-line)
4042 (looking-at "<M> "))])
4043 "Additional menu-items to add to speedbar frame.")
4044
4045 ;; Make sure our special speedbar major mode is loaded
4046 (if (featurep 'speedbar)
4047 (rmail-install-speedbar-variables)
4048 (add-hook 'speedbar-load-hook 'rmail-install-speedbar-variables))
4049
4050 (defun rmail-speedbar-buttons (buffer)
4051 "Create buttons for BUFFER containing rmail messages.
4052 Click on the address under Reply to: to reply to this person.
4053 Under Folders: Click a name to read it, or on the <M> to move the
4054 current message into that RMAIL folder."
4055 (let ((from nil))
4056 (with-current-buffer buffer
4057 (goto-char (point-min))
4058 (if (not (re-search-forward "^Reply-To: " nil t))
4059 (if (not (re-search-forward "^From:? " nil t))
4060 (setq from t)))
4061 (if from
4062 nil
4063 (setq from (buffer-substring (point) (line-end-position)))))
4064 (goto-char (point-min))
4065 (if (and (looking-at "Reply to:")
4066 (equal from rmail-speedbar-last-user))
4067 nil
4068 (setq rmail-speedbar-last-user from)
4069 (erase-buffer)
4070 (insert "Reply To:\n")
4071 (if (stringp from)
4072 (speedbar-insert-button from 'speedbar-directory-face 'highlight
4073 'rmail-speedbar-button 'rmail-reply))
4074 (insert "Folders:\n")
4075 (let* ((case-fold-search nil)
4076 (df (directory-files (with-current-buffer buffer
4077 default-directory)
4078 nil rmail-speedbar-match-folder-regexp)))
4079 (dolist (file df)
4080 (when (file-regular-p file)
4081 (speedbar-insert-button "<M>" 'speedbar-button-face 'highlight
4082 'rmail-speedbar-move-message file)
4083 (speedbar-insert-button file 'speedbar-file-face 'highlight
4084 'rmail-speedbar-find-file nil t)))))))
4085
4086 (defun rmail-speedbar-button (text token indent)
4087 "Execute an rmail command specified by TEXT.
4088 The command used is TOKEN. INDENT is not used."
4089 (speedbar-with-attached-buffer
4090 (funcall token t)))
4091
4092 (defun rmail-speedbar-find-file (text token indent)
4093 "Load in the rmail file TEXT.
4094 TOKEN and INDENT are not used."
4095 (speedbar-with-attached-buffer
4096 (message "Loading in RMAIL file %s..." text)
4097 (rmail text)))
4098
4099 (defun rmail-speedbar-move-message-to-folder-on-line ()
4100 "If the current line is a folder, move current message to it."
4101 (interactive)
4102 (save-excursion
4103 (beginning-of-line)
4104 (if (re-search-forward "<M> " (line-end-position) t)
4105 (progn
4106 (forward-char -2)
4107 (speedbar-do-function-pointer)))))
4108
4109 (defun rmail-speedbar-move-message (text token indent)
4110 "From button TEXT, copy current message to the rmail file specified by TOKEN.
4111 TEXT and INDENT are not used."
4112 (speedbar-with-attached-buffer
4113 (message "Moving message to %s" token)
4114 ;; expand-file-name is needed due to the unhelpful way in which
4115 ;; rmail-output expands non-absolute filenames against rmail-default-file.
4116 ;; What is the point of that, anyway?
4117 (rmail-output (expand-file-name token))))
4118
4119 ;; Functions for setting, getting and encoding the POP password.
4120 ;; The password is encoded to prevent it from being easily accessible
4121 ;; to "prying eyes." Obviously, this encoding isn't "real security,"
4122 ;; nor is it meant to be.
4123
4124 ;;;###autoload
4125 (defun rmail-set-remote-password (password)
4126 "Set PASSWORD to be used for retrieving mail from a POP or IMAP server."
4127 (interactive "sPassword: ")
4128 (if password
4129 (setq rmail-encoded-remote-password
4130 (rmail-encode-string password (emacs-pid)))
4131 (setq rmail-remote-password nil)
4132 (setq rmail-encoded-remote-password nil)))
4133
4134 (defun rmail-get-remote-password (imap)
4135 "Get the password for retrieving mail from a POP or IMAP server. If none
4136 has been set, then prompt the user for one."
4137 (when (not rmail-encoded-remote-password)
4138 (if (not rmail-remote-password)
4139 (setq rmail-remote-password
4140 (read-passwd (if imap
4141 "IMAP password: "
4142 "POP password: "))))
4143 (rmail-set-remote-password rmail-remote-password)
4144 (setq rmail-remote-password nil))
4145 (rmail-encode-string rmail-encoded-remote-password (emacs-pid)))
4146
4147 (defun rmail-have-password ()
4148 (or rmail-remote-password rmail-encoded-remote-password))
4149
4150 (defun rmail-encode-string (string mask)
4151 "Encode STRING with integer MASK, by taking the exclusive OR of the
4152 lowest byte in the mask with the first character of string, the
4153 second-lowest-byte with the second character of the string, etc.,
4154 restarting at the lowest byte of the mask whenever it runs out.
4155 Returns the encoded string. Calling the function again with an
4156 encoded string (and the same mask) will decode the string."
4157 (setq mask (abs mask)) ; doesn't work if negative
4158 (let* ((string-vector (string-to-vector string)) (i 0)
4159 (len (length string-vector)) (curmask mask) charmask)
4160 (while (< i len)
4161 (if (= curmask 0)
4162 (setq curmask mask))
4163 (setq charmask (% curmask 256))
4164 (setq curmask (lsh curmask -8))
4165 (aset string-vector i (logxor charmask (aref string-vector i)))
4166 (setq i (1+ i)))
4167 (concat string-vector)))
4168
4169 ;;;; Desktop support
4170
4171 (defun rmail-restore-desktop-buffer (desktop-buffer-file-name
4172 desktop-buffer-name
4173 desktop-buffer-misc)
4174 "Restore an rmail buffer specified in a desktop file."
4175 (condition-case error
4176 (progn
4177 (rmail-input desktop-buffer-file-name)
4178 (if (eq major-mode 'rmail-mode)
4179 (current-buffer)
4180 rmail-buffer))
4181 (file-locked
4182 (kill-buffer (current-buffer))
4183 nil)))
4184
4185 (add-to-list 'desktop-buffer-mode-handlers
4186 '(rmail-mode . rmail-restore-desktop-buffer))
4187
4188 ;; We use this to record the encoding of the current message before
4189 ;; saving the message collection.
4190 (defvar rmail-message-encoding nil)
4191
4192 ;; Used in `write-region-annotate-functions' to write rmail files.
4193 (defun rmail-write-region-annotate (start end)
4194 (when (and (null start) (rmail-buffers-swapped-p))
4195 (setq rmail-message-encoding buffer-file-coding-system)
4196 (set-buffer rmail-view-buffer)
4197 (widen)
4198 nil))
4199
4200 ;; Used to restore the encoding of the buffer where we show the
4201 ;; current message, after we save the message collection. This is
4202 ;; needed because rmail-write-region-annotate switches buffers behind
4203 ;; save-file's back, with the side effect that last-coding-system-used
4204 ;; is assigned to buffer-file-coding-system of the wrong buffer.
4205 (defun rmail-after-save-hook ()
4206 (if (or (eq rmail-view-buffer (current-buffer))
4207 (eq rmail-buffer (current-buffer)))
4208 (with-current-buffer
4209 (if (rmail-buffers-swapped-p) rmail-buffer rmail-view-buffer)
4210 (setq buffer-file-coding-system rmail-message-encoding))))
4211 (add-hook 'after-save-hook 'rmail-after-save-hook)
4212
4213 \f
4214 ;;; Start of automatically extracted autoloads.
4215 \f
4216 ;;;### (autoloads (rmail-edit-current-message) "rmailedit" "rmailedit.el"
4217 ;;;;;; "31f0128d57ee5aefe13ec6060a5c63cc")
4218 ;;; Generated autoloads from rmailedit.el
4219
4220 (autoload 'rmail-edit-current-message "rmailedit" "\
4221 Edit the contents of this message.
4222
4223 \(fn)" t nil)
4224
4225 ;;;***
4226 \f
4227 ;;;### (autoloads (rmail-next-labeled-message rmail-previous-labeled-message
4228 ;;;;;; rmail-read-label rmail-kill-label rmail-add-label) "rmailkwd"
4229 ;;;;;; "rmailkwd.el" "2e986921026eea971b49e91f53967f77")
4230 ;;; Generated autoloads from rmailkwd.el
4231
4232 (autoload 'rmail-add-label "rmailkwd" "\
4233 Add LABEL to labels associated with current RMAIL message.
4234 Completes (see `rmail-read-label') over known labels when reading.
4235 LABEL may be a symbol or string. Only one label is allowed.
4236
4237 \(fn LABEL)" t nil)
4238
4239 (autoload 'rmail-kill-label "rmailkwd" "\
4240 Remove LABEL from labels associated with current RMAIL message.
4241 Completes (see `rmail-read-label') over known labels when reading.
4242 LABEL may be a symbol or string. Only one label is allowed.
4243
4244 \(fn LABEL)" t nil)
4245
4246 (autoload 'rmail-read-label "rmailkwd" "\
4247 Read a label with completion, prompting with PROMPT.
4248 Completions are chosen from `rmail-label-obarray'. The default
4249 is `rmail-last-label', if that is non-nil. Updates `rmail-last-label'
4250 according to the choice made, and returns a symbol.
4251
4252 \(fn PROMPT)" nil nil)
4253
4254 (autoload 'rmail-previous-labeled-message "rmailkwd" "\
4255 Show previous message with one of the labels LABELS.
4256 LABELS should be a comma-separated list of label names.
4257 If LABELS is empty, the last set of labels specified is used.
4258 With prefix argument N moves backward N messages with these labels.
4259
4260 \(fn N LABELS)" t nil)
4261
4262 (autoload 'rmail-next-labeled-message "rmailkwd" "\
4263 Show next message with one of the labels LABELS.
4264 LABELS should be a comma-separated list of label names.
4265 If LABELS is empty, the last set of labels specified is used.
4266 With prefix argument N moves forward N messages with these labels.
4267
4268 \(fn N LABELS)" t nil)
4269
4270 ;;;***
4271 \f
4272 ;;;### (autoloads (rmail-mime) "rmailmm" "rmailmm.el" "04becfcbd937ebfb3020515f84e79d0a")
4273 ;;; Generated autoloads from rmailmm.el
4274
4275 (autoload 'rmail-mime "rmailmm" "\
4276 Process the current Rmail message as a MIME message.
4277 This creates a temporary \"*RMAIL*\" buffer holding a decoded
4278 copy of the message. Inline content-types are handled according to
4279 `rmail-mime-media-type-handlers-alist'. By default, this
4280 displays text and multipart messages, and offers to download
4281 attachments as specfied by `rmail-mime-attachment-dirs-alist'.
4282
4283 \(fn)" t nil)
4284
4285 ;;;***
4286 \f
4287 ;;;### (autoloads (set-rmail-inbox-list) "rmailmsc" "rmailmsc.el"
4288 ;;;;;; "de01c37c81339201034a01732b97f44e")
4289 ;;; Generated autoloads from rmailmsc.el
4290
4291 (autoload 'set-rmail-inbox-list "rmailmsc" "\
4292 Set the inbox list of the current RMAIL file to FILE-NAME.
4293 You can specify one file name, or several names separated by commas.
4294 If FILE-NAME is empty, remove any existing inbox list.
4295
4296 This applies only to the current session.
4297
4298 \(fn FILE-NAME)" t nil)
4299
4300 ;;;***
4301 \f
4302 ;;;### (autoloads (rmail-sort-by-labels rmail-sort-by-lines rmail-sort-by-correspondent
4303 ;;;;;; rmail-sort-by-recipient rmail-sort-by-author rmail-sort-by-subject
4304 ;;;;;; rmail-sort-by-date) "rmailsort" "rmailsort.el" "3f2b10b0272ea56cb604f29330d95fc4")
4305 ;;; Generated autoloads from rmailsort.el
4306
4307 (autoload 'rmail-sort-by-date "rmailsort" "\
4308 Sort messages of current Rmail buffer by \"Date\" header.
4309 If prefix argument REVERSE is non-nil, sorts in reverse order.
4310
4311 \(fn REVERSE)" t nil)
4312
4313 (autoload 'rmail-sort-by-subject "rmailsort" "\
4314 Sort messages of current Rmail buffer by \"Subject\" header.
4315 Ignores any \"Re: \" prefix. If prefix argument REVERSE is
4316 non-nil, sorts in reverse order.
4317
4318 \(fn REVERSE)" t nil)
4319
4320 (autoload 'rmail-sort-by-author "rmailsort" "\
4321 Sort messages of current Rmail buffer by author.
4322 This uses either the \"From\" or \"Sender\" header, downcased.
4323 If prefix argument REVERSE is non-nil, sorts in reverse order.
4324
4325 \(fn REVERSE)" t nil)
4326
4327 (autoload 'rmail-sort-by-recipient "rmailsort" "\
4328 Sort messages of current Rmail buffer by recipient.
4329 This uses either the \"To\" or \"Apparently-To\" header, downcased.
4330 If prefix argument REVERSE is non-nil, sorts in reverse order.
4331
4332 \(fn REVERSE)" t nil)
4333
4334 (autoload 'rmail-sort-by-correspondent "rmailsort" "\
4335 Sort messages of current Rmail buffer by other correspondent.
4336 This uses either the \"From\", \"Sender\", \"To\", or
4337 \"Apparently-To\" header, downcased. Uses the first header not
4338 excluded by `rmail-dont-reply-to-names'. If prefix argument
4339 REVERSE is non-nil, sorts in reverse order.
4340
4341 \(fn REVERSE)" t nil)
4342
4343 (autoload 'rmail-sort-by-lines "rmailsort" "\
4344 Sort messages of current Rmail buffer by the number of lines.
4345 If prefix argument REVERSE is non-nil, sorts in reverse order.
4346
4347 \(fn REVERSE)" t nil)
4348
4349 (autoload 'rmail-sort-by-labels "rmailsort" "\
4350 Sort messages of current Rmail buffer by labels.
4351 LABELS is a comma-separated list of labels. The order of these
4352 labels specifies the order of messages: messages with the first
4353 label come first, messages with the second label come second, and
4354 so on. Messages that have none of these labels come last.
4355 If prefix argument REVERSE is non-nil, sorts in reverse order.
4356
4357 \(fn REVERSE LABELS)" t nil)
4358
4359 ;;;***
4360 \f
4361 ;;;### (autoloads (rmail-summary-by-senders rmail-summary-by-topic
4362 ;;;;;; rmail-summary-by-regexp rmail-summary-by-recipients rmail-summary-by-labels
4363 ;;;;;; rmail-summary) "rmailsum" "rmailsum.el" "d7d82233836cae1295ffa85f7371f857")
4364 ;;; Generated autoloads from rmailsum.el
4365
4366 (autoload 'rmail-summary "rmailsum" "\
4367 Display a summary of all messages, one line per message.
4368
4369 \(fn)" t nil)
4370
4371 (autoload 'rmail-summary-by-labels "rmailsum" "\
4372 Display a summary of all messages with one or more LABELS.
4373 LABELS should be a string containing the desired labels, separated by commas.
4374
4375 \(fn LABELS)" t nil)
4376
4377 (autoload 'rmail-summary-by-recipients "rmailsum" "\
4378 Display a summary of all messages with the given RECIPIENTS.
4379 Normally checks the To, From and Cc fields of headers;
4380 but if PRIMARY-ONLY is non-nil (prefix arg given),
4381 only look in the To and From fields.
4382 RECIPIENTS is a string of regexps separated by commas.
4383
4384 \(fn RECIPIENTS &optional PRIMARY-ONLY)" t nil)
4385
4386 (autoload 'rmail-summary-by-regexp "rmailsum" "\
4387 Display a summary of all messages according to regexp REGEXP.
4388 If the regular expression is found in the header of the message
4389 \(including in the date and other lines, as well as the subject line),
4390 Emacs will list the message in the summary.
4391
4392 \(fn REGEXP)" t nil)
4393
4394 (autoload 'rmail-summary-by-topic "rmailsum" "\
4395 Display a summary of all messages with the given SUBJECT.
4396 Normally checks just the Subject field of headers; but with prefix
4397 argument WHOLE-MESSAGE is non-nil, looks in the whole message.
4398 SUBJECT is a string of regexps separated by commas.
4399
4400 \(fn SUBJECT &optional WHOLE-MESSAGE)" t nil)
4401
4402 (autoload 'rmail-summary-by-senders "rmailsum" "\
4403 Display a summary of all messages whose \"From\" field matches SENDERS.
4404 SENDERS is a string of regexps separated by commas.
4405
4406 \(fn SENDERS)" t nil)
4407
4408 ;;;***
4409 \f
4410 ;;;### (autoloads (unforward-rmail-message undigestify-rmail-message)
4411 ;;;;;; "undigest" "undigest.el" "b691540ddff5c394e9ebc3517051445f")
4412 ;;; Generated autoloads from undigest.el
4413
4414 (autoload 'undigestify-rmail-message "undigest" "\
4415 Break up a digest message into its constituent messages.
4416 Leaves original message, deleted, before the undigestified messages.
4417
4418 \(fn)" t nil)
4419
4420 (autoload 'unforward-rmail-message "undigest" "\
4421 Extract a forwarded message from the containing message.
4422 This puts the forwarded message into a separate rmail message
4423 following the containing message.
4424
4425 \(fn)" t nil)
4426
4427 ;;;***
4428 \f
4429 ;;; End of automatically extracted autoloads.
4430
4431
4432 (provide 'rmail)
4433
4434 ;; arch-tag: 65d257d3-c281-4a65-9c38-e61af95af2f0
4435 ;;; rmail.el ends here