]> code.delx.au - gnu-emacs/blob - lisp/mh-e/mh-folder.el
01f304a38dca4468f37885a0af902315c5ee535f
[gnu-emacs] / lisp / mh-e / mh-folder.el
1 ;;; mh-folder.el --- MH-Folder mode
2
3 ;; Copyright (C) 2002-2003, 2005-2013 Free Software Foundation, Inc.
4
5 ;; Author: Bill Wohler <wohler@newt.com>
6 ;; Maintainer: Bill Wohler <wohler@newt.com>
7 ;; Keywords: mail
8 ;; See: mh-e.el
9
10 ;; This file is part of GNU Emacs.
11
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
16
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
21
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24
25 ;;; Commentary:
26
27 ;; Mode for browsing folders
28
29 ;;; Change Log:
30
31 ;;; Code:
32
33 (require 'mh-e)
34 (require 'mh-scan)
35 (mh-require-cl)
36
37 ;; Dynamically-created functions not found in mh-loaddefs.el.
38 (autoload 'mh-tool-bar-folder-buttons-init "mh-tool-bar")
39 (autoload 'mh-tool-bar-init "mh-tool-bar")
40
41 (require 'gnus-util)
42 (autoload 'message-fetch-field "message")
43
44 \f
45
46 ;;; MH-E Entry Points
47
48 ;;;###autoload
49 (defun mh-rmail (&optional arg)
50 "Incorporate new mail with MH.
51 Scan an MH folder if ARG is non-nil.
52
53 This function is an entry point to MH-E, the Emacs interface to
54 the MH mail system."
55 (interactive "P")
56 (mh-find-path)
57 (if arg
58 (call-interactively 'mh-visit-folder)
59 (unless (get-buffer mh-inbox)
60 (mh-visit-folder mh-inbox (symbol-name mh-unseen-seq)))
61 (mh-inc-folder)))
62
63 ;;;###autoload
64 (defun mh-nmail (&optional arg)
65 "Check for new mail in inbox folder.
66 Scan an MH folder if ARG is non-nil.
67
68 This function is an entry point to MH-E, the Emacs interface to
69 the MH mail system."
70 (interactive "P")
71 (mh-find-path) ; init mh-inbox
72 (if arg
73 (call-interactively 'mh-visit-folder)
74 (mh-visit-folder mh-inbox)))
75 \f
76
77 ;;; Desktop Integration
78
79 ;; desktop-buffer-mode-handlers appeared in Emacs 22.
80 (if (boundp 'desktop-buffer-mode-handlers)
81 (add-to-list 'desktop-buffer-mode-handlers
82 '(mh-folder-mode . mh-restore-desktop-buffer)))
83
84 (defun mh-restore-desktop-buffer (desktop-buffer-file-name
85 desktop-buffer-name
86 desktop-buffer-misc)
87 "Restore an MH folder buffer specified in a desktop file.
88 When desktop creates a buffer, DESKTOP-BUFFER-FILE-NAME holds the
89 file name to visit, DESKTOP-BUFFER-NAME holds the desired buffer
90 name, and DESKTOP-BUFFER-MISC holds a list of miscellaneous info
91 used by the `desktop-buffer-handlers' functions."
92 (mh-find-path)
93 (mh-visit-folder desktop-buffer-name)
94 (current-buffer))
95
96 \f
97
98 ;;; Variables
99
100 (defvar mh-folder-filename nil
101 "Full path of directory for this folder.")
102
103 (defvar mh-partial-folder-mode-line-annotation "select"
104 "Annotation when displaying part of a folder.
105 The string is displayed after the folder's name. nil for no
106 annotation.")
107
108 (defvar mh-last-destination nil
109 "Destination of last refile or write command.")
110
111 (defvar mh-last-destination-folder nil
112 "Destination of last refile command.")
113
114 (defvar mh-last-destination-write nil
115 "Destination of last write command.")
116
117 (defvar mh-first-msg-num nil
118 "Number of first message in buffer.")
119
120 (defvar mh-last-msg-num nil
121 "Number of last msg in buffer.")
122
123 (defvar mh-msg-count nil
124 "Number of msgs in buffer.")
125
126 \f
127
128 ;;; Sequence Menu
129
130 (easy-menu-define
131 mh-folder-sequence-menu mh-folder-mode-map "Menu for MH-E folder-sequence."
132 '("Sequence"
133 ["Add Message to Sequence..." mh-put-msg-in-seq (mh-get-msg-num nil)]
134 ["List Sequences for Message" mh-msg-is-in-seq (mh-get-msg-num nil)]
135 ["Delete Message from Sequence..." mh-delete-msg-from-seq
136 (mh-get-msg-num nil)]
137 ["List Sequences in Folder..." mh-list-sequences t]
138 ["Delete Sequence..." mh-delete-seq t]
139 ["Narrow to Sequence..." mh-narrow-to-seq t]
140 ["Widen from Sequence" mh-widen mh-folder-view-stack]
141 "--"
142 ["Narrow to Subject Sequence" mh-narrow-to-subject t]
143 ["Narrow to Tick Sequence" mh-narrow-to-tick
144 (and mh-tick-seq (mh-seq-msgs (mh-find-seq mh-tick-seq)))]
145 ["Delete Rest of Same Subject" mh-delete-subject t]
146 ["Toggle Tick Mark" mh-toggle-tick t]
147 "--"
148 ["Push State Out to MH" mh-update-sequences t]))
149
150 ;;; Message Menu
151
152 (easy-menu-define
153 mh-folder-message-menu mh-folder-mode-map "Menu for MH-E folder-message."
154 '("Message"
155 ["Show Message" mh-show (mh-get-msg-num nil)]
156 ["Show Message with Header" mh-header-display (mh-get-msg-num nil)]
157 ["Show Message with Preferred Alternative"
158 mh-show-preferred-alternative (mh-get-msg-num nil)]
159 ["Next Message" mh-next-undeleted-msg t]
160 ["Previous Message" mh-previous-undeleted-msg t]
161 ["Go to First Message" mh-first-msg t]
162 ["Go to Last Message" mh-last-msg t]
163 ["Go to Message by Number..." mh-goto-msg t]
164 ["Modify Message" mh-modify t]
165 ["Refile Message" mh-refile-msg (mh-get-msg-num nil)]
166 ["Delete Message" mh-delete-msg (mh-get-msg-num nil)]
167 ["Undo Delete/Refile/Junk" mh-undo (mh-outstanding-commands-p)]
168 ["Execute Delete/Refile" mh-execute-commands
169 (mh-outstanding-commands-p)]
170 "--"
171 ["Compose a New Message" mh-send t]
172 ["Reply to Message..." mh-reply (mh-get-msg-num nil)]
173 ["Forward Message..." mh-forward (mh-get-msg-num nil)]
174 ["Redistribute Message..." mh-redistribute (mh-get-msg-num nil)]
175 ["Edit Message Again" mh-edit-again (mh-get-msg-num nil)]
176 ["Re-edit a Bounced Message" mh-extract-rejected-mail t]
177 "--"
178 ["Copy Message to Folder..." mh-copy-msg (mh-get-msg-num nil)]
179 ["Print Message" mh-print-msg (mh-get-msg-num nil)]
180 ["Write Message to File..." mh-write-msg-to-file
181 (mh-get-msg-num nil)]
182 ["Pipe Message to Command..." mh-pipe-msg (mh-get-msg-num nil)]
183 ["Unpack Uuencoded Message..." mh-store-msg (mh-get-msg-num nil)]
184 ["Burst Digest Message" mh-burst-digest (mh-get-msg-num nil)]))
185
186 ;;; Folder Menu
187
188 (easy-menu-define
189 mh-folder-folder-menu mh-folder-mode-map "Menu for MH-E folder."
190 '("Folder"
191 ["Incorporate New Mail" mh-inc-folder t]
192 ["Toggle Show/Folder" mh-toggle-showing t]
193 ["Execute Delete/Refile" mh-execute-commands
194 (mh-outstanding-commands-p)]
195 ["Rescan Folder" mh-rescan-folder t]
196 ["Thread Folder" mh-toggle-threads
197 (not (memq 'unthread mh-view-ops))]
198 ["Pack Folder" mh-pack-folder t]
199 ["Sort Folder" mh-sort-folder t]
200 "--"
201 ["List Folders" mh-list-folders t]
202 ["Visit a Folder..." mh-visit-folder t]
203 ["View New Messages" mh-index-new-messages t]
204 ["Search..." mh-search t]
205 "--"
206 ["Quit MH-E" mh-quit t]))
207
208 \f
209
210 ;;; MH-Folder Keys
211
212 (suppress-keymap mh-folder-mode-map)
213
214 ;; Use defalias to make sure the documented primary key bindings
215 ;; appear in menu lists.
216 (defalias 'mh-alt-show 'mh-show)
217 (defalias 'mh-alt-refile-msg 'mh-refile-msg)
218 (defalias 'mh-alt-send 'mh-send)
219 (defalias 'mh-alt-visit-folder 'mh-visit-folder)
220
221 ;; Save the "b" binding for a future `back'. Maybe?
222 (gnus-define-keys mh-folder-mode-map
223 " " mh-page-msg
224 "!" mh-refile-or-write-again
225 "'" mh-toggle-tick
226 "," mh-header-display
227 "." mh-alt-show
228 ":" mh-show-preferred-alternative
229 ";" mh-toggle-mh-decode-mime-flag
230 ">" mh-write-msg-to-file
231 "?" mh-help
232 "E" mh-extract-rejected-mail
233 "M" mh-modify
234 "\177" mh-previous-page
235 "\C-d" mh-delete-msg-no-motion
236 "\t" mh-index-next-folder
237 [backtab] mh-index-previous-folder
238 "\M-\t" mh-index-previous-folder
239 "\e<" mh-first-msg
240 "\e>" mh-last-msg
241 "\ed" mh-redistribute
242 "\r" mh-show
243 "^" mh-alt-refile-msg
244 "c" mh-copy-msg
245 "d" mh-delete-msg
246 "e" mh-edit-again
247 "f" mh-forward
248 "g" mh-goto-msg
249 "i" mh-inc-folder
250 "k" mh-delete-subject-or-thread
251 "m" mh-alt-send
252 "n" mh-next-undeleted-msg
253 "\M-n" mh-next-unread-msg
254 "o" mh-refile-msg
255 "p" mh-previous-undeleted-msg
256 "\M-p" mh-previous-unread-msg
257 "q" mh-quit
258 "r" mh-reply
259 "s" mh-send
260 "t" mh-toggle-showing
261 "u" mh-undo
262 "v" mh-index-visit-folder
263 "x" mh-execute-commands
264 "|" mh-pipe-msg)
265
266 (gnus-define-keys (mh-folder-map "F" mh-folder-mode-map)
267 "?" mh-prefix-help
268 "'" mh-index-ticked-messages
269 "S" mh-sort-folder
270 "c" mh-catchup
271 "f" mh-alt-visit-folder
272 "k" mh-kill-folder
273 "l" mh-list-folders
274 "n" mh-index-new-messages
275 "o" mh-alt-visit-folder
276 "p" mh-pack-folder
277 "q" mh-index-sequenced-messages
278 "r" mh-rescan-folder
279 "s" mh-search
280 "u" mh-undo-folder
281 "v" mh-visit-folder)
282
283 (define-key mh-folder-mode-map "I" mh-inc-spool-map)
284
285 (gnus-define-keys (mh-junk-map "J" mh-folder-mode-map)
286 "?" mh-prefix-help
287 "b" mh-junk-blacklist
288 "w" mh-junk-whitelist)
289
290 (gnus-define-keys (mh-ps-print-map "P" mh-folder-mode-map)
291 "?" mh-prefix-help
292 "C" mh-ps-print-toggle-color
293 "F" mh-ps-print-toggle-faces
294 "f" mh-ps-print-msg-file
295 "l" mh-print-msg
296 "p" mh-ps-print-msg)
297
298 (gnus-define-keys (mh-sequence-map "S" mh-folder-mode-map)
299 "'" mh-narrow-to-tick
300 "?" mh-prefix-help
301 "d" mh-delete-msg-from-seq
302 "k" mh-delete-seq
303 "l" mh-list-sequences
304 "n" mh-narrow-to-seq
305 "p" mh-put-msg-in-seq
306 "s" mh-msg-is-in-seq
307 "w" mh-widen)
308
309 (gnus-define-keys (mh-thread-map "T" mh-folder-mode-map)
310 "?" mh-prefix-help
311 "u" mh-thread-ancestor
312 "p" mh-thread-previous-sibling
313 "n" mh-thread-next-sibling
314 "t" mh-toggle-threads
315 "d" mh-thread-delete
316 "o" mh-thread-refile)
317
318 (gnus-define-keys (mh-limit-map "/" mh-folder-mode-map)
319 "'" mh-narrow-to-tick
320 "?" mh-prefix-help
321 "c" mh-narrow-to-cc
322 "g" mh-narrow-to-range
323 "m" mh-narrow-to-from
324 "s" mh-narrow-to-subject
325 "t" mh-narrow-to-to
326 "w" mh-widen)
327
328 (gnus-define-keys (mh-extract-map "X" mh-folder-mode-map)
329 "?" mh-prefix-help
330 "s" mh-store-msg ;shar
331 "u" mh-store-msg) ;uuencode
332
333 (gnus-define-keys (mh-digest-map "D" mh-folder-mode-map)
334 " " mh-page-digest
335 "?" mh-prefix-help
336 "\177" mh-page-digest-backwards
337 "b" mh-burst-digest)
338
339 (gnus-define-keys (mh-mime-map "K" mh-folder-mode-map)
340 "?" mh-prefix-help
341 "a" mh-mime-save-parts
342 "e" mh-display-with-external-viewer
343 "i" mh-folder-inline-mime-part
344 "o" mh-folder-save-mime-part
345 "t" mh-toggle-mime-buttons
346 "v" mh-folder-toggle-mime-part
347 "\t" mh-next-button
348 [backtab] mh-prev-button
349 "\M-\t" mh-prev-button)
350
351 (cond
352 ((featurep 'xemacs)
353 (define-key mh-folder-mode-map [button2] 'mh-show-mouse))
354 (t
355 (define-key mh-folder-mode-map [mouse-2] 'mh-show-mouse)))
356
357 ;; "C-c /" prefix is used in mh-folder-mode by pgp.el and mailcrypt
358
359 \f
360
361 ;;; MH-Folder Help Messages
362
363 ;; If you add a new prefix, add appropriate text to the nil key.
364
365 ;; In general, messages are grouped logically. Taking the main commands for
366 ;; example, the first line is "ways to view messages," the second line is
367 ;; "things you can do with messages", and the third is "composing" messages.
368
369 ;; When adding a new prefix, ensure that the help message contains "what" the
370 ;; prefix is for. For example, if the word "folder" were not present in the
371 ;; "F" entry, it would not be clear what these commands operated upon.
372 (defvar mh-folder-mode-help-messages
373 '((nil "[i]nc, [.]show, [,]show all, [n]ext, [p]revious,\n"
374 "[d]elete, [o]refile, e[x]ecute,\n"
375 "[s]end, [r]eply,\n"
376 "[;]toggle MIME decoding.\n"
377 "Prefix characters:\n [F]older, [S]equence, [J]unk, MIME [K]eys,"
378 "\n [T]hread, [/]limit, e[X]tract, [D]igest, [I]nc spools.")
379
380 (?F "[l]ist; [v]isit folder;\n"
381 "[n]ew messages; [']ticked messages; [s]earch;\n"
382 "[p]ack; [S]ort; [r]escan; [k]ill")
383 (?P "[p]rint message to [f]ile; old-style [l]pr printing;\n"
384 "Toggle printing of [C]olors, [F]aces")
385 (?S "[p]ut message in sequence, [n]arrow, [']narrow to ticked, [w]iden,\n"
386 "[s]equences, [l]ist,\n"
387 "[d]elete message from sequence, [k]ill sequence")
388 (?T "[t]oggle, [d]elete, [o]refile thread")
389 (?/ "Limit to [c]c, ran[g]e, fro[m], [s]ubject, [t]o; [w]iden")
390 (?X "un[s]har, [u]udecode message")
391 (?D "[b]urst digest")
392 (?K "[v]iew, [i]nline, with [e]xternal viewer; \n"
393 "[o]utput/save MIME part; save [a]ll parts; \n"
394 "[t]oggle buttons; [TAB] next; [SHIFT-TAB] previous")
395 (?J "[b]lacklist, [w]hitelist message"))
396 "Key binding cheat sheet.
397 See `mh-set-help'.")
398
399 \f
400
401 ;;; MH-Folder Font Lock
402
403 (defvar mh-folder-font-lock-keywords
404 (list
405 ;; Folders when displaying index buffer
406 (list "^\\+.*"
407 '(0 'mh-search-folder))
408 ;; Marked for refile
409 (list (concat mh-scan-refiled-msg-regexp ".*")
410 '(0 'mh-folder-refiled))
411 ;; Marked for deletion
412 (list (concat mh-scan-deleted-msg-regexp ".*")
413 '(0 'mh-folder-deleted))
414 ;; Marked for blacklisting
415 (list (concat mh-scan-blacklisted-msg-regexp ".*")
416 '(0 'mh-folder-blacklisted))
417 ;; Marked for whitelisting
418 (list (concat mh-scan-whitelisted-msg-regexp ".*")
419 '(0 'mh-folder-whitelisted))
420 ;; After subject
421 (list mh-scan-body-regexp
422 '(1 'mh-folder-body nil t))
423 ;; Subject
424 '(mh-folder-font-lock-subject
425 (1 'mh-folder-followup append t)
426 (2 'mh-folder-subject append t))
427 ;; Current message number
428 (list mh-scan-cur-msg-number-regexp
429 '(1 'mh-folder-cur-msg-number))
430 ;; Message number
431 (list mh-scan-good-msg-regexp
432 '(1 'mh-folder-msg-number))
433 ;; Date
434 (list mh-scan-date-regexp
435 '(1 'mh-folder-date))
436 ;; Messages from me (To:)
437 (list mh-scan-rcpt-regexp
438 '(1 'mh-folder-to)
439 '(2 'mh-folder-address))
440 ;; Messages to me
441 (list mh-scan-sent-to-me-sender-regexp
442 '(1 'mh-folder-sent-to-me-hint)
443 '(2 'mh-folder-sent-to-me-sender)))
444 "Keywords (regular expressions) used to fontify the MH-Folder buffer.")
445
446 (defun mh-folder-font-lock-subject (limit)
447 "Return MH-E scan subject strings to font-lock between point and LIMIT."
448 (if (not (re-search-forward mh-scan-subject-regexp limit t))
449 nil
450 (if (match-beginning 1)
451 (set-match-data (list (match-beginning 1) (match-end 3)
452 (match-beginning 1) (match-end 3) nil nil))
453 (set-match-data (list (match-beginning 3) (match-end 3)
454 nil nil (match-beginning 3) (match-end 3))))
455 t))
456
457 ;; Fontify unseen messages in bold.
458
459 (defmacro mh-generate-sequence-font-lock (seq prefix face)
460 "Generate the appropriate code to fontify messages in SEQ.
461 PREFIX is used to generate unique names for the variables and
462 functions defined by the macro. So a different prefix should be
463 provided for every invocation.
464 FACE is the font-lock face used to display the matching scan lines."
465 (let ((cache (intern (format "mh-folder-%s-seq-cache" prefix)))
466 (func (intern (format "mh-folder-font-lock-%s" prefix))))
467 `(progn
468 (defvar ,cache nil
469 "Internal cache variable used for font-lock in MH-E.
470 Should only be non-nil through font-lock stepping, and nil once
471 font-lock is done highlighting.")
472 (make-variable-buffer-local ',cache)
473
474 (defun ,func (limit)
475 "Return unseen message lines to font-lock between point and LIMIT."
476 (if (not ,cache) (setq ,cache (mh-seq-msgs (mh-find-seq ,seq))))
477 (let ((cur-msg (mh-get-msg-num nil)))
478 (cond ((not ,cache)
479 nil)
480 ((>= (point) limit) ;Presumably at end of buffer
481 (setq ,cache nil)
482 nil)
483 ((member cur-msg ,cache)
484 (let ((bpoint (progn (beginning-of-line)(point)))
485 (epoint (progn (forward-line 1)(point))))
486 (if (<= limit (point)) (setq ,cache nil))
487 (set-match-data (list bpoint epoint bpoint epoint))
488 t))
489 (t
490 ;; move forward one line at a time, checking each message
491 (while (and (= 0 (forward-line 1))
492 (> limit (point))
493 (not (member (mh-get-msg-num nil) ,cache))))
494 ;; Examine how we must have exited the loop...
495 (let ((cur-msg (mh-get-msg-num nil)))
496 (cond ((or (<= limit (point))
497 (not (member cur-msg ,cache)))
498 (setq ,cache nil)
499 nil)
500 ((member cur-msg ,cache)
501 (let ((bpoint (progn (beginning-of-line) (point)))
502 (epoint (progn (forward-line 1) (point))))
503 (if (<= limit (point)) (setq ,cache nil))
504 (set-match-data
505 (list bpoint epoint bpoint epoint))
506 t))))))))
507
508 (setq mh-folder-font-lock-keywords
509 (append mh-folder-font-lock-keywords
510 (list (list ',func (list 1 '',face 'prepend t))))))))
511
512 (mh-generate-sequence-font-lock mh-unseen-seq unseen bold)
513 (mh-generate-sequence-font-lock mh-tick-seq tick mh-folder-tick)
514
515 \f
516
517 ;;; MH-Folder Mode
518
519 (defmacro mh-remove-xemacs-horizontal-scrollbar ()
520 "Get rid of the horizontal scrollbar that XEmacs insists on putting in."
521 (when (featurep 'xemacs)
522 `(if (and (featurep 'scrollbar)
523 (fboundp 'set-specifier))
524 (set-specifier horizontal-scrollbar-visible-p nil
525 (cons (current-buffer) nil)))))
526
527 ;; Register mh-folder-mode as supporting which-function-mode...
528 (mh-require 'which-func nil t)
529 (when (and (boundp 'which-func-modes) (listp which-func-modes))
530 (add-to-list 'which-func-modes 'mh-folder-mode))
531
532 ;; Shush compiler.
533 (defvar desktop-save-buffer)
534 (defvar font-lock-auto-fontify)
535 (mh-do-in-xemacs
536 (defvar font-lock-defaults))
537
538 ;; Ensure new buffers won't get this mode if default major-mode is nil.
539 (put 'mh-folder-mode 'mode-class 'special)
540
541 ;; Autoload cookie needed by desktop.el
542 ;;;###autoload
543 (define-derived-mode mh-folder-mode fundamental-mode "MH-Folder"
544 "Major MH-E mode for \"editing\" an MH folder scan listing.\\<mh-folder-mode-map>
545
546 You can show the message the cursor is pointing to, and step through
547 the messages. Messages can be marked for deletion or refiling into
548 another folder; these commands are executed all at once with a
549 separate command.
550
551 Options that control this mode can be changed with
552 \\[customize-group]; specify the \"mh\" group. In particular, please
553 see the `mh-scan-format-file' option if you wish to modify scan's
554 format.
555
556 When a folder is visited, the hook `mh-folder-mode-hook' is run.
557
558 Ranges
559 ======
560 Many commands that operate on individual messages, such as
561 `mh-forward' or `mh-refile-msg' take a RANGE argument. This argument
562 can be used in several ways.
563
564 If you provide the prefix argument (\\[universal-argument]) to
565 these commands, then you will be prompted for the message range.
566 This can be any valid MH range which can include messages,
567 sequences, and the abbreviations (described in the mh(1) man
568 page):
569
570 <num1>-<num2>
571 Indicates all messages in the range <num1> to <num2>, inclusive.
572 The range must be nonempty.
573
574 <num>:N
575 <num>:+N
576 <num>:-N
577 Up to N messages beginning with (or ending with) message num. Num
578 may be any of the predefined symbols: first, prev, cur, next or
579 last.
580
581 first:N
582 prev:N
583 next:N
584 last:N
585 The first, previous, next or last messages, if they exist.
586
587 all
588 All of the messages.
589
590 For example, a range that shows all of these things is `1 2 3
591 5-10 last:5 unseen'.
592
593 If the option `transient-mark-mode' is set to t and you set a
594 region in the MH-Folder buffer, then the MH-E command will
595 perform the operation on all messages in that region.
596
597 \\{mh-folder-mode-map}"
598 (mh-do-in-gnu-emacs
599 (unless mh-folder-tool-bar-map
600 (mh-tool-bar-folder-buttons-init))
601 (if (boundp 'tool-bar-map)
602 (set (make-local-variable 'tool-bar-map) mh-folder-tool-bar-map)))
603 (mh-do-in-xemacs
604 (mh-tool-bar-init :folder))
605 (make-local-variable 'font-lock-defaults)
606 (setq font-lock-defaults '(mh-folder-font-lock-keywords t))
607 (make-local-variable 'desktop-save-buffer)
608 (setq desktop-save-buffer t)
609 (mh-make-local-vars
610 'mh-colors-available-flag (mh-colors-available-p)
611 ; Do we have colors available
612 'mh-current-folder (buffer-name) ; Name of folder, a string
613 'mh-show-buffer (format "show-%s" (buffer-name)) ; Buffer that displays msgs
614 'mh-folder-filename ; e.g. "/usr/foobar/Mail/inbox/"
615 (file-name-as-directory (mh-expand-file-name (buffer-name)))
616 'mh-display-buttons-for-inline-parts-flag
617 mh-display-buttons-for-inline-parts-flag ; Allow for display of buttons to
618 ; be toggled.
619 'mh-arrow-marker (make-marker) ; Marker where arrow is displayed
620 'overlay-arrow-position nil ; Allow for simultaneous display in
621 'overlay-arrow-string ">" ; different MH-E buffers.
622 'mh-showing-mode nil ; Show message also?
623 'mh-refile-list nil ; List of folder names in mh-seq-list
624 'mh-delete-list nil ; List of msgs nums to delete
625 'mh-blacklist nil ; List of messages to process as spam
626 'mh-whitelist nil ; List of messages to process as ham
627 'mh-seq-list nil ; Alist of (seq . msgs) nums
628 'mh-seen-list nil ; List of displayed messages
629 'mh-next-direction 'forward ; Direction to move to next message
630 'mh-view-ops () ; Stack that keeps track of the order
631 ; in which narrowing/threading has been
632 ; carried out.
633 'mh-folder-view-stack () ; Stack of previous views of the
634 ; folder.
635 'mh-index-data nil ; If the folder was created by a call
636 ; to mh-search, this contains info
637 ; about the search results.
638 'mh-index-previous-search nil ; folder, indexer, search-regexp
639 'mh-index-msg-checksum-map nil ; msg -> checksum map
640 'mh-index-checksum-origin-map nil ; checksum -> ( orig-folder, orig-msg )
641 'mh-index-sequence-search-flag nil ; folder resulted from sequence search
642 'mh-first-msg-num nil ; Number of first msg in buffer
643 'mh-last-msg-num nil ; Number of last msg in buffer
644 'mh-msg-count nil ; Number of msgs in buffer
645 'mh-mode-line-annotation nil ; Indicates message range
646 'mh-sequence-notation-history (make-hash-table)
647 ; Remember what is overwritten by
648 ; mh-note-seq.
649 'imenu-create-index-function 'mh-index-create-imenu-index
650 ; Setup imenu support
651 'mh-previous-window-config nil) ; Previous window configuration
652 (mh-remove-xemacs-horizontal-scrollbar)
653 (setq truncate-lines t)
654 (auto-save-mode -1)
655 (setq buffer-offer-save t)
656 (mh-make-local-hook (mh-write-file-functions))
657 (add-hook (mh-write-file-functions) 'mh-execute-commands nil t)
658 (make-local-variable 'revert-buffer-function)
659 (make-local-variable 'hl-line-mode) ; avoid pollution
660 (mh-funcall-if-exists hl-line-mode 1)
661 (setq revert-buffer-function 'mh-undo-folder)
662 (add-to-list 'minor-mode-alist '(mh-showing-mode " Show"))
663 (easy-menu-add mh-folder-sequence-menu)
664 (easy-menu-add mh-folder-message-menu)
665 (easy-menu-add mh-folder-folder-menu)
666 (mh-inc-spool-make)
667 (mh-set-help mh-folder-mode-help-messages)
668 (if (and (featurep 'xemacs)
669 font-lock-auto-fontify)
670 (turn-on-font-lock))) ; Force font-lock in XEmacs.
671
672 \f
673
674 ;;; MH-Folder Commands
675
676 ;; Alphabetical.
677 ;; See also mh-comp.el, mh-junk.el, mh-mime.el, mh-print.el,
678 ;; mh-search.el, and mh-seq.el.
679
680 ;;;###mh-autoload
681 (defun mh-delete-msg (range)
682 "Delete RANGE\\<mh-folder-mode-map>.
683
684 To mark a message for deletion, use this command. A \"D\" is
685 placed by the message in the scan window, and the next undeleted
686 message is displayed. If the previous command had been
687 \\[mh-previous-undeleted-msg], then the next message displayed is
688 the first undeleted message previous to the message just deleted.
689 Use \\[mh-next-undeleted-msg] to force subsequent
690 \\[mh-delete-msg] commands to move forward to the next undeleted
691 message after deleting the message under the cursor.
692
693 The hook `mh-delete-msg-hook' is called after you mark a message
694 for deletion. For example, a past maintainer of MH-E used this
695 once when he kept statistics on his mail usage.
696
697 Check the documentation of `mh-interactive-range' to see how
698 RANGE is read in interactive use."
699 (interactive (list (mh-interactive-range "Delete")))
700 (mh-delete-msg-no-motion range)
701 (if (looking-at mh-scan-deleted-msg-regexp)
702 (mh-next-msg)))
703
704 ;;;###mh-autoload
705 (defun mh-delete-msg-no-motion (range)
706 "Delete RANGE, don't move to next message.
707
708 This command marks the RANGE for deletion but leaves the cursor
709 at the current message in case you wish to perform other
710 operations on the message.
711
712 Check the documentation of `mh-interactive-range' to see how
713 RANGE is read in interactive use."
714 (interactive (list (mh-interactive-range "Delete")))
715 (mh-iterate-on-range () range
716 (mh-delete-a-msg nil)))
717
718 ;;;###mh-autoload
719 (defun mh-execute-commands ()
720 "Perform outstanding operations\\<mh-folder-mode-map>.
721
722 If you've marked messages to be refiled, deleted, blacklisted, or
723 whitelisted and you want to go ahead and perform these operations
724 on these messages, use this command. Many MH-E commands that may
725 affect the numbering of the messages (such as
726 \\[mh-rescan-folder] or \\[mh-pack-folder]) will ask if you want
727 to perform these operations first and then either run this
728 command for you or undo the pending operations.
729
730 This function runs `mh-before-commands-processed-hook' before the
731 commands are processed and `mh-after-commands-processed-hook'
732 after the commands are processed."
733 (interactive)
734 (if mh-folder-view-stack (mh-widen t))
735 (mh-process-commands mh-current-folder)
736 (mh-set-scan-mode)
737 (mh-goto-cur-msg) ; after mh-set-scan-mode for efficiency
738 (mh-make-folder-mode-line)
739 t) ; return t for write-file-functions
740
741 ;;;###mh-autoload
742 (defun mh-first-msg ()
743 "Display first message."
744 (interactive)
745 (goto-char (point-min))
746 (while (and (not (eobp)) (not (looking-at mh-scan-valid-regexp)))
747 (forward-line 1)))
748
749 ;;;###mh-autoload
750 (defun mh-goto-msg (number &optional no-error-if-no-message dont-show)
751 "Go to a message\\<mh-folder-mode-map>.
752
753 You can enter the message NUMBER either before or after typing
754 \\[mh-goto-msg]. In the latter case, Emacs prompts you.
755
756 In a program, optional non-nil second argument NO-ERROR-IF-NO-MESSAGE
757 means return nil instead of signaling an error if message does not
758 exist\; in this case, the cursor is positioned near where the message
759 would have been. Non-nil third argument DONT-SHOW means not to show
760 the message."
761 (interactive "NGo to message: ")
762 (setq number (prefix-numeric-value number))
763 (let ((point (point))
764 (return-value t))
765 (goto-char (point-min))
766 (unless (re-search-forward (format (mh-scan-msg-search-regexp) number)
767 nil t)
768 (goto-char point)
769 (unless no-error-if-no-message
770 (error "No message %d" number))
771 (setq return-value nil))
772 (beginning-of-line)
773 (or dont-show (not return-value) (mh-maybe-show number))
774 return-value))
775
776 ;;;###mh-autoload
777 (defun mh-inc-folder (&optional file folder)
778 "Incorporate new mail into a folder.
779
780 You can incorporate mail from any file into the current folder by
781 specifying a prefix argument; you'll be prompted for the name of
782 the FILE to use as well as the destination FOLDER
783
784 The hook `mh-inc-folder-hook' is run after incorporating new
785 mail.
786
787 Do not call this function from outside MH-E; use \\[mh-rmail]
788 instead."
789 (interactive (list (if current-prefix-arg
790 (expand-file-name
791 (read-file-name "inc mail from file: "
792 mh-user-path)))
793 (if current-prefix-arg
794 (mh-prompt-for-folder "inc mail into" mh-inbox t))))
795 (if (not folder)
796 (setq folder mh-inbox))
797 (let ((threading-needed-flag nil))
798 (let ((config (current-window-configuration)))
799 (when (and mh-show-buffer (get-buffer mh-show-buffer))
800 (delete-windows-on mh-show-buffer))
801 (cond ((not (get-buffer folder))
802 (mh-make-folder folder)
803 (setq threading-needed-flag mh-show-threads-flag)
804 (setq mh-previous-window-config config))
805 ((not (eq (current-buffer) (get-buffer folder)))
806 (switch-to-buffer folder)
807 (setq mh-previous-window-config config))))
808 (mh-get-new-mail file)
809 (when (and threading-needed-flag
810 (save-excursion
811 (goto-char (point-min))
812 (or (null mh-large-folder)
813 (not (equal (forward-line (1+ mh-large-folder)) 0))
814 (and (message "Not threading since the number of messages exceeds `mh-large-folder'")
815 nil))))
816 (mh-toggle-threads))
817 (beginning-of-line)
818 (when (mh-outstanding-commands-p)
819 (mh-notate-deleted-and-refiled))
820 (if (and mh-showing-mode (looking-at mh-scan-valid-regexp)) (mh-show))
821 (run-hooks 'mh-inc-folder-hook)))
822
823 ;;;###mh-autoload
824 (defun mh-last-msg ()
825 "Display last message."
826 (interactive)
827 (goto-char (point-max))
828 (while (and (not (bobp)) (not (looking-at mh-scan-valid-regexp)))
829 (forward-line -1))
830 (mh-recenter nil))
831
832 ;;;###mh-autoload
833 (defun mh-modify (&optional message)
834 "Edit message.
835
836 There are times when you need to edit a message. For example, you
837 may need to fix a broken Content-Type header field. You can do
838 this with this command. It displays the raw message in an
839 editable buffer. When you are done editing, save and kill the
840 buffer as you would any other.
841
842 From a program, edit MESSAGE; nil means edit current message."
843 (interactive)
844 (let* ((message (or message (mh-get-msg-num t)))
845 (msg-filename (mh-msg-filename message))
846 edit-buffer)
847 (when (not (file-exists-p msg-filename))
848 (error "Message %d does not exist" message))
849
850 ;; Invalidate the show buffer if it is showing the same message that is
851 ;; to be edited.
852 (when (and (buffer-live-p (get-buffer mh-show-buffer))
853 (equal (with-current-buffer mh-show-buffer
854 buffer-file-name)
855 msg-filename))
856 (mh-invalidate-show-buffer))
857
858 ;; Edit message
859 (find-file msg-filename)
860 (setq edit-buffer (current-buffer))
861
862 ;; Set buffer properties
863 (mh-letter-mode)
864 (use-local-map text-mode-map)
865
866 ;; Just show the edit buffer...
867 (delete-other-windows)
868 (switch-to-buffer edit-buffer)))
869
870 ;;;###mh-autoload
871 (defun mh-next-button (&optional backward-flag)
872 "Go to the next button.
873
874 If the end of the buffer is reached then the search wraps over to
875 the start of the buffer.
876
877 If an optional prefix argument BACKWARD-FLAG is given, the cursor
878 will move to the previous button."
879 (interactive (list current-prefix-arg))
880 (unless mh-showing-mode
881 (mh-show))
882 (mh-in-show-buffer (mh-show-buffer)
883 (mh-goto-next-button backward-flag)))
884
885 ;;;###mh-autoload
886 (defun mh-next-undeleted-msg (&optional count wait-after-complaining-flag)
887 "Display next message.
888
889 This command can be given a prefix argument COUNT to specify how
890 many unread messages to skip.
891
892 In a program, pause for a second after printing message if we are
893 at the last undeleted message and optional argument
894 WAIT-AFTER-COMPLAINING-FLAG is non-nil."
895 (interactive "p")
896 (setq mh-next-direction 'forward)
897 (forward-line 1)
898 (cond ((re-search-forward mh-scan-good-msg-regexp nil t count)
899 (beginning-of-line)
900 (mh-maybe-show))
901 (t (forward-line -1)
902 (message "No more undeleted messages")
903 (if wait-after-complaining-flag (sit-for 1)))))
904
905 ;;;###mh-autoload
906 (defun mh-next-unread-msg (&optional count)
907 "Display next unread message.
908
909 This command can be given a prefix argument COUNT to specify how
910 many unread messages to skip."
911 (interactive "p")
912 (unless (> count 0)
913 (error "The function `mh-next-unread-msg' expects positive argument"))
914 (setq count (1- count))
915 (let ((unread-sequence (reverse (cdr (assoc mh-unseen-seq mh-seq-list))))
916 (cur-msg (mh-get-msg-num nil)))
917 (cond ((and (not cur-msg) (not (bobp))
918 ;; If we are at the end of the buffer back up one line and go
919 ;; to unread message after that.
920 (progn
921 (forward-line -1)
922 (setq cur-msg (mh-get-msg-num nil)))
923 nil))
924 ((or (null unread-sequence) (not cur-msg))
925 ;; No unread message or there aren't any messages in buffer...
926 (message "No more unread messages"))
927 ((progn
928 ;; Skip messages
929 (while (and unread-sequence (>= cur-msg (car unread-sequence)))
930 (setq unread-sequence (cdr unread-sequence)))
931 (while (> count 0)
932 (setq unread-sequence (cdr unread-sequence))
933 (setq count (1- count)))
934 (not (car unread-sequence)))
935 (message "No more unread messages"))
936 (t (loop for msg in unread-sequence
937 when (mh-goto-msg msg t) return nil
938 finally (message "No more unread messages"))))))
939
940 ;;;###mh-autoload
941 (defun mh-page-msg (&optional lines)
942 "Display next page in message.
943
944 You can give this command a prefix argument that specifies the
945 number of LINES to scroll. This command will also show the next
946 undeleted message if it is used at the bottom of a message."
947 (interactive "P")
948 (if mh-showing-mode
949 (if mh-page-to-next-msg-flag
950 (if (equal mh-next-direction 'backward)
951 (mh-previous-undeleted-msg)
952 (mh-next-undeleted-msg))
953 (if (mh-in-show-buffer (mh-show-buffer)
954 (pos-visible-in-window-p (point-max)))
955 (progn
956 (message
957 "End of message (Type %s to read %s undeleted message)"
958 (single-key-description last-input-event)
959 (if (equal mh-next-direction 'backward)
960 "previous"
961 "next"))
962 (setq mh-page-to-next-msg-flag t))
963 (scroll-other-window lines)))
964 (mh-show)))
965
966 ;;;###mh-autoload
967 (defun mh-prev-button ()
968 "Go to the previous button.
969
970 If the beginning of the buffer is reached then the search wraps
971 over to the end of the buffer."
972 (interactive)
973 (mh-next-button t))
974
975 ;;;###mh-autoload
976 (defun mh-previous-page (&optional lines)
977 "Display next page in message.
978
979 You can give this command a prefix argument that specifies the
980 number of LINES to scroll."
981 (interactive "P")
982 (mh-in-show-buffer (mh-show-buffer)
983 (scroll-down lines)))
984
985 ;;;###mh-autoload
986 (defun mh-previous-undeleted-msg (&optional count wait-after-complaining-flag)
987 "Display previous message.
988
989 This command can be given a prefix argument COUNT to specify how
990 many unread messages to skip.
991
992 In a program, pause for a second after printing message if we are
993 at the last undeleted message and optional argument
994 WAIT-AFTER-COMPLAINING-FLAG is non-nil."
995 (interactive "p")
996 (setq mh-next-direction 'backward)
997 (beginning-of-line)
998 (cond ((re-search-backward mh-scan-good-msg-regexp nil t count)
999 (mh-maybe-show))
1000 (t (message "No previous undeleted message")
1001 (if wait-after-complaining-flag (sit-for 1)))))
1002
1003 ;;;###mh-autoload
1004 (defun mh-previous-unread-msg (&optional count)
1005 "Display previous unread message.
1006
1007 This command can be given a prefix argument COUNT to specify how
1008 many unread messages to skip."
1009 (interactive "p")
1010 (unless (> count 0)
1011 (error "The function `mh-previous-unread-msg' expects positive argument"))
1012 (setq count (1- count))
1013 (let ((unread-sequence (cdr (assoc mh-unseen-seq mh-seq-list)))
1014 (cur-msg (mh-get-msg-num nil)))
1015 (cond ((and (not cur-msg) (not (bobp))
1016 ;; If we are at the end of the buffer back up one line and go
1017 ;; to unread message after that.
1018 (progn
1019 (forward-line -1)
1020 (setq cur-msg (mh-get-msg-num nil)))
1021 nil))
1022 ((or (null unread-sequence) (not cur-msg))
1023 ;; No unread message or there aren't any messages in buffer...
1024 (message "No more unread messages"))
1025 ((progn
1026 ;; Skip count messages...
1027 (while (and unread-sequence (>= (car unread-sequence) cur-msg))
1028 (setq unread-sequence (cdr unread-sequence)))
1029 (while (> count 0)
1030 (setq unread-sequence (cdr unread-sequence))
1031 (setq count (1- count)))
1032 (not (car unread-sequence)))
1033 (message "No more unread messages"))
1034 (t (loop for msg in unread-sequence
1035 when (mh-goto-msg msg t) return nil
1036 finally (message "No more unread messages"))))))
1037
1038 ;;;###mh-autoload
1039 (defun mh-quit ()
1040 "Quit the current MH-E folder.
1041
1042 When you want to quit using MH-E and go back to editing, you can use
1043 this command. This buries the buffers of the current MH-E folder and
1044 restores the buffers that were present when you first ran
1045 \\[mh-rmail]. It also removes any MH-E working buffers whose name
1046 begins with \" *mh-\" or \"*MH-E \". You can later restore your MH-E
1047 session by selecting the \"+inbox\" buffer or by running \\[mh-rmail]
1048 again.
1049
1050 The two hooks `mh-before-quit-hook' and `mh-quit-hook' are called by
1051 this function. The former one is called before the quit occurs, so you
1052 might use it to perform any MH-E operations; you could perform some
1053 query and abort the quit or call `mh-execute-commands', for example.
1054 The latter is not run in an MH-E context, so you might use it to
1055 modify the window setup."
1056 (interactive)
1057 (run-hooks 'mh-before-quit-hook)
1058 (let ((show-buffer (get-buffer mh-show-buffer)))
1059 (when show-buffer
1060 (kill-buffer show-buffer)))
1061 (mh-update-sequences)
1062 (mh-destroy-postponed-handles)
1063 (bury-buffer (current-buffer))
1064
1065 ;; Delete all MH-E temporary and working buffers.
1066 (dolist (buffer (buffer-list))
1067 (when (or (string-match "^ \\*mh-" (buffer-name buffer))
1068 (string-match "^\\*MH-E " (buffer-name buffer)))
1069 (kill-buffer buffer)))
1070
1071 (if mh-previous-window-config
1072 (set-window-configuration mh-previous-window-config))
1073 (run-hooks 'mh-quit-hook))
1074
1075 ;;;###mh-autoload
1076 (defun mh-refile-msg (range folder &optional dont-update-last-destination-flag)
1077 "Refile (output) RANGE into FOLDER.
1078
1079 You are prompted for the folder name. Note that this command can also
1080 be used to create folders. If you specify a folder that does not
1081 exist, you will be prompted to create it.
1082
1083 The hook `mh-refile-msg-hook' is called after a message is marked to
1084 be refiled.
1085
1086 Check the documentation of `mh-interactive-range' to see how RANGE is
1087 read in interactive use.
1088
1089 In a program, the variables `mh-last-destination' and
1090 `mh-last-destination-folder' are not updated if
1091 DONT-UPDATE-LAST-DESTINATION-FLAG is non-nil."
1092 (interactive (list (mh-interactive-range "Refile")
1093 (intern (mh-prompt-for-refile-folder))))
1094 (unless dont-update-last-destination-flag
1095 (setq mh-last-destination (cons 'refile folder)
1096 mh-last-destination-folder mh-last-destination))
1097 (mh-iterate-on-range () range
1098 (mh-refile-a-msg nil folder))
1099 (when (looking-at mh-scan-refiled-msg-regexp) (mh-next-msg)))
1100
1101 ;;;###mh-autoload
1102 (defun mh-refile-or-write-again (range &optional interactive-flag)
1103 "Repeat last output command.
1104
1105 If you are refiling several messages into the same folder, you
1106 can use this command to repeat the last
1107 refile (\\[mh-refile-msg]) or write (\\[mh-write-msg-to-file]).
1108 You can use a range.
1109
1110 Check the documentation of `mh-interactive-range' to see how RANGE is
1111 read in interactive use.
1112
1113 In a program, a non-nil INTERACTIVE-FLAG means that the function was
1114 called interactively."
1115 (interactive (list (mh-interactive-range "Redo") t))
1116 (if (null mh-last-destination)
1117 (error "No previous refile or write"))
1118 (cond ((eq (car mh-last-destination) 'refile)
1119 (mh-refile-msg range (cdr mh-last-destination))
1120 (message "Destination folder: %s" (cdr mh-last-destination)))
1121 (t
1122 (mh-iterate-on-range msg range
1123 (apply 'mh-write-msg-to-file msg (cdr mh-last-destination)))
1124 (mh-next-msg interactive-flag))))
1125
1126 ;;;###mh-autoload
1127 (defun mh-rescan-folder (&optional range dont-exec-pending)
1128 "Rescan folder\\<mh-folder-mode-map>.
1129
1130 This command is useful to grab all messages in your \"+inbox\" after
1131 processing your new mail for the first time. If you don't want to
1132 rescan the entire folder, this command will accept a RANGE. Check the
1133 documentation of `mh-interactive-range' to see how RANGE is read in
1134 interactive use.
1135
1136 This command will ask if you want to process refiles or deletes first
1137 and then either run \\[mh-execute-commands] for you or undo the
1138 pending refiles and deletes.
1139
1140 In a program, the processing of outstanding commands is not performed
1141 if DONT-EXEC-PENDING is non-nil."
1142 (interactive (list (if current-prefix-arg
1143 (mh-read-range "Rescan" mh-current-folder t nil t
1144 mh-interpret-number-as-range-flag)
1145 nil)))
1146 (setq mh-next-direction 'forward)
1147 (let ((threaded-flag (memq 'unthread mh-view-ops))
1148 (msg-num (mh-get-msg-num nil)))
1149 (mh-scan-folder mh-current-folder (or range "all") dont-exec-pending)
1150 ;; If there isn't a cur sequence, mh-scan-folder goes to the first message.
1151 ;; Try to stay where we were.
1152 (if (null (car (mh-seq-to-msgs 'cur)))
1153 (mh-goto-msg msg-num t t))
1154 (cond (threaded-flag (mh-toggle-threads))
1155 (mh-index-data (mh-index-insert-folder-headers)))))
1156
1157 (defun mh-show-mouse (event)
1158 "Move point to mouse EVENT and show message."
1159 (interactive "e")
1160 (mouse-set-point event)
1161 (mh-show))
1162
1163 ;;;###mh-autoload
1164 (defun mh-toggle-showing ()
1165 "Toggle between MH-Folder and MH-Folder Show modes.
1166
1167 This command switches between MH-Folder mode and MH-Folder Show
1168 mode. MH-Folder mode turns off the associated show buffer so that
1169 you can perform operations on the messages quickly without
1170 reading them. This is an excellent way to prune out your junk
1171 mail or to refile a group of messages to another folder for later
1172 examination."
1173 (interactive)
1174 (if mh-showing-mode
1175 (mh-set-scan-mode)
1176 (mh-show)))
1177
1178 ;;;###mh-autoload
1179 (defun mh-undo (range)
1180 "Undo pending deletes or refiles in RANGE.
1181
1182 If you've deleted a message or refiled it, but changed your mind,
1183 you can cancel the action before you've executed it. Use this
1184 command to undo a refile on or deletion of a single message. You
1185 can also undo refiles and deletes for messages that are found in
1186 a given RANGE.
1187
1188 Check the documentation of `mh-interactive-range' to see how
1189 RANGE is read in interactive use."
1190 (interactive (list (mh-interactive-range "Undo")))
1191 (cond ((numberp range)
1192 (let ((original-position (point)))
1193 (beginning-of-line)
1194 (while (not (or (looking-at mh-scan-refiled-msg-regexp)
1195 (looking-at mh-scan-deleted-msg-regexp)
1196 (looking-at mh-scan-blacklisted-msg-regexp)
1197 (looking-at mh-scan-whitelisted-msg-regexp)
1198 (and (eq mh-next-direction 'forward) (bobp))
1199 (and (eq mh-next-direction 'backward)
1200 (save-excursion (forward-line) (eobp)))))
1201 (forward-line (if (eq mh-next-direction 'forward) -1 1)))
1202 (if (or (looking-at mh-scan-refiled-msg-regexp)
1203 (looking-at mh-scan-deleted-msg-regexp)
1204 (looking-at mh-scan-blacklisted-msg-regexp)
1205 (looking-at mh-scan-whitelisted-msg-regexp))
1206 (progn
1207 (mh-undo-msg (mh-get-msg-num t))
1208 (mh-maybe-show))
1209 (goto-char original-position)
1210 (error "Nothing to undo"))))
1211 (t (mh-iterate-on-range () range
1212 (mh-undo-msg nil))))
1213 (if (not (mh-outstanding-commands-p))
1214 (mh-set-folder-modified-p nil)))
1215
1216 ;;;###mh-autoload
1217 (defun mh-visit-folder (folder &optional range index-data)
1218 "Visit FOLDER.
1219
1220 When you want to read the messages that you have refiled into folders,
1221 use this command to visit the folder. You are prompted for the folder
1222 name.
1223
1224 The folder buffer will show just unseen messages if there are any;
1225 otherwise, it will show all the messages in the buffer as long there
1226 are fewer than `mh-large-folder' messages. If there are more, then you
1227 are prompted for a range of messages to scan.
1228
1229 You can provide a prefix argument in order to specify a RANGE of
1230 messages to show when you visit the folder. In this case, regions are
1231 not used to specify the range and `mh-large-folder' is ignored. Check
1232 the documentation of `mh-interactive-range' to see how RANGE is read
1233 in interactive use.
1234
1235 Note that this command can also be used to create folders. If you
1236 specify a folder that does not exist, you will be prompted to create
1237 it.
1238
1239 Do not call this function from outside MH-E; use \\[mh-rmail] instead.
1240
1241 If, in a program, RANGE is nil (the default), then all messages in
1242 FOLDER are displayed. If an index buffer is being created then
1243 INDEX-DATA is used to initialize the index buffer specific data
1244 structures."
1245 (interactive (let ((folder-name (mh-prompt-for-folder "Visit" mh-inbox t)))
1246 (list folder-name
1247 (mh-read-range "Scan" folder-name t nil
1248 current-prefix-arg
1249 mh-interpret-number-as-range-flag))))
1250 (let ((config (current-window-configuration))
1251 (current-buffer (current-buffer))
1252 (threaded-view-flag mh-show-threads-flag))
1253 (delete-other-windows)
1254 (when (get-buffer folder)
1255 (with-current-buffer folder
1256 (setq threaded-view-flag (memq 'unthread mh-view-ops))))
1257 (when index-data
1258 (mh-make-folder folder)
1259 (setq mh-index-data (car index-data)
1260 mh-index-msg-checksum-map (make-hash-table :test #'equal)
1261 mh-index-checksum-origin-map (make-hash-table :test #'equal))
1262 (mh-index-update-maps folder (cadr index-data))
1263 (mh-index-create-sequences))
1264 (mh-scan-folder folder (or range "all"))
1265 (cond ((and threaded-view-flag
1266 (save-excursion
1267 (goto-char (point-min))
1268 (or (null mh-large-folder)
1269 (not (equal (forward-line (1+ mh-large-folder)) 0))
1270 (and (message "Not threading since the number of messages exceeds `mh-large-folder'")
1271 nil))))
1272 (mh-toggle-threads))
1273 (mh-index-data
1274 (mh-index-insert-folder-headers)))
1275 (unless (eq current-buffer (current-buffer))
1276 (setq mh-previous-window-config config)))
1277 nil)
1278
1279 ;;;###mh-autoload
1280 (defun mh-write-msg-to-file (message file no-header)
1281 "Append MESSAGE to end of FILE\\<mh-folder-mode-map>.
1282
1283 You are prompted for the filename. If the file already exists,
1284 the message is appended to it. You can also write the message to
1285 the file without the header by specifying a prefix argument
1286 NO-HEADER. Subsequent writes to the same file can be made with
1287 the command \\[mh-refile-or-write-again]."
1288 (interactive
1289 (list (mh-get-msg-num t)
1290 (let ((default-dir (if (eq 'write (car mh-last-destination-write))
1291 (file-name-directory
1292 (car (cdr mh-last-destination-write)))
1293 default-directory)))
1294 (read-file-name (format "Save message%s in file: "
1295 (if current-prefix-arg " body" ""))
1296 default-dir
1297 (if (eq 'write (car mh-last-destination-write))
1298 (car (cdr mh-last-destination-write))
1299 (expand-file-name "mail.out" default-dir))))
1300 current-prefix-arg))
1301 (let ((msg-file-to-output (mh-msg-filename message))
1302 (output-file (mh-expand-file-name file)))
1303 (setq mh-last-destination (list 'write file (if no-header 'no-header))
1304 mh-last-destination-write mh-last-destination)
1305 (with-current-buffer (get-buffer-create mh-temp-buffer)
1306 (erase-buffer)
1307 (insert-file-contents msg-file-to-output)
1308 (goto-char (point-min))
1309 (if no-header (search-forward "\n\n"))
1310 (append-to-file (point) (point-max) output-file))))
1311
1312 ;;;###mh-autoload
1313 (defun mh-update-sequences ()
1314 "Flush MH-E's state out to MH.
1315
1316 This function updates the sequence specified by your
1317 \"Unseen-Sequence:\" profile component, \"cur\", and the sequence
1318 listed by the `mh-tick-seq' option which is \"tick\" by default.
1319 The message at the cursor is used for \"cur\"."
1320 (interactive)
1321 ;; mh-update-sequences is the opposite of mh-read-folder-sequences,
1322 ;; which updates MH-E's state from MH.
1323 (let ((folder-set (mh-update-unseen))
1324 (new-cur (mh-get-msg-num nil)))
1325 (if new-cur
1326 (let ((seq-entry (mh-find-seq 'cur)))
1327 (mh-remove-cur-notation)
1328 (setcdr seq-entry
1329 (list new-cur)) ;delete-seq-locally, add-msgs-to-seq
1330 (mh-define-sequence 'cur (list new-cur))
1331 (beginning-of-line)
1332 (if (looking-at mh-scan-good-msg-regexp)
1333 (mh-notate-cur)))
1334 (or folder-set
1335 (save-excursion
1336 ;; psg - mh-current-folder is nil if mh-summary-height < 4 !
1337 ;; So I added this sanity check.
1338 (if (stringp mh-current-folder)
1339 (mh-exec-cmd-quiet t "folder" mh-current-folder "-fast")
1340 (mh-exec-cmd-quiet t "folder" "-fast")))))))
1341
1342 \f
1343
1344 ;;; Support Routines
1345
1346 (defun mh-get-new-mail (maildrop-name)
1347 "Read new mail from MAILDROP-NAME into the current buffer.
1348 Return in the current buffer."
1349 (let ((point-before-inc (point))
1350 (folder mh-current-folder)
1351 (new-mail-flag nil))
1352 (with-mh-folder-updating (t)
1353 (if maildrop-name
1354 (message "inc %s -file %s..." folder maildrop-name)
1355 (message "inc %s..." folder))
1356 (setq mh-next-direction 'forward)
1357 (goto-char (point-max))
1358 (mh-remove-cur-notation)
1359 (let ((start-of-inc (point)))
1360 (if maildrop-name
1361 ;; I think MH 5 used "-ms-file" instead of "-file",
1362 ;; which would make inc'ing from maildrops fail.
1363 (mh-exec-cmd-output mh-inc-prog nil folder
1364 (mh-scan-format)
1365 "-file" (expand-file-name maildrop-name)
1366 "-width" (window-width)
1367 "-truncate")
1368 (mh-exec-cmd-output mh-inc-prog nil
1369 (mh-scan-format)
1370 "-width" (window-width)))
1371 (if maildrop-name
1372 (message "inc %s -file %s...done" folder maildrop-name)
1373 (message "inc %s...done" folder))
1374 (goto-char start-of-inc)
1375 (cond ((save-excursion
1376 (re-search-forward "^inc: no mail" nil t))
1377 (message "No new mail%s%s" (if maildrop-name " in " "")
1378 (if maildrop-name maildrop-name "")))
1379 ((and (when mh-folder-view-stack
1380 (let ((saved-text (buffer-substring-no-properties
1381 start-of-inc (point-max))))
1382 (delete-region start-of-inc (point-max))
1383 (unwind-protect (mh-widen t)
1384 (mh-remove-cur-notation)
1385 (goto-char (point-max))
1386 (setq start-of-inc (point))
1387 (insert saved-text)
1388 (goto-char start-of-inc))))
1389 nil))
1390 ((re-search-forward "^inc:" nil t) ; Error messages
1391 (error "Error incorporating mail"))
1392 ((and
1393 (equal mh-scan-format-file t)
1394 mh-adaptive-cmd-note-flag
1395 ;; Have we reached an edge condition?
1396 (save-excursion
1397 (re-search-forward mh-scan-msg-overflow-regexp nil 0 1))
1398 (setq start-of-inc (mh-generate-new-cmd-note folder))
1399 nil))
1400 (t
1401 (setq new-mail-flag t)))
1402 (keep-lines mh-scan-valid-regexp) ; Flush random scan lines
1403 (let* ((sequences (mh-read-folder-sequences folder t))
1404 (new-cur (assoc 'cur sequences))
1405 (new-unseen (assoc mh-unseen-seq sequences)))
1406 (unless (assoc 'cur mh-seq-list)
1407 (push (list 'cur) mh-seq-list))
1408 (unless (assoc mh-unseen-seq mh-seq-list)
1409 (push (list mh-unseen-seq) mh-seq-list))
1410 (setcdr (assoc 'cur mh-seq-list) (cdr new-cur))
1411 (setcdr (assoc mh-unseen-seq mh-seq-list) (cdr new-unseen)))
1412 (when (equal (point-max) start-of-inc)
1413 (mh-notate-cur))
1414 (if new-mail-flag
1415 (progn
1416 (mh-make-folder-mode-line)
1417 (when (mh-speed-flists-active-p)
1418 (mh-speed-flists t mh-current-folder))
1419 (when (memq 'unthread mh-view-ops)
1420 (mh-thread-inc folder start-of-inc))
1421 (mh-goto-cur-msg))
1422 (goto-char point-before-inc))
1423 (mh-notate-user-sequences (cons start-of-inc (point-max)))))))
1424
1425 (defun mh-generate-new-cmd-note (folder)
1426 "Fix the `mh-cmd-note' value for this FOLDER.
1427
1428 After doing an `mh-get-new-mail' operation in this FOLDER, at least
1429 one line that looks like a truncated message number was found.
1430
1431 Remove the text added by the last `mh-inc' command. It should be the
1432 messages cur-last. Call `mh-set-cmd-note', adjusting the notation
1433 column with the width of the largest message number in FOLDER.
1434
1435 Reformat the message number width on each line in the buffer and trim
1436 the line length to fit in the window.
1437
1438 Rescan the FOLDER in the range cur-last in order to display the
1439 messages that were removed earlier. They should all fit in the scan
1440 line now with no message truncation."
1441 (save-excursion
1442 (let ((maxcol (1- (window-width)))
1443 (old-cmd-note mh-cmd-note)
1444 mh-cmd-note-fmt
1445 msgnum)
1446 ;; Nuke all of the lines just added by the last inc
1447 (delete-char (- (point-max) (point)))
1448 ;; Update the current buffer to reflect the new mh-cmd-note
1449 ;; value needed to display messages.
1450 (mh-set-cmd-note (mh-msg-num-width-to-column (mh-msg-num-width folder)))
1451 (setq mh-cmd-note-fmt (concat "%" (format "%d" mh-cmd-note) "d"))
1452 ;; Cleanup the messages that are in the buffer right now
1453 (goto-char (point-min))
1454 (cond ((memq 'unthread mh-view-ops)
1455 (mh-thread-add-spaces (- mh-cmd-note old-cmd-note)))
1456 (t (while (re-search-forward (mh-scan-msg-number-regexp) nil 0 1)
1457 ;; reformat the number to fix in mh-cmd-note columns
1458 (setq msgnum (string-to-number
1459 (buffer-substring
1460 (match-beginning 1) (match-end 1))))
1461 (replace-match (format mh-cmd-note-fmt msgnum))
1462 ;; trim the line to fix in the window
1463 (end-of-line)
1464 (let ((eol (point)))
1465 (move-to-column maxcol)
1466 (if (<= (point) eol)
1467 (delete-char (- eol (point))))))))
1468 ;; now re-read the lost messages
1469 (goto-char (point-max))
1470 (prog1 (point)
1471 (mh-regenerate-headers "cur-last" t)))))
1472
1473 ;;;###mh-autoload
1474 (defun mh-goto-cur-msg (&optional minimal-changes-flag)
1475 "Position the cursor at the current message.
1476 When optional argument MINIMAL-CHANGES-FLAG is non-nil, the
1477 function doesn't recenter the folder buffer."
1478 (let ((cur-msg (car (mh-seq-to-msgs 'cur))))
1479 (cond ((and cur-msg
1480 (mh-goto-msg cur-msg t t))
1481 (unless minimal-changes-flag
1482 (mh-notate-cur)
1483 (mh-recenter 0)
1484 (mh-maybe-show cur-msg)))
1485 (t
1486 (setq overlay-arrow-position nil)
1487 (message "No current message")))))
1488
1489 ;;;###mh-autoload
1490 (defun mh-recenter (arg)
1491 "Like recenter but with three improvements:
1492
1493 - At the end of the buffer it tries to show fewer empty lines.
1494
1495 - operates only if the current buffer is in the selected window.
1496 (Commands like `save-some-buffers' can make this false.)
1497
1498 - nil ARG means recenter as if prefix argument had been given."
1499 (cond ((not (eq (get-buffer-window (current-buffer)) (selected-window)))
1500 nil)
1501 ((= (point-max) (save-excursion
1502 (forward-line (- (/ (window-height) 2) 2))
1503 (point)))
1504 (let ((lines-from-end 2))
1505 (save-excursion
1506 (while (> (point-max) (progn (forward-line) (point)))
1507 (incf lines-from-end)))
1508 (recenter (- lines-from-end))))
1509 ;; '(4) is the same as C-u prefix argument.
1510 (t (recenter (or arg '(4))))))
1511
1512 (defun mh-update-unseen ()
1513 "Synchronize the unseen sequence with MH.
1514 Return non-nil if the MH folder was set.
1515 The hook `mh-unseen-updated-hook' is called after the unseen sequence
1516 is updated."
1517 (if mh-seen-list
1518 (let* ((unseen-seq (mh-find-seq mh-unseen-seq))
1519 (unseen-msgs (mh-seq-msgs unseen-seq)))
1520 (if unseen-msgs
1521 (progn
1522 (mh-undefine-sequence mh-unseen-seq mh-seen-list)
1523 (run-hooks 'mh-unseen-updated-hook)
1524 (while mh-seen-list
1525 (setq unseen-msgs (delq (car mh-seen-list) unseen-msgs))
1526 (setq mh-seen-list (cdr mh-seen-list)))
1527 (setcdr unseen-seq unseen-msgs)
1528 t) ;since we set the folder
1529 (setq mh-seen-list nil)))))
1530
1531 ;;;###mh-autoload
1532 (defun mh-outstanding-commands-p ()
1533 "Return non-nil if there are outstanding deletes or refiles."
1534 (save-excursion
1535 (when (eq major-mode 'mh-show-mode)
1536 (set-buffer mh-show-folder-buffer))
1537 (or mh-delete-list mh-refile-list mh-blacklist mh-whitelist)))
1538
1539 ;;;###mh-autoload
1540 (defun mh-set-folder-modified-p (flag)
1541 "Mark current folder as modified or unmodified according to FLAG."
1542 (set-buffer-modified-p flag))
1543
1544 (defun mh-process-commands (folder)
1545 "Process outstanding commands for FOLDER.
1546
1547 This function runs `mh-before-commands-processed-hook' before the
1548 commands are processed and `mh-after-commands-processed-hook'
1549 after the commands are processed."
1550 (message "Processing deletes and refiles for %s..." folder)
1551 (set-buffer folder)
1552 (with-mh-folder-updating (nil)
1553 ;; Run the before hook -- the refile and delete lists are still valid
1554 (run-hooks 'mh-before-commands-processed-hook)
1555
1556 ;; Update the unseen sequence if it exists
1557 (mh-update-unseen)
1558
1559 (let ((redraw-needed-flag mh-index-data)
1560 (folders-changed (list mh-current-folder))
1561 (seq-map (and
1562 (or (and mh-refile-list mh-refile-preserves-sequences-flag)
1563 (and mh-whitelist
1564 mh-whitelist-preserves-sequences-flag))
1565 (mh-create-sequence-map mh-seq-list)))
1566 (dest-map (and mh-refile-list mh-refile-preserves-sequences-flag
1567 (make-hash-table)))
1568 (white-map (and mh-whitelist mh-whitelist-preserves-sequences-flag
1569 (make-hash-table))))
1570 ;; Remove invalid scan lines if we are in an index folder and then remove
1571 ;; the real messages
1572 (when mh-index-data
1573 (mh-index-delete-folder-headers)
1574 (setq folders-changed
1575 (append folders-changed (mh-index-execute-commands))))
1576
1577 ;; Then refile messages
1578 (mh-mapc #'(lambda (folder-msg-list)
1579 (let* ((dest-folder (symbol-name (car folder-msg-list)))
1580 (last (car (mh-translate-range dest-folder "last")))
1581 (msgs (cdr folder-msg-list)))
1582 (push dest-folder folders-changed)
1583 (setq redraw-needed-flag t)
1584 (apply #'mh-exec-cmd
1585 "refile" "-src" folder dest-folder
1586 (mh-coalesce-msg-list msgs))
1587 (mh-delete-scan-msgs msgs)
1588 ;; Preserve sequences in destination folder...
1589 (when mh-refile-preserves-sequences-flag
1590 (clrhash dest-map)
1591 (loop for i from (1+ (or last 0))
1592 for msg in (sort (copy-sequence msgs) #'<)
1593 do (loop for seq-name in (gethash msg seq-map)
1594 do (push i (gethash seq-name dest-map))))
1595 (maphash
1596 #'(lambda (seq msgs)
1597 ;; Can't be run in the background, since the
1598 ;; current folder is changed by mark this could
1599 ;; lead to a race condition with the next refile.
1600 (apply #'mh-exec-cmd "mark"
1601 "-sequence" (symbol-name seq) dest-folder
1602 "-add" (mapcar #'(lambda (x) (format "%s" x))
1603 (mh-coalesce-msg-list msgs))))
1604 dest-map))))
1605 mh-refile-list)
1606 (setq mh-refile-list ())
1607
1608 ;; Now delete messages
1609 (cond (mh-delete-list
1610 (setq redraw-needed-flag t)
1611 (apply 'mh-exec-cmd "rmm" folder
1612 (mh-coalesce-msg-list mh-delete-list))
1613 (mh-delete-scan-msgs mh-delete-list)
1614 (setq mh-delete-list nil)))
1615
1616 ;; Blacklist messages.
1617 (when mh-blacklist
1618 (let ((msg-list (mh-coalesce-msg-list mh-blacklist))
1619 (dest (mh-junk-blacklist-disposition)))
1620 (mh-junk-process-blacklist mh-blacklist)
1621 ;; TODO I wonder why mh-exec-cmd is used instead of the following:
1622 ;; (mh-refile-a-msg nil (intern dest))
1623 ;; (mh-delete-a-msg nil)))
1624 (if (null dest)
1625 (apply 'mh-exec-cmd "rmm" folder msg-list)
1626 (apply 'mh-exec-cmd "refile" "-src" folder dest msg-list)
1627 (push dest folders-changed))
1628 (setq redraw-needed-flag t)
1629 (mh-delete-scan-msgs mh-blacklist)
1630 (setq mh-blacklist nil)))
1631
1632 ;; Whitelist messages.
1633 (when mh-whitelist
1634 (let ((msg-list (mh-coalesce-msg-list mh-whitelist))
1635 (last (car (mh-translate-range mh-inbox "last"))))
1636 (mh-junk-process-whitelist mh-whitelist)
1637 (apply #'mh-exec-cmd "refile" "-src" folder mh-inbox msg-list)
1638 (push mh-inbox folders-changed)
1639 (setq redraw-needed-flag t)
1640 (mh-delete-scan-msgs mh-whitelist)
1641 (when mh-whitelist-preserves-sequences-flag
1642 (clrhash white-map)
1643 (loop for i from (1+ (or last 0))
1644 for msg in (sort (copy-sequence mh-whitelist) #'<)
1645 do (loop for seq-name in (gethash msg seq-map)
1646 do (push i (gethash seq-name white-map))))
1647 (maphash
1648 #'(lambda (seq msgs)
1649 ;; Can't be run in background, since the current
1650 ;; folder is changed by mark this could lead to a
1651 ;; race condition with the next refile/whitelist.
1652 (apply #'mh-exec-cmd "mark"
1653 "-sequence" (symbol-name seq) mh-inbox
1654 "-add" (mapcar #'(lambda(x) (format "%s" x))
1655 (mh-coalesce-msg-list msgs))))
1656 white-map))
1657 (setq mh-whitelist nil)))
1658
1659 ;; Don't need to remove sequences since delete and refile do so.
1660 ;; Mark cur message
1661 (if (> (buffer-size) 0)
1662 (mh-define-sequence 'cur (list (or (mh-get-msg-num nil) "last"))))
1663
1664 ;; Redraw folder buffer if needed
1665 (when (and redraw-needed-flag)
1666 (when (mh-speed-flists-active-p)
1667 (apply #'mh-speed-flists t folders-changed))
1668 (cond ((memq 'unthread mh-view-ops) (mh-thread-inc folder (point-max)))
1669 (mh-index-data (mh-index-insert-folder-headers))))
1670
1671 (and (buffer-file-name (get-buffer mh-show-buffer))
1672 (not (file-exists-p (buffer-file-name (get-buffer mh-show-buffer))))
1673 ;; If "inc" were to put a new msg in this file,
1674 ;; we would not notice, so mark it invalid now.
1675 (mh-invalidate-show-buffer))
1676
1677 (setq mh-seq-list (mh-read-folder-sequences mh-current-folder nil))
1678 (mh-remove-all-notation)
1679 (mh-notate-user-sequences)
1680
1681 ;; Run the after hook -- now folders-changed is valid,
1682 ;; but not the lists of specific messages.
1683 (let ((mh-folders-changed folders-changed))
1684 (run-hooks 'mh-after-commands-processed-hook)))
1685
1686 (message "Processing deletes and refiles for %s...done" folder)))
1687
1688 (defun mh-delete-scan-msgs (msgs)
1689 "Delete the scan listing lines for MSGS."
1690 (save-excursion
1691 (while msgs
1692 (when (mh-goto-msg (car msgs) t t)
1693 (when (memq 'unthread mh-view-ops)
1694 (mh-thread-forget-message (car msgs)))
1695 (mh-delete-line 1))
1696 (setq msgs (cdr msgs)))))
1697
1698 (defun mh-set-scan-mode ()
1699 "Display the scan listing buffer, but do not show a message."
1700 (if (get-buffer mh-show-buffer)
1701 (delete-windows-on mh-show-buffer))
1702 (mh-showing-mode 0)
1703 (force-mode-line-update)
1704 (if mh-recenter-summary-flag
1705 (mh-recenter nil)))
1706
1707 ;;;###mh-autoload
1708 (defun mh-make-folder-mode-line (&optional ignored)
1709 "Set the fields of the mode line for a folder buffer.
1710 The optional argument is now obsolete and IGNORED. It used to be
1711 used to pass in what is now stored in the buffer-local variable
1712 `mh-mode-line-annotation'."
1713 (save-excursion
1714 (save-window-excursion
1715 (mh-first-msg)
1716 (let ((new-first-msg-num (mh-get-msg-num nil)))
1717 (when (or (not (memq 'unthread mh-view-ops))
1718 (null mh-first-msg-num)
1719 (null new-first-msg-num)
1720 (< new-first-msg-num mh-first-msg-num))
1721 (setq mh-first-msg-num new-first-msg-num)))
1722 (mh-last-msg)
1723 (let ((new-last-msg-num (mh-get-msg-num nil)))
1724 (when (or (not (memq 'unthread mh-view-ops))
1725 (null mh-last-msg-num)
1726 (null new-last-msg-num)
1727 (> new-last-msg-num mh-last-msg-num))
1728 (setq mh-last-msg-num new-last-msg-num)))
1729 (setq mh-msg-count (if mh-first-msg-num
1730 (count-lines (point-min) (point-max))
1731 0))
1732 (setq mode-line-buffer-identification
1733 (list (format " {%%b%s} %s msg%s"
1734 (if mh-mode-line-annotation
1735 (format "/%s" mh-mode-line-annotation)
1736 "")
1737 (if (zerop mh-msg-count)
1738 "no"
1739 (format "%d" mh-msg-count))
1740 (if (zerop mh-msg-count)
1741 "s"
1742 (cond ((> mh-msg-count 1)
1743 (format "s (%d-%d)" mh-first-msg-num
1744 mh-last-msg-num))
1745 (mh-first-msg-num
1746 (format " (%d)" mh-first-msg-num))
1747 (""))))))
1748 (mh-logo-display))))
1749
1750 ;;;###mh-autoload
1751 (defun mh-scan-folder (folder range &optional dont-exec-pending)
1752 "Scan FOLDER over RANGE.
1753
1754 After the scan is performed, switch to the buffer associated with
1755 FOLDER.
1756
1757 Check the documentation of `mh-interactive-range' to see how RANGE is
1758 read in interactive use.
1759
1760 The processing of outstanding commands is not performed if
1761 DONT-EXEC-PENDING is non-nil."
1762 (when (stringp range)
1763 (setq range (delete "" (split-string range "[ \t\n]"))))
1764 (cond ((null (get-buffer folder))
1765 (mh-make-folder folder))
1766 (t
1767 (unless dont-exec-pending
1768 (mh-process-or-undo-commands folder)
1769 (mh-reset-threads-and-narrowing))
1770 (switch-to-buffer folder)))
1771 (mh-regenerate-headers range)
1772 (if (zerop (buffer-size))
1773 (if (equal range "all")
1774 (message "Folder %s is empty" folder)
1775 (message "No messages in %s, range %s" folder range))
1776 (mh-goto-cur-msg))
1777 (when (mh-outstanding-commands-p)
1778 (mh-notate-deleted-and-refiled)))
1779
1780 ;;;###mh-autoload
1781 (defun mh-process-or-undo-commands (folder)
1782 "If FOLDER has outstanding commands, then either process or discard them.
1783 Called by functions like `mh-sort-folder', so also invalidate
1784 show buffer."
1785 (set-buffer folder)
1786 (if (mh-outstanding-commands-p)
1787 (if (or mh-do-not-confirm-flag
1788 (y-or-n-p
1789 "Process outstanding deletes and refiles? "))
1790 (mh-process-commands folder)
1791 (set-buffer folder)
1792 (mh-undo-folder)))
1793 (mh-update-unseen)
1794 (mh-invalidate-show-buffer))
1795
1796 ;;;###mh-autoload
1797 (defun mh-regenerate-headers (range &optional update)
1798 "Scan folder over RANGE.
1799 If UPDATE, append the scan lines, otherwise replace."
1800 (let ((folder mh-current-folder)
1801 (range (if (and range (atom range)) (list range) range))
1802 scan-start)
1803 (message "Scanning %s..." folder)
1804 (mh-remove-all-notation)
1805 (with-mh-folder-updating (nil)
1806 (if update
1807 (goto-char (point-max))
1808 (delete-region (point-min) (point-max))
1809 (if mh-adaptive-cmd-note-flag
1810 (mh-set-cmd-note (mh-msg-num-width-to-column (mh-msg-num-width
1811 folder)))))
1812 (setq scan-start (point))
1813 (apply #'mh-exec-cmd-output
1814 mh-scan-prog nil
1815 (mh-scan-format)
1816 "-noclear" "-noheader"
1817 "-width" (window-width)
1818 folder range)
1819 (goto-char scan-start)
1820 (cond ((looking-at "scan: no messages in")
1821 (keep-lines mh-scan-valid-regexp)) ; Flush random scan lines
1822 ((looking-at (if (mh-variant-p 'gnu-mh)
1823 "scan: message set .* does not exist"
1824 "scan: bad message list "))
1825 (keep-lines mh-scan-valid-regexp))
1826 ((looking-at "scan: ")) ; Keep error messages
1827 (t
1828 (keep-lines mh-scan-valid-regexp))) ; Flush random scan lines
1829 (setq mh-seq-list (mh-read-folder-sequences folder nil))
1830 (mh-notate-user-sequences)
1831 (or update
1832 (setq mh-mode-line-annotation
1833 (if (equal range '("all"))
1834 nil
1835 mh-partial-folder-mode-line-annotation)))
1836 (mh-make-folder-mode-line))
1837 (message "Scanning %s...done" folder)))
1838
1839 ;;;###mh-autoload
1840 (defun mh-reset-threads-and-narrowing ()
1841 "Reset all variables pertaining to threads and narrowing.
1842 Also removes all content from the folder buffer."
1843 (setq mh-view-ops ())
1844 (setq mh-folder-view-stack ())
1845 (setq mh-thread-scan-line-map-stack ())
1846 (let ((buffer-read-only nil)) (erase-buffer)))
1847
1848 (defun mh-make-folder (name)
1849 "Create a new mail folder called NAME.
1850 Make it the current folder."
1851 (switch-to-buffer name)
1852 (setq buffer-read-only nil)
1853 (erase-buffer)
1854 (if mh-adaptive-cmd-note-flag
1855 (mh-set-cmd-note (mh-msg-num-width-to-column (mh-msg-num-width name))))
1856 (setq buffer-read-only t)
1857 (mh-folder-mode)
1858 (mh-set-folder-modified-p nil)
1859 (setq buffer-file-name mh-folder-filename)
1860 (when (and (not mh-index-data)
1861 (file-exists-p (concat buffer-file-name mh-index-data-file)))
1862 (mh-index-read-data))
1863 (mh-make-folder-mode-line))
1864
1865 ;;;###mh-autoload
1866 (defun mh-next-msg (&optional wait-after-complaining-flag)
1867 "Move backward or forward to the next undeleted message in the buffer.
1868 If optional argument WAIT-AFTER-COMPLAINING-FLAG is non-nil and
1869 we are at the last message, then wait for a second after telling
1870 the user that there aren't any more unread messages."
1871 (if (eq mh-next-direction 'forward)
1872 (mh-next-undeleted-msg 1 wait-after-complaining-flag)
1873 (mh-previous-undeleted-msg 1 wait-after-complaining-flag)))
1874
1875 ;;;###mh-autoload
1876 (defun mh-prompt-for-refile-folder ()
1877 "Prompt the user for a folder in which the message should be filed.
1878 The folder is returned as a string.
1879
1880 The default folder name is generated by the option
1881 `mh-default-folder-for-message-function' if it is non-nil or
1882 `mh-folder-from-address'."
1883 (mh-prompt-for-folder
1884 "Destination"
1885 (let ((refile-file (ignore-errors (mh-msg-filename (mh-get-msg-num t)))))
1886 (if (null refile-file) ""
1887 (with-current-buffer (get-buffer-create mh-temp-buffer)
1888 (erase-buffer)
1889 (insert-file-contents refile-file)
1890 (or (and mh-default-folder-for-message-function
1891 (let ((buffer-file-name refile-file))
1892 (funcall mh-default-folder-for-message-function)))
1893 (mh-folder-from-address)
1894 (and (eq 'refile (car mh-last-destination-folder))
1895 (symbol-name (cdr mh-last-destination-folder)))
1896 ""))))
1897 t))
1898
1899 ;;;###mh-autoload
1900 (defun mh-folder-from-address ()
1901 "Derive folder name from sender.
1902
1903 The name of the folder is derived as follows:
1904
1905 a) The folder name associated with the first address found in
1906 the list `mh-default-folder-list' is used. Each element in
1907 this list contains a \"Check Recipient\" item. If this item is
1908 turned on, then the address is checked against the recipient
1909 instead of the sender. This is useful for mailing lists.
1910
1911 b) An alias prefixed by `mh-default-folder-prefix'
1912 corresponding to the address is used. The prefix is used to
1913 prevent clutter in your mail directory.
1914
1915 Return nil if a folder name was not derived, or if the variable
1916 `mh-default-folder-must-exist-flag' is t and the folder does not
1917 exist."
1918 ;; Loop for all entries in mh-default-folder-list
1919 (save-restriction
1920 (goto-char (point-min))
1921 (re-search-forward "\n\n" nil 'limit)
1922 (narrow-to-region (point-min) (point))
1923 (let ((to/cc (concat (or (message-fetch-field "to") "") ", "
1924 (or (message-fetch-field "cc") "")))
1925 (from (or (message-fetch-field "from") ""))
1926 folder-name)
1927 (setq folder-name
1928 (loop for list in mh-default-folder-list
1929 when (string-match (nth 0 list) (if (nth 2 list) to/cc from))
1930 return (nth 1 list)
1931 finally return nil))
1932
1933 ;; Make sure a result from `mh-default-folder-list' begins with "+"
1934 ;; since 'mh-expand-file-name below depends on it
1935 (when (and folder-name (not (eq (aref folder-name 0) ?+)))
1936 (setq folder-name (concat "+" folder-name)))
1937
1938 ;; If not, is there an alias for the address?
1939 (when (not folder-name)
1940 (let* ((from-header (mh-extract-from-header-value))
1941 (address (and from-header
1942 (nth 1 (mail-extract-address-components
1943 from-header))))
1944 (alias (and address (mh-alias-address-to-alias address))))
1945 (when alias
1946 (setq folder-name
1947 (and alias (concat "+" mh-default-folder-prefix alias))))))
1948
1949 ;; If mh-default-folder-must-exist-flag set, check that folder exists.
1950 (if (and folder-name
1951 (or (not mh-default-folder-must-exist-flag)
1952 (file-exists-p (mh-expand-file-name folder-name))))
1953 folder-name))))
1954
1955 ;;;###mh-autoload
1956 (defun mh-delete-a-msg (message)
1957 "Delete MESSAGE.
1958 If MESSAGE is nil then the message at point is deleted.
1959 The hook `mh-delete-msg-hook' is called after you mark a message
1960 for deletion. For example, a past maintainer of MH-E used this
1961 once when he kept statistics on his mail usage."
1962 (save-excursion
1963 (if (numberp message)
1964 (mh-goto-msg message nil t)
1965 (beginning-of-line)
1966 (setq message (mh-get-msg-num t)))
1967 (if (looking-at mh-scan-refiled-msg-regexp)
1968 (error "Message %d is refiled; undo refile before deleting" message))
1969 (if (looking-at mh-scan-blacklisted-msg-regexp)
1970 (error "Message %d is blacklisted; undo before deleting" message))
1971 (if (looking-at mh-scan-whitelisted-msg-regexp)
1972 (error "Message %d is whitelisted; undo before deleting" message))
1973 (if (looking-at mh-scan-deleted-msg-regexp)
1974 nil
1975 (mh-set-folder-modified-p t)
1976 (setq mh-delete-list (cons message mh-delete-list))
1977 (mh-notate nil mh-note-deleted mh-cmd-note)
1978 (run-hooks 'mh-delete-msg-hook))))
1979
1980 ;;;###mh-autoload
1981 (defun mh-refile-a-msg (message folder)
1982 "Refile MESSAGE in FOLDER.
1983 If MESSAGE is nil then the message at point is refiled.
1984 Folder is a symbol, not a string.
1985 The hook `mh-refile-msg-hook' is called after a message is marked to
1986 be refiled."
1987 (save-excursion
1988 (if (numberp message)
1989 (mh-goto-msg message nil t)
1990 (beginning-of-line)
1991 (setq message (mh-get-msg-num t)))
1992 (cond ((looking-at mh-scan-deleted-msg-regexp)
1993 (error "Message %d is deleted; undo delete before moving" message))
1994 ((looking-at mh-scan-blacklisted-msg-regexp)
1995 (error "Message %d is blacklisted; undo before moving" message))
1996 ((looking-at mh-scan-whitelisted-msg-regexp)
1997 (error "Message %d is whitelisted; undo before moving" message))
1998 ((looking-at mh-scan-refiled-msg-regexp)
1999 (if (y-or-n-p
2000 (format "Message %d already refiled; copy to %s as well? "
2001 message folder))
2002 (mh-exec-cmd "refile" (mh-get-msg-num t) "-link"
2003 "-src" mh-current-folder
2004 (symbol-name folder))
2005 (message "Message not copied")))
2006 (t
2007 (mh-set-folder-modified-p t)
2008 (cond ((null (assoc folder mh-refile-list))
2009 (push (list folder message) mh-refile-list))
2010 ((not (member message (cdr (assoc folder mh-refile-list))))
2011 (push message (cdr (assoc folder mh-refile-list)))))
2012 (mh-notate nil mh-note-refiled mh-cmd-note)
2013 (run-hooks 'mh-refile-msg-hook)))))
2014
2015 (defun mh-undo-msg (msg)
2016 "Undo the deletion, refile, black- or whitelisting of one MSG.
2017 If MSG is nil then act on the message at point"
2018 (save-excursion
2019 (if (numberp msg)
2020 (mh-goto-msg msg t t)
2021 (beginning-of-line)
2022 (setq msg (mh-get-msg-num t)))
2023 (cond ((memq msg mh-delete-list)
2024 (setq mh-delete-list (delq msg mh-delete-list)))
2025 ((memq msg mh-blacklist)
2026 (setq mh-blacklist (delq msg mh-blacklist)))
2027 ((memq msg mh-whitelist)
2028 (setq mh-whitelist (delq msg mh-whitelist)))
2029 (t
2030 (dolist (folder-msg-list mh-refile-list)
2031 (setf (cdr folder-msg-list) (remove msg (cdr folder-msg-list))))
2032 (setq mh-refile-list (loop for x in mh-refile-list
2033 unless (null (cdr x)) collect x))))
2034 (mh-notate nil ? mh-cmd-note)))
2035
2036 ;;;###mh-autoload
2037 (defun mh-msg-filename (msg &optional folder)
2038 "Return the file name of MSG in FOLDER (default current folder)."
2039 (expand-file-name (int-to-string msg)
2040 (if folder
2041 (mh-expand-file-name folder)
2042 mh-folder-filename)))
2043
2044 (provide 'mh-folder)
2045
2046 ;; Local Variables:
2047 ;; indent-tabs-mode: nil
2048 ;; sentence-end-double-space: nil
2049 ;; End:
2050
2051 ;;; mh-folder.el ends here