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