| blob | aab40c7be13db94584bcfd4d27033369d5d2c949 |
1 ;;; mh-folder.el --- MH-Folder mode
3 ;; Copyright (C) 2002-2003, 2005-2011 Free Software Foundation, Inc.
5 ;; Author: Bill Wohler <wohler@newt.com>
6 ;; Maintainer: Bill Wohler <wohler@newt.com>
7 ;; Keywords: mail
8 ;; See: mh-e.el
10 ;; This file is part of GNU Emacs.
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.
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.
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/>.
25 ;;; Commentary:
27 ;; Mode for browsing folders
29 ;;; Change Log:
31 ;;; Code:
37 ;; Dynamically-created functions not found in mh-loaddefs.el.
44 \f
46 ;;; MH-E Entry Points
48 ;;;###autoload
50 "Incorporate new mail with MH.
51 Scan an MH folder if ARG is non-nil.
53 This function is an entry point to MH-E, the Emacs interface to
54 the MH mail system."
63 ;;;###autoload
65 "Check for new mail in inbox folder.
66 Scan an MH folder if ARG is non-nil.
68 This function is an entry point to MH-E, the Emacs interface to
69 the MH mail system."
75 \f
77 ;;; Desktop Integration
79 ;; desktop-buffer-mode-handlers appeared in Emacs 22.
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."
96 \f
98 ;;; Variables
104 "Annotation when displaying part of a folder.
105 The string is displayed after the folder's name. nil for no
126 \f
128 ;;; Sequence Menu
131 mh-folder-sequence-menu mh-folder-mode-map "Menu for MH-E folder-sequence."
141 "--"
147 "--"
150 ;;; Message Menu
153 mh-folder-message-menu mh-folder-mode-map "Menu for MH-E folder-message."
170 "--"
177 "--"
186 ;;; Folder Menu
189 mh-folder-folder-menu mh-folder-mode-map "Menu for MH-E folder."
200 "--"
205 "--"
208 \f
210 ;;; MH-Folder Keys
214 ;; Use defalias to make sure the documented primary key bindings
215 ;; appear in menu lists.
221 ;; Save the "b" binding for a future `back'. Maybe?
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
235 "\C-d" mh-delete-msg-no-motion
237 [backtab] mh-index-previous-folder
239 "\e<" mh-first-msg
240 "\e>" mh-last-msg
241 "\ed" mh-redistribute
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)
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)
283 (define-key mh-folder-mode-map "I" mh-inc-spool-map)
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)
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)
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)
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)
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)
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
333 (gnus-define-keys (mh-digest-map "D" mh-folder-mode-map)
334 " " mh-page-digest
335 "?" mh-prefix-help
337 "b" mh-burst-digest)
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
348 [backtab] mh-prev-button
354 (t
355 (define-key mh-folder-mode-map [mouse-2] 'mh-show-mouse)))
357 ;; "C-c /" prefix is used in mh-folder-mode by pgp.el and mailcrypt
359 \f
361 ;;; MH-Folder Help Messages
363 ;; If you add a new prefix, add appropriate text to the nil key.
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.
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
382 "[p]ack; [S]ort; [r]escan; [k]ill")
384 "Toggle printing of [C]olors, [F]aces")
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")
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'.")
399 \f
401 ;;; MH-Folder Font Lock
403 (defvar mh-folder-font-lock-keywords
404 (list
405 ;; Folders when displaying index buffer
407 '(0 'mh-search-folder))
408 ;; Marked for deletion
409 (list (concat mh-scan-deleted-msg-regexp ".*")
410 '(0 'mh-folder-deleted))
411 ;; Marked for refile
412 (list (concat mh-scan-refiled-msg-regexp ".*")
413 '(0 'mh-folder-refiled))
414 ;; After subject
415 (list mh-scan-body-regexp
416 '(1 'mh-folder-body nil t))
417 ;; Subject
418 '(mh-folder-font-lock-subject
419 (1 'mh-folder-followup append t)
420 (2 'mh-folder-subject append t))
421 ;; Current message number
422 (list mh-scan-cur-msg-number-regexp
423 '(1 'mh-folder-cur-msg-number))
424 ;; Message number
425 (list mh-scan-good-msg-regexp
426 '(1 'mh-folder-msg-number))
427 ;; Date
428 (list mh-scan-date-regexp
429 '(1 'mh-folder-date))
430 ;; Messages from me (To:)
431 (list mh-scan-rcpt-regexp
432 '(1 'mh-folder-to)
433 '(2 'mh-folder-address))
434 ;; Messages to me
435 (list mh-scan-sent-to-me-sender-regexp
436 '(1 'mh-folder-sent-to-me-hint)
437 '(2 'mh-folder-sent-to-me-sender)))
438 "Keywords (regular expressions) used to fontify the MH-Folder buffer.")
440 (defun mh-folder-font-lock-subject (limit)
441 "Return MH-E scan subject strings to font-lock between point and LIMIT."
442 (if (not (re-search-forward mh-scan-subject-regexp limit t))
443 nil
444 (if (match-beginning 1)
445 (set-match-data (list (match-beginning 1) (match-end 3)
446 (match-beginning 1) (match-end 3) nil nil))
447 (set-match-data (list (match-beginning 3) (match-end 3)
448 nil nil (match-beginning 3) (match-end 3))))
449 t))
451 ;; Fontify unseen messages in bold.
453 (defmacro mh-generate-sequence-font-lock (seq prefix face)
454 "Generate the appropriate code to fontify messages in SEQ.
455 PREFIX is used to generate unique names for the variables and
456 functions defined by the macro. So a different prefix should be
457 provided for every invocation.
458 FACE is the font-lock face used to display the matching scan lines."
459 (let ((cache (intern (format "mh-folder-%s-seq-cache" prefix)))
460 (func (intern (format "mh-folder-font-lock-%s" prefix))))
461 `(progn
462 (defvar ,cache nil
463 "Internal cache variable used for font-lock in MH-E.
464 Should only be non-nil through font-lock stepping, and nil once
465 font-lock is done highlighting.")
466 (make-variable-buffer-local ',cache)
468 (defun ,func (limit)
469 "Return unseen message lines to font-lock between point and LIMIT."
470 (if (not ,cache) (setq ,cache (mh-seq-msgs (mh-find-seq ,seq))))
471 (let ((cur-msg (mh-get-msg-num nil)))
472 (cond ((not ,cache)
473 nil)
474 ((>= (point) limit) ;Presumably at end of buffer
475 (setq ,cache nil)
476 nil)
477 ((member cur-msg ,cache)
478 (let ((bpoint (progn (beginning-of-line)(point)))
479 (epoint (progn (forward-line 1)(point))))
480 (if (<= limit (point)) (setq ,cache nil))
481 (set-match-data (list bpoint epoint bpoint epoint))
482 t))
483 (t
484 ;; move forward one line at a time, checking each message
485 (while (and (= 0 (forward-line 1))
486 (> limit (point))
487 (not (member (mh-get-msg-num nil) ,cache))))
488 ;; Examine how we must have exited the loop...
489 (let ((cur-msg (mh-get-msg-num nil)))
490 (cond ((or (<= limit (point))
491 (not (member cur-msg ,cache)))
492 (setq ,cache nil)
493 nil)
494 ((member cur-msg ,cache)
495 (let ((bpoint (progn (beginning-of-line) (point)))
496 (epoint (progn (forward-line 1) (point))))
497 (if (<= limit (point)) (setq ,cache nil))
498 (set-match-data
499 (list bpoint epoint bpoint epoint))
500 t))))))))
502 (setq mh-folder-font-lock-keywords
503 (append mh-folder-font-lock-keywords
504 (list (list ',func (list 1 '',face 'prepend t))))))))
506 (mh-generate-sequence-font-lock mh-unseen-seq unseen bold)
507 (mh-generate-sequence-font-lock mh-tick-seq tick mh-folder-tick)
509 \f
511 ;;; MH-Folder Mode
513 (defmacro mh-remove-xemacs-horizontal-scrollbar ()
514 "Get rid of the horizontal scrollbar that XEmacs insists on putting in."
515 (when (featurep 'xemacs)
516 `(if (and (featurep 'scrollbar)
517 (fboundp 'set-specifier))
518 (set-specifier horizontal-scrollbar-visible-p nil
519 (cons (current-buffer) nil)))))
521 ;; Register mh-folder-mode as supporting which-function-mode...
522 (mh-require 'which-func nil t)
523 (when (boundp 'which-func-modes)
524 (add-to-list 'which-func-modes 'mh-folder-mode))
526 ;; Shush compiler.
527 (defvar desktop-save-buffer)
528 (defvar font-lock-auto-fontify)
529 (defvar font-lock-defaults) ; XEmacs
531 ;; Ensure new buffers won't get this mode if default major-mode is nil.
532 (put 'mh-folder-mode 'mode-class 'special)
534 ;; Autoload cookie needed by desktop.el
535 ;;;###autoload
536 (define-derived-mode mh-folder-mode fundamental-mode "MH-Folder"
539 You can show the message the cursor is pointing to, and step through
540 the messages. Messages can be marked for deletion or refiling into
541 another folder; these commands are executed all at once with a
542 separate command.
544 Options that control this mode can be changed with
546 see the `mh-scan-format-file' option if you wish to modify scan's
547 format.
549 When a folder is visited, the hook `mh-folder-mode-hook' is run.
551 Ranges
552 ======
553 Many commands that operate on individual messages, such as
554 `mh-forward' or `mh-refile-msg' take a RANGE argument. This argument
555 can be used in several ways.
558 these commands, then you will be prompted for the message range.
559 This can be any valid MH range which can include messages,
560 sequences, and the abbreviations (described in the mh(1) man
561 page):
563 <num1>-<num2>
564 Indicates all messages in the range <num1> to <num2>, inclusive.
565 The range must be nonempty.
567 <num>:N
568 <num>:+N
569 <num>:-N
570 Up to N messages beginning with (or ending with) message num. Num
571 may be any of the predefined symbols: first, prev, cur, next or
572 last.
574 first:N
575 prev:N
576 next:N
577 last:N
578 The first, previous, next or last messages, if they exist.
580 all
581 All of the messages.
583 For example, a range that shows all of these things is `1 2 3
584 5-10 last:5 unseen'.
586 If the option `transient-mark-mode' is set to t and you set a
587 region in the MH-Folder buffer, then the MH-E command will
588 perform the operation on all messages in that region.
591 (mh-do-in-gnu-emacs
592 (unless mh-folder-tool-bar-map
593 (mh-tool-bar-folder-buttons-init))
594 (if (boundp 'tool-bar-map)
595 (set (make-local-variable 'tool-bar-map) mh-folder-tool-bar-map)))
596 (mh-do-in-xemacs
597 (mh-tool-bar-init :folder))
598 (make-local-variable 'font-lock-defaults)
599 (setq font-lock-defaults '(mh-folder-font-lock-keywords t))
600 (make-local-variable 'desktop-save-buffer)
601 (setq desktop-save-buffer t)
602 (mh-make-local-vars
603 'mh-colors-available-flag (mh-colors-available-p)
604 ; Do we have colors available
605 'mh-current-folder (buffer-name) ; Name of folder, a string
606 'mh-show-buffer (format "show-%s" (buffer-name)) ; Buffer that displays msgs
607 'mh-folder-filename ; e.g. "/usr/foobar/Mail/inbox/"
608 (file-name-as-directory (mh-expand-file-name (buffer-name)))
609 'mh-display-buttons-for-inline-parts-flag
610 mh-display-buttons-for-inline-parts-flag ; Allow for display of buttons to
611 ; be toggled.
612 'mh-arrow-marker (make-marker) ; Marker where arrow is displayed
613 'overlay-arrow-position nil ; Allow for simultaneous display in
614 'overlay-arrow-string ">" ; different MH-E buffers.
615 'mh-showing-mode nil ; Show message also?
616 'mh-delete-list nil ; List of msgs nums to delete
617 'mh-refile-list nil ; List of folder names in mh-seq-list
618 'mh-seq-list nil ; Alist of (seq . msgs) nums
619 'mh-seen-list nil ; List of displayed messages
620 'mh-next-direction 'forward ; Direction to move to next message
621 'mh-view-ops () ; Stack that keeps track of the order
622 ; in which narrowing/threading has been
623 ; carried out.
624 'mh-folder-view-stack () ; Stack of previous views of the
625 ; folder.
626 'mh-index-data nil ; If the folder was created by a call
627 ; to mh-search, this contains info
628 ; about the search results.
629 'mh-index-previous-search nil ; folder, indexer, search-regexp
630 'mh-index-msg-checksum-map nil ; msg -> checksum map
631 'mh-index-checksum-origin-map nil ; checksum -> ( orig-folder, orig-msg )
632 'mh-index-sequence-search-flag nil ; folder resulted from sequence search
633 'mh-first-msg-num nil ; Number of first msg in buffer
634 'mh-last-msg-num nil ; Number of last msg in buffer
635 'mh-msg-count nil ; Number of msgs in buffer
636 'mh-mode-line-annotation nil ; Indicates message range
637 'mh-sequence-notation-history (make-hash-table)
638 ; Remember what is overwritten by
639 ; mh-note-seq.
640 'imenu-create-index-function 'mh-index-create-imenu-index
641 ; Setup imenu support
642 'mh-previous-window-config nil) ; Previous window configuration
643 (mh-remove-xemacs-horizontal-scrollbar)
644 (setq truncate-lines t)
645 (auto-save-mode -1)
646 (setq buffer-offer-save t)
647 (mh-make-local-hook (mh-write-file-functions))
648 (add-hook (mh-write-file-functions) 'mh-execute-commands nil t)
649 (make-local-variable 'revert-buffer-function)
650 (make-local-variable 'hl-line-mode) ; avoid pollution
651 (mh-funcall-if-exists hl-line-mode 1)
652 (setq revert-buffer-function 'mh-undo-folder)
653 (add-to-list 'minor-mode-alist '(mh-showing-mode " Show"))
654 (easy-menu-add mh-folder-sequence-menu)
655 (easy-menu-add mh-folder-message-menu)
656 (easy-menu-add mh-folder-folder-menu)
657 (mh-inc-spool-make)
658 (mh-set-help mh-folder-mode-help-messages)
659 (if (and (featurep 'xemacs)
660 font-lock-auto-fontify)
661 (turn-on-font-lock))) ; Force font-lock in XEmacs.
663 \f
665 ;;; MH-Folder Commands
667 ;; Alphabetical.
668 ;; See also mh-comp.el, mh-junk.el, mh-mime.el, mh-print.el,
669 ;; mh-search.el, and mh-seq.el.
671 ;;;###mh-autoload
672 (defun mh-delete-msg (range)
676 placed by the message in the scan window, and the next undeleted
677 message is displayed. If the previous command had been
679 the first undeleted message previous to the message just deleted.
682 message after deleting the message under the cursor.
684 The hook `mh-delete-msg-hook' is called after you mark a message
685 for deletion. For example, a past maintainer of MH-E used this
686 once when he kept statistics on his mail usage.
688 Check the documentation of `mh-interactive-range' to see how
689 RANGE is read in interactive use."
690 (interactive (list (mh-interactive-range "Delete")))
691 (mh-delete-msg-no-motion range)
692 (if (looking-at mh-scan-deleted-msg-regexp)
693 (mh-next-msg)))
695 ;;;###mh-autoload
696 (defun mh-delete-msg-no-motion (range)
697 "Delete RANGE, don't move to next message.
699 This command marks the RANGE for deletion but leaves the cursor
700 at the current message in case you wish to perform other
701 operations on the message.
703 Check the documentation of `mh-interactive-range' to see how
704 RANGE is read in interactive use."
705 (interactive (list (mh-interactive-range "Delete")))
706 (mh-iterate-on-range () range
707 (mh-delete-a-msg nil)))
709 ;;;###mh-autoload
710 (defun mh-execute-commands ()
713 If you've marked messages to be deleted or refiled and you want
714 to go ahead and delete or refile the messages, use this command.
715 Many MH-E commands that may affect the numbering of the
717 will ask if you want to process refiles or deletes first and then
718 either run this command for you or undo the pending refiles and
719 deletes.
721 This function runs `mh-before-commands-processed-hook' before the
722 commands are processed and `mh-after-commands-processed-hook'
723 after the commands are processed."
724 (interactive)
725 (if mh-folder-view-stack (mh-widen t))
726 (mh-process-commands mh-current-folder)
727 (mh-set-scan-mode)
728 (mh-goto-cur-msg) ; after mh-set-scan-mode for efficiency
729 (mh-make-folder-mode-line)
730 t) ; return t for write-file-functions
732 ;;;###mh-autoload
733 (defun mh-first-msg ()
734 "Display first message."
735 (interactive)
736 (goto-char (point-min))
737 (while (and (not (eobp)) (not (looking-at mh-scan-valid-regexp)))
738 (forward-line 1)))
740 ;;;###mh-autoload
741 (defun mh-goto-msg (number &optional no-error-if-no-message dont-show)
744 You can enter the message NUMBER either before or after typing
747 In a program, optional non-nil second argument NO-ERROR-IF-NO-MESSAGE
748 means return nil instead of signaling an error if message does not
749 exist\; in this case, the cursor is positioned near where the message
750 would have been. Non-nil third argument DONT-SHOW means not to show
751 the message."
752 (interactive "NGo to message: ")
753 (setq number (prefix-numeric-value number))
754 (let ((point (point))
755 (return-value t))
756 (goto-char (point-min))
757 (unless (re-search-forward (format (mh-scan-msg-search-regexp) number)
758 nil t)
759 (goto-char point)
760 (unless no-error-if-no-message
761 (error "No message %d" number))
762 (setq return-value nil))
763 (beginning-of-line)
764 (or dont-show (not return-value) (mh-maybe-show number))
765 return-value))
767 ;;;###mh-autoload
768 (defun mh-inc-folder (&optional file folder)
769 "Incorporate new mail into a folder.
771 You can incorporate mail from any file into the current folder by
772 specifying a prefix argument; you'll be prompted for the name of
773 the FILE to use as well as the destination FOLDER
775 The hook `mh-inc-folder-hook' is run after incorporating new
776 mail.
779 instead."
780 (interactive (list (if current-prefix-arg
781 (expand-file-name
782 (read-file-name "inc mail from file: "
783 mh-user-path)))
784 (if current-prefix-arg
785 (mh-prompt-for-folder "inc mail into" mh-inbox t))))
786 (if (not folder)
787 (setq folder mh-inbox))
788 (let ((threading-needed-flag nil))
789 (let ((config (current-window-configuration)))
790 (when (and mh-show-buffer (get-buffer mh-show-buffer))
791 (delete-windows-on mh-show-buffer))
792 (cond ((not (get-buffer folder))
793 (mh-make-folder folder)
794 (setq threading-needed-flag mh-show-threads-flag)
795 (setq mh-previous-window-config config))
796 ((not (eq (current-buffer) (get-buffer folder)))
797 (switch-to-buffer folder)
798 (setq mh-previous-window-config config))))
799 (mh-get-new-mail file)
800 (when (and threading-needed-flag
801 (save-excursion
802 (goto-char (point-min))
803 (or (null mh-large-folder)
804 (not (equal (forward-line (1+ mh-large-folder)) 0))
805 (and (message "Not threading since the number of messages exceeds `mh-large-folder'")
806 nil))))
807 (mh-toggle-threads))
808 (beginning-of-line)
809 (if (and mh-showing-mode (looking-at mh-scan-valid-regexp)) (mh-show))
810 (run-hooks 'mh-inc-folder-hook)))
812 ;;;###mh-autoload
813 (defun mh-last-msg ()
814 "Display last message."
815 (interactive)
816 (goto-char (point-max))
817 (while (and (not (bobp)) (not (looking-at mh-scan-valid-regexp)))
818 (forward-line -1))
819 (mh-recenter nil))
821 ;;;###mh-autoload
822 (defun mh-modify (&optional message)
823 "Edit message.
825 There are times when you need to edit a message. For example, you
826 may need to fix a broken Content-Type header field. You can do
827 this with this command. It displays the raw message in an
828 editable buffer. When you are done editing, save and kill the
829 buffer as you would any other.
831 From a program, edit MESSAGE; nil means edit current message."
832 (interactive)
833 (let* ((message (or message (mh-get-msg-num t)))
834 (msg-filename (mh-msg-filename message))
835 edit-buffer)
836 (when (not (file-exists-p msg-filename))
837 (error "Message %d does not exist" message))
839 ;; Invalidate the show buffer if it is showing the same message that is
840 ;; to be edited.
841 (when (and (buffer-live-p (get-buffer mh-show-buffer))
842 (equal (with-current-buffer mh-show-buffer
843 buffer-file-name)
844 msg-filename))
845 (mh-invalidate-show-buffer))
847 ;; Edit message
848 (find-file msg-filename)
849 (setq edit-buffer (current-buffer))
851 ;; Set buffer properties
852 (mh-letter-mode)
853 (use-local-map text-mode-map)
855 ;; Just show the edit buffer...
856 (delete-other-windows)
857 (switch-to-buffer edit-buffer)))
859 ;;;###mh-autoload
860 (defun mh-next-button (&optional backward-flag)
861 "Go to the next button.
863 If the end of the buffer is reached then the search wraps over to
864 the start of the buffer.
866 If an optional prefix argument BACKWARD-FLAG is given, the cursor
867 will move to the previous button."
868 (interactive (list current-prefix-arg))
869 (unless mh-showing-mode
870 (mh-show))
871 (mh-in-show-buffer (mh-show-buffer)
872 (mh-goto-next-button backward-flag)))
874 ;;;###mh-autoload
875 (defun mh-next-undeleted-msg (&optional count wait-after-complaining-flag)
876 "Display next message.
878 This command can be given a prefix argument COUNT to specify how
879 many unread messages to skip.
881 In a program, pause for a second after printing message if we are
882 at the last undeleted message and optional argument
883 WAIT-AFTER-COMPLAINING-FLAG is non-nil."
884 (interactive "p")
885 (setq mh-next-direction 'forward)
886 (forward-line 1)
887 (cond ((re-search-forward mh-scan-good-msg-regexp nil t count)
888 (beginning-of-line)
889 (mh-maybe-show))
890 (t (forward-line -1)
891 (message "No more undeleted messages")
892 (if wait-after-complaining-flag (sit-for 1)))))
894 ;;;###mh-autoload
895 (defun mh-next-unread-msg (&optional count)
896 "Display next unread message.
898 This command can be given a prefix argument COUNT to specify how
899 many unread messages to skip."
900 (interactive "p")
901 (unless (> count 0)
902 (error "The function `mh-next-unread-msg' expects positive argument"))
903 (setq count (1- count))
904 (let ((unread-sequence (reverse (cdr (assoc mh-unseen-seq mh-seq-list))))
905 (cur-msg (mh-get-msg-num nil)))
906 (cond ((and (not cur-msg) (not (bobp))
907 ;; If we are at the end of the buffer back up one line and go
908 ;; to unread message after that.
909 (progn
910 (forward-line -1)
911 (setq cur-msg (mh-get-msg-num nil)))
912 nil))
913 ((or (null unread-sequence) (not cur-msg))
914 ;; No unread message or there aren't any messages in buffer...
915 (message "No more unread messages"))
916 ((progn
917 ;; Skip messages
918 (while (and unread-sequence (>= cur-msg (car unread-sequence)))
919 (setq unread-sequence (cdr unread-sequence)))
920 (while (> count 0)
921 (setq unread-sequence (cdr unread-sequence))
922 (setq count (1- count)))
923 (not (car unread-sequence)))
924 (message "No more unread messages"))
925 (t (loop for msg in unread-sequence
926 when (mh-goto-msg msg t) return nil
927 finally (message "No more unread messages"))))))
929 ;;;###mh-autoload
930 (defun mh-page-msg (&optional lines)
931 "Display next page in message.
933 You can give this command a prefix argument that specifies the
934 number of LINES to scroll. This command will also show the next
935 undeleted message if it is used at the bottom of a message."
936 (interactive "P")
937 (if mh-showing-mode
938 (if mh-page-to-next-msg-flag
939 (if (equal mh-next-direction 'backward)
940 (mh-previous-undeleted-msg)
941 (mh-next-undeleted-msg))
942 (if (mh-in-show-buffer (mh-show-buffer)
943 (pos-visible-in-window-p (point-max)))
944 (progn
945 (message
946 "End of message (Type %s to read %s undeleted message)"
947 (single-key-description last-input-event)
948 (if (equal mh-next-direction 'backward)
949 "previous"
950 "next"))
951 (setq mh-page-to-next-msg-flag t))
952 (scroll-other-window lines)))
953 (mh-show)))
955 ;;;###mh-autoload
956 (defun mh-prev-button ()
957 "Go to the previous button.
959 If the beginning of the buffer is reached then the search wraps
960 over to the end of the buffer."
961 (interactive)
962 (mh-next-button t))
964 ;;;###mh-autoload
965 (defun mh-previous-page (&optional lines)
966 "Display next page in message.
968 You can give this command a prefix argument that specifies the
969 number of LINES to scroll."
970 (interactive "P")
971 (mh-in-show-buffer (mh-show-buffer)
972 (scroll-down lines)))
974 ;;;###mh-autoload
975 (defun mh-previous-undeleted-msg (&optional count wait-after-complaining-flag)
976 "Display previous message.
978 This command can be given a prefix argument COUNT to specify how
979 many unread messages to skip.
981 In a program, pause for a second after printing message if we are
982 at the last undeleted message and optional argument
983 WAIT-AFTER-COMPLAINING-FLAG is non-nil."
984 (interactive "p")
985 (setq mh-next-direction 'backward)
986 (beginning-of-line)
987 (cond ((re-search-backward mh-scan-good-msg-regexp nil t count)
988 (mh-maybe-show))
989 (t (message "No previous undeleted message")
990 (if wait-after-complaining-flag (sit-for 1)))))
992 ;;;###mh-autoload
993 (defun mh-previous-unread-msg (&optional count)
994 "Display previous unread message.
996 This command can be given a prefix argument COUNT to specify how
997 many unread messages to skip."
998 (interactive "p")
999 (unless (> count 0)
1000 (error "The function `mh-previous-unread-msg' expects positive argument"))
1001 (setq count (1- count))
1002 (let ((unread-sequence (cdr (assoc mh-unseen-seq mh-seq-list)))
1003 (cur-msg (mh-get-msg-num nil)))
1004 (cond ((and (not cur-msg) (not (bobp))
1005 ;; If we are at the end of the buffer back up one line and go
1006 ;; to unread message after that.
1007 (progn
1008 (forward-line -1)
1009 (setq cur-msg (mh-get-msg-num nil)))
1010 nil))
1011 ((or (null unread-sequence) (not cur-msg))
1012 ;; No unread message or there aren't any messages in buffer...
1013 (message "No more unread messages"))
1014 ((progn
1015 ;; Skip count messages...
1016 (while (and unread-sequence (>= (car unread-sequence) cur-msg))
1017 (setq unread-sequence (cdr unread-sequence)))
1018 (while (> count 0)
1019 (setq unread-sequence (cdr unread-sequence))
1020 (setq count (1- count)))
1021 (not (car unread-sequence)))
1022 (message "No more unread messages"))
1023 (t (loop for msg in unread-sequence
1024 when (mh-goto-msg msg t) return nil
1025 finally (message "No more unread messages"))))))
1027 ;;;###mh-autoload
1028 (defun mh-quit ()
1029 "Quit the current MH-E folder.
1031 When you want to quit using MH-E and go back to editing, you can use
1032 this command. This buries the buffers of the current MH-E folder and
1033 restores the buffers that were present when you first ran
1037 again.
1039 The two hooks `mh-before-quit-hook' and `mh-quit-hook' are called by
1040 this function. The former one is called before the quit occurs, so you
1041 might use it to perform any MH-E operations; you could perform some
1042 query and abort the quit or call `mh-execute-commands', for example.
1043 The latter is not run in an MH-E context, so you might use it to
1044 modify the window setup."
1045 (interactive)
1046 (run-hooks 'mh-before-quit-hook)
1047 (let ((show-buffer (get-buffer mh-show-buffer)))
1048 (when show-buffer
1049 (kill-buffer show-buffer)))
1050 (mh-update-sequences)
1051 (mh-destroy-postponed-handles)
1052 (bury-buffer (current-buffer))
1054 ;; Delete all MH-E temporary and working buffers.
1055 (dolist (buffer (buffer-list))
1058 (kill-buffer buffer)))
1060 (if mh-previous-window-config
1061 (set-window-configuration mh-previous-window-config))
1062 (run-hooks 'mh-quit-hook))
1064 ;;;###mh-autoload
1065 (defun mh-refile-msg (range folder &optional dont-update-last-destination-flag)
1066 "Refile (output) RANGE into FOLDER.
1068 You are prompted for the folder name. Note that this command can also
1069 be used to create folders. If you specify a folder that does not
1070 exist, you will be prompted to create it.
1072 The hook `mh-refile-msg-hook' is called after a message is marked to
1073 be refiled.
1075 Check the documentation of `mh-interactive-range' to see how RANGE is
1076 read in interactive use.
1078 In a program, the variables `mh-last-destination' and
1079 `mh-last-destination-folder' are not updated if
1080 DONT-UPDATE-LAST-DESTINATION-FLAG is non-nil."
1081 (interactive (list (mh-interactive-range "Refile")
1082 (intern (mh-prompt-for-refile-folder))))
1083 (unless dont-update-last-destination-flag
1084 (setq mh-last-destination (cons 'refile folder)
1085 mh-last-destination-folder mh-last-destination))
1086 (mh-iterate-on-range () range
1087 (mh-refile-a-msg nil folder))
1088 (when (looking-at mh-scan-refiled-msg-regexp) (mh-next-msg)))
1090 ;;;###mh-autoload
1091 (defun mh-refile-or-write-again (range &optional interactive-flag)
1092 "Repeat last output command.
1094 If you are refiling several messages into the same folder, you
1095 can use this command to repeat the last
1097 You can use a range.
1099 Check the documentation of `mh-interactive-range' to see how RANGE is
1100 read in interactive use.
1102 In a program, a non-nil INTERACTIVE-FLAG means that the function was
1103 called interactively."
1104 (interactive (list (mh-interactive-range "Redo") t))
1105 (if (null mh-last-destination)
1106 (error "No previous refile or write"))
1107 (cond ((eq (car mh-last-destination) 'refile)
1108 (mh-refile-msg range (cdr mh-last-destination))
1109 (message "Destination folder: %s" (cdr mh-last-destination)))
1110 (t
1111 (mh-iterate-on-range msg range
1112 (apply 'mh-write-msg-to-file msg (cdr mh-last-destination)))
1113 (mh-next-msg interactive-flag))))
1115 ;;;###mh-autoload
1116 (defun mh-rescan-folder (&optional range dont-exec-pending)
1120 processing your new mail for the first time. If you don't want to
1121 rescan the entire folder, this command will accept a RANGE. Check the
1122 documentation of `mh-interactive-range' to see how RANGE is read in
1123 interactive use.
1125 This command will ask if you want to process refiles or deletes first
1127 pending refiles and deletes.
1129 In a program, the processing of outstanding commands is not performed
1130 if DONT-EXEC-PENDING is non-nil."
1131 (interactive (list (if current-prefix-arg
1132 (mh-read-range "Rescan" mh-current-folder t nil t
1133 mh-interpret-number-as-range-flag)
1134 nil)))
1135 (setq mh-next-direction 'forward)
1136 (let ((threaded-flag (memq 'unthread mh-view-ops))
1137 (msg-num (mh-get-msg-num nil)))
1138 (mh-scan-folder mh-current-folder (or range "all") dont-exec-pending)
1139 ;; If there isn't a cur sequence, mh-scan-folder goes to the first message.
1140 ;; Try to stay where we were.
1141 (if (null (car (mh-seq-to-msgs 'cur)))
1142 (mh-goto-msg msg-num t t))
1143 (cond (threaded-flag (mh-toggle-threads))
1144 (mh-index-data (mh-index-insert-folder-headers)))))
1146 (defun mh-show-mouse (event)
1147 "Move point to mouse EVENT and show message."
1148 (interactive "e")
1149 (mouse-set-point event)
1150 (mh-show))
1152 ;;;###mh-autoload
1153 (defun mh-toggle-showing ()
1154 "Toggle between MH-Folder and MH-Folder Show modes.
1156 This command switches between MH-Folder mode and MH-Folder Show
1157 mode. MH-Folder mode turns off the associated show buffer so that
1158 you can perform operations on the messages quickly without
1159 reading them. This is an excellent way to prune out your junk
1160 mail or to refile a group of messages to another folder for later
1161 examination."
1162 (interactive)
1163 (if mh-showing-mode
1164 (mh-set-scan-mode)
1165 (mh-show)))
1167 ;;;###mh-autoload
1168 (defun mh-undo (range)
1169 "Undo pending deletes or refiles in RANGE.
1171 If you've deleted a message or refiled it, but changed your mind,
1172 you can cancel the action before you've executed it. Use this
1173 command to undo a refile on or deletion of a single message. You
1174 can also undo refiles and deletes for messages that are found in
1175 a given RANGE.
1177 Check the documentation of `mh-interactive-range' to see how
1178 RANGE is read in interactive use."
1179 (interactive (list (mh-interactive-range "Undo")))
1180 (cond ((numberp range)
1181 (let ((original-position (point)))
1182 (beginning-of-line)
1183 (while (not (or (looking-at mh-scan-deleted-msg-regexp)
1184 (looking-at mh-scan-refiled-msg-regexp)
1185 (and (eq mh-next-direction 'forward) (bobp))
1186 (and (eq mh-next-direction 'backward)
1187 (save-excursion (forward-line) (eobp)))))
1188 (forward-line (if (eq mh-next-direction 'forward) -1 1)))
1189 (if (or (looking-at mh-scan-deleted-msg-regexp)
1190 (looking-at mh-scan-refiled-msg-regexp))
1191 (progn
1192 (mh-undo-msg (mh-get-msg-num t))
1193 (mh-maybe-show))
1194 (goto-char original-position)
1195 (error "Nothing to undo"))))
1196 (t (mh-iterate-on-range () range
1197 (mh-undo-msg nil))))
1198 (if (not (mh-outstanding-commands-p))
1199 (mh-set-folder-modified-p nil)))
1201 ;;;###mh-autoload
1202 (defun mh-visit-folder (folder &optional range index-data)
1203 "Visit FOLDER.
1205 When you want to read the messages that you have refiled into folders,
1206 use this command to visit the folder. You are prompted for the folder
1207 name.
1209 The folder buffer will show just unseen messages if there are any;
1210 otherwise, it will show all the messages in the buffer as long there
1211 are fewer than `mh-large-folder' messages. If there are more, then you
1212 are prompted for a range of messages to scan.
1214 You can provide a prefix argument in order to specify a RANGE of
1215 messages to show when you visit the folder. In this case, regions are
1216 not used to specify the range and `mh-large-folder' is ignored. Check
1217 the documentation of `mh-interactive-range' to see how RANGE is read
1218 in interactive use.
1220 Note that this command can also be used to create folders. If you
1221 specify a folder that does not exist, you will be prompted to create
1222 it.
1226 If, in a program, RANGE is nil (the default), then all messages in
1227 FOLDER are displayed. If an index buffer is being created then
1228 INDEX-DATA is used to initialize the index buffer specific data
1229 structures."
1230 (interactive (let ((folder-name (mh-prompt-for-folder "Visit" mh-inbox t)))
1231 (list folder-name
1232 (mh-read-range "Scan" folder-name t nil
1233 current-prefix-arg
1234 mh-interpret-number-as-range-flag))))
1235 (let ((config (current-window-configuration))
1236 (current-buffer (current-buffer))
1237 (threaded-view-flag mh-show-threads-flag))
1238 (delete-other-windows)
1239 (when (get-buffer folder)
1240 (with-current-buffer folder
1241 (setq threaded-view-flag (memq 'unthread mh-view-ops))))
1242 (when index-data
1243 (mh-make-folder folder)
1244 (setq mh-index-data (car index-data)
1245 mh-index-msg-checksum-map (make-hash-table :test #'equal)
1246 mh-index-checksum-origin-map (make-hash-table :test #'equal))
1247 (mh-index-update-maps folder (cadr index-data))
1248 (mh-index-create-sequences))
1249 (mh-scan-folder folder (or range "all"))
1250 (cond ((and threaded-view-flag
1251 (save-excursion
1252 (goto-char (point-min))
1253 (or (null mh-large-folder)
1254 (not (equal (forward-line (1+ mh-large-folder)) 0))
1255 (and (message "Not threading since the number of messages exceeds `mh-large-folder'")
1256 nil))))
1257 (mh-toggle-threads))
1258 (mh-index-data
1259 (mh-index-insert-folder-headers)))
1260 (unless (eq current-buffer (current-buffer))
1261 (setq mh-previous-window-config config)))
1262 nil)
1264 ;;;###mh-autoload
1265 (defun mh-write-msg-to-file (message file no-header)
1268 You are prompted for the filename. If the file already exists,
1269 the message is appended to it. You can also write the message to
1270 the file without the header by specifying a prefix argument
1271 NO-HEADER. Subsequent writes to the same file can be made with
1273 (interactive
1274 (list (mh-get-msg-num t)
1275 (let ((default-dir (if (eq 'write (car mh-last-destination-write))
1276 (file-name-directory
1277 (car (cdr mh-last-destination-write)))
1278 default-directory)))
1279 (read-file-name (format "Save message%s in file: "
1280 (if current-prefix-arg " body" ""))
1281 default-dir
1282 (if (eq 'write (car mh-last-destination-write))
1283 (car (cdr mh-last-destination-write))
1284 (expand-file-name "mail.out" default-dir))))
1285 current-prefix-arg))
1286 (let ((msg-file-to-output (mh-msg-filename message))
1287 (output-file (mh-expand-file-name file)))
1288 (setq mh-last-destination (list 'write file (if no-header 'no-header))
1289 mh-last-destination-write mh-last-destination)
1290 (with-current-buffer (get-buffer-create mh-temp-buffer)
1291 (erase-buffer)
1292 (insert-file-contents msg-file-to-output)
1293 (goto-char (point-min))
1295 (append-to-file (point) (point-max) output-file))))
1297 ;;;###mh-autoload
1298 (defun mh-update-sequences ()
1299 "Flush MH-E's state out to MH.
1301 This function updates the sequence specified by your
1305 (interactive)
1306 ;; mh-update-sequences is the opposite of mh-read-folder-sequences,
1307 ;; which updates MH-E's state from MH.
1308 (let ((folder-set (mh-update-unseen))
1309 (new-cur (mh-get-msg-num nil)))
1310 (if new-cur
1311 (let ((seq-entry (mh-find-seq 'cur)))
1312 (mh-remove-cur-notation)
1313 (setcdr seq-entry
1314 (list new-cur)) ;delete-seq-locally, add-msgs-to-seq
1315 (mh-define-sequence 'cur (list new-cur))
1316 (beginning-of-line)
1317 (if (looking-at mh-scan-good-msg-regexp)
1318 (mh-notate-cur)))
1319 (or folder-set
1320 (save-excursion
1321 ;; psg - mh-current-folder is nil if mh-summary-height < 4 !
1322 ;; So I added this sanity check.
1323 (if (stringp mh-current-folder)
1324 (mh-exec-cmd-quiet t "folder" mh-current-folder "-fast")
1325 (mh-exec-cmd-quiet t "folder" "-fast")))))))
1327 \f
1329 ;;; Support Routines
1331 (defun mh-get-new-mail (maildrop-name)
1332 "Read new mail from MAILDROP-NAME into the current buffer.
1333 Return in the current buffer."
1334 (let ((point-before-inc (point))
1335 (folder mh-current-folder)
1336 (new-mail-flag nil))
1337 (with-mh-folder-updating (t)
1338 (if maildrop-name
1339 (message "inc %s -file %s..." folder maildrop-name)
1340 (message "inc %s..." folder))
1341 (setq mh-next-direction 'forward)
1342 (goto-char (point-max))
1343 (mh-remove-cur-notation)
1344 (let ((start-of-inc (point)))
1345 (if maildrop-name
1346 ;; I think MH 5 used "-ms-file" instead of "-file",
1347 ;; which would make inc'ing from maildrops fail.
1348 (mh-exec-cmd-output mh-inc-prog nil folder
1349 (mh-scan-format)
1350 "-file" (expand-file-name maildrop-name)
1351 "-width" (window-width)
1352 "-truncate")
1353 (mh-exec-cmd-output mh-inc-prog nil
1354 (mh-scan-format)
1355 "-width" (window-width)))
1356 (if maildrop-name
1357 (message "inc %s -file %s...done" folder maildrop-name)
1358 (message "inc %s...done" folder))
1359 (goto-char start-of-inc)
1360 (cond ((save-excursion
1361 (re-search-forward "^inc: no mail" nil t))
1362 (message "No new mail%s%s" (if maildrop-name " in " "")
1363 (if maildrop-name maildrop-name "")))
1364 ((and (when mh-folder-view-stack
1365 (let ((saved-text (buffer-substring-no-properties
1366 start-of-inc (point-max))))
1367 (delete-region start-of-inc (point-max))
1368 (unwind-protect (mh-widen t)
1369 (mh-remove-cur-notation)
1370 (goto-char (point-max))
1371 (setq start-of-inc (point))
1372 (insert saved-text)
1373 (goto-char start-of-inc))))
1374 nil))
1375 ((re-search-forward "^inc:" nil t) ; Error messages
1376 (error "Error incorporating mail"))
1377 ((and
1378 (equal mh-scan-format-file t)
1379 mh-adaptive-cmd-note-flag
1380 ;; Have we reached an edge condition?
1381 (save-excursion
1382 (re-search-forward mh-scan-msg-overflow-regexp nil 0 1))
1383 (setq start-of-inc (mh-generate-new-cmd-note folder))
1384 nil))
1385 (t
1386 (setq new-mail-flag t)))
1387 (keep-lines mh-scan-valid-regexp) ; Flush random scan lines
1388 (let* ((sequences (mh-read-folder-sequences folder t))
1389 (new-cur (assoc 'cur sequences))
1390 (new-unseen (assoc mh-unseen-seq sequences)))
1391 (unless (assoc 'cur mh-seq-list)
1392 (push (list 'cur) mh-seq-list))
1393 (unless (assoc mh-unseen-seq mh-seq-list)
1394 (push (list mh-unseen-seq) mh-seq-list))
1395 (setcdr (assoc 'cur mh-seq-list) (cdr new-cur))
1396 (setcdr (assoc mh-unseen-seq mh-seq-list) (cdr new-unseen)))
1397 (when (equal (point-max) start-of-inc)
1398 (mh-notate-cur))
1399 (if new-mail-flag
1400 (progn
1401 (mh-make-folder-mode-line)
1402 (when (mh-speed-flists-active-p)
1403 (mh-speed-flists t mh-current-folder))
1404 (when (memq 'unthread mh-view-ops)
1405 (mh-thread-inc folder start-of-inc))
1406 (mh-goto-cur-msg))
1407 (goto-char point-before-inc))
1408 (mh-notate-user-sequences (cons start-of-inc (point-max)))))))
1410 (defun mh-generate-new-cmd-note (folder)
1411 "Fix the `mh-cmd-note' value for this FOLDER.
1413 After doing an `mh-get-new-mail' operation in this FOLDER, at least
1414 one line that looks like a truncated message number was found.
1416 Remove the text added by the last `mh-inc' command. It should be the
1417 messages cur-last. Call `mh-set-cmd-note', adjusting the notation
1418 column with the width of the largest message number in FOLDER.
1420 Reformat the message number width on each line in the buffer and trim
1421 the line length to fit in the window.
1423 Rescan the FOLDER in the range cur-last in order to display the
1424 messages that were removed earlier. They should all fit in the scan
1425 line now with no message truncation."
1426 (save-excursion
1427 (let ((maxcol (1- (window-width)))
1428 (old-cmd-note mh-cmd-note)
1429 mh-cmd-note-fmt
1430 msgnum)
1431 ;; Nuke all of the lines just added by the last inc
1432 (delete-char (- (point-max) (point)))
1433 ;; Update the current buffer to reflect the new mh-cmd-note
1434 ;; value needed to display messages.
1435 (mh-set-cmd-note (mh-msg-num-width-to-column (mh-msg-num-width folder)))
1436 (setq mh-cmd-note-fmt (concat "%" (format "%d" mh-cmd-note) "d"))
1437 ;; Cleanup the messages that are in the buffer right now
1438 (goto-char (point-min))
1439 (cond ((memq 'unthread mh-view-ops)
1440 (mh-thread-add-spaces (- mh-cmd-note old-cmd-note)))
1441 (t (while (re-search-forward (mh-scan-msg-number-regexp) nil 0 1)
1442 ;; reformat the number to fix in mh-cmd-note columns
1443 (setq msgnum (string-to-number
1444 (buffer-substring
1445 (match-beginning 1) (match-end 1))))
1446 (replace-match (format mh-cmd-note-fmt msgnum))
1447 ;; trim the line to fix in the window
1448 (end-of-line)
1449 (let ((eol (point)))
1450 (move-to-column maxcol)
1451 (if (<= (point) eol)
1452 (delete-char (- eol (point))))))))
1453 ;; now re-read the lost messages
1454 (goto-char (point-max))
1455 (prog1 (point)
1456 (mh-regenerate-headers "cur-last" t)))))
1458 ;;;###mh-autoload
1459 (defun mh-goto-cur-msg (&optional minimal-changes-flag)
1460 "Position the cursor at the current message.
1461 When optional argument MINIMAL-CHANGES-FLAG is non-nil, the
1462 function doesn't recenter the folder buffer."
1463 (let ((cur-msg (car (mh-seq-to-msgs 'cur))))
1464 (cond ((and cur-msg
1465 (mh-goto-msg cur-msg t t))
1466 (unless minimal-changes-flag
1467 (mh-notate-cur)
1468 (mh-recenter 0)
1469 (mh-maybe-show cur-msg)))
1470 (t
1471 (setq overlay-arrow-position nil)
1472 (message "No current message")))))
1474 ;;;###mh-autoload
1475 (defun mh-recenter (arg)
1476 "Like recenter but with three improvements:
1478 - At the end of the buffer it tries to show fewer empty lines.
1480 - operates only if the current buffer is in the selected window.
1481 (Commands like `save-some-buffers' can make this false.)
1483 - nil ARG means recenter as if prefix argument had been given."
1484 (cond ((not (eq (get-buffer-window (current-buffer)) (selected-window)))
1485 nil)
1486 ((= (point-max) (save-excursion
1487 (forward-line (- (/ (window-height) 2) 2))
1488 (point)))
1489 (let ((lines-from-end 2))
1490 (save-excursion
1491 (while (> (point-max) (progn (forward-line) (point)))
1492 (incf lines-from-end)))
1493 (recenter (- lines-from-end))))
1494 ;; '(4) is the same as C-u prefix argument.
1495 (t (recenter (or arg '(4))))))
1497 (defun mh-update-unseen ()
1498 "Synchronize the unseen sequence with MH.
1499 Return non-nil if the MH folder was set.
1500 The hook `mh-unseen-updated-hook' is called after the unseen sequence
1501 is updated."
1502 (if mh-seen-list
1503 (let* ((unseen-seq (mh-find-seq mh-unseen-seq))
1504 (unseen-msgs (mh-seq-msgs unseen-seq)))
1505 (if unseen-msgs
1506 (progn
1507 (mh-undefine-sequence mh-unseen-seq mh-seen-list)
1508 (run-hooks 'mh-unseen-updated-hook)
1509 (while mh-seen-list
1510 (setq unseen-msgs (delq (car mh-seen-list) unseen-msgs))
1511 (setq mh-seen-list (cdr mh-seen-list)))
1512 (setcdr unseen-seq unseen-msgs)
1513 t) ;since we set the folder
1514 (setq mh-seen-list nil)))))
1516 ;;;###mh-autoload
1517 (defun mh-outstanding-commands-p ()
1518 "Return non-nil if there are outstanding deletes or refiles."
1519 (save-excursion
1520 (when (eq major-mode 'mh-show-mode)
1521 (set-buffer mh-show-folder-buffer))
1522 (or mh-delete-list mh-refile-list)))
1524 ;;;###mh-autoload
1525 (defun mh-set-folder-modified-p (flag)
1526 "Mark current folder as modified or unmodified according to FLAG."
1527 (set-buffer-modified-p flag))
1529 (defun mh-process-commands (folder)
1530 "Process outstanding commands for FOLDER.
1532 This function runs `mh-before-commands-processed-hook' before the
1533 commands are processed and `mh-after-commands-processed-hook'
1534 after the commands are processed."
1535 (message "Processing deletes and refiles for %s..." folder)
1536 (set-buffer folder)
1537 (with-mh-folder-updating (nil)
1538 ;; Run the before hook -- the refile and delete lists are still valid
1539 (run-hooks 'mh-before-commands-processed-hook)
1541 ;; Update the unseen sequence if it exists
1542 (mh-update-unseen)
1544 (let ((redraw-needed-flag mh-index-data)
1545 (folders-changed (list mh-current-folder))
1546 (seq-map (and mh-refile-list mh-refile-preserves-sequences-flag
1547 (mh-create-sequence-map mh-seq-list)))
1548 (dest-map (and mh-refile-list mh-refile-preserves-sequences-flag
1549 (make-hash-table))))
1550 ;; Remove invalid scan lines if we are in an index folder and then remove
1551 ;; the real messages
1552 (when mh-index-data
1553 (mh-index-delete-folder-headers)
1554 (setq folders-changed
1555 (append folders-changed (mh-index-execute-commands))))
1557 ;; Then refile messages
1558 (mh-mapc #'(lambda (folder-msg-list)
1559 (let* ((dest-folder (symbol-name (car folder-msg-list)))
1560 (last (car (mh-translate-range dest-folder "last")))
1561 (msgs (cdr folder-msg-list)))
1562 (push dest-folder folders-changed)
1563 (setq redraw-needed-flag t)
1564 (apply #'mh-exec-cmd
1565 "refile" "-src" folder dest-folder
1566 (mh-coalesce-msg-list msgs))
1567 (mh-delete-scan-msgs msgs)
1568 ;; Preserve sequences in destination folder...
1569 (when mh-refile-preserves-sequences-flag
1570 (clrhash dest-map)
1571 (loop for i from (1+ (or last 0))
1572 for msg in (sort (copy-sequence msgs) #'<)
1573 do (loop for seq-name in (gethash msg seq-map)
1574 do (push i (gethash seq-name dest-map))))
1575 (maphash
1576 #'(lambda (seq msgs)
1577 ;; Can't be run in the background, since the
1578 ;; current folder is changed by mark this could
1579 ;; lead to a race condition with the next refile.
1580 (apply #'mh-exec-cmd "mark"
1581 "-sequence" (symbol-name seq) dest-folder
1582 "-add" (mapcar #'(lambda (x) (format "%s" x))
1583 (mh-coalesce-msg-list msgs))))
1584 dest-map))))
1585 mh-refile-list)
1586 (setq mh-refile-list ())
1588 ;; Now delete messages
1589 (cond (mh-delete-list
1590 (setq redraw-needed-flag t)
1591 (apply 'mh-exec-cmd "rmm" folder
1592 (mh-coalesce-msg-list mh-delete-list))
1593 (mh-delete-scan-msgs mh-delete-list)
1594 (setq mh-delete-list nil)))
1596 ;; Don't need to remove sequences since delete and refile do so.
1597 ;; Mark cur message
1598 (if (> (buffer-size) 0)
1599 (mh-define-sequence 'cur (list (or (mh-get-msg-num nil) "last"))))
1601 ;; Redraw folder buffer if needed
1602 (when (and redraw-needed-flag)
1603 (when (mh-speed-flists-active-p)
1604 (apply #'mh-speed-flists t folders-changed))
1605 (cond ((memq 'unthread mh-view-ops) (mh-thread-inc folder (point-max)))
1606 (mh-index-data (mh-index-insert-folder-headers))))
1608 (and (buffer-file-name (get-buffer mh-show-buffer))
1609 (not (file-exists-p (buffer-file-name (get-buffer mh-show-buffer))))
1610 ;; If "inc" were to put a new msg in this file,
1611 ;; we would not notice, so mark it invalid now.
1612 (mh-invalidate-show-buffer))
1614 (setq mh-seq-list (mh-read-folder-sequences mh-current-folder nil))
1615 (mh-remove-all-notation)
1616 (mh-notate-user-sequences)
1618 ;; Run the after hook -- now folders-changed is valid,
1619 ;; but not the lists of specific messages.
1620 (let ((mh-folders-changed folders-changed))
1621 (run-hooks 'mh-after-commands-processed-hook)))
1623 (message "Processing deletes and refiles for %s...done" folder)))
1625 (defun mh-delete-scan-msgs (msgs)
1626 "Delete the scan listing lines for MSGS."
1627 (save-excursion
1628 (while msgs
1629 (when (mh-goto-msg (car msgs) t t)
1630 (when (memq 'unthread mh-view-ops)
1631 (mh-thread-forget-message (car msgs)))
1632 (mh-delete-line 1))
1633 (setq msgs (cdr msgs)))))
1635 (defun mh-set-scan-mode ()
1636 "Display the scan listing buffer, but do not show a message."
1637 (if (get-buffer mh-show-buffer)
1638 (delete-windows-on mh-show-buffer))
1639 (mh-showing-mode 0)
1640 (force-mode-line-update)
1641 (if mh-recenter-summary-flag
1642 (mh-recenter nil)))
1644 ;;;###mh-autoload
1645 (defun mh-make-folder-mode-line (&optional ignored)
1646 "Set the fields of the mode line for a folder buffer.
1647 The optional argument is now obsolete and IGNORED. It used to be
1648 used to pass in what is now stored in the buffer-local variable
1649 `mh-mode-line-annotation'."
1650 (save-excursion
1651 (save-window-excursion
1652 (mh-first-msg)
1653 (let ((new-first-msg-num (mh-get-msg-num nil)))
1654 (when (or (not (memq 'unthread mh-view-ops))
1655 (null mh-first-msg-num)
1656 (null new-first-msg-num)
1657 (< new-first-msg-num mh-first-msg-num))
1658 (setq mh-first-msg-num new-first-msg-num)))
1659 (mh-last-msg)
1660 (let ((new-last-msg-num (mh-get-msg-num nil)))
1661 (when (or (not (memq 'unthread mh-view-ops))
1662 (null mh-last-msg-num)
1663 (null new-last-msg-num)
1664 (> new-last-msg-num mh-last-msg-num))
1665 (setq mh-last-msg-num new-last-msg-num)))
1666 (setq mh-msg-count (if mh-first-msg-num
1667 (count-lines (point-min) (point-max))
1668 0))
1669 (setq mode-line-buffer-identification
1670 (list (format " {%%b%s} %s msg%s"
1671 (if mh-mode-line-annotation
1672 (format "/%s" mh-mode-line-annotation)
1673 "")
1674 (if (zerop mh-msg-count)
1675 "no"
1676 (format "%d" mh-msg-count))
1677 (if (zerop mh-msg-count)
1678 "s"
1679 (cond ((> mh-msg-count 1)
1680 (format "s (%d-%d)" mh-first-msg-num
1681 mh-last-msg-num))
1682 (mh-first-msg-num
1683 (format " (%d)" mh-first-msg-num))
1684 (""))))))
1685 (mh-logo-display))))
1687 ;;;###mh-autoload
1688 (defun mh-scan-folder (folder range &optional dont-exec-pending)
1689 "Scan FOLDER over RANGE.
1691 After the scan is performed, switch to the buffer associated with
1692 FOLDER.
1694 Check the documentation of `mh-interactive-range' to see how RANGE is
1695 read in interactive use.
1697 The processing of outstanding commands is not performed if
1698 DONT-EXEC-PENDING is non-nil."
1699 (when (stringp range)
1701 (cond ((null (get-buffer folder))
1702 (mh-make-folder folder))
1703 (t
1704 (unless dont-exec-pending
1705 (mh-process-or-undo-commands folder)
1706 (mh-reset-threads-and-narrowing))
1707 (switch-to-buffer folder)))
1708 (mh-regenerate-headers range)
1709 (if (zerop (buffer-size))
1710 (if (equal range "all")
1711 (message "Folder %s is empty" folder)
1712 (message "No messages in %s, range %s" folder range))
1713 (mh-goto-cur-msg))
1714 (when (mh-outstanding-commands-p)
1715 (mh-notate-deleted-and-refiled)))
1717 ;;;###mh-autoload
1718 (defun mh-process-or-undo-commands (folder)
1719 "If FOLDER has outstanding commands, then either process or discard them.
1720 Called by functions like `mh-sort-folder', so also invalidate
1721 show buffer."
1722 (set-buffer folder)
1723 (if (mh-outstanding-commands-p)
1724 (if (or mh-do-not-confirm-flag
1725 (y-or-n-p
1726 "Process outstanding deletes and refiles? "))
1727 (mh-process-commands folder)
1728 (set-buffer folder)
1729 (mh-undo-folder)))
1730 (mh-update-unseen)
1731 (mh-invalidate-show-buffer))
1733 ;;;###mh-autoload
1734 (defun mh-regenerate-headers (range &optional update)
1735 "Scan folder over RANGE.
1736 If UPDATE, append the scan lines, otherwise replace."
1737 (let ((folder mh-current-folder)
1738 (range (if (and range (atom range)) (list range) range))
1739 scan-start)
1740 (message "Scanning %s..." folder)
1741 (mh-remove-all-notation)
1742 (with-mh-folder-updating (nil)
1743 (if update
1744 (goto-char (point-max))
1745 (delete-region (point-min) (point-max))
1746 (if mh-adaptive-cmd-note-flag
1747 (mh-set-cmd-note (mh-msg-num-width-to-column (mh-msg-num-width
1748 folder)))))
1749 (setq scan-start (point))
1750 (apply #'mh-exec-cmd-output
1751 mh-scan-prog nil
1752 (mh-scan-format)
1753 "-noclear" "-noheader"
1754 "-width" (window-width)
1755 folder range)
1756 (goto-char scan-start)
1757 (cond ((looking-at "scan: no messages in")
1758 (keep-lines mh-scan-valid-regexp)) ; Flush random scan lines
1759 ((looking-at (if (mh-variant-p 'gnu-mh)
1760 "scan: message set .* does not exist"
1761 "scan: bad message list "))
1762 (keep-lines mh-scan-valid-regexp))
1763 ((looking-at "scan: ")) ; Keep error messages
1764 (t
1765 (keep-lines mh-scan-valid-regexp))) ; Flush random scan lines
1766 (setq mh-seq-list (mh-read-folder-sequences folder nil))
1767 (mh-notate-user-sequences)
1768 (or update
1769 (setq mh-mode-line-annotation
1770 (if (equal range '("all"))
1771 nil
1772 mh-partial-folder-mode-line-annotation)))
1773 (mh-make-folder-mode-line))
1774 (message "Scanning %s...done" folder)))
1776 ;;;###mh-autoload
1777 (defun mh-reset-threads-and-narrowing ()
1778 "Reset all variables pertaining to threads and narrowing.
1779 Also removes all content from the folder buffer."
1780 (setq mh-view-ops ())
1781 (setq mh-folder-view-stack ())
1782 (setq mh-thread-scan-line-map-stack ())
1783 (let ((buffer-read-only nil)) (erase-buffer)))
1785 (defun mh-make-folder (name)
1786 "Create a new mail folder called NAME.
1787 Make it the current folder."
1788 (switch-to-buffer name)
1789 (setq buffer-read-only nil)
1790 (erase-buffer)
1791 (if mh-adaptive-cmd-note-flag
1792 (mh-set-cmd-note (mh-msg-num-width-to-column (mh-msg-num-width name))))
1793 (setq buffer-read-only t)
1794 (mh-folder-mode)
1795 (mh-set-folder-modified-p nil)
1796 (setq buffer-file-name mh-folder-filename)
1797 (when (and (not mh-index-data)
1798 (file-exists-p (concat buffer-file-name mh-index-data-file)))
1799 (mh-index-read-data))
1800 (mh-make-folder-mode-line))
1802 ;;;###mh-autoload
1803 (defun mh-next-msg (&optional wait-after-complaining-flag)
1804 "Move backward or forward to the next undeleted message in the buffer.
1805 If optional argument WAIT-AFTER-COMPLAINING-FLAG is non-nil and
1806 we are at the last message, then wait for a second after telling
1807 the user that there aren't any more unread messages."
1808 (if (eq mh-next-direction 'forward)
1809 (mh-next-undeleted-msg 1 wait-after-complaining-flag)
1810 (mh-previous-undeleted-msg 1 wait-after-complaining-flag)))
1812 ;;;###mh-autoload
1813 (defun mh-prompt-for-refile-folder ()
1814 "Prompt the user for a folder in which the message should be filed.
1815 The folder is returned as a string.
1817 The default folder name is generated by the option
1818 `mh-default-folder-for-message-function' if it is non-nil or
1819 `mh-folder-from-address'."
1820 (mh-prompt-for-folder
1821 "Destination"
1822 (let ((refile-file (ignore-errors (mh-msg-filename (mh-get-msg-num t)))))
1823 (if (null refile-file) ""
1824 (with-current-buffer (get-buffer-create mh-temp-buffer)
1825 (erase-buffer)
1826 (insert-file-contents refile-file)
1827 (or (and mh-default-folder-for-message-function
1828 (let ((buffer-file-name refile-file))
1829 (funcall mh-default-folder-for-message-function)))
1830 (mh-folder-from-address)
1831 (and (eq 'refile (car mh-last-destination-folder))
1832 (symbol-name (cdr mh-last-destination-folder)))
1833 ""))))
1834 t))
1836 ;;;###mh-autoload
1837 (defun mh-folder-from-address ()
1838 "Derive folder name from sender.
1840 The name of the folder is derived as follows:
1842 a) The folder name associated with the first address found in
1843 the list `mh-default-folder-list' is used. Each element in
1845 turned on, then the address is checked against the recipient
1846 instead of the sender. This is useful for mailing lists.
1848 b) An alias prefixed by `mh-default-folder-prefix'
1849 corresponding to the address is used. The prefix is used to
1850 prevent clutter in your mail directory.
1852 Return nil if a folder name was not derived, or if the variable
1853 `mh-default-folder-must-exist-flag' is t and the folder does not
1854 exist."
1855 ;; Loop for all entries in mh-default-folder-list
1856 (save-restriction
1857 (goto-char (point-min))
1859 (narrow-to-region (point-min) (point))
1860 (let ((to/cc (concat (or (message-fetch-field "to") "") ", "
1861 (or (message-fetch-field "cc") "")))
1862 (from (or (message-fetch-field "from") ""))
1863 folder-name)
1864 (setq folder-name
1865 (loop for list in mh-default-folder-list
1866 when (string-match (nth 0 list) (if (nth 2 list) to/cc from))
1867 return (nth 1 list)
1868 finally return nil))
1870 ;; Make sure a result from `mh-default-folder-list' begins with "+"
1871 ;; since 'mh-expand-file-name below depends on it
1872 (when (and folder-name (not (eq (aref folder-name 0) ?+)))
1873 (setq folder-name (concat "+" folder-name)))
1875 ;; If not, is there an alias for the address?
1876 (when (not folder-name)
1877 (let* ((from-header (mh-extract-from-header-value))
1878 (address (and from-header
1879 (nth 1 (mail-extract-address-components
1880 from-header))))
1881 (alias (and address (mh-alias-address-to-alias address))))
1882 (when alias
1883 (setq folder-name
1884 (and alias (concat "+" mh-default-folder-prefix alias))))))
1886 ;; If mh-default-folder-must-exist-flag set, check that folder exists.
1887 (if (and folder-name
1888 (or (not mh-default-folder-must-exist-flag)
1889 (file-exists-p (mh-expand-file-name folder-name))))
1890 folder-name))))
1892 ;;;###mh-autoload
1893 (defun mh-delete-a-msg (message)
1894 "Delete MESSAGE.
1895 If MESSAGE is nil then the message at point is deleted.
1896 The hook `mh-delete-msg-hook' is called after you mark a message
1897 for deletion. For example, a past maintainer of MH-E used this
1898 once when he kept statistics on his mail usage."
1899 (save-excursion
1900 (if (numberp message)
1901 (mh-goto-msg message nil t)
1902 (beginning-of-line)
1903 (setq message (mh-get-msg-num t)))
1904 (if (looking-at mh-scan-refiled-msg-regexp)
1905 (error "Message %d is refiled; undo refile before deleting" message))
1906 (if (looking-at mh-scan-deleted-msg-regexp)
1907 nil
1908 (mh-set-folder-modified-p t)
1909 (setq mh-delete-list (cons message mh-delete-list))
1910 (mh-notate nil mh-note-deleted mh-cmd-note)
1911 (run-hooks 'mh-delete-msg-hook))))
1913 ;;;###mh-autoload
1914 (defun mh-refile-a-msg (message folder)
1915 "Refile MESSAGE in FOLDER.
1916 If MESSAGE is nil then the message at point is refiled.
1917 Folder is a symbol, not a string.
1918 The hook `mh-refile-msg-hook' is called after a message is marked to
1919 be refiled."
1920 (save-excursion
1921 (if (numberp message)
1922 (mh-goto-msg message nil t)
1923 (beginning-of-line)
1924 (setq message (mh-get-msg-num t)))
1925 (cond ((looking-at mh-scan-deleted-msg-regexp)
1926 (error "Message %d is deleted; undo delete before moving" message))
1927 ((looking-at mh-scan-refiled-msg-regexp)
1928 (if (y-or-n-p
1929 (format "Message %d already refiled; copy to %s as well? "
1930 message folder))
1931 (mh-exec-cmd "refile" (mh-get-msg-num t) "-link"
1932 "-src" mh-current-folder
1933 (symbol-name folder))
1934 (message "Message not copied")))
1935 (t
1936 (mh-set-folder-modified-p t)
1937 (cond ((null (assoc folder mh-refile-list))
1938 (push (list folder message) mh-refile-list))
1939 ((not (member message (cdr (assoc folder mh-refile-list))))
1940 (push message (cdr (assoc folder mh-refile-list)))))
1941 (mh-notate nil mh-note-refiled mh-cmd-note)
1942 (run-hooks 'mh-refile-msg-hook)))))
1944 (defun mh-undo-msg (msg)
1945 "Undo the deletion or refile of one MSG.
1946 If MSG is nil then act on the message at point"
1947 (save-excursion
1948 (if (numberp msg)
1949 (mh-goto-msg msg t t)
1950 (beginning-of-line)
1951 (setq msg (mh-get-msg-num t)))
1952 (cond ((memq msg mh-delete-list)
1953 (setq mh-delete-list (delq msg mh-delete-list)))
1954 (t
1955 (dolist (folder-msg-list mh-refile-list)
1956 (setf (cdr folder-msg-list) (remove msg (cdr folder-msg-list))))
1957 (setq mh-refile-list (loop for x in mh-refile-list
1958 unless (null (cdr x)) collect x))))
1959 (mh-notate nil ? mh-cmd-note)))
1961 ;;;###mh-autoload
1962 (defun mh-msg-filename (msg &optional folder)
1963 "Return the file name of MSG in FOLDER (default current folder)."
1964 (expand-file-name (int-to-string msg)
1965 (if folder
1966 (mh-expand-file-name folder)
1967 mh-folder-filename)))
1969 (provide 'mh-folder)
1971 ;; Local Variables:
1972 ;; indent-tabs-mode: nil
1973 ;; sentence-end-double-space: nil
1974 ;; End:
1976 ;;; mh-folder.el ends here