(rmail-summary-font-lock-keywords): Make sure the
[emacs.git] / lisp / mail / rmailsum.el
blobb1387633dbe01aab55e563cf4d5dfbb15bc28988
1 ;;; rmailsum.el --- make summary buffers for the mail reader
3 ;; Copyright (C) 1985, 1993, 1994, 1995, 1996 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Keywords: mail
8 ;; This file is part of GNU Emacs.
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 2, or (at your option)
13 ;; any later version.
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.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;; Extended by Bob Weiner of Motorola
28 ;; Provided all commands from rmail-mode in rmail-summary-mode and made key
29 ;; bindings in both modes wholly compatible.
31 ;;; Code:
33 ;; For rmail-select-summary
34 (require 'rmail)
36 ;;;###autoload
37 (defcustom rmail-summary-scroll-between-messages t
38 "*Non-nil means Rmail summary scroll commands move between messages."
39 :type 'boolean
40 :group 'rmail-summary)
42 ;;;###autoload
43 (defcustom rmail-summary-line-count-flag t
44 "*Non-nil if Rmail summary should show the number of lines in each message."
45 :type 'boolean
46 :group 'rmail-summary)
48 (defvar rmail-summary-font-lock-keywords
49 '(("^....D.*" . font-lock-string-face) ; Deleted.
50 ("^....-.*" . font-lock-type-face) ; Unread.
51 ;; Neither of the below will be highlighted if either of the above are:
52 ("^....[^D-] \\(......\\)" 1 font-lock-keyword-face) ; Date.
53 ("{ \\([^\n}]+\\),}" 1 font-lock-comment-face)) ; Labels.
54 "Additional expressions to highlight in Rmail Summary mode.")
56 ;; Entry points for making a summary buffer.
58 ;; Regenerate the contents of the summary
59 ;; using the same selection criterion as last time.
60 ;; M-x revert-buffer in a summary buffer calls this function.
61 (defun rmail-update-summary (&rest ignore)
62 (apply (car rmail-summary-redo) (cdr rmail-summary-redo)))
64 ;;;###autoload
65 (defun rmail-summary ()
66 "Display a summary of all messages, one line per message."
67 (interactive)
68 (rmail-new-summary "All" '(rmail-summary) nil))
70 ;;;###autoload
71 (defun rmail-summary-by-labels (labels)
72 "Display a summary of all messages with one or more LABELS.
73 LABELS should be a string containing the desired labels, separated by commas."
74 (interactive "sLabels to summarize by: ")
75 (if (string= labels "")
76 (setq labels (or rmail-last-multi-labels
77 (error "No label specified"))))
78 (setq rmail-last-multi-labels labels)
79 (rmail-new-summary (concat "labels " labels)
80 (list 'rmail-summary-by-labels labels)
81 'rmail-message-labels-p
82 (concat ", \\(" (mail-comma-list-regexp labels) "\\),")))
84 ;;;###autoload
85 (defun rmail-summary-by-recipients (recipients &optional primary-only)
86 "Display a summary of all messages with the given RECIPIENTS.
87 Normally checks the To, From and Cc fields of headers;
88 but if PRIMARY-ONLY is non-nil (prefix arg given),
89 only look in the To and From fields.
90 RECIPIENTS is a string of regexps separated by commas."
91 (interactive "sRecipients to summarize by: \nP")
92 (rmail-new-summary
93 (concat "recipients " recipients)
94 (list 'rmail-summary-by-recipients recipients primary-only)
95 'rmail-message-recipients-p
96 (mail-comma-list-regexp recipients) primary-only))
98 ;;;###autoload
99 (defun rmail-summary-by-regexp (regexp)
100 "Display a summary of all messages according to regexp REGEXP.
101 If the regular expression is found in the header of the message
102 \(including in the date and other lines, as well as the subject line),
103 Emacs will list the header line in the RMAIL-summary."
104 (interactive "sRegexp to summarize by: ")
105 (if (string= regexp "")
106 (setq regexp (or rmail-last-regexp
107 (error "No regexp specified."))))
108 (setq rmail-last-regexp regexp)
109 (rmail-new-summary (concat "regexp " regexp)
110 (list 'rmail-summary-by-regexp regexp)
111 'rmail-message-regexp-p
112 regexp))
114 ;; rmail-summary-by-topic
115 ;; 1989 R.A. Schnitzler
117 ;;;###autoload
118 (defun rmail-summary-by-topic (subject &optional whole-message)
119 "Display a summary of all messages with the given SUBJECT.
120 Normally checks the Subject field of headers;
121 but if WHOLE-MESSAGE is non-nil (prefix arg given),
122 look in the whole message.
123 SUBJECT is a string of regexps separated by commas."
124 (interactive "sTopics to summarize by: \nP")
125 (rmail-new-summary
126 (concat "about " subject)
127 (list 'rmail-summary-by-topic subject whole-message)
128 'rmail-message-subject-p
129 (mail-comma-list-regexp subject) whole-message))
131 (defun rmail-message-subject-p (msg subject &optional whole-message)
132 (save-restriction
133 (goto-char (rmail-msgbeg msg))
134 (search-forward "\n*** EOOH ***\n" (rmail-msgend msg) 'move)
135 (narrow-to-region
136 (point)
137 (progn (search-forward (if whole-message "\^_" "\n\n")) (point)))
138 (goto-char (point-min))
139 (if whole-message (re-search-forward subject nil t)
140 (string-match subject (or (mail-fetch-field "Subject") "")) )))
142 ;;;###autoload
143 (defun rmail-summary-by-senders (senders)
144 "Display a summary of all messages with the given SENDERS.
145 SENDERS is a string of names separated by commas."
146 (interactive "sSenders to summarize by: ")
147 (rmail-new-summary
148 (concat "senders " senders)
149 (list 'rmail-summary-by-senders senders)
150 'rmail-message-senders-p
151 (mail-comma-list-regexp senders)))
153 (defun rmail-message-senders-p (msg senders)
154 (save-restriction
155 (goto-char (rmail-msgbeg msg))
156 (search-forward "\n*** EOOH ***\n")
157 (narrow-to-region (point) (progn (search-forward "\n\n") (point)))
158 (string-match senders (or (mail-fetch-field "From") ""))))
160 ;; General making of a summary buffer.
162 (defvar rmail-summary-symbol-number 0)
164 (defun rmail-new-summary (description redo-form function &rest args)
165 "Create a summary of selected messages.
166 DESCRIPTION makes part of the mode line of the summary buffer.
167 For each message, FUNCTION is applied to the message number and ARGS...
168 and if the result is non-nil, that message is included.
169 nil for FUNCTION means all messages."
170 (message "Computing summary lines...")
171 (let (sumbuf mesg was-in-summary)
172 (save-excursion
173 ;; Go to the Rmail buffer.
174 (if (eq major-mode 'rmail-summary-mode)
175 (progn
176 (setq was-in-summary t)
177 (set-buffer rmail-buffer)))
178 ;; Find its summary buffer, or make one.
179 (setq sumbuf
180 (if (and rmail-summary-buffer
181 (buffer-name rmail-summary-buffer))
182 rmail-summary-buffer
183 (generate-new-buffer (concat (buffer-name) "-summary"))))
184 (setq mesg rmail-current-message)
185 ;; Filter the messages; make or get their summary lines.
186 (let ((summary-msgs ())
187 (new-summary-line-count 0))
188 (let ((msgnum 1)
189 (buffer-read-only nil)
190 (old-min (point-min-marker))
191 (old-max (point-max-marker)))
192 ;; Can't use save-restriction here; that doesn't work if we
193 ;; plan to modify text outside the original restriction.
194 (save-excursion
195 (widen)
196 (goto-char (point-min))
197 (while (>= rmail-total-messages msgnum)
198 (if (or (null function)
199 (apply function (cons msgnum args)))
200 (setq summary-msgs
201 (cons (cons msgnum (rmail-make-summary-line msgnum))
202 summary-msgs)))
203 (setq msgnum (1+ msgnum)))
204 (setq summary-msgs (nreverse summary-msgs)))
205 (narrow-to-region old-min old-max))
206 ;; Temporarily, while summary buffer is unfinished,
207 ;; we "don't have" a summary.
208 (setq rmail-summary-buffer nil)
209 (save-excursion
210 (let ((rbuf (current-buffer))
211 (vbuf rmail-view-buffer)
212 (total rmail-total-messages))
213 (set-buffer sumbuf)
214 ;; Set up the summary buffer's contents.
215 (let ((buffer-read-only nil))
216 (erase-buffer)
217 (while summary-msgs
218 (princ (cdr (car summary-msgs)) sumbuf)
219 (setq summary-msgs (cdr summary-msgs)))
220 (goto-char (point-min)))
221 ;; Set up the rest of its state and local variables.
222 (setq buffer-read-only t)
223 (rmail-summary-mode)
224 (make-local-variable 'minor-mode-alist)
225 (setq minor-mode-alist (list (list t (concat ": " description))))
226 (setq rmail-buffer rbuf
227 rmail-view-buffer vbuf
228 rmail-summary-redo redo-form
229 rmail-total-messages total))))
230 (setq rmail-summary-buffer sumbuf))
231 ;; Now display the summary buffer and go to the right place in it.
232 (or was-in-summary
233 (progn
234 (if (and (one-window-p)
235 pop-up-windows (not pop-up-frames))
236 ;; If there is just one window, put the summary on the top.
237 (progn
238 (split-window (selected-window) rmail-summary-window-size)
239 (select-window (next-window (frame-first-window)))
240 (pop-to-buffer sumbuf)
241 ;; If pop-to-buffer did not use that window, delete that
242 ;; window. (This can happen if it uses another frame.)
243 (if (not (eq sumbuf (window-buffer (frame-first-window))))
244 (delete-other-windows)))
245 (pop-to-buffer sumbuf))
246 (set-buffer rmail-buffer)
247 ;; This is how rmail makes the summary buffer reappear.
248 ;; We do this here to make the window the proper size.
249 (rmail-select-summary nil)
250 (set-buffer rmail-summary-buffer)))
251 (rmail-summary-goto-msg mesg t t)
252 (rmail-summary-construct-io-menu)
253 (message "Computing summary lines...done")))
255 ;; Low levels of generating a summary.
257 (defun rmail-make-summary-line (msg)
258 (let ((line (or (aref rmail-summary-vector (1- msg))
259 (progn
260 (setq new-summary-line-count
261 (1+ new-summary-line-count))
262 (if (zerop (% new-summary-line-count 10))
263 (message "Computing summary lines...%d"
264 new-summary-line-count))
265 (rmail-make-summary-line-1 msg)))))
266 ;; Fix up the part of the summary that says "deleted" or "unseen".
267 (aset line 4
268 (if (rmail-message-deleted-p msg) ?\D
269 (if (= ?0 (char-after (+ 3 (rmail-msgbeg msg))))
270 ?\- ?\ )))
271 line))
273 ;;;###autoload
274 (defcustom rmail-summary-line-decoder (function identity)
275 "*Function to decode summary-line.
277 By default, `identity' is set."
278 :type 'function
279 :group 'rmail-summary)
281 (defun rmail-make-summary-line-1 (msg)
282 (goto-char (rmail-msgbeg msg))
283 (let* ((lim (save-excursion (forward-line 2) (point)))
285 (labels
286 (progn
287 (forward-char 3)
288 (concat
289 ; (if (save-excursion (re-search-forward ",answered," lim t))
290 ; "*" "")
291 ; (if (save-excursion (re-search-forward ",filed," lim t))
292 ; "!" "")
293 (if (progn (search-forward ",,") (eolp))
295 (concat "{"
296 (buffer-substring (point)
297 (progn (end-of-line) (point)))
298 "} ")))))
299 (line
300 (progn
301 (forward-line 1)
302 (if (looking-at "Summary-line: ")
303 (progn
304 (goto-char (match-end 0))
305 (setq line
306 (buffer-substring (point)
307 (progn (forward-line 1) (point)))))))))
308 ;; Obsolete status lines lacking a # should be flushed.
309 (and line
310 (not (string-match "#" line))
311 (progn
312 (delete-region (point)
313 (progn (forward-line -1) (point)))
314 (setq line nil)))
315 ;; If we didn't get a valid status line from the message,
316 ;; make a new one and put it in the message.
317 (or line
318 (let* ((case-fold-search t)
319 (next (rmail-msgend msg))
320 (beg (if (progn (goto-char (rmail-msgbeg msg))
321 (search-forward "\n*** EOOH ***\n" next t))
322 (point)
323 (forward-line 1)
324 (point)))
325 (end (progn (search-forward "\n\n" nil t) (point))))
326 (save-restriction
327 (narrow-to-region beg end)
328 (goto-char beg)
329 (setq line (rmail-make-basic-summary-line)))
330 (goto-char (rmail-msgbeg msg))
331 (forward-line 2)
332 (insert "Summary-line: " line)))
333 (setq pos (string-match "#" line))
334 (aset rmail-summary-vector (1- msg)
335 (funcall rmail-summary-line-decoder
336 (concat (format "%4d " msg)
337 (substring line 0 pos)
338 labels
339 (substring line (1+ pos)))))
342 (defun rmail-make-basic-summary-line ()
343 (goto-char (point-min))
344 (concat (save-excursion
345 (if (not (re-search-forward "^Date:" nil t))
347 (cond ((re-search-forward "\\([^0-9:]\\)\\([0-3]?[0-9]\\)\\([- \t_]+\\)\\([adfjmnos][aceopu][bcglnprtvy]\\)"
348 (save-excursion (end-of-line) (point)) t)
349 (format "%2d-%3s"
350 (string-to-int (buffer-substring
351 (match-beginning 2)
352 (match-end 2)))
353 (buffer-substring
354 (match-beginning 4) (match-end 4))))
355 ((re-search-forward "\\([^a-z]\\)\\([adfjmnos][acepou][bcglnprtvy]\\)\\([-a-z \t_]*\\)\\([0-9][0-9]?\\)"
356 (save-excursion (end-of-line) (point)) t)
357 (format "%2d-%3s"
358 (string-to-int (buffer-substring
359 (match-beginning 4)
360 (match-end 4)))
361 (buffer-substring
362 (match-beginning 2) (match-end 2))))
363 ((re-search-forward "\\(19\\|20\\)\\([0-9][0-9]\\)-\\([01][0-9]\\)-\\([0-3][0-9]\\)"
364 (save-excursion (end-of-line) (point)) t)
365 (format "%2s%2s%2s"
366 (buffer-substring
367 (match-beginning 2) (match-end 2))
368 (buffer-substring
369 (match-beginning 3) (match-end 3))
370 (buffer-substring
371 (match-beginning 4) (match-end 4))))
372 (t "??????"))))
374 (save-excursion
375 (if (not (re-search-forward "^From:[ \t]*" nil t))
377 (let* ((from (mail-strip-quoted-names
378 (buffer-substring
379 (1- (point))
380 ;; Get all the lines of the From field
381 ;; so that we get a whole comment if there is one,
382 ;; so that mail-strip-quoted-names can discard it.
383 (let ((opoint (point)))
384 (while (progn (forward-line 1)
385 (looking-at "[ \t]")))
386 ;; Back up over newline, then trailing spaces or tabs
387 (forward-char -1)
388 (skip-chars-backward " \t")
389 (point)))))
390 len mch lo)
391 (if (string-match (concat "^\\("
392 (regexp-quote (user-login-name))
393 "\\($\\|@\\)\\|"
394 (regexp-quote
395 ;; Don't lose if run from init file
396 ;; where user-mail-address is not
397 ;; set yet.
398 (or user-mail-address
399 (concat (user-login-name) "@"
400 (or mail-host-address
401 (system-name)))))
402 "\\>\\)")
403 from)
404 (save-excursion
405 (goto-char (point-min))
406 (if (not (re-search-forward "^To:[ \t]*" nil t))
408 (setq from
409 (concat "to: "
410 (mail-strip-quoted-names
411 (buffer-substring
412 (point)
413 (progn (end-of-line)
414 (skip-chars-backward " \t")
415 (point)))))))))
416 (setq len (length from))
417 (setq mch (string-match "[@%]" from))
418 (format "%25s"
419 (if (or (not mch) (<= len 25))
420 (substring from (max 0 (- len 25)))
421 (substring from
422 (setq lo (cond ((< (- mch 14) 0) 0)
423 ((< len (+ mch 11))
424 (- len 25))
425 (t (- mch 14))))
426 (min len (+ lo 25))))))))
427 (if rmail-summary-line-count-flag
428 (save-excursion
429 (save-restriction
430 (widen)
431 (let ((beg (rmail-msgbeg msgnum))
432 (end (rmail-msgend msgnum))
433 lines)
434 (save-excursion
435 (goto-char beg)
436 ;; Count only lines in the reformatted header,
437 ;; if we have reformatted it.
438 (search-forward "\n*** EOOH ***\n" end t)
439 (setq lines (count-lines (point) end)))
440 (format (cond
441 ((<= lines 9) " [%d]")
442 ((<= lines 99) " [%d]")
443 ((<= lines 999) " [%3d]")
444 (t "[%d]"))
445 lines))))
446 " ")
447 " #" ;The # is part of the format.
448 (if (re-search-forward "^Subject:" nil t)
449 (progn (skip-chars-forward " \t")
450 (buffer-substring (point)
451 (progn (end-of-line)
452 (point))))
453 (re-search-forward "[\n][\n]+" nil t)
454 (buffer-substring (point) (progn (end-of-line) (point))))
455 "\n"))
457 ;; Simple motion in a summary buffer.
459 (defun rmail-summary-next-all (&optional number)
460 (interactive "p")
461 (forward-line (if number number 1))
462 ;; It doesn't look nice to move forward past the last message line.
463 (and (eobp) (> number 0)
464 (forward-line -1))
465 (display-buffer rmail-buffer))
467 (defun rmail-summary-previous-all (&optional number)
468 (interactive "p")
469 (forward-line (- (if number number 1)))
470 ;; It doesn't look nice to move forward past the last message line.
471 (and (eobp) (< number 0)
472 (forward-line -1))
473 (display-buffer rmail-buffer))
475 (defun rmail-summary-next-msg (&optional number)
476 "Display next non-deleted msg from rmail file.
477 With optional prefix argument NUMBER, moves forward this number of non-deleted
478 messages, or backward if NUMBER is negative."
479 (interactive "p")
480 (forward-line 0)
481 (and (> number 0) (end-of-line))
482 (let ((count (if (< number 0) (- number) number))
483 (search (if (> number 0) 're-search-forward 're-search-backward))
484 (non-del-msg-found nil))
485 (while (and (> count 0) (setq non-del-msg-found
486 (or (funcall search "^....[^D]" nil t)
487 non-del-msg-found)))
488 (setq count (1- count))))
489 (beginning-of-line)
490 (display-buffer rmail-view-buffer)
493 (defun rmail-summary-previous-msg (&optional number)
494 (interactive "p")
495 (rmail-summary-next-msg (- (if number number 1))))
497 (defun rmail-summary-next-labeled-message (n labels)
498 "Show next message with LABEL. Defaults to last labels used.
499 With prefix argument N moves forward N messages with these labels."
500 (interactive "p\nsMove to next msg with labels: ")
501 (let (msg)
502 (save-excursion
503 (set-buffer rmail-buffer)
504 (rmail-next-labeled-message n labels)
505 (setq msg rmail-current-message))
506 (rmail-summary-goto-msg msg)))
508 (defun rmail-summary-previous-labeled-message (n labels)
509 "Show previous message with LABEL. Defaults to last labels used.
510 With prefix argument N moves backward N messages with these labels."
511 (interactive "p\nsMove to previous msg with labels: ")
512 (let (msg)
513 (save-excursion
514 (set-buffer rmail-buffer)
515 (rmail-previous-labeled-message n labels)
516 (setq msg rmail-current-message))
517 (rmail-summary-goto-msg msg)))
519 (defun rmail-summary-next-same-subject (n)
520 "Go to the next message in the summary having the same subject.
521 With prefix argument N, do this N times.
522 If N is negative, go backwards."
523 (interactive "p")
524 (let (subject search-regexp i found
525 (forward (> n 0)))
526 (save-excursion
527 (set-buffer rmail-buffer)
528 (setq subject (mail-fetch-field "Subject"))
529 (setq i rmail-current-message))
530 (if (string-match "Re:[ \t]*" subject)
531 (setq subject (substring subject (match-end 0))))
532 (setq search-regexp (concat "^Subject: *\\(Re: *\\)?"
533 (regexp-quote subject)
534 "\n"))
535 (save-excursion
536 (while (and (/= n 0)
537 (if forward
538 (not (eobp))
539 (not (bobp))))
540 (let (done)
541 (while (and (not done)
542 (if forward
543 (not (eobp))
544 (not (bobp))))
545 ;; Advance thru summary.
546 (forward-line (if forward 1 -1))
547 ;; Get msg number of this line.
548 (setq i (string-to-int
549 (buffer-substring (point)
550 (min (point-max) (+ 5 (point))))))
551 ;; See if that msg has desired subject.
552 (save-excursion
553 (set-buffer rmail-buffer)
554 (save-restriction
555 (widen)
556 (goto-char (rmail-msgbeg i))
557 (search-forward "\n*** EOOH ***\n")
558 (let ((beg (point)) end)
559 (search-forward "\n\n")
560 (setq end (point))
561 (goto-char beg)
562 (setq done (re-search-forward search-regexp end t))))))
563 (if done (setq found i)))
564 (setq n (if forward (1- n) (1+ n)))))
565 (if found
566 (rmail-summary-goto-msg found)
567 (error "No %s message with same subject"
568 (if forward "following" "previous")))))
570 (defun rmail-summary-previous-same-subject (n)
571 "Go to the previous message in the summary having the same subject.
572 With prefix argument N, do this N times.
573 If N is negative, go forwards instead."
574 (interactive "p")
575 (rmail-summary-next-same-subject (- n)))
577 ;; Delete and undelete summary commands.
579 (defun rmail-summary-delete-forward (&optional count)
580 "Delete this message and move to next nondeleted one.
581 Deleted messages stay in the file until the \\[rmail-expunge] command is given.
582 A prefix argument serves as a repeat count;
583 a negative argument means to delete and move backward."
584 (interactive "p")
585 (unless (numberp count) (setq count 1))
586 (let (end del-msg
587 (backward (< count 0)))
588 (while (/= count 0)
589 (rmail-summary-goto-msg)
590 (with-current-buffer rmail-buffer
591 (rmail-delete-message)
592 (setq del-msg rmail-current-message))
593 (rmail-summary-mark-deleted del-msg)
594 (while (and (not (if backward (bobp) (eobp)))
595 (save-excursion (beginning-of-line)
596 (looking-at " *[0-9]+D")))
597 (forward-line (if backward -1 1)))
598 ;; It looks ugly to move to the empty line at end of buffer.
599 (and (eobp) (not backward)
600 (forward-line -1))
601 (setq count
602 (if (> count 0) (1- count) (1+ count))))))
604 (defun rmail-summary-delete-backward (&optional count)
605 "Delete this message and move to previous nondeleted one.
606 Deleted messages stay in the file until the \\[rmail-expunge] command is given.
607 A prefix argument serves as a repeat count;
608 a negative argument means to delete and move forward."
609 (interactive "p")
610 (rmail-summary-delete-forward (- count)))
612 (defun rmail-summary-mark-deleted (&optional n undel)
613 ;; Since third arg is t, this only alters the summary, not the Rmail buf.
614 (and n (rmail-summary-goto-msg n t t))
615 (or (eobp)
616 (not (overlay-get rmail-summary-overlay 'face))
617 (let ((buffer-read-only nil))
618 (skip-chars-forward " ")
619 (skip-chars-forward "[0-9]")
620 (if undel
621 (if (looking-at "D")
622 (progn (delete-char 1) (insert " ")))
623 (delete-char 1)
624 (insert "D"))))
625 (beginning-of-line))
627 (defun rmail-summary-mark-undeleted (n)
628 (rmail-summary-mark-deleted n t))
630 (defun rmail-summary-deleted-p (&optional n)
631 (save-excursion
632 (and n (rmail-summary-goto-msg n nil t))
633 (skip-chars-forward " ")
634 (skip-chars-forward "[0-9]")
635 (looking-at "D")))
637 (defun rmail-summary-undelete (&optional arg)
638 "Undelete current message.
639 Optional prefix ARG means undelete ARG previous messages."
640 (interactive "p")
641 (if (/= arg 1)
642 (rmail-summary-undelete-many arg)
643 (let ((buffer-read-only nil)
644 (opoint (point)))
645 (end-of-line)
646 (cond ((re-search-backward "\\(^ *[0-9]*\\)\\(D\\)" nil t)
647 (replace-match "\\1 ")
648 (rmail-summary-goto-msg)
649 (pop-to-buffer rmail-buffer)
650 (and (rmail-message-deleted-p rmail-current-message)
651 (rmail-undelete-previous-message))
652 (pop-to-buffer rmail-summary-buffer))
653 (t (goto-char opoint))))))
655 (defun rmail-summary-undelete-many (&optional n)
656 "Undelete all deleted msgs, optional prefix arg N means undelete N prev msgs."
657 (interactive "P")
658 (save-excursion
659 (set-buffer rmail-buffer)
660 (let* ((init-msg (if n rmail-current-message rmail-total-messages))
661 (rmail-current-message init-msg)
662 (n (or n rmail-total-messages))
663 (msgs-undeled 0))
664 (while (and (> rmail-current-message 0)
665 (< msgs-undeled n))
666 (if (rmail-message-deleted-p rmail-current-message)
667 (progn (rmail-set-attribute "deleted" nil)
668 (setq msgs-undeled (1+ msgs-undeled))))
669 (setq rmail-current-message (1- rmail-current-message)))
670 (set-buffer rmail-summary-buffer)
671 (setq rmail-current-message init-msg msgs-undeled 0)
672 (while (and (> rmail-current-message 0)
673 (< msgs-undeled n))
674 (if (rmail-summary-deleted-p rmail-current-message)
675 (progn (rmail-summary-mark-undeleted rmail-current-message)
676 (setq msgs-undeled (1+ msgs-undeled))))
677 (setq rmail-current-message (1- rmail-current-message))))
678 (rmail-summary-goto-msg)))
680 ;; Rmail Summary mode is suitable only for specially formatted data.
681 (put 'rmail-summary-mode 'mode-class 'special)
683 (defun rmail-summary-mode ()
684 "Rmail Summary Mode is invoked from Rmail Mode by using \\<rmail-mode-map>\\[rmail-summary].
685 As commands are issued in the summary buffer, they are applied to the
686 corresponding mail messages in the rmail buffer.
688 All normal editing commands are turned off.
689 Instead, nearly all the Rmail mode commands are available,
690 though many of them move only among the messages in the summary.
692 These additional commands exist:
694 \\[rmail-summary-undelete-many] Undelete all or prefix arg deleted messages.
695 \\[rmail-summary-wipe] Delete the summary and go to the Rmail buffer.
697 Commands for sorting the summary:
699 \\[rmail-summary-sort-by-date] Sort by date.
700 \\[rmail-summary-sort-by-subject] Sort by subject.
701 \\[rmail-summary-sort-by-author] Sort by author.
702 \\[rmail-summary-sort-by-recipient] Sort by recipient.
703 \\[rmail-summary-sort-by-correspondent] Sort by correspondent.
704 \\[rmail-summary-sort-by-lines] Sort by lines.
705 \\[rmail-summary-sort-by-keywords] Sort by keywords."
706 (interactive)
707 (kill-all-local-variables)
708 (setq major-mode 'rmail-summary-mode)
709 (setq mode-name "RMAIL Summary")
710 (setq truncate-lines t)
711 (setq buffer-read-only t)
712 (set-syntax-table text-mode-syntax-table)
713 (make-local-variable 'rmail-buffer)
714 (make-local-variable 'rmail-view-buffer)
715 (make-local-variable 'rmail-total-messages)
716 (make-local-variable 'rmail-current-message)
717 (setq rmail-current-message nil)
718 (make-local-variable 'rmail-summary-redo)
719 (setq rmail-summary-redo nil)
720 (make-local-variable 'revert-buffer-function)
721 (make-local-hook 'post-command-hook)
722 (make-local-variable 'font-lock-defaults)
723 (setq font-lock-defaults '(rmail-summary-font-lock-keywords t))
724 (rmail-summary-enable)
725 (run-hooks 'rmail-summary-mode-hook))
727 ;; Summary features need to be disabled during edit mode.
728 (defun rmail-summary-disable ()
729 (use-local-map text-mode-map)
730 (remove-hook 'post-command-hook 'rmail-summary-rmail-update t)
731 (setq revert-buffer-function nil))
733 (defun rmail-summary-enable ()
734 (use-local-map rmail-summary-mode-map)
735 (add-hook 'post-command-hook 'rmail-summary-rmail-update nil t)
736 (setq revert-buffer-function 'rmail-update-summary))
738 (defvar rmail-summary-put-back-unseen nil
739 "Used for communicating between calls to `rmail-summary-rmail-update'.
740 If it moves to a message within an Incremental Search, and removes
741 the `unseen' attribute from that message, it sets this flag
742 so that if the next motion between messages is in the same Incremental
743 Search, the `unseen' attribute is restored.")
745 ;; Show in Rmail the message described by the summary line that point is on,
746 ;; but only if the Rmail buffer is already visible.
747 ;; This is a post-command-hook in summary buffers.
748 (defun rmail-summary-rmail-update ()
749 (let (buffer-read-only)
750 (save-excursion
751 ;; If at end of buffer, pretend we are on the last text line.
752 (if (eobp)
753 (forward-line -1))
754 (beginning-of-line)
755 (skip-chars-forward " ")
756 (let ((msg-num (string-to-int (buffer-substring
757 (point)
758 (progn (skip-chars-forward "0-9")
759 (point))))))
760 ;; Always leave `unseen' removed
761 ;; if we get out of isearch mode.
762 ;; Don't let a subsequent isearch restore that `unseen'.
763 (if (not isearch-mode)
764 (setq rmail-summary-put-back-unseen nil))
766 (or (eq rmail-current-message msg-num)
767 (let ((window (get-buffer-window rmail-view-buffer t))
768 (owin (selected-window)))
769 (if isearch-mode
770 (save-excursion
771 (set-buffer rmail-buffer)
772 ;; If we first saw the previous message in this search,
773 ;; and we have gone to a different message while searching,
774 ;; put back `unseen' on the former one.
775 (if rmail-summary-put-back-unseen
776 (rmail-set-attribute "unseen" t
777 rmail-current-message))
778 ;; Arrange to do that later, for the new current message,
779 ;; if it still has `unseen'.
780 (setq rmail-summary-put-back-unseen
781 (rmail-message-labels-p msg-num ", ?\\(unseen\\),")))
782 (setq rmail-summary-put-back-unseen nil))
784 ;; Go to the desired message.
785 (setq rmail-current-message msg-num)
787 ;; Update the summary to show the message has been seen.
788 (if (= (following-char) ?-)
789 (progn
790 (delete-char 1)
791 (insert " ")))
793 (if window
794 ;; Using save-window-excursion would cause the new value
795 ;; of point to get lost.
796 (unwind-protect
797 (progn
798 (select-window window)
799 (rmail-show-message msg-num t))
800 (select-window owin))
801 (if (buffer-name rmail-buffer)
802 (save-excursion
803 (set-buffer rmail-buffer)
804 (rmail-show-message msg-num t))))))
805 (rmail-summary-update-highlight nil)))))
807 (defvar rmail-summary-mode-map nil)
809 (if rmail-summary-mode-map
811 (setq rmail-summary-mode-map (make-keymap))
812 (suppress-keymap rmail-summary-mode-map)
814 (define-key rmail-summary-mode-map [mouse-2] 'rmail-summary-mouse-goto-message)
815 (define-key rmail-summary-mode-map "a" 'rmail-summary-add-label)
816 (define-key rmail-summary-mode-map "b" 'rmail-summary-bury)
817 (define-key rmail-summary-mode-map "c" 'rmail-summary-continue)
818 (define-key rmail-summary-mode-map "d" 'rmail-summary-delete-forward)
819 (define-key rmail-summary-mode-map "\C-d" 'rmail-summary-delete-backward)
820 (define-key rmail-summary-mode-map "e" 'rmail-summary-edit-current-message)
821 (define-key rmail-summary-mode-map "f" 'rmail-summary-forward)
822 (define-key rmail-summary-mode-map "g" 'rmail-summary-get-new-mail)
823 (define-key rmail-summary-mode-map "h" 'rmail-summary)
824 (define-key rmail-summary-mode-map "i" 'rmail-summary-input)
825 (define-key rmail-summary-mode-map "j" 'rmail-summary-goto-msg)
826 (define-key rmail-summary-mode-map "\C-m" 'rmail-summary-goto-msg)
827 (define-key rmail-summary-mode-map "k" 'rmail-summary-kill-label)
828 (define-key rmail-summary-mode-map "l" 'rmail-summary-by-labels)
829 (define-key rmail-summary-mode-map "\e\C-h" 'rmail-summary)
830 (define-key rmail-summary-mode-map "\e\C-l" 'rmail-summary-by-labels)
831 (define-key rmail-summary-mode-map "\e\C-r" 'rmail-summary-by-recipients)
832 (define-key rmail-summary-mode-map "\e\C-s" 'rmail-summary-by-regexp)
833 (define-key rmail-summary-mode-map "\e\C-t" 'rmail-summary-by-topic)
834 (define-key rmail-summary-mode-map "m" 'rmail-summary-mail)
835 (define-key rmail-summary-mode-map "\M-m" 'rmail-summary-retry-failure)
836 (define-key rmail-summary-mode-map "n" 'rmail-summary-next-msg)
837 (define-key rmail-summary-mode-map "\en" 'rmail-summary-next-all)
838 (define-key rmail-summary-mode-map "\e\C-n" 'rmail-summary-next-labeled-message)
839 (define-key rmail-summary-mode-map "o" 'rmail-summary-output-to-rmail-file)
840 (define-key rmail-summary-mode-map "\C-o" 'rmail-summary-output)
841 (define-key rmail-summary-mode-map "p" 'rmail-summary-previous-msg)
842 (define-key rmail-summary-mode-map "\ep" 'rmail-summary-previous-all)
843 (define-key rmail-summary-mode-map "\e\C-p" 'rmail-summary-previous-labeled-message)
844 (define-key rmail-summary-mode-map "q" 'rmail-summary-quit)
845 (define-key rmail-summary-mode-map "Q" 'rmail-summary-wipe)
846 (define-key rmail-summary-mode-map "r" 'rmail-summary-reply)
847 (define-key rmail-summary-mode-map "s" 'rmail-summary-expunge-and-save)
848 (define-key rmail-summary-mode-map "\es" 'rmail-summary-search)
849 (define-key rmail-summary-mode-map "t" 'rmail-summary-toggle-header)
850 (define-key rmail-summary-mode-map "u" 'rmail-summary-undelete)
851 (define-key rmail-summary-mode-map "\M-u" 'rmail-summary-undelete-many)
852 (define-key rmail-summary-mode-map "x" 'rmail-summary-expunge)
853 (define-key rmail-summary-mode-map "w" 'rmail-summary-output-body)
854 (define-key rmail-summary-mode-map "." 'rmail-summary-beginning-of-message)
855 (define-key rmail-summary-mode-map "<" 'rmail-summary-first-message)
856 (define-key rmail-summary-mode-map ">" 'rmail-summary-last-message)
857 (define-key rmail-summary-mode-map " " 'rmail-summary-scroll-msg-up)
858 (define-key rmail-summary-mode-map "\177" 'rmail-summary-scroll-msg-down)
859 (define-key rmail-summary-mode-map "?" 'describe-mode)
860 (define-key rmail-summary-mode-map "\C-c\C-n" 'rmail-summary-next-same-subject)
861 (define-key rmail-summary-mode-map "\C-c\C-p" 'rmail-summary-previous-same-subject)
862 (define-key rmail-summary-mode-map "\C-c\C-s\C-d"
863 'rmail-summary-sort-by-date)
864 (define-key rmail-summary-mode-map "\C-c\C-s\C-s"
865 'rmail-summary-sort-by-subject)
866 (define-key rmail-summary-mode-map "\C-c\C-s\C-a"
867 'rmail-summary-sort-by-author)
868 (define-key rmail-summary-mode-map "\C-c\C-s\C-r"
869 'rmail-summary-sort-by-recipient)
870 (define-key rmail-summary-mode-map "\C-c\C-s\C-c"
871 'rmail-summary-sort-by-correspondent)
872 (define-key rmail-summary-mode-map "\C-c\C-s\C-l"
873 'rmail-summary-sort-by-lines)
874 (define-key rmail-summary-mode-map "\C-c\C-s\C-k"
875 'rmail-summary-sort-by-keywords)
878 ;;; Menu bar bindings.
880 (define-key rmail-summary-mode-map [menu-bar] (make-sparse-keymap))
882 (define-key rmail-summary-mode-map [menu-bar classify]
883 (cons "Classify" (make-sparse-keymap "Classify")))
885 (define-key rmail-summary-mode-map [menu-bar classify output-menu]
886 '("Output (Rmail Menu)..." . rmail-summary-output-menu))
888 (define-key rmail-summary-mode-map [menu-bar classify input-menu]
889 '("Input Rmail File (menu)..." . rmail-input-menu))
891 (define-key rmail-summary-mode-map [menu-bar classify input-menu]
892 '(nil))
894 (define-key rmail-summary-mode-map [menu-bar classify output-menu]
895 '(nil))
897 (define-key rmail-summary-mode-map [menu-bar classify output-body]
898 '("Output (body)..." . rmail-summary-output-body))
900 (define-key rmail-summary-mode-map [menu-bar classify output-inbox]
901 '("Output (inbox)..." . rmail-summary-output))
903 (define-key rmail-summary-mode-map [menu-bar classify output]
904 '("Output (Rmail)..." . rmail-summary-output-to-rmail-file))
906 (define-key rmail-summary-mode-map [menu-bar classify kill-label]
907 '("Kill Label..." . rmail-summary-kill-label))
909 (define-key rmail-summary-mode-map [menu-bar classify add-label]
910 '("Add Label..." . rmail-summary-add-label))
912 (define-key rmail-summary-mode-map [menu-bar summary]
913 (cons "Summary" (make-sparse-keymap "Summary")))
915 (define-key rmail-summary-mode-map [menu-bar summary senders]
916 '("By Senders..." . rmail-summary-by-senders))
918 (define-key rmail-summary-mode-map [menu-bar summary labels]
919 '("By Labels..." . rmail-summary-by-labels))
921 (define-key rmail-summary-mode-map [menu-bar summary recipients]
922 '("By Recipients..." . rmail-summary-by-recipients))
924 (define-key rmail-summary-mode-map [menu-bar summary topic]
925 '("By Topic..." . rmail-summary-by-topic))
927 (define-key rmail-summary-mode-map [menu-bar summary regexp]
928 '("By Regexp..." . rmail-summary-by-regexp))
930 (define-key rmail-summary-mode-map [menu-bar summary all]
931 '("All" . rmail-summary))
933 (define-key rmail-summary-mode-map [menu-bar mail]
934 (cons "Mail" (make-sparse-keymap "Mail")))
936 (define-key rmail-summary-mode-map [menu-bar mail rmail-summary-get-new-mail]
937 '("Get New Mail" . rmail-summary-get-new-mail))
939 (define-key rmail-summary-mode-map [menu-bar mail lambda]
940 '("----"))
942 (define-key rmail-summary-mode-map [menu-bar mail continue]
943 '("Continue" . rmail-summary-continue))
945 (define-key rmail-summary-mode-map [menu-bar mail resend]
946 '("Re-send..." . rmail-summary-resend))
948 (define-key rmail-summary-mode-map [menu-bar mail forward]
949 '("Forward" . rmail-summary-forward))
951 (define-key rmail-summary-mode-map [menu-bar mail retry]
952 '("Retry" . rmail-summary-retry-failure))
954 (define-key rmail-summary-mode-map [menu-bar mail reply]
955 '("Reply" . rmail-summary-reply))
957 (define-key rmail-summary-mode-map [menu-bar mail mail]
958 '("Mail" . rmail-summary-mail))
960 (define-key rmail-summary-mode-map [menu-bar delete]
961 (cons "Delete" (make-sparse-keymap "Delete")))
963 (define-key rmail-summary-mode-map [menu-bar delete expunge/save]
964 '("Expunge/Save" . rmail-summary-expunge-and-save))
966 (define-key rmail-summary-mode-map [menu-bar delete expunge]
967 '("Expunge" . rmail-summary-expunge))
969 (define-key rmail-summary-mode-map [menu-bar delete undelete]
970 '("Undelete" . rmail-summary-undelete))
972 (define-key rmail-summary-mode-map [menu-bar delete delete]
973 '("Delete" . rmail-summary-delete-forward))
975 (define-key rmail-summary-mode-map [menu-bar move]
976 (cons "Move" (make-sparse-keymap "Move")))
978 (define-key rmail-summary-mode-map [menu-bar move search-back]
979 '("Search Back..." . rmail-summary-search-backward))
981 (define-key rmail-summary-mode-map [menu-bar move search]
982 '("Search..." . rmail-summary-search))
984 (define-key rmail-summary-mode-map [menu-bar move previous]
985 '("Previous Nondeleted" . rmail-summary-previous-msg))
987 (define-key rmail-summary-mode-map [menu-bar move next]
988 '("Next Nondeleted" . rmail-summary-next-msg))
990 (define-key rmail-summary-mode-map [menu-bar move last]
991 '("Last" . rmail-summary-last-message))
993 (define-key rmail-summary-mode-map [menu-bar move first]
994 '("First" . rmail-summary-first-message))
996 (define-key rmail-summary-mode-map [menu-bar move previous]
997 '("Previous" . rmail-summary-previous-all))
999 (define-key rmail-summary-mode-map [menu-bar move next]
1000 '("Next" . rmail-summary-next-all))
1002 (defvar rmail-summary-overlay nil)
1003 (put 'rmail-summary-overlay 'permanent-local t)
1005 (defun rmail-summary-mouse-goto-message (event)
1006 "Select the message whose summary line you click on."
1007 (interactive "@e")
1008 (goto-char (posn-point (event-end event)))
1009 (rmail-summary-goto-msg))
1011 (defun rmail-summary-goto-msg (&optional n nowarn skip-rmail)
1012 "Go to message N in the summary buffer and the Rmail buffer.
1013 If N is nil, use the message corresponding to point in the summary
1014 and move to that message in the Rmail buffer.
1016 If NOWARN, don't say anything if N is out of range.
1017 If SKIP-RMAIL, don't do anything to the Rmail buffer."
1018 (interactive "P")
1019 (if (consp n) (setq n (prefix-numeric-value n)))
1020 (if (eobp) (forward-line -1))
1021 (beginning-of-line)
1022 (let* ((obuf (current-buffer))
1023 (buf rmail-buffer)
1024 (cur (point))
1025 message-not-found
1026 (curmsg (string-to-int
1027 (buffer-substring (point)
1028 (min (point-max) (+ 5 (point))))))
1029 (total (save-excursion (set-buffer buf) rmail-total-messages)))
1030 ;; If message number N was specified, find that message's line
1031 ;; or set message-not-found.
1032 ;; If N wasn't specified or that message can't be found.
1033 ;; set N by default.
1034 (if (not n)
1035 (setq n curmsg)
1036 (if (< n 1)
1037 (progn (message "No preceding message")
1038 (setq n 1)))
1039 (if (> n total)
1040 (progn (message "No following message")
1041 (goto-char (point-max))
1042 (rmail-summary-goto-msg nil nowarn skip-rmail)))
1043 (goto-char (point-min))
1044 (if (not (re-search-forward (format "^%4d[^0-9]" n) nil t))
1045 (progn (or nowarn (message "Message %d not found" n))
1046 (setq n curmsg)
1047 (setq message-not-found t)
1048 (goto-char cur))))
1049 (beginning-of-line)
1050 (skip-chars-forward " ")
1051 (skip-chars-forward "0-9")
1052 (save-excursion (if (= (following-char) ?-)
1053 (let ((buffer-read-only nil))
1054 (delete-char 1)
1055 (insert " "))))
1056 (rmail-summary-update-highlight message-not-found)
1057 (beginning-of-line)
1058 (if skip-rmail
1060 (let ((selwin (selected-window)))
1061 (unwind-protect
1062 (progn (pop-to-buffer buf)
1063 (rmail-show-message n))
1064 (select-window selwin)
1065 ;; The actions above can alter the current buffer. Preserve it.
1066 (set-buffer obuf))))))
1068 ;; Update the highlighted line in an rmail summary buffer.
1069 ;; That should be current. We highlight the line point is on.
1070 ;; If NOT-FOUND is non-nil, we turn off highlighting.
1071 (defun rmail-summary-update-highlight (not-found)
1072 ;; Make sure we have an overlay to use.
1073 (or rmail-summary-overlay
1074 (progn
1075 (make-local-variable 'rmail-summary-overlay)
1076 (setq rmail-summary-overlay (make-overlay (point) (point)))))
1077 ;; If this message is in the summary, use the overlay to highlight it.
1078 ;; Otherwise, don't highlight anything.
1079 (if not-found
1080 (overlay-put rmail-summary-overlay 'face nil)
1081 (move-overlay rmail-summary-overlay
1082 (save-excursion (beginning-of-line)
1083 (skip-chars-forward " ")
1084 (point))
1085 (save-excursion (end-of-line) (point)))
1086 (overlay-put rmail-summary-overlay 'face 'highlight)))
1088 (defun rmail-summary-scroll-msg-up (&optional dist)
1089 "Scroll the Rmail window forward.
1090 If the Rmail window is displaying the end of a message,
1091 advance to the next message."
1092 (interactive "P")
1093 (if (eq dist '-)
1094 (rmail-summary-scroll-msg-down nil)
1095 (let ((rmail-buffer-window (get-buffer-window rmail-view-buffer)))
1096 (if rmail-buffer-window
1097 (if (let ((rmail-summary-window (selected-window)))
1098 (select-window rmail-buffer-window)
1099 (prog1
1100 ;; Is EOB visible in the buffer?
1101 (save-excursion
1102 (let ((ht (window-height (selected-window))))
1103 (move-to-window-line (- ht 2))
1104 (end-of-line)
1105 (eobp)))
1106 (select-window rmail-summary-window)))
1107 (if (not rmail-summary-scroll-between-messages)
1108 (error "End of buffer")
1109 (rmail-summary-next-msg (or dist 1)))
1110 (let ((other-window-scroll-buffer rmail-view-buffer))
1111 (scroll-other-window dist)))
1112 ;; If it isn't visible at all, show the beginning.
1113 (rmail-summary-beginning-of-message)))))
1115 (defun rmail-summary-scroll-msg-down (&optional dist)
1116 "Scroll the Rmail window backward.
1117 If the Rmail window is now displaying the beginning of a message,
1118 move to the previous message."
1119 (interactive "P")
1120 (if (eq dist '-)
1121 (rmail-summary-scroll-msg-up nil)
1122 (let ((rmail-buffer-window (get-buffer-window rmail-buffer)))
1123 (if rmail-buffer-window
1124 (if (let ((rmail-summary-window (selected-window)))
1125 (select-window rmail-buffer-window)
1126 (prog1
1127 ;; Is BOB visible in the buffer?
1128 (save-excursion
1129 (move-to-window-line 0)
1130 (beginning-of-line)
1131 (bobp))
1132 (select-window rmail-summary-window)))
1133 (if (not rmail-summary-scroll-between-messages)
1134 (error "Beginning of buffer")
1135 (rmail-summary-previous-msg (or dist 1)))
1136 (let ((other-window-scroll-buffer rmail-buffer))
1137 (scroll-other-window-down dist)))
1138 ;; If it isn't visible at all, show the beginning.
1139 (rmail-summary-beginning-of-message)))))
1141 (defun rmail-summary-beginning-of-message ()
1142 "Show current message from the beginning."
1143 (interactive)
1144 (if (and (one-window-p) (not pop-up-frames))
1145 ;; If there is just one window, put the summary on the top.
1146 (let ((buffer rmail-buffer))
1147 (split-window (selected-window) rmail-summary-window-size)
1148 (select-window (frame-first-window))
1149 (pop-to-buffer rmail-buffer)
1150 ;; If pop-to-buffer did not use that window, delete that
1151 ;; window. (This can happen if it uses another frame.)
1152 (or (eq buffer (window-buffer (next-window (frame-first-window))))
1153 (delete-other-windows)))
1154 (pop-to-buffer rmail-buffer))
1155 (beginning-of-buffer)
1156 (pop-to-buffer rmail-summary-buffer))
1158 (defun rmail-summary-bury ()
1159 "Bury the Rmail buffer and the Rmail summary buffer."
1160 (interactive)
1161 (let ((buffer-to-bury (current-buffer)))
1162 (let (window)
1163 (while (setq window (get-buffer-window rmail-buffer))
1164 (set-window-buffer window (other-buffer rmail-buffer)))
1165 (bury-buffer rmail-buffer))
1166 (switch-to-buffer (other-buffer buffer-to-bury))
1167 (bury-buffer buffer-to-bury)))
1169 (defun rmail-summary-quit ()
1170 "Quit out of Rmail and Rmail summary."
1171 (interactive)
1172 (rmail-summary-wipe)
1173 (rmail-quit))
1175 (defun rmail-summary-wipe ()
1176 "Kill and wipe away Rmail summary, remaining within Rmail."
1177 (interactive)
1178 (save-excursion (set-buffer rmail-buffer) (setq rmail-summary-buffer nil))
1179 (let ((local-rmail-buffer rmail-buffer))
1180 (kill-buffer (current-buffer))
1181 ;; Delete window if not only one.
1182 (if (not (eq (selected-window) (next-window nil 'no-minibuf)))
1183 (delete-window))
1184 ;; Switch windows to the rmail buffer, or switch to it in this window.
1185 (pop-to-buffer local-rmail-buffer)))
1187 (defun rmail-summary-expunge ()
1188 "Actually erase all deleted messages and recompute summary headers."
1189 (interactive)
1190 (save-excursion
1191 (set-buffer rmail-buffer)
1192 (rmail-only-expunge))
1193 (rmail-update-summary))
1195 (defun rmail-summary-expunge-and-save ()
1196 "Expunge and save RMAIL file."
1197 (interactive)
1198 (save-excursion
1199 (set-buffer rmail-buffer)
1200 (rmail-only-expunge))
1201 (rmail-update-summary)
1202 (save-excursion
1203 (set-buffer rmail-buffer)
1204 (save-buffer))
1205 (set-buffer-modified-p nil))
1207 (defun rmail-summary-get-new-mail (&optional file-name)
1208 "Get new mail and recompute summary headers.
1210 Optionally you can specify the file to get new mail from. In this case,
1211 the file of new mail is not changed or deleted. Noninteractively, you can
1212 pass the inbox file name as an argument. Interactively, a prefix
1213 argument says to read a file name and use that file as the inbox."
1214 (interactive
1215 (list (if current-prefix-arg
1216 (read-file-name "Get new mail from file: "))))
1217 (let (msg)
1218 (save-excursion
1219 (set-buffer rmail-buffer)
1220 (rmail-get-new-mail file-name)
1221 ;; Get the proper new message number.
1222 (setq msg rmail-current-message))
1223 ;; Make sure that message is displayed.
1224 (or (zerop msg)
1225 (rmail-summary-goto-msg msg))))
1227 (defun rmail-summary-input (filename)
1228 "Run Rmail on file FILENAME."
1229 (interactive "FRun rmail on RMAIL file: ")
1230 ;; We switch windows here, then display the other Rmail file there.
1231 (pop-to-buffer rmail-buffer)
1232 (rmail filename))
1234 (defun rmail-summary-first-message ()
1235 "Show first message in Rmail file from summary buffer."
1236 (interactive)
1237 (beginning-of-buffer))
1239 (defun rmail-summary-last-message ()
1240 "Show last message in Rmail file from summary buffer."
1241 (interactive)
1242 (end-of-buffer)
1243 (forward-line -1))
1245 (defvar rmail-summary-edit-map nil)
1246 (if rmail-summary-edit-map
1248 (setq rmail-summary-edit-map
1249 (nconc (make-sparse-keymap) text-mode-map))
1250 (define-key rmail-summary-edit-map "\C-c\C-c" 'rmail-cease-edit)
1251 (define-key rmail-summary-edit-map "\C-c\C-]" 'rmail-abort-edit))
1253 (defun rmail-summary-edit-current-message ()
1254 "Edit the contents of this message."
1255 (interactive)
1256 (pop-to-buffer rmail-buffer)
1257 (rmail-edit-current-message)
1258 (use-local-map rmail-summary-edit-map))
1260 (defun rmail-summary-cease-edit ()
1261 "Finish editing message, then go back to Rmail summary buffer."
1262 (interactive)
1263 (rmail-cease-edit)
1264 (pop-to-buffer rmail-summary-buffer))
1266 (defun rmail-summary-abort-edit ()
1267 "Abort edit of current message; restore original contents.
1268 Go back to summary buffer."
1269 (interactive)
1270 (rmail-abort-edit)
1271 (pop-to-buffer rmail-summary-buffer))
1273 (defun rmail-summary-search-backward (regexp &optional n)
1274 "Show message containing next match for REGEXP.
1275 Prefix argument gives repeat count; negative argument means search
1276 backwards (through earlier messages).
1277 Interactively, empty argument means use same regexp used last time."
1278 (interactive
1279 (let* ((reversep (>= (prefix-numeric-value current-prefix-arg) 0))
1280 (prompt
1281 (concat (if reversep "Reverse " "") "Rmail search (regexp): "))
1282 regexp)
1283 (if rmail-search-last-regexp
1284 (setq prompt (concat prompt
1285 "(default "
1286 rmail-search-last-regexp
1287 ") ")))
1288 (setq regexp (read-string prompt))
1289 (cond ((not (equal regexp ""))
1290 (setq rmail-search-last-regexp regexp))
1291 ((not rmail-search-last-regexp)
1292 (error "No previous Rmail search string")))
1293 (list rmail-search-last-regexp
1294 (prefix-numeric-value current-prefix-arg))))
1295 ;; Don't use save-excursion because that prevents point from moving
1296 ;; properly in the summary buffer.
1297 (let ((buffer (current-buffer)))
1298 (unwind-protect
1299 (progn
1300 (set-buffer rmail-buffer)
1301 (rmail-search regexp (- n)))
1302 (set-buffer buffer))))
1304 (defun rmail-summary-search (regexp &optional n)
1305 "Show message containing next match for REGEXP.
1306 Prefix argument gives repeat count; negative argument means search
1307 backwards (through earlier messages).
1308 Interactively, empty argument means use same regexp used last time."
1309 (interactive
1310 (let* ((reversep (< (prefix-numeric-value current-prefix-arg) 0))
1311 (prompt
1312 (concat (if reversep "Reverse " "") "Rmail search (regexp): "))
1313 regexp)
1314 (if rmail-search-last-regexp
1315 (setq prompt (concat prompt
1316 "(default "
1317 rmail-search-last-regexp
1318 ") ")))
1319 (setq regexp (read-string prompt))
1320 (cond ((not (equal regexp ""))
1321 (setq rmail-search-last-regexp regexp))
1322 ((not rmail-search-last-regexp)
1323 (error "No previous Rmail search string")))
1324 (list rmail-search-last-regexp
1325 (prefix-numeric-value current-prefix-arg))))
1326 ;; Don't use save-excursion because that prevents point from moving
1327 ;; properly in the summary buffer.
1328 (let ((buffer (current-buffer)))
1329 (unwind-protect
1330 (progn
1331 (set-buffer rmail-buffer)
1332 (rmail-search regexp n))
1333 (set-buffer buffer))))
1335 (defun rmail-summary-toggle-header ()
1336 "Show original message header if pruned header currently shown, or vice versa."
1337 (interactive)
1338 (save-excursion
1339 (set-buffer rmail-buffer)
1340 (rmail-toggle-header))
1341 ;; Inside save-excursion, some changes to point in the RMAIL buffer are lost.
1342 ;; Set point to point-min in the RMAIL buffer, if it is visible.
1343 (let ((window (get-buffer-window rmail-buffer)))
1344 (if window
1345 ;; Using save-window-excursion would lose the new value of point.
1346 (let ((owin (selected-window)))
1347 (unwind-protect
1348 (progn
1349 (select-window window)
1350 (goto-char (point-min)))
1351 (select-window owin))))))
1354 (defun rmail-summary-add-label (label)
1355 "Add LABEL to labels associated with current Rmail message.
1356 Completion is performed over known labels when reading."
1357 (interactive (list (save-excursion
1358 (set-buffer rmail-buffer)
1359 (rmail-read-label "Add label"))))
1360 (save-excursion
1361 (set-buffer rmail-buffer)
1362 (rmail-add-label label)))
1364 (defun rmail-summary-kill-label (label)
1365 "Remove LABEL from labels associated with current Rmail message.
1366 Completion is performed over known labels when reading."
1367 (interactive (list (save-excursion
1368 (set-buffer rmail-buffer)
1369 (rmail-read-label "Kill label"))))
1370 (save-excursion
1371 (set-buffer rmail-buffer)
1372 (rmail-set-label label nil)))
1374 ;;;; *** Rmail Summary Mailing Commands ***
1376 (defun rmail-summary-mail ()
1377 "Send mail in another window.
1378 While composing the message, use \\[mail-yank-original] to yank the
1379 original message into it."
1380 (interactive)
1381 (let ((window (get-buffer-window rmail-buffer)))
1382 (if window
1383 (select-window window)
1384 (set-buffer rmail-buffer)))
1385 (rmail-start-mail nil nil nil nil nil (current-buffer))
1386 (use-local-map (copy-keymap (current-local-map)))
1387 (define-key (current-local-map)
1388 "\C-c\C-c" 'rmail-summary-send-and-exit))
1390 (defun rmail-summary-continue ()
1391 "Continue composing outgoing message previously being composed."
1392 (interactive)
1393 (let ((window (get-buffer-window rmail-buffer)))
1394 (if window
1395 (select-window window)
1396 (set-buffer rmail-buffer)))
1397 (rmail-start-mail t))
1399 (defun rmail-summary-reply (just-sender)
1400 "Reply to the current message.
1401 Normally include CC: to all other recipients of original message;
1402 prefix argument means ignore them. While composing the reply,
1403 use \\[mail-yank-original] to yank the original message into it."
1404 (interactive "P")
1405 (let ((window (get-buffer-window rmail-buffer)))
1406 (if window
1407 (select-window window)
1408 (set-buffer rmail-buffer)))
1409 (rmail-reply just-sender)
1410 (use-local-map (copy-keymap (current-local-map)))
1411 (define-key (current-local-map)
1412 "\C-c\C-c" 'rmail-summary-send-and-exit))
1414 (defun rmail-summary-retry-failure ()
1415 "Edit a mail message which is based on the contents of the current message.
1416 For a message rejected by the mail system, extract the interesting headers and
1417 the body of the original message; otherwise copy the current message."
1418 (interactive)
1419 (let ((window (get-buffer-window rmail-buffer)))
1420 (if window
1421 (select-window window)
1422 (set-buffer rmail-buffer)))
1423 (rmail-retry-failure)
1424 (use-local-map (copy-keymap (current-local-map)))
1425 (define-key (current-local-map)
1426 "\C-c\C-c" 'rmail-summary-send-and-exit))
1428 (defun rmail-summary-send-and-exit ()
1429 "Send mail reply and return to summary buffer."
1430 (interactive)
1431 (mail-send-and-exit t))
1433 (defun rmail-summary-forward (resend)
1434 "Forward the current message to another user.
1435 With prefix argument, \"resend\" the message instead of forwarding it;
1436 see the documentation of `rmail-resend'."
1437 (interactive "P")
1438 (save-excursion
1439 (let ((window (get-buffer-window rmail-buffer)))
1440 (if window
1441 (select-window window)
1442 (set-buffer rmail-buffer)))
1443 (rmail-forward resend)
1444 (use-local-map (copy-keymap (current-local-map)))
1445 (define-key (current-local-map)
1446 "\C-c\C-c" 'rmail-summary-send-and-exit)))
1448 (defun rmail-summary-resend ()
1449 "Resend current message using 'rmail-resend'."
1450 (interactive)
1451 (save-excursion
1452 (let ((window (get-buffer-window rmail-buffer)))
1453 (if window
1454 (select-window window)
1455 (set-buffer rmail-buffer)))
1456 (call-interactively 'rmail-resend)))
1458 ;; Summary output commands.
1460 (defun rmail-summary-output-to-rmail-file (&optional file-name n)
1461 "Append the current message to an Rmail file named FILE-NAME.
1462 If the file does not exist, ask if it should be created.
1463 If file is being visited, the message is appended to the Emacs
1464 buffer visiting that file.
1466 A prefix argument N says to output N consecutive messages
1467 starting with the current one. Deleted messages are skipped and don't count."
1468 (interactive
1469 (progn (require 'rmailout)
1470 (list (rmail-output-read-rmail-file-name)
1471 (prefix-numeric-value current-prefix-arg))))
1472 (let ((i 0) prev-msg)
1473 (while
1474 (and (< i n)
1475 (progn (rmail-summary-goto-msg)
1476 (not (eq prev-msg
1477 (setq prev-msg
1478 (with-current-buffer rmail-buffer
1479 rmail-current-message))))))
1480 (setq i (1+ i))
1481 (with-current-buffer rmail-buffer
1482 (let ((rmail-delete-after-output nil))
1483 (rmail-output-to-rmail-file file-name 1)))
1484 (if rmail-delete-after-output
1485 (rmail-summary-delete-forward nil)
1486 (if (< i n)
1487 (rmail-summary-next-msg 1))))))
1489 (defun rmail-summary-output (&optional file-name n)
1490 "Append this message to Unix mail file named FILE-NAME.
1492 A prefix argument N says to output N consecutive messages
1493 starting with the current one. Deleted messages are skipped and don't count."
1494 (interactive
1495 (progn (require 'rmailout)
1496 (list (rmail-output-read-file-name)
1497 (prefix-numeric-value current-prefix-arg))))
1498 (let ((i 0))
1499 (while (< i n)
1500 (setq i (1+ i))
1501 (with-current-buffer rmail-buffer
1502 (let ((rmail-delete-after-output nil))
1503 (rmail-output file-name 1)))
1504 (if rmail-delete-after-output
1505 (rmail-summary-delete-forward nil)
1506 (if (< i n)
1507 (rmail-summary-next-msg 1))))))
1509 (defun rmail-summary-output-menu ()
1510 "Output current message to another Rmail file, chosen with a menu.
1511 Also set the default for subsequent \\[rmail-output-to-rmail-file] commands.
1512 The variables `rmail-secondary-file-directory' and
1513 `rmail-secondary-file-regexp' control which files are offered in the menu."
1514 (interactive)
1515 (save-excursion
1516 (set-buffer rmail-buffer)
1517 (let ((rmail-delete-after-output nil))
1518 (call-interactively 'rmail-output-menu)))
1519 (if rmail-delete-after-output
1520 (rmail-summary-delete-forward nil)))
1522 (defun rmail-summary-construct-io-menu ()
1523 (let ((files (rmail-find-all-files rmail-secondary-file-directory)))
1524 (if files
1525 (progn
1526 (define-key rmail-summary-mode-map [menu-bar classify input-menu]
1527 (cons "Input Rmail File"
1528 (rmail-list-to-menu "Input Rmail File"
1529 files
1530 'rmail-summary-input)))
1531 (define-key rmail-summary-mode-map [menu-bar classify output-menu]
1532 (cons "Output Rmail File"
1533 (rmail-list-to-menu "Output Rmail File"
1534 files
1535 'rmail-summary-output-to-rmail-file))))
1536 (define-key rmail-summary-mode-map [menu-bar classify input-menu]
1537 '("Input Rmail File" . rmail-disable-menu))
1538 (define-key rmail-summary-mode-map [menu-bar classify output-menu]
1539 '("Output Rmail File" . rmail-disable-menu)))))
1541 (defun rmail-summary-output-body (&optional file-name)
1542 "Write this message body to the file FILE-NAME.
1543 FILE-NAME defaults, interactively, from the Subject field of the message."
1544 (interactive)
1545 (save-excursion
1546 (set-buffer rmail-buffer)
1547 (let ((rmail-delete-after-output nil))
1548 (if file-name
1549 (rmail-output-body-to-file file-name)
1550 (call-interactively 'rmail-output-body-to-file))))
1551 (if rmail-delete-after-output
1552 (rmail-summary-delete-forward nil)))
1554 ;; Sorting messages in Rmail Summary buffer.
1556 (defun rmail-summary-sort-by-date (reverse)
1557 "Sort messages of current Rmail summary by date.
1558 If prefix argument REVERSE is non-nil, sort them in reverse order."
1559 (interactive "P")
1560 (rmail-sort-from-summary (function rmail-sort-by-date) reverse))
1562 (defun rmail-summary-sort-by-subject (reverse)
1563 "Sort messages of current Rmail summary by subject.
1564 If prefix argument REVERSE is non-nil, sort them in reverse order."
1565 (interactive "P")
1566 (rmail-sort-from-summary (function rmail-sort-by-subject) reverse))
1568 (defun rmail-summary-sort-by-author (reverse)
1569 "Sort messages of current Rmail summary by author.
1570 If prefix argument REVERSE is non-nil, sort them in reverse order."
1571 (interactive "P")
1572 (rmail-sort-from-summary (function rmail-sort-by-author) reverse))
1574 (defun rmail-summary-sort-by-recipient (reverse)
1575 "Sort messages of current Rmail summary by recipient.
1576 If prefix argument REVERSE is non-nil, sort them in reverse order."
1577 (interactive "P")
1578 (rmail-sort-from-summary (function rmail-sort-by-recipient) reverse))
1580 (defun rmail-summary-sort-by-correspondent (reverse)
1581 "Sort messages of current Rmail summary by other correspondent.
1582 If prefix argument REVERSE is non-nil, sort them in reverse order."
1583 (interactive "P")
1584 (rmail-sort-from-summary (function rmail-sort-by-correspondent) reverse))
1586 (defun rmail-summary-sort-by-lines (reverse)
1587 "Sort messages of current Rmail summary by lines of the message.
1588 If prefix argument REVERSE is non-nil, sort them in reverse order."
1589 (interactive "P")
1590 (rmail-sort-from-summary (function rmail-sort-by-lines) reverse))
1592 (defun rmail-summary-sort-by-keywords (reverse labels)
1593 "Sort messages of current Rmail summary by keywords.
1594 If prefix argument REVERSE is non-nil, sort them in reverse order.
1595 KEYWORDS is a comma-separated list of labels."
1596 (interactive "P\nsSort by labels: ")
1597 (rmail-sort-from-summary
1598 (function (lambda (reverse)
1599 (rmail-sort-by-keywords reverse labels)))
1600 reverse))
1602 (defun rmail-sort-from-summary (sortfun reverse)
1603 "Sort Rmail messages from Summary buffer and update it after sorting."
1604 (require 'rmailsort)
1605 (let ((selwin (selected-window)))
1606 (unwind-protect
1607 (progn (pop-to-buffer rmail-buffer)
1608 (funcall sortfun reverse))
1609 (select-window selwin))))
1611 ;;; rmailsum.el ends here