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