1 ;;; mh-e.el --- GNU Emacs interface to the MH mail system
3 ;; Copyright (C) 1985, 1986, 1987, 1988,
4 ;; 1990, 1992, 1993, 1994, 1995, 1997, 1999,
5 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
7 ;; Author: Bill Wohler <wohler@newt.com>
8 ;; Maintainer: Bill Wohler <wohler@newt.com>
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 2, or (at your option)
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
27 ;; Boston, MA 02110-1301, USA.
32 ;; M-x mh-rmail to read mail. Type C-h m there for a list of commands.
33 ;; C-u M-x mh-rmail to visit any folder.
34 ;; M-x mh-smail to send mail. From within the mail reader, "m" works, too.
36 ;; Your .emacs might benefit from these bindings:
37 ;; (global-set-key "\C-cr" 'mh-rmail)
38 ;; (global-set-key "\C-xm" 'mh-smail)
39 ;; (global-set-key "\C-x4m" 'mh-smail-other-window)
41 ;; MH (Message Handler) is a powerful mail reader.
43 ;; The MH newsgroup is comp.mail.mh; the mailing list is mh-users@ics.uci.edu
44 ;; (send to mh-users-request to be added). See the monthly Frequently Asked
45 ;; Questions posting there for information on getting MH and MH-E:
46 ;; http://www.faqs.org/faqs/mail/mh-faq/part1/preamble.html
48 ;; N.B. MH must have been compiled with the MHE compiler flag or several
49 ;; features necessary for MH-E will be missing from MH commands, specifically
50 ;; the -build switch to repl and forw.
52 ;; MH-E is an Emacs interface to the MH mail system.
54 ;; MH-E is supported in GNU Emacs 21 and 22 as well as XEmacs 21
55 ;; (except for versions 21.5.9-21.5.16), with MH 6.8.4 on, nmh 1.0.4
56 ;; on, and GNU mailutils 0.4 on.
59 ;; mh-e-users@lists.sourceforge.net
60 ;; mh-e-announce@lists.sourceforge.net
61 ;; mh-e-devel@lists.sourceforge.net
63 ;; Subscribe by sending a "subscribe" message to
64 ;; <list>-request@lists.sourceforge.net, or by using the web interface at
65 ;; https://sourceforge.net/mail/?group_id=13357
68 ;; https://sourceforge.net/tracker/?group_id=13357&atid=113357
69 ;; Include the output of M-x mh-version in any bug report.
72 ;; https://sourceforge.net/tracker/?atid=363357&group_id=13357&func=browse
75 ;; https://sourceforge.net/tracker/?group_id=13357&atid=213357
79 ;; Original version for Gosling emacs by Brian Reid, Stanford, 1982.
80 ;; Modified by James Larus, BBN, July 1984 and UCB, 1984 & 1985.
81 ;; Rewritten for GNU Emacs, James Larus, 1985.
82 ;; Modified by Stephen Gildea, 1988.
83 ;; Maintenance picked up by Bill Wohler and the
84 ;; SourceForge Crew <http://mh-e.sourceforge.net/>, 2001.
90 (eval-when-compile (require 'mh-acros))
98 (defconst mh-version "7.85+cvs" "Version number of MH-E.")
100 (defvar mh-partial-folder-mode-line-annotation "select"
101 "Annotation when displaying part of a folder.
102 The string is displayed after the folder's name. nil for no
107 ;;; Scan Line Formats
109 ;; Parameterize MH-E to work with different scan formats. The defaults work
110 ;; with the standard MH scan listings, in which the first 4 characters on
111 ;; the line are the message number, followed by two places for notations.
113 ;; The following scan formats are passed to the scan program if the setting of
114 ;; `mh-scan-format-file' is t. They are identical except the later one makes
115 ;; use of the nmh `decode' function to decode RFC 2047 encodings. If you just
116 ;; want to change the column of the notations, use the `mh-set-cmd-note'
119 (defvar mh-scan-format-mh
124 "%?(nonnull(comp{to}))%<(mymbox{to})t%>"
125 "%?(nonnull(comp{cc}))%<(mymbox{cc})c%>"
126 "%?(nonnull(comp{bcc}))%<(mymbox{bcc})b%>"
127 "%?(nonnull(comp{newsgroups}))n%>"
129 "%02(mon{date})/%02(mday{date})%<{date} %|*%>"
130 "%<(mymbox{from})%<{to}To:%14(friendly{to})%>%>"
131 "%<(zero)%17(friendly{from})%> "
132 "%{subject}%<{body}<<%{body}%>")
133 "*Scan format string for MH.
134 This string is passed to the scan program via the -format
135 argument. This format is identical to the default except that
136 additional hints for fontification have been added to the fifth
137 column (remember that in Emacs, the first column is 0).
139 The values of the fifth column, in priority order, are: \"-\" if
140 the message has been replied to, t if an address on the To: line
141 matches one of the mailboxes of the current user, \"c\" if the Cc:
142 line matches, \"b\" if the Bcc: line matches, and \"n\" if a
143 non-empty Newsgroups: header is present.")
145 (defvar mh-scan-format-nmh
150 "%?(nonnull(comp{to}))%<(mymbox{to})t%>"
151 "%?(nonnull(comp{cc}))%<(mymbox{cc})c%>"
152 "%?(nonnull(comp{bcc}))%<(mymbox{bcc})b%>"
153 "%?(nonnull(comp{newsgroups}))n%>"
155 "%02(mon{date})/%02(mday{date})%<{date} %|*%>"
156 "%<(mymbox{from})%<{to}To:%14(decode(friendly{to}))%>%>"
157 "%<(zero)%17(decode(friendly{from}))%> "
158 "%(decode{subject})%<{body}<<%{body}%>")
159 "*Scan format string for nmh.
160 This string is passed to the scan program via the -format arg.
161 This format is identical to the default except that additional
162 hints for fontification have been added to the fifth
163 column (remember that in Emacs, the first column is 0).
165 The values of the fifth column, in priority order, are: \"-\" if
166 the message has been replied to, t if an address on the To: field
167 matches one of the mailboxes of the current user, \"c\" if the Cc:
168 field matches, \"b\" if the Bcc: field matches, and \"n\" if a
169 non-empty Newsgroups: field is present.")
171 (defvar mh-note-deleted ?D
172 "Messages that have been deleted are marked by this character.
173 See also `mh-scan-deleted-msg-regexp'.")
175 (defvar mh-note-refiled ?^
176 "Messages that have been refiled are marked by this character.
177 See also `mh-scan-refiled-msg-regexp'.")
179 (defvar mh-note-cur ?+
180 "The current message (in MH, not in MH-E) is marked by this character.
181 See also `mh-scan-cur-msg-number-regexp'.")
183 (defvar mh-scan-good-msg-regexp "^\\( *[0-9]+\\)[^D^0-9]"
184 "This regular expression matches \"good\" messages.
186 It must match from the beginning of the line. Note that the
187 default setting of `mh-folder-font-lock-keywords' expects this
188 expression to contain at least one parenthesized expression which
189 matches the message number as in the default of
191 \"^\\\\( *[0-9]+\\\\)[^D^0-9]\".
193 This expression includes the leading space within the parenthesis
194 since it looks better to highlight it as well. The highlighting
195 is done with the face `mh-folder-msg-number'. This regular
196 expression should be correct as it is needed by non-fontification
199 (defvar mh-scan-deleted-msg-regexp "^\\( *[0-9]+\\)D"
200 "This regular expression matches deleted messages.
202 It must match from the beginning of the line. Note that the
203 default setting of `mh-folder-font-lock-keywords' expects this
204 expression to contain at least one parenthesized expression which
205 matches the message number as in the default of
207 \"^\\\\( *[0-9]+\\\\)D\".
209 This expression includes the leading space within the parenthesis
210 since it looks better to highlight it as well. The highlighting
211 is done with the face `mh-folder-deleted'. This regular
212 expression should be correct as it is needed by non-fontification
213 functions. See also `mh-note-deleted'.")
215 (defvar mh-scan-refiled-msg-regexp "^\\( *[0-9]+\\)\\^"
216 "This regular expression matches refiled messages.
218 It must match from the beginning of the line. Note that the
219 default setting of `mh-folder-font-lock-keywords' expects this
220 expression to contain at least one parenthesized expression which
221 matches the message number as in the default of
223 \"^\\\\( *[0-9]+\\\\)\\\\^\".
225 This expression includes the leading space within the parenthesis
226 since it looks better to highlight it as well. The highlighting
227 is done with the face `mh-folder-refiled'. This regular
228 expression should be correct as it is needed by non-fontification
229 functions. See also `mh-note-refiled'.")
231 (defvar mh-scan-valid-regexp "^ *[0-9]"
232 "This regular expression describes a valid scan line.
234 This is used to eliminate error messages that are occasionally
235 produced by \"inc\".")
237 (defvar mh-scan-cur-msg-number-regexp "^\\( *[0-9]+\\+\\).*"
238 "This regular expression matches the current message.
240 It must match from the beginning of the line. Note that the
241 default setting of `mh-folder-font-lock-keywords' expects this
242 expression to contain at least one parenthesized expression which
243 matches the message number as in the default of
245 \"^\\\\( *[0-9]+\\\\+\\\\).*\".
247 This expression includes the leading space and current message
248 marker \"+\" within the parenthesis since it looks better to
249 highlight these items as well. The highlighting is done with the
250 face `mh-folder-cur-msg-number'. This regular expression should
251 be correct as it is needed by non-fontification functions. See
252 also `mh-note-cur'.")
254 (defvar mh-scan-date-regexp "\\([0-9][0-9]/[0-9][0-9]\\)"
255 "This regular expression matches a valid date.
257 It must not be anchored to the beginning or the end of the line.
258 Note that the default setting of `mh-folder-font-lock-keywords'
259 expects this expression to contain only one parenthesized
260 expression which matches the date field as in the default of
261 \"\\\\([0-9][0-9]/[0-9][0-9]\\\\)\"}. If this regular expression
262 is not correct, the date will not be highlighted with the face
265 (defvar mh-scan-rcpt-regexp "\\(To:\\)\\(..............\\)"
266 "This regular expression specifies the recipient in messages you sent.
268 Note that the default setting of `mh-folder-font-lock-keywords'
269 expects this expression to contain two parenthesized expressions.
270 The first is expected to match the \"To:\" that the default scan
271 format file generates. The second is expected to match the
272 recipient's name as in the default of
273 \"\\\\(To:\\\\)\\\\(..............\\\\)\". If this regular
274 expression is not correct, the \"To:\" string will not be
275 highlighted with the face `mh-folder-to' and the recipient will
276 not be highlighted with the face `mh-folder-address'")
278 (defvar mh-scan-body-regexp "\\(<<\\([^\n]+\\)?\\)"
279 "This regular expression matches the message body fragment.
281 Note that the default setting of `mh-folder-font-lock-keywords'
282 expects this expression to contain at least one parenthesized
283 expression which matches the body text as in the default of
284 \"\\\\(<<\\\\([^\\n]+\\\\)?\\\\)\". If this regular expression is
285 not correct, the body fragment will not be highlighted with the
286 face `mh-folder-body'.")
288 (defvar mh-scan-subject-regexp
289 "^ *[0-9]+........[ ]*...................\\([Rr][Ee]\\(\\[[0-9]+\\]\\)?:\\s-*\\)*\\([^<\n]*\\)"
290 "This regular expression matches the subject.
292 It must match from the beginning of the line. Note that the
293 default setting of `mh-folder-font-lock-keywords' expects this
294 expression to contain at least three parenthesized expressions.
295 The first is expected to match the \"Re:\" string, if any, and is
296 highlighted with the face `mh-folder-followup'. The second
297 matches an optional bracketed number after \"Re:\", such as in
298 \"Re[2]:\" (and is thus a sub-expression of the first expression)
299 and the third is expected to match the subject line itself which
300 is highlighted with the face `mh-folder-subject'. For example,
301 the default (broken on multiple lines for readability) is
303 ^ *[0-9]+........[ ]*...................
304 \\\\([Rr][Ee]\\\\(\\\\\\=[[0-9]+\\\\]\\\\)?:\\\\s-*\\\\)*
307 This regular expression should be correct as it is needed by
308 non-fontification functions.")
310 (defvar mh-scan-sent-to-me-sender-regexp
311 "^ *[0-9]+.\\([bct]\\).....[ ]*\\(..................\\)"
312 "This regular expression matches messages sent to us.
314 Note that the default setting of `mh-folder-font-lock-keywords'
315 expects this expression to contain at least two parenthesized
316 expressions. The first should match the fontification hint (see
317 `mh-scan-format-nmh') and the second should match the user name
320 ^ *[0-9]+.\\\\([bct]\\\\).....[ ]*\\\\(..................\\\\)
322 If this regular expression is not correct, the notation hints
323 will not be highlighted with the face
324 `mh-mh-folder-sent-to-me-hint' and the sender will not be
325 highlighted with the face `mh-folder-sent-to-me-sender'.")
329 (defvar mh-folder-font-lock-keywords
331 ;; Folders when displaying index buffer
333 '(0 'mh-index-folder))
334 ;; Marked for deletion
335 (list (concat mh-scan-deleted-msg-regexp ".*")
336 '(0 'mh-folder-deleted))
338 (list (concat mh-scan-refiled-msg-regexp ".*")
339 '(0 'mh-folder-refiled))
341 (list mh-scan-body-regexp
342 '(1 'mh-folder-body nil t))
344 '(mh-folder-font-lock-subject
345 (1 'mh-folder-followup append t)
346 (2 'mh-folder-subject append t))
347 ;; Current message number
348 (list mh-scan-cur-msg-number-regexp
349 '(1 'mh-folder-cur-msg-number))
351 (list mh-scan-good-msg-regexp
352 '(1 'mh-folder-msg-number))
354 (list mh-scan-date-regexp
355 '(1 'mh-folder-date))
356 ;; Messages from me (To:)
357 (list mh-scan-rcpt-regexp
359 '(2 'mh-folder-address))
361 (list mh-scan-sent-to-me-sender-regexp
362 '(1 'mh-folder-sent-to-me-hint)
363 '(2 'mh-folder-sent-to-me-sender)))
364 "Keywords (regular expressions) used to fontify the MH-Folder buffer.")
366 (defvar mh-scan-cmd-note-width 1
367 "Number of columns consumed by the cmd-note field in `mh-scan-format'.
369 This column will have one of the values: \" \", \"D\", \"^\", \"+\" and
370 where \" \" is the default value,
372 \"D\" is the `mh-note-deleted' character,
373 \"^\" is the `mh-note-refiled' character, and
374 \"+\" is the `mh-note-cur' character.")
376 (defvar mh-scan-destination-width 1
377 "Number of columns consumed by the destination field in `mh-scan-format'.
379 This column will have one of \" \", \"%\", \"-\", \"t\", \"c\", \"b\", or \"n\"
382 \" \" blank space is the default character.
383 \"%\" indicates that the message in in a named MH sequence.
384 \"-\" indicates that the message has been annotated with a replied field.
385 \"t\" indicates that the message contains mymbox in the To: field.
386 \"c\" indicates that the message contains mymbox in the Cc: field.
387 \"b\" indicates that the message contains mymbox in the Bcc: field.
388 \"n\" indicates that the message contains a Newsgroups: field.")
390 (defvar mh-scan-date-width 5
391 "Number of columns consumed by the date field in `mh-scan-format'.
392 This column will typically be of the form mm/dd.")
394 (defvar mh-scan-date-flag-width 1
395 "Number of columns consumed to flag (in)valid dates in `mh-scan-format'.
396 This column will have \" \" for valid and \"*\" for invalid or
399 (defvar mh-scan-from-mbox-width 17
400 "Number of columns consumed with the \"From:\" line in `mh-scan-format'.
401 This column will have a friendly name or e-mail address of the
402 originator, or a \"To: address\" for outgoing e-mail messages.")
404 (defvar mh-scan-from-mbox-sep-width 2
405 "Number of columns consumed by whitespace after from-mbox in `mh-scan-format'.
406 This column will only ever have spaces in it.")
408 (defvar mh-scan-field-destination-offset
409 (+ mh-scan-cmd-note-width)
410 "The offset from the `mh-cmd-note' for the destination column.")
412 (defvar mh-scan-field-from-start-offset
413 (+ mh-scan-cmd-note-width
414 mh-scan-destination-width
416 mh-scan-date-flag-width)
417 "The offset from the `mh-cmd-note' to find the start of \"From:\" address.")
419 (defvar mh-scan-field-from-end-offset
420 (+ mh-scan-field-from-start-offset mh-scan-from-mbox-width)
421 "The offset from the `mh-cmd-note' to find the end of \"From:\" address.")
423 (defvar mh-scan-field-subject-start-offset
424 (+ mh-scan-cmd-note-width
425 mh-scan-destination-width
427 mh-scan-date-flag-width
428 mh-scan-from-mbox-width
429 mh-scan-from-mbox-sep-width)
430 "The offset from the `mh-cmd-note' to find the start of the subject.")
432 (defun mh-folder-font-lock-subject (limit)
433 "Return MH-E scan subject strings to font-lock between point and LIMIT."
434 (if (not (re-search-forward mh-scan-subject-regexp limit t))
436 (if (match-beginning 1)
437 (set-match-data (list (match-beginning 1) (match-end 3)
438 (match-beginning 1) (match-end 3) nil nil))
439 (set-match-data (list (match-beginning 3) (match-end 3)
440 nil nil (match-beginning 3) (match-end 3))))
445 ;; Fontifify unseen mesages in bold.
447 (defmacro mh-generate-sequence-font-lock (seq prefix face)
448 "Generate the appropriate code to fontify messages in SEQ.
449 PREFIX is used to generate unique names for the variables and
450 functions defined by the macro. So a different prefix should be
451 provided for every invocation.
452 FACE is the font-lock face used to display the matching scan lines."
453 (let ((cache (intern (format "mh-folder-%s-seq-cache" prefix)))
454 (func (intern (format "mh-folder-font-lock-%s" prefix))))
457 "Internal cache variable used for font-lock in MH-E.
458 Should only be non-nil through font-lock stepping, and nil once
459 font-lock is done highlighting.")
460 (make-variable-buffer-local ',cache)
463 "Return unseen message lines to font-lock between point and LIMIT."
464 (if (not ,cache) (setq ,cache (mh-seq-msgs (mh-find-seq ,seq))))
465 (let ((cur-msg (mh-get-msg-num nil)))
468 ((>= (point) limit) ;Presumably at end of buffer
471 ((member cur-msg ,cache)
472 (let ((bpoint (progn (beginning-of-line)(point)))
473 (epoint (progn (forward-line 1)(point))))
474 (if (<= limit (point)) (setq ,cache nil))
475 (set-match-data (list bpoint epoint bpoint epoint))
478 ;; move forward one line at a time, checking each message
479 (while (and (= 0 (forward-line 1))
481 (not (member (mh-get-msg-num nil) ,cache))))
482 ;; Examine how we must have exited the loop...
483 (let ((cur-msg (mh-get-msg-num nil)))
484 (cond ((or (<= limit (point))
485 (not (member cur-msg ,cache)))
488 ((member cur-msg ,cache)
489 (let ((bpoint (progn (beginning-of-line) (point)))
490 (epoint (progn (forward-line 1) (point))))
491 (if (<= limit (point)) (setq ,cache nil))
493 (list bpoint epoint bpoint epoint))
496 (setq mh-folder-font-lock-keywords
497 (append mh-folder-font-lock-keywords
498 (list (list ',func (list 1 '',face 'prepend t))))))))
500 (mh-generate-sequence-font-lock mh-unseen-seq unseen bold)
501 (mh-generate-sequence-font-lock mh-tick-seq tick mh-folder-tick)
505 ;;; Internal variables:
507 (defvar mh-last-destination nil
508 "Destination of last refile or write command.")
510 (defvar mh-last-destination-folder nil
511 "Destination of last refile command.")
513 (defvar mh-last-destination-write nil
514 "Destination of last write command.")
516 (defvar mh-folder-mode-map (make-keymap)
517 "Keymap for MH folders.")
519 (defvar mh-arrow-marker nil
520 "Marker for arrow display in fringe.")
522 (defvar mh-delete-list nil
523 "List of message numbers to delete.
524 This variable can be used by
525 `mh-before-commands-processed-hook'.")
527 (defvar mh-refile-list nil
528 "List of folder names in `mh-seq-list'.
529 This variable can be used by
530 `mh-before-commands-processed-hook'.")
532 (defvar mh-folders-changed nil
533 "Lists which folders were affected by deletes and refiles.
534 This list will always include the current folder
535 `mh-current-folder'. This variable can be used by
536 `mh-after-commands-processed-hook'.")
538 (defvar mh-next-direction 'forward
539 "Direction to move to next message.")
541 (defvar mh-view-ops ()
542 "Stack of operations that change the folder view.
543 These operations include narrowing or threading.")
545 (defvar mh-folder-view-stack ()
546 "Stack of previous folder views.")
548 (defvar mh-index-data nil
549 "Info about index search results.")
551 (defvar mh-index-previous-search nil)
552 (defvar mh-index-msg-checksum-map nil)
553 (defvar mh-index-checksum-origin-map nil)
554 (defvar mh-index-sequence-search-flag nil)
556 (defvar mh-first-msg-num nil
557 "Number of first message in buffer.")
559 (defvar mh-last-msg-num nil
560 "Number of last msg in buffer.")
562 (defvar mh-mode-line-annotation nil
563 "Message range displayed in buffer.")
565 (defvar mh-sequence-notation-history nil
566 "Remember original notation that is overwritten by `mh-note-seq'.")
568 (defvar mh-colors-available-flag nil
569 "Non-nil means colors are available.")
573 ;;; Macros and generic functions:
575 (defun mh-mapc (function list)
576 "Apply FUNCTION to each element of LIST for side effects only."
578 (funcall function (car list))
579 (setq list (cdr list))))
581 (defun mh-scan-format ()
582 "Return the output format argument for the scan program."
583 (if (equal mh-scan-format-file t)
584 (list "-format" (if (mh-variant-p 'nmh 'mu-mh)
585 (list (mh-update-scan-format
586 mh-scan-format-nmh mh-cmd-note))
587 (list (mh-update-scan-format
588 mh-scan-format-mh mh-cmd-note))))
589 (if (not (equal mh-scan-format-file nil))
590 (list "-form" mh-scan-format-file))))
597 (defun mh-rmail (&optional arg)
598 "Incorporate new mail with MH.
599 Scan an MH folder if ARG is non-nil.
601 This function is an entry point to MH-E, the Emacs interface to
606 (call-interactively 'mh-visit-folder)
607 (unless (get-buffer mh-inbox)
608 (mh-visit-folder mh-inbox (symbol-name mh-unseen-seq)))
612 (defun mh-nmail (&optional arg)
613 "Check for new mail in inbox folder.
614 Scan an MH folder if ARG is non-nil.
616 This function is an entry point to MH-E, the Emacs interface to
619 (mh-find-path) ; init mh-inbox
621 (call-interactively 'mh-visit-folder)
622 (mh-visit-folder mh-inbox)))
626 ;;; User executable MH-E commands:
628 (defun mh-delete-msg (range)
629 "Delete RANGE\\<mh-folder-mode-map>.
631 To mark a message for deletion, use this command. A \"D\" is
632 placed by the message in the scan window, and the next undeleted
633 message is displayed. If the previous command had been
634 \\[mh-previous-undeleted-msg], then the next message displayed is
635 the first undeleted message previous to the message just deleted.
636 Use \\[mh-next-undeleted-msg] to force subsequent
637 \\[mh-delete-msg] commands to move forward to the next undeleted
638 message after deleting the message under the cursor.
640 The hook `mh-delete-msg-hook' is called after you mark a message
641 for deletion. For example, a past maintainer of MH-E used this
642 once when he kept statistics on his mail usage.
644 Check the documentation of `mh-interactive-range' to see how
645 RANGE is read in interactive use."
646 (interactive (list (mh-interactive-range "Delete")))
647 (mh-delete-msg-no-motion range)
648 (if (looking-at mh-scan-deleted-msg-regexp)
651 (defun mh-delete-msg-no-motion (range)
652 "Delete RANGE, don't move to next message.
654 This command marks the RANGE for deletion but leaves the cursor
655 at the current message in case you wish to perform other
656 operations on the message.
658 Check the documentation of `mh-interactive-range' to see how
659 RANGE is read in interactive use."
660 (interactive (list (mh-interactive-range "Delete")))
661 (mh-iterate-on-range () range
662 (mh-delete-a-msg nil)))
664 (defun mh-execute-commands ()
665 "Process outstanding delete and refile requests\\<mh-folder-mode-map>.
667 If you've marked messages to be deleted or refiled and you want
668 to go ahead and delete or refile the messages, use this command.
669 Many MH-E commands that may affect the numbering of the
670 messages (such as \\[mh-rescan-folder] or \\[mh-pack-folder])
671 will ask if you want to process refiles or deletes first and then
672 either run this command for you or undo the pending refiles and
673 deletes, which are lost.
675 This function runs `mh-before-commands-processed-hook' before the
676 commands are processed and `mh-after-commands-processed-hook'
677 after the commands are processed."
679 (if mh-folder-view-stack (mh-widen t))
680 (mh-process-commands mh-current-folder)
682 (mh-goto-cur-msg) ; after mh-set-scan-mode for efficiency
683 (mh-make-folder-mode-line)
684 t) ; return t for write-file-functions
686 (defun mh-first-msg ()
687 "Display first message."
689 (goto-char (point-min))
690 (while (and (not (eobp)) (not (looking-at mh-scan-valid-regexp)))
693 (defun mh-header-display ()
694 "Display message with all header fields\\<mh-folder-mode-map>.
696 Use the command \\[mh-show] to show the message normally again."
698 (and (not mh-showing-with-headers)
699 (or mh-mhl-format-file mh-clean-message-header-flag)
700 (mh-invalidate-show-buffer))
701 (let ((mh-decode-mime-flag nil)
702 (mh-mhl-format-file nil)
703 (mh-clean-message-header-flag nil))
705 (mh-in-show-buffer (mh-show-buffer)
706 (goto-char (point-min))
708 (setq mh-showing-with-headers t)))
710 (defun mh-inc-folder (&optional file folder)
711 "Incorporate new mail into a folder.
713 You can incorporate mail from any file into the current folder by
714 specifying a prefix argument; you'll be prompted for the name of
715 the FILE to use as well as the destination FOLDER
717 The hook `mh-inc-folder-hook' is run after incorporating new
720 Do not call this function from outside MH-E; use \\[mh-rmail]
722 (interactive (list (if current-prefix-arg
724 (read-file-name "inc mail from file: "
726 (if current-prefix-arg
727 (mh-prompt-for-folder "inc mail into" mh-inbox t))))
729 (setq folder mh-inbox))
730 (let ((threading-needed-flag nil))
731 (let ((config (current-window-configuration)))
732 (when (and mh-show-buffer (get-buffer mh-show-buffer))
733 (delete-windows-on mh-show-buffer))
734 (cond ((not (get-buffer folder))
735 (mh-make-folder folder)
736 (setq threading-needed-flag mh-show-threads-flag)
737 (setq mh-previous-window-config config))
738 ((not (eq (current-buffer) (get-buffer folder)))
739 (switch-to-buffer folder)
740 (setq mh-previous-window-config config))))
741 (mh-get-new-mail file)
742 (when (and threading-needed-flag
744 (goto-char (point-min))
745 (or (null mh-large-folder)
746 (not (equal (forward-line (1+ mh-large-folder)) 0))
747 (and (message "Not threading since the number of messages exceeds `mh-large-folder'")
751 (if (and mh-showing-mode (looking-at mh-scan-valid-regexp)) (mh-show))
752 (run-hooks 'mh-inc-folder-hook)))
754 (defun mh-last-msg ()
755 "Display last message."
757 (goto-char (point-max))
758 (while (and (not (bobp)) (not (looking-at mh-scan-valid-regexp)))
762 (defun mh-next-undeleted-msg (&optional count wait-after-complaining-flag)
763 "Display next message.
765 This command can be given a prefix argument COUNT to specify how
766 many unread messages to skip.
768 In a program, pause for a second after printing message if we are
769 at the last undeleted message and optional argument
770 WAIT-AFTER-COMPLAINING-FLAG is non-nil."
772 (setq mh-next-direction 'forward)
774 (cond ((re-search-forward mh-scan-good-msg-regexp nil t count)
778 (message "No more undeleted messages")
779 (if wait-after-complaining-flag (sit-for 1)))))
781 (defun mh-folder-from-address ()
782 "Derive folder name from sender.
784 The name of the folder is derived as follows:
786 a) The folder name associated with the first address found in
787 the list `mh-default-folder-list' is used. Each element in
788 this list contains a \"Check Recipient\" item. If this item is
789 turned on, then the address is checked against the recipient
790 instead of the sender. This is useful for mailing lists.
792 b) An alias prefixed by `mh-default-folder-prefix'
793 corresponding to the address is used. The prefix is used to
794 prevent clutter in your mail directory.
796 Return nil if a folder name was not derived, or if the variable
797 `mh-default-folder-must-exist-flag' is t and the folder does not
799 ;; Loop for all entries in mh-default-folder-list
801 (goto-char (point-min))
802 (re-search-forward "\n\n" nil 'limit)
803 (narrow-to-region (point-min) (point))
804 (let ((to/cc (concat (or (message-fetch-field "to") "") ", "
805 (or (message-fetch-field "cc") "")))
806 (from (or (message-fetch-field "from") ""))
809 (loop for list in mh-default-folder-list
810 when (string-match (nth 0 list) (if (nth 2 list) to/cc from))
814 ;; Make sure a result from `mh-default-folder-list' begins with "+"
815 ;; since 'mh-expand-file-name below depends on it
816 (when (and folder-name (not (eq (aref folder-name 0) ?+)))
817 (setq folder-name (concat "+" folder-name)))
819 ;; If not, is there an alias for the address?
820 (when (not folder-name)
821 (let* ((from-header (mh-extract-from-header-value))
822 (address (and from-header
823 (nth 1 (mail-extract-address-components
825 (alias (and address (mh-alias-address-to-alias address))))
828 (and alias (concat "+" mh-default-folder-prefix alias))))))
830 ;; If mh-default-folder-must-exist-flag set, check that folder exists.
832 (or (not mh-default-folder-must-exist-flag)
833 (file-exists-p (mh-expand-file-name folder-name))))
836 (defun mh-prompt-for-refile-folder ()
837 "Prompt the user for a folder in which the message should be filed.
838 The folder is returned as a string.
840 The default folder name is generated by the option
841 `mh-default-folder-for-message-function' if it is non-nil or
842 `mh-folder-from-address'."
843 (mh-prompt-for-folder
845 (let ((refile-file (ignore-errors (mh-msg-filename (mh-get-msg-num t)))))
846 (if (null refile-file) ""
848 (set-buffer (get-buffer-create mh-temp-buffer))
850 (insert-file-contents refile-file)
851 (or (and mh-default-folder-for-message-function
852 (let ((buffer-file-name refile-file))
853 (funcall mh-default-folder-for-message-function)))
854 (mh-folder-from-address)
855 (and (eq 'refile (car mh-last-destination-folder))
856 (symbol-name (cdr mh-last-destination-folder)))
860 (defun mh-refile-msg (range folder &optional dont-update-last-destination-flag)
861 "Refile (output) RANGE into FOLDER.
863 You are prompted for the folder name. Note that this command can also
864 be used to create folders. If you specify a folder that does not
865 exist, you will be prompted to create it.
867 The hook `mh-refile-msg-hook' is called after a message is marked to
870 Check the documentation of `mh-interactive-range' to see how RANGE is
871 read in interactive use.
873 In a program, the variables `mh-last-destination' and
874 `mh-last-destination-folder' are not updated if
875 DONT-UPDATE-LAST-DESTINATION-FLAG is non-nil."
876 (interactive (list (mh-interactive-range "Refile")
877 (intern (mh-prompt-for-refile-folder))))
878 (unless dont-update-last-destination-flag
879 (setq mh-last-destination (cons 'refile folder)
880 mh-last-destination-folder mh-last-destination))
881 (mh-iterate-on-range () range
882 (mh-refile-a-msg nil folder))
883 (when (looking-at mh-scan-refiled-msg-regexp) (mh-next-msg)))
885 (defun mh-refile-or-write-again (range &optional interactive-flag)
886 "Repeat last output command.
888 If you are refiling several messages into the same folder, you
889 can use this command to repeat the last
890 refile (\\[mh-refile-msg]) or write (\\[mh-write-msg-to-file]).
893 Check the documentation of `mh-interactive-range' to see how RANGE is
894 read in interactive use.
896 In a program, a non-nil INTERACTIVE-FLAG means that the function was
897 called interactively."
898 (interactive (list (mh-interactive-range "Redo") t))
899 (if (null mh-last-destination)
900 (error "No previous refile or write"))
901 (cond ((eq (car mh-last-destination) 'refile)
902 (mh-refile-msg range (cdr mh-last-destination))
903 (message "Destination folder: %s" (cdr mh-last-destination)))
905 (mh-iterate-on-range msg range
906 (apply 'mh-write-msg-to-file msg (cdr mh-last-destination)))
907 (mh-next-msg interactive-flag))))
910 "Quit the current MH-E folder.
912 When you want to quit using MH-E and go back to editing, you can use
913 this command. This buries the buffers of the current MH-E folder and
914 restores the buffers that were present when you first ran
915 \\[mh-rmail]. It also removes any MH-E working buffers whose name
916 begins with \" *mh-\" or \"*MH-E \". You can later restore your MH-E
917 session by selecting the \"+inbox\" buffer or by running \\[mh-rmail]
920 The two hooks `mh-before-quit-hook' and `mh-quit-hook' are called by
921 this function. The former one is called before the quit occurs, so you
922 might use it to perform any MH-E operations; you could perform some
923 query and abort the quit or call `mh-execute-commands', for example.
924 The latter is not run in an MH-E context, so you might use it to
925 modify the window setup."
927 (run-hooks 'mh-before-quit-hook)
928 (let ((show-buffer (get-buffer mh-show-buffer)))
930 (kill-buffer show-buffer)))
931 (mh-update-sequences)
932 (mh-destroy-postponed-handles)
933 (bury-buffer (current-buffer))
935 ;; Delete all MH-E temporary and working buffers.
936 (dolist (buffer (buffer-list))
937 (when (or (string-match "^ \\*mh-" (buffer-name buffer))
938 (string-match "^\\*MH-E " (buffer-name buffer)))
939 (kill-buffer buffer)))
941 (if mh-previous-window-config
942 (set-window-configuration mh-previous-window-config))
943 (run-hooks 'mh-quit-hook))
945 (defun mh-page-msg (&optional lines)
946 "Display next page in message.
948 You can give this command a prefix argument that specifies the
949 number of LINES to scroll. This command will also show the next
950 undeleted message if it is used at the bottom of a message."
953 (if mh-page-to-next-msg-flag
954 (if (equal mh-next-direction 'backward)
955 (mh-previous-undeleted-msg)
956 (mh-next-undeleted-msg))
957 (if (mh-in-show-buffer (mh-show-buffer)
958 (pos-visible-in-window-p (point-max)))
961 "End of message (Type %s to read %s undeleted message)"
962 (single-key-description last-input-event)
963 (if (equal mh-next-direction 'backward)
966 (setq mh-page-to-next-msg-flag t))
967 (scroll-other-window lines)))
970 (defun mh-previous-page (&optional lines)
971 "Display next page in message.
973 You can give this command a prefix argument that specifies the
974 number of LINES to scroll."
976 (mh-in-show-buffer (mh-show-buffer)
977 (scroll-down lines)))
979 (defun mh-previous-undeleted-msg (&optional count wait-after-complaining-flag)
980 "Display previous message.
982 This command can be given a prefix argument COUNT to specify how
983 many unread messages to skip.
985 In a program, pause for a second after printing message if we are
986 at the last undeleted message and optional argument
987 WAIT-AFTER-COMPLAINING-FLAG is non-nil."
989 (setq mh-next-direction 'backward)
991 (cond ((re-search-backward mh-scan-good-msg-regexp nil t count)
993 (t (message "No previous undeleted message")
994 (if wait-after-complaining-flag (sit-for 1)))))
996 (defun mh-previous-unread-msg (&optional count)
997 "Display previous unread message.
999 This command can be given a prefix argument COUNT to specify how
1000 many unread messages to skip."
1003 (error "The function `mh-previous-unread-msg' expects positive argument"))
1004 (setq count (1- count))
1005 (let ((unread-sequence (cdr (assoc mh-unseen-seq mh-seq-list)))
1006 (cur-msg (mh-get-msg-num nil)))
1007 (cond ((and (not cur-msg) (not (bobp))
1008 ;; If we are at the end of the buffer back up one line and go
1009 ;; to unread message after that.
1012 (setq cur-msg (mh-get-msg-num nil)))
1014 ((or (null unread-sequence) (not cur-msg))
1015 ;; No unread message or there aren't any messages in buffer...
1016 (message "No more unread messages"))
1018 ;; Skip count messages...
1019 (while (and unread-sequence (>= (car unread-sequence) cur-msg))
1020 (setq unread-sequence (cdr unread-sequence)))
1022 (setq unread-sequence (cdr unread-sequence))
1023 (setq count (1- count)))
1024 (not (car unread-sequence)))
1025 (message "No more unread messages"))
1026 (t (loop for msg in unread-sequence
1027 when (mh-goto-msg msg t) return nil
1028 finally (message "No more unread messages"))))))
1030 (defun mh-goto-next-button (backward-flag &optional criterion)
1031 "Search for next button satisfying criterion.
1033 If BACKWARD-FLAG is non-nil search backward in the buffer for a mime
1035 If CRITERION is a function or a symbol which has a function binding
1036 then that function must return non-nil at the button we stop."
1037 (unless (or (and (symbolp criterion) (fboundp criterion))
1038 (functionp criterion))
1039 (setq criterion (lambda (x) t)))
1040 ;; Move to the next button in the buffer satisfying criterion
1041 (goto-char (or (save-excursion
1043 ;; Find point before current button
1044 (let ((point-before-current-button
1046 (while (get-text-property (point) 'mh-data)
1047 (unless (= (forward-line
1048 (if backward-flag 1 -1))
1051 (goto-char (point-min))
1052 (goto-char (point-max)))))
1054 ;; Skip over current button
1055 (while (and (get-text-property (point) 'mh-data)
1056 (not (if backward-flag (bobp) (eobp))))
1057 (forward-line (if backward-flag -1 1)))
1058 ;; Stop at next MIME button if any exists.
1061 (unless (= (forward-line
1062 (if backward-flag -1 1))
1065 (goto-char (point-max))
1066 (goto-char (point-min)))
1067 (beginning-of-line))
1069 point-before-current-button)
1070 (when (and (get-text-property (point) 'mh-data)
1071 (funcall criterion (point)))
1072 (return-from loop (point))))
1076 (defun mh-next-button (&optional backward-flag)
1077 "Go to the next button.
1079 If the end of the buffer is reached then the search wraps over to
1080 the start of the buffer.
1082 If an optional prefix argument BACKWARD-FLAG is given, the cursor
1083 will move to the previous button."
1084 (interactive (list current-prefix-arg))
1085 (unless mh-showing-mode
1087 (mh-in-show-buffer (mh-show-buffer)
1088 (mh-goto-next-button backward-flag)))
1090 (defun mh-prev-button ()
1091 "Go to the previous button.
1093 If the beginning of the buffer is reached then the search wraps
1094 over to the end of the buffer."
1098 (defun mh-folder-mime-action (part-index action include-security-flag)
1099 "Go to PART-INDEX and carry out ACTION.
1101 If PART-INDEX is nil then go to the next part in the buffer. The
1102 search for the next buffer wraps around if end of buffer is reached.
1103 If argument INCLUDE-SECURITY-FLAG is non-nil then include security
1104 info buttons when searching for a suitable parts."
1105 (unless mh-showing-mode
1107 (mh-in-show-buffer (mh-show-buffer)
1111 (let ((part (get-text-property p 'mh-part)))
1112 (and (integerp part) (= part part-index)))))
1114 (if include-security-flag
1115 (get-text-property p 'mh-data)
1116 (integerp (get-text-property p 'mh-part)))))))
1118 (cond ((and (get-text-property point 'mh-part)
1119 (or (null part-index)
1120 (= (get-text-property point 'mh-part) part-index)))
1122 ((and (get-text-property point 'mh-data)
1123 include-security-flag
1127 (mh-goto-next-button nil criterion)
1128 (if (= (point) point)
1129 (message "No matching MIME part found")
1130 (funcall action)))))))
1132 (defun mh-folder-toggle-mime-part (part-index)
1135 This command displays (or hides) the attachment associated with
1136 the button under the cursor. If the cursor is not located over a
1137 button, then the cursor first moves to the next button, wrapping
1138 to the beginning of the message if necessary. This command has
1139 the advantage over related commands of working from the MH-Folder
1142 You can also provide a numeric prefix argument PART-INDEX to view
1143 the attachment labeled with that number. If Emacs does not know
1144 how to display the attachment, then Emacs offers to save the
1145 attachment in a file."
1147 (when (consp part-index) (setq part-index (car part-index)))
1148 (mh-folder-mime-action part-index #'mh-press-button t))
1150 (defun mh-folder-inline-mime-part (part-index)
1151 "Show attachment verbatim.
1153 You can view the raw contents of an attachment with this command.
1154 This command displays (or hides) the contents of the attachment
1155 associated with the button under the cursor verbatim. If the
1156 cursor is not located over a button, then the cursor first moves
1157 to the next button, wrapping to the beginning of the message if
1160 You can also provide a numeric prefix argument PART-INDEX to view
1161 the attachment labeled with that number."
1163 (when (consp part-index) (setq part-index (car part-index)))
1164 (mh-folder-mime-action part-index #'mh-mime-inline-part nil))
1166 (defun mh-folder-save-mime-part (part-index)
1167 "Save (output) attachment.
1169 This command saves the attachment associated with the button under the
1170 cursor. If the cursor is not located over a button, then the cursor
1171 first moves to the next button, wrapping to the beginning of the
1172 message if necessary.
1174 You can also provide a numeric prefix argument PART-INDEX to save the
1175 attachment labeled with that number.
1177 This command prompts you for a filename and suggests a specific name
1178 if it is available."
1180 (when (consp part-index) (setq part-index (car part-index)))
1181 (mh-folder-mime-action part-index #'mh-mime-save-part nil))
1183 (defun mh-reset-threads-and-narrowing ()
1184 "Reset all variables pertaining to threads and narrowing.
1185 Also removes all content from the folder buffer."
1186 (setq mh-view-ops ())
1187 (setq mh-folder-view-stack ())
1188 (setq mh-thread-scan-line-map-stack ())
1189 (let ((buffer-read-only nil)) (erase-buffer)))
1191 (defun mh-rescan-folder (&optional range dont-exec-pending)
1192 "Rescan folder\\<mh-folder-mode-map>.
1194 This command is useful to grab all messages in your \"+inbox\" after
1195 processing your new mail for the first time. If you don't want to
1196 rescan the entire folder, this command will accept a RANGE. Check the
1197 documentation of `mh-interactive-range' to see how RANGE is read in
1200 This command will ask if you want to process refiles or deletes first
1201 and then either run \\[mh-execute-commands] for you or undo the
1202 pending refiles and deletes, which are lost.
1204 In a program, the processing of outstanding commands is not performed
1205 if DONT-EXEC-PENDING is non-nil."
1206 (interactive (list (if current-prefix-arg
1207 (mh-read-range "Rescan" mh-current-folder t nil t
1208 mh-interpret-number-as-range-flag)
1210 (setq mh-next-direction 'forward)
1211 (let ((threaded-flag (memq 'unthread mh-view-ops)))
1212 (mh-scan-folder mh-current-folder (or range "all") dont-exec-pending)
1213 (cond (threaded-flag (mh-toggle-threads))
1214 (mh-index-data (mh-index-insert-folder-headers)))))
1216 (defun mh-write-msg-to-file (message file no-header)
1217 "Append MESSAGE to end of FILE\\<mh-folder-mode-map>.
1219 You are prompted for the filename. If the file already exists,
1220 the message is appended to it. You can also write the message to
1221 the file without the header by specifying a prefix argument
1222 NO-HEADER. Subsequent writes to the same file can be made with
1223 the command \\[mh-refile-or-write-again]."
1225 (list (mh-get-msg-num t)
1226 (let ((default-dir (if (eq 'write (car mh-last-destination-write))
1227 (file-name-directory
1228 (car (cdr mh-last-destination-write)))
1229 default-directory)))
1230 (read-file-name (format "Save message%s in file: "
1231 (if current-prefix-arg " body" ""))
1233 (if (eq 'write (car mh-last-destination-write))
1234 (car (cdr mh-last-destination-write))
1235 (expand-file-name "mail.out" default-dir))))
1236 current-prefix-arg))
1237 (let ((msg-file-to-output (mh-msg-filename message))
1238 (output-file (mh-expand-file-name file)))
1239 (setq mh-last-destination (list 'write file (if no-header 'no-header))
1240 mh-last-destination-write mh-last-destination)
1242 (set-buffer (get-buffer-create mh-temp-buffer))
1244 (insert-file-contents msg-file-to-output)
1245 (goto-char (point-min))
1246 (if no-header (search-forward "\n\n"))
1247 (append-to-file (point) (point-max) output-file))))
1249 (defun mh-toggle-showing ()
1250 "Toggle between MH-Folder and MH-Folder Show modes.
1252 This command switches between MH-Folder mode and MH-Folder Show
1253 mode. MH-Folder mode turns off the associated show buffer so that
1254 you can perform operations on the messages quickly without
1255 reading them. This is an excellent way to prune out your junk
1256 mail or to refile a group of messages to another folder for later
1263 (defun mh-undo (range)
1264 "Undo pending deletes or refiles in RANGE.
1266 If you've deleted a message or refiled it, but changed your mind,
1267 you can cancel the action before you've executed it. Use this
1268 command to undo a refile on or deletion of a single message. You
1269 can also undo refiles and deletes for messages that are found in
1272 Check the documentation of `mh-interactive-range' to see how
1273 RANGE is read in interactive use."
1274 (interactive (list (mh-interactive-range "Undo")))
1275 (cond ((numberp range)
1276 (let ((original-position (point)))
1278 (while (not (or (looking-at mh-scan-deleted-msg-regexp)
1279 (looking-at mh-scan-refiled-msg-regexp)
1280 (and (eq mh-next-direction 'forward) (bobp))
1281 (and (eq mh-next-direction 'backward)
1282 (save-excursion (forward-line) (eobp)))))
1283 (forward-line (if (eq mh-next-direction 'forward) -1 1)))
1284 (if (or (looking-at mh-scan-deleted-msg-regexp)
1285 (looking-at mh-scan-refiled-msg-regexp))
1287 (mh-undo-msg (mh-get-msg-num t))
1289 (goto-char original-position)
1290 (error "Nothing to undo"))))
1291 (t (mh-iterate-on-range () range
1292 (mh-undo-msg nil))))
1293 (if (not (mh-outstanding-commands-p))
1294 (mh-set-folder-modified-p nil)))
1297 (defun mh-folder-line-matches-show-buffer-p ()
1298 "Return t if the message under point in folder-mode is in the show buffer.
1299 Return nil in any other circumstance (no message under point, no
1300 show buffer, the message in the show buffer doesn't match."
1301 (and (eq major-mode 'mh-folder-mode)
1302 (mh-get-msg-num nil)
1304 (get-buffer mh-show-buffer)
1305 (buffer-file-name (get-buffer mh-show-buffer))
1306 (string-match ".*/\\([0-9]+\\)$"
1307 (buffer-file-name (get-buffer mh-show-buffer)))
1309 (match-string 1 (buffer-file-name (get-buffer mh-show-buffer)))
1310 (int-to-string (mh-get-msg-num nil)))))
1312 (eval-when-compile (require 'gnus))
1314 (defmacro mh-macro-expansion-time-gnus-version ()
1315 "Return Gnus version available at macro expansion time.
1316 The macro evaluates the Gnus version at macro expansion time. If
1317 MH-E was compiled then macro expansion happens at compile time."
1320 (defun mh-run-time-gnus-version ()
1321 "Return Gnus version available at run time."
1326 (defun mh-version ()
1327 "Display version information about MH-E and the MH mail handling system."
1329 (set-buffer (get-buffer-create mh-info-buffer))
1332 (insert "MH-E " mh-version "\n\n")
1333 ;; MH-E compilation details.
1334 (insert "MH-E compilation details:\n")
1335 (let* ((compiled-mhe (byte-code-function-p (symbol-function 'mh-version)))
1336 (gnus-compiled-version (if compiled-mhe
1337 (mh-macro-expansion-time-gnus-version)
1339 (insert " Byte compiled:\t\t" (if compiled-mhe "yes" "no") "\n"
1340 " Gnus (compile-time):\t" gnus-compiled-version "\n"
1341 " Gnus (run-time):\t" (mh-run-time-gnus-version) "\n\n"))
1343 (insert (emacs-version) "\n\n")
1345 (if mh-variant-in-use
1346 (insert mh-variant-in-use "\n"
1347 " mh-progs:\t" mh-progs "\n"
1348 " mh-lib:\t" mh-lib "\n"
1349 " mh-lib-progs:\t" mh-lib-progs "\n\n")
1350 (insert "No MH variant detected\n"))
1353 (call-process "uname" nil t nil "-a")
1355 (goto-char (point-min))
1356 (display-buffer mh-info-buffer))
1358 (defun mh-parse-flist-output-line (line &optional current-folder)
1359 "Parse LINE to generate folder name, unseen messages and total messages.
1360 If CURRENT-FOLDER is non-nil then it contains the current folder
1361 name and it is used to avoid problems in corner cases involving
1362 folders whose names end with a '+' character."
1365 (goto-char (point-max))
1366 (let (folder unseen total p)
1367 (when (search-backward " out of " (point-min) t)
1368 (setq total (read-from-string
1369 (buffer-substring-no-properties
1370 (match-end 0) (line-end-position))))
1371 (when (search-backward " in sequence " (point-min) t)
1373 (when (search-backward " has " (point-min) t)
1374 (setq unseen (read-from-string (buffer-substring-no-properties
1376 (while (eq (char-after) ? )
1378 (setq folder (buffer-substring-no-properties
1379 (point-min) (1+ (point))))
1380 (when (and (equal (aref folder (1- (length folder))) ?+)
1381 (equal current-folder folder))
1382 (setq folder (substring folder 0 (1- (length folder)))))
1383 (values (format "+%s" folder) (car unseen) (car total))))))))
1385 (defun mh-folder-size-folder (folder)
1386 "Find size of FOLDER using \"folder\"."
1388 (let ((u (length (cdr (assoc mh-unseen-seq
1389 (mh-read-folder-sequences folder nil))))))
1390 (call-process (expand-file-name "folder" mh-progs) nil t nil
1391 "-norecurse" folder)
1392 (goto-char (point-min))
1393 (if (re-search-forward " has \\([0-9]+\\) " nil t)
1394 (values (car (read-from-string (match-string 1))) u folder)
1395 (values 0 u folder)))))
1397 (defun mh-folder-size-flist (folder)
1398 "Find size of FOLDER using \"flist\"."
1400 (call-process (expand-file-name "flist" mh-progs) nil t nil "-showzero"
1401 "-norecurse" folder "-sequence" (symbol-name mh-unseen-seq))
1402 (goto-char (point-min))
1403 (multiple-value-bind (folder unseen total)
1404 (mh-parse-flist-output-line
1405 (buffer-substring (point) (line-end-position)))
1406 (values total unseen folder))))
1408 (defun mh-folder-size (folder)
1409 "Find size of FOLDER."
1410 (if mh-flists-present-flag
1411 (mh-folder-size-flist folder)
1412 (mh-folder-size-folder folder)))
1414 (defun mh-visit-folder (folder &optional range index-data)
1417 When you want to read the messages that you have refiled into folders,
1418 use this command to visit the folder. You are prompted for the folder
1421 The folder buffer will show just unseen messages if there are any;
1422 otherwise, it will show all the messages in the buffer as long there
1423 are fewer than `mh-large-folder' messages. If there are more, then you
1424 are prompted for a range of messages to scan.
1426 You can provide a prefix argument in order to specify a RANGE of
1427 messages to show when you visit the folder. In this case, regions are
1428 not used to specify the range and `mh-large-folder' is ignored. Check
1429 the documentation of `mh-interactive-range' to see how RANGE is read
1432 Note that this command can also be used to create folders. If you
1433 specify a folder that does not exist, you will be prompted to create
1436 Do not call this function from outside MH-E; use \\[mh-rmail] instead.
1438 If, in a program, RANGE is nil (the default), then all messages in
1439 FOLDER are displayed. If an index buffer is being created then
1440 INDEX-DATA is used to initialize the index buffer specific data
1442 (interactive (let ((folder-name (mh-prompt-for-folder "Visit" mh-inbox t)))
1444 (mh-read-range "Scan" folder-name t nil
1446 mh-interpret-number-as-range-flag))))
1447 (let ((config (current-window-configuration))
1448 (current-buffer (current-buffer))
1449 (threaded-view-flag mh-show-threads-flag))
1450 (delete-other-windows)
1452 (when (get-buffer folder)
1454 (setq threaded-view-flag (memq 'unthread mh-view-ops))))
1456 (mh-make-folder folder)
1457 (setq mh-index-data (car index-data)
1458 mh-index-msg-checksum-map (make-hash-table :test #'equal)
1459 mh-index-checksum-origin-map (make-hash-table :test #'equal))
1460 (mh-index-update-maps folder (cadr index-data))
1461 (mh-index-create-sequences))
1462 (mh-scan-folder folder (or range "all"))
1463 (cond ((and threaded-view-flag
1465 (goto-char (point-min))
1466 (or (null mh-large-folder)
1467 (not (equal (forward-line (1+ mh-large-folder)) 0))
1468 (and (message "Not threading since the number of messages exceeds `mh-large-folder'")
1470 (mh-toggle-threads))
1472 (mh-index-insert-folder-headers)))
1473 (unless (eq current-buffer (current-buffer))
1474 (setq mh-previous-window-config config)))
1478 (defun mh-update-sequences ()
1479 "Flush MH-E's state out to MH.
1481 This function updates the sequence specified by your
1482 \"Unseen-Sequence:\" profile component, \"cur\", and the sequence
1483 listed by the `mh-tick-seq' option which is \"tick\" by default.
1484 The message at the cursor is used for \"cur\"."
1486 ;; mh-update-sequences is the opposite of mh-read-folder-sequences,
1487 ;; which updates MH-E's state from MH.
1488 (let ((folder-set (mh-update-unseen))
1489 (new-cur (mh-get-msg-num nil)))
1491 (let ((seq-entry (mh-find-seq 'cur)))
1492 (mh-remove-cur-notation)
1494 (list new-cur)) ;delete-seq-locally, add-msgs-to-seq
1495 (mh-define-sequence 'cur (list new-cur))
1497 (if (looking-at mh-scan-good-msg-regexp)
1501 ;; psg - mh-current-folder is nil if mh-summary-height < 4 !
1502 ;; So I added this sanity check.
1503 (if (stringp mh-current-folder)
1504 (mh-exec-cmd-quiet t "folder" mh-current-folder "-fast")
1505 (mh-exec-cmd-quiet t "folder" "-fast")))))))
1509 ;;; Support routines.
1511 (defun mh-delete-a-msg (message)
1513 If MESSAGE is nil then the message at point is deleted.
1514 The hook `mh-delete-msg-hook' is called after you mark a message
1515 for deletion. For example, a past maintainer of MH-E used this
1516 once when he kept statistics on his mail usage."
1518 (if (numberp message)
1519 (mh-goto-msg message nil t)
1521 (setq message (mh-get-msg-num t)))
1522 (if (looking-at mh-scan-refiled-msg-regexp)
1523 (error "Message %d is refiled; undo refile before deleting" message))
1524 (if (looking-at mh-scan-deleted-msg-regexp)
1526 (mh-set-folder-modified-p t)
1527 (setq mh-delete-list (cons message mh-delete-list))
1528 (mh-notate nil mh-note-deleted mh-cmd-note)
1529 (run-hooks 'mh-delete-msg-hook))))
1531 (defun mh-refile-a-msg (message folder)
1532 "Refile MESSAGE in FOLDER.
1533 If MESSAGE is nil then the message at point is refiled.
1534 Folder is a symbol, not a string.
1535 The hook `mh-refile-msg-hook' is called after a message is marked to
1538 (if (numberp message)
1539 (mh-goto-msg message nil t)
1541 (setq message (mh-get-msg-num t)))
1542 (cond ((looking-at mh-scan-deleted-msg-regexp)
1543 (error "Message %d is deleted; undo delete before moving" message))
1544 ((looking-at mh-scan-refiled-msg-regexp)
1546 (format "Message %d already refiled; copy to %s as well? "
1548 (mh-exec-cmd "refile" (mh-get-msg-num t) "-link"
1549 "-src" mh-current-folder
1550 (symbol-name folder))
1551 (message "Message not copied")))
1553 (mh-set-folder-modified-p t)
1554 (cond ((null (assoc folder mh-refile-list))
1555 (push (list folder message) mh-refile-list))
1556 ((not (member message (cdr (assoc folder mh-refile-list))))
1557 (push message (cdr (assoc folder mh-refile-list)))))
1558 (mh-notate nil mh-note-refiled mh-cmd-note)
1559 (run-hooks 'mh-refile-msg-hook)))))
1561 (defun mh-next-msg (&optional wait-after-complaining-flag)
1562 "Move backward or forward to the next undeleted message in the buffer.
1563 If optional argument WAIT-AFTER-COMPLAINING-FLAG is non-nil and
1564 we are at the last message, then wait for a second after telling
1565 the user that there aren't any more unread messages."
1566 (if (eq mh-next-direction 'forward)
1567 (mh-next-undeleted-msg 1 wait-after-complaining-flag)
1568 (mh-previous-undeleted-msg 1 wait-after-complaining-flag)))
1570 (defun mh-next-unread-msg (&optional count)
1571 "Display next unread message.
1573 This command can be given a prefix argument COUNT to specify how
1574 many unread messages to skip."
1577 (error "The function `mh-next-unread-msg' expects positive argument"))
1578 (setq count (1- count))
1579 (let ((unread-sequence (reverse (cdr (assoc mh-unseen-seq mh-seq-list))))
1580 (cur-msg (mh-get-msg-num nil)))
1581 (cond ((and (not cur-msg) (not (bobp))
1582 ;; If we are at the end of the buffer back up one line and go
1583 ;; to unread message after that.
1586 (setq cur-msg (mh-get-msg-num nil)))
1588 ((or (null unread-sequence) (not cur-msg))
1589 ;; No unread message or there aren't any messages in buffer...
1590 (message "No more unread messages"))
1593 (while (and unread-sequence (>= cur-msg (car unread-sequence)))
1594 (setq unread-sequence (cdr unread-sequence)))
1596 (setq unread-sequence (cdr unread-sequence))
1597 (setq count (1- count)))
1598 (not (car unread-sequence)))
1599 (message "No more unread messages"))
1600 (t (loop for msg in unread-sequence
1601 when (mh-goto-msg msg t) return nil
1602 finally (message "No more unread messages"))))))
1604 (defun mh-set-scan-mode ()
1605 "Display the scan listing buffer, but do not show a message."
1606 (if (get-buffer mh-show-buffer)
1607 (delete-windows-on mh-show-buffer))
1609 (force-mode-line-update)
1610 (if mh-recenter-summary-flag
1613 (defun mh-undo-msg (msg)
1614 "Undo the deletion or refile of one MSG.
1615 If MSG is nil then act on the message at point"
1618 (mh-goto-msg msg t t)
1620 (setq msg (mh-get-msg-num t)))
1621 (cond ((memq msg mh-delete-list)
1622 (setq mh-delete-list (delq msg mh-delete-list)))
1624 (dolist (folder-msg-list mh-refile-list)
1625 (setf (cdr folder-msg-list) (remove msg (cdr folder-msg-list))))
1626 (setq mh-refile-list (loop for x in mh-refile-list
1627 unless (null (cdr x)) collect x))))
1628 (mh-notate nil ? mh-cmd-note)))
1632 ;;; The folder data abstraction.
1634 (defvar mh-index-data-file ".mhe_index"
1635 "MH-E specific file where index seach info is stored.")
1637 (defun mh-make-folder (name)
1638 "Create a new mail folder called NAME.
1639 Make it the current folder."
1640 (switch-to-buffer name)
1641 (setq buffer-read-only nil)
1643 (if mh-adaptive-cmd-note-flag
1644 (mh-set-cmd-note (mh-msg-num-width-to-column (mh-msg-num-width name))))
1645 (setq buffer-read-only t)
1647 (mh-set-folder-modified-p nil)
1648 (setq buffer-file-name mh-folder-filename)
1649 (when (and (not mh-index-data)
1650 (file-exists-p (concat buffer-file-name mh-index-data-file)))
1651 (mh-index-read-data))
1652 (mh-make-folder-mode-line))
1654 ;; Ensure new buffers won't get this mode if default-major-mode is nil.
1655 (put 'mh-folder-mode 'mode-class 'special)
1659 ;;; Build mh-folder-mode menu
1661 ;; Menu extracted from mh-menubar.el V1.1 (31 July 2001)
1662 ;; Menus for folder mode: folder, message, sequence (in that order)
1663 ;; folder-mode "Sequence" menu
1665 mh-folder-sequence-menu mh-folder-mode-map "Menu for MH-E folder-sequence."
1667 ["Add Message to Sequence..." mh-put-msg-in-seq (mh-get-msg-num nil)]
1668 ["List Sequences for Message" mh-msg-is-in-seq (mh-get-msg-num nil)]
1669 ["Delete Message from Sequence..." mh-delete-msg-from-seq
1670 (mh-get-msg-num nil)]
1671 ["List Sequences in Folder..." mh-list-sequences t]
1672 ["Delete Sequence..." mh-delete-seq t]
1673 ["Narrow to Sequence..." mh-narrow-to-seq t]
1674 ["Widen from Sequence" mh-widen mh-folder-view-stack]
1676 ["Narrow to Subject Sequence" mh-narrow-to-subject t]
1677 ["Narrow to Tick Sequence" mh-narrow-to-tick
1678 (and mh-tick-seq (mh-seq-msgs (mh-find-seq mh-tick-seq)))]
1679 ["Delete Rest of Same Subject" mh-delete-subject t]
1680 ["Toggle Tick Mark" mh-toggle-tick t]
1682 ["Push State Out to MH" mh-update-sequences t]))
1684 ;; folder-mode "Message" menu
1686 mh-folder-message-menu mh-folder-mode-map "Menu for MH-E folder-message."
1688 ["Show Message" mh-show (mh-get-msg-num nil)]
1689 ["Show Message with Header" mh-header-display (mh-get-msg-num nil)]
1690 ["Next Message" mh-next-undeleted-msg t]
1691 ["Previous Message" mh-previous-undeleted-msg t]
1692 ["Go to First Message" mh-first-msg t]
1693 ["Go to Last Message" mh-last-msg t]
1694 ["Go to Message by Number..." mh-goto-msg t]
1695 ["Modify Message" mh-modify t]
1696 ["Delete Message" mh-delete-msg (mh-get-msg-num nil)]
1697 ["Refile Message" mh-refile-msg (mh-get-msg-num nil)]
1698 ["Undo Delete/Refile" mh-undo (mh-outstanding-commands-p)]
1699 ["Execute Delete/Refile" mh-execute-commands
1700 (mh-outstanding-commands-p)]
1702 ["Compose a New Message" mh-send t]
1703 ["Reply to Message..." mh-reply (mh-get-msg-num nil)]
1704 ["Forward Message..." mh-forward (mh-get-msg-num nil)]
1705 ["Redistribute Message..." mh-redistribute (mh-get-msg-num nil)]
1706 ["Edit Message Again" mh-edit-again (mh-get-msg-num nil)]
1707 ["Re-edit a Bounced Message" mh-extract-rejected-mail t]
1709 ["Copy Message to Folder..." mh-copy-msg (mh-get-msg-num nil)]
1710 ["Print Message" mh-print-msg (mh-get-msg-num nil)]
1711 ["Write Message to File..." mh-write-msg-to-file
1712 (mh-get-msg-num nil)]
1713 ["Pipe Message to Command..." mh-pipe-msg (mh-get-msg-num nil)]
1714 ["Unpack Uuencoded Message..." mh-store-msg (mh-get-msg-num nil)]
1715 ["Burst Digest Message" mh-burst-digest (mh-get-msg-num nil)]))
1717 ;; folder-mode "Folder" menu
1719 mh-folder-folder-menu mh-folder-mode-map "Menu for MH-E folder."
1721 ["Incorporate New Mail" mh-inc-folder t]
1722 ["Toggle Show/Folder" mh-toggle-showing t]
1723 ["Execute Delete/Refile" mh-execute-commands
1724 (mh-outstanding-commands-p)]
1725 ["Rescan Folder" mh-rescan-folder t]
1726 ["Thread Folder" mh-toggle-threads
1727 (not (memq 'unthread mh-view-ops))]
1728 ["Pack Folder" mh-pack-folder t]
1729 ["Sort Folder" mh-sort-folder t]
1731 ["List Folders" mh-list-folders t]
1732 ["Visit a Folder..." mh-visit-folder t]
1733 ["View New Messages" mh-index-new-messages t]
1734 ["Search a Folder..." mh-search-folder t]
1735 ["Indexed Search..." mh-index-search t]
1737 ["Quit MH-E" mh-quit t]))
1741 (defmacro mh-remove-xemacs-horizontal-scrollbar ()
1742 "Get rid of the horizontal scrollbar that XEmacs insists on putting in."
1743 (when mh-xemacs-flag
1744 `(if (and (featurep 'scrollbar)
1745 (fboundp 'set-specifier))
1746 (set-specifier horizontal-scrollbar-visible-p nil
1747 (cons (current-buffer) nil)))))
1749 (defmacro mh-write-file-functions-compat ()
1750 "Return `write-file-functions' if it exists.
1751 Otherwise return `local-write-file-hooks'. This macro exists
1752 purely for compatibility. The former symbol is used in Emacs 21.4
1753 onward while the latter is used in previous versions and XEmacs."
1754 (if (boundp 'write-file-functions)
1755 ''write-file-functions ;Emacs 21.4
1756 ''local-write-file-hooks)) ;<Emacs 21.4, XEmacs
1758 ;; Register mh-folder-mode as supporting which-function-mode...
1759 (load "which-func" t t)
1760 (when (and (boundp 'which-func-modes)
1761 (not (member 'mh-folder-mode which-func-modes)))
1762 (push 'mh-folder-mode which-func-modes))
1764 ;; Shush compiler in non-bleeding edge versions of Emacs.
1766 (defvar desktop-save-buffer) ;Emacs 21.4
1767 (defvar font-lock-auto-fontify)
1768 (defvar font-lock-defaults)
1769 (defvar tool-bar-map))
1771 (defvar mh-folder-buttons-init-flag nil)
1773 ;; Autoload cookie needed by desktop.el
1775 (define-derived-mode mh-folder-mode fundamental-mode "MH-Folder"
1776 "Major MH-E mode for \"editing\" an MH folder scan listing.\\<mh-folder-mode-map>
1778 You can show the message the cursor is pointing to, and step through
1779 the messages. Messages can be marked for deletion or refiling into
1780 another folder; these commands are executed all at once with a
1783 Options that control this mode can be changed with
1784 \\[customize-group]; specify the \"mh\" group. In particular, please
1785 see the `mh-scan-format-file' option if you wish to modify scan's
1788 When a folder is visited, the hook `mh-folder-mode-hook' is run.
1792 Many commands that operate on individual messages, such as
1793 `mh-forward' or `mh-refile-msg' take a RANGE argument. This argument
1794 can be used in several ways.
1796 If you provide the prefix argument (\\[universal-argument]) to
1797 these commands, then you will be prompted for the message range.
1798 This can be any valid MH range which can include messages,
1799 sequences, and the abbreviations (described in the mh(1) man
1803 Indicates all messages in the range <num1> to <num2>, inclusive.
1804 The range must be nonempty.
1809 Up to N messages beginning with (or ending with) message num. Num
1810 may be any of the predefined symbols: first, prev, cur, next or
1817 The first, previous, next or last messages, if they exist.
1820 All of the messages.
1822 For example, a range that shows all of these things is `1 2 3
1823 5-10 last:5 unseen'.
1825 If the option `transient-mark-mode' is set to t and you set a
1826 region in the MH-Folder buffer, then the MH-E command will
1827 perform the operation on all messages in that region.
1829 \\{mh-folder-mode-map}"
1831 (unless mh-folder-buttons-init-flag
1832 (mh-tool-bar-folder-buttons-init)
1833 (setq mh-folder-buttons-init-flag t)))
1834 (make-local-variable 'font-lock-defaults)
1835 (setq font-lock-defaults '(mh-folder-font-lock-keywords t))
1836 (make-local-variable 'desktop-save-buffer)
1837 (setq desktop-save-buffer t)
1839 'mh-colors-available-flag (mh-colors-available-p)
1840 ; Do we have colors available
1841 'mh-current-folder (buffer-name) ; Name of folder, a string
1842 'mh-show-buffer (format "show-%s" (buffer-name)) ; Buffer that displays msgs
1843 'mh-folder-filename ; e.g. "/usr/foobar/Mail/inbox/"
1844 (file-name-as-directory (mh-expand-file-name (buffer-name)))
1845 'mh-display-buttons-for-inline-parts-flag
1846 mh-display-buttons-for-inline-parts-flag ; Allow for display of buttons to
1848 'mh-arrow-marker (make-marker) ; Marker where arrow is displayed
1849 'overlay-arrow-position nil ; Allow for simultaneous display in
1850 'overlay-arrow-string ">" ; different MH-E buffers.
1851 'mh-showing-mode nil ; Show message also?
1852 'mh-delete-list nil ; List of msgs nums to delete
1853 'mh-refile-list nil ; List of folder names in mh-seq-list
1854 'mh-seq-list nil ; Alist of (seq . msgs) nums
1855 'mh-seen-list nil ; List of displayed messages
1856 'mh-next-direction 'forward ; Direction to move to next message
1857 'mh-view-ops () ; Stack that keeps track of the order
1858 ; in which narrowing/threading has been
1860 'mh-folder-view-stack () ; Stack of previous views of the
1862 'mh-index-data nil ; If the folder was created by a call
1863 ; to mh-index-search this contains info
1864 ; about the search results.
1865 'mh-index-previous-search nil ; Previous folder and search-regexp
1866 'mh-index-msg-checksum-map nil ; msg -> checksum map
1867 'mh-index-checksum-origin-map nil ; checksum -> ( orig-folder, orig-msg )
1868 'mh-index-sequence-search-flag nil ; folder resulted from sequence search
1869 'mh-first-msg-num nil ; Number of first msg in buffer
1870 'mh-last-msg-num nil ; Number of last msg in buffer
1871 'mh-msg-count nil ; Number of msgs in buffer
1872 'mh-mode-line-annotation nil ; Indicates message range
1873 'mh-sequence-notation-history (make-hash-table)
1874 ; Remember what is overwritten by
1876 'imenu-create-index-function 'mh-index-create-imenu-index
1877 ; Setup imenu support
1878 'mh-previous-window-config nil) ; Previous window configuration
1879 (mh-remove-xemacs-horizontal-scrollbar)
1880 (setq truncate-lines t)
1882 (setq buffer-offer-save t)
1883 (mh-make-local-hook (mh-write-file-functions-compat))
1884 (add-hook (mh-write-file-functions-compat) 'mh-execute-commands nil t)
1885 (make-local-variable 'revert-buffer-function)
1886 (make-local-variable 'hl-line-mode) ; avoid pollution
1887 (mh-funcall-if-exists hl-line-mode 1)
1888 (setq revert-buffer-function 'mh-undo-folder)
1889 (or (assq 'mh-showing-mode minor-mode-alist)
1890 (setq minor-mode-alist
1891 (cons '(mh-showing-mode " Show") minor-mode-alist)))
1892 (easy-menu-add mh-folder-sequence-menu)
1893 (easy-menu-add mh-folder-message-menu)
1894 (easy-menu-add mh-folder-folder-menu)
1895 (set (make-local-variable 'tool-bar-map) mh-folder-tool-bar-map)
1896 (mh-funcall-if-exists mh-tool-bar-init :folder)
1897 (if (and mh-xemacs-flag
1898 font-lock-auto-fontify)
1899 (turn-on-font-lock))) ; Force font-lock in XEmacs.
1901 (defun mh-toggle-mime-buttons ()
1902 "Toggle option `mh-display-buttons-for-inline-parts-flag'."
1904 (setq mh-display-buttons-for-inline-parts-flag
1905 (not mh-display-buttons-for-inline-parts-flag))
1908 (defun mh-colors-available-p ()
1909 "Check if colors are available in the Emacs being used."
1911 (let ((color-cells (display-color-cells)))
1912 (and (numberp color-cells) (>= color-cells 8)))))
1914 (defun mh-colors-in-use-p ()
1915 "Check if colors are being used in the folder buffer."
1916 (and mh-colors-available-flag font-lock-mode))
1918 (defun mh-make-local-vars (&rest pairs)
1919 "Initialize local variables according to the variable-value PAIRS."
1922 (set (make-local-variable (car pairs)) (car (cdr pairs)))
1923 (setq pairs (cdr (cdr pairs)))))
1925 (defun mh-restore-desktop-buffer (desktop-buffer-file-name
1927 desktop-buffer-misc)
1928 "Restore an MH folder buffer specified in a desktop file.
1929 When desktop creates a buffer, DESKTOP-BUFFER-FILE-NAME holds the
1930 file name to visit, DESKTOP-BUFFER-NAME holds the desired buffer
1931 name, and DESKTOP-BUFFER-MISC holds a list of miscellaneous info
1932 used by the `desktop-buffer-handlers' functions."
1934 (mh-visit-folder desktop-buffer-name)
1937 ;; desktop-buffer-mode-handlers appeared in Emacs 22.
1938 (if (fboundp 'desktop-buffer-mode-handlers)
1939 (add-to-list 'desktop-buffer-mode-handlers
1940 '(mh-folder-mode . mh-restore-desktop-buffer)))
1942 (defun mh-scan-folder (folder range &optional dont-exec-pending)
1943 "Scan FOLDER over RANGE.
1945 After the scan is performed, switch to the buffer associated with
1948 Check the documentation of `mh-interactive-range' to see how RANGE is
1949 read in interactive use.
1951 The processing of outstanding commands is not performed if
1952 DONT-EXEC-PENDING is non-nil."
1953 (when (stringp range)
1954 (setq range (delete "" (split-string range "[ \t\n]"))))
1955 (cond ((null (get-buffer folder))
1956 (mh-make-folder folder))
1958 (unless dont-exec-pending
1959 (mh-process-or-undo-commands folder)
1960 (mh-reset-threads-and-narrowing))
1961 (switch-to-buffer folder)))
1962 (mh-regenerate-headers range)
1963 (if (zerop (buffer-size))
1964 (if (equal range "all")
1965 (message "Folder %s is empty" folder)
1966 (message "No messages in %s, range %s" folder range))
1968 (when (mh-outstanding-commands-p)
1969 (mh-notate-deleted-and-refiled)))
1971 (defun mh-msg-num-width-to-column (width)
1972 "Return the column for notations given message number WIDTH.
1973 Note that columns in Emacs start with 0.
1975 If `mh-scan-format-file' is set to \"Use MH-E scan Format\" this
1976 means that either `mh-scan-format-mh' or `mh-scan-format-nmh' are
1977 in use. This function therefore assumes that the first column is
1978 empty (to provide room for the cursor), the following WIDTH
1979 columns contain the message number, and the column for notations
1981 (if (eq mh-scan-format-file t)
1983 (error "%s %s" "Can't call `mh-msg-num-width-to-column' when"
1984 "`mh-scan-format-file' is not set to \"Use MH-E scan Format\"")))
1986 (defun mh-set-cmd-note (column)
1987 "Set `mh-cmd-note' to COLUMN.
1988 Note that columns in Emacs start with 0."
1989 (setq mh-cmd-note column))
1991 (defun mh-regenerate-headers (range &optional update)
1992 "Scan folder over RANGE.
1993 If UPDATE, append the scan lines, otherwise replace."
1994 (let ((folder mh-current-folder)
1995 (range (if (and range (atom range)) (list range) range))
1997 (message "Scanning %s..." folder)
1998 (mh-remove-all-notation)
1999 (with-mh-folder-updating (nil)
2001 (goto-char (point-max))
2002 (delete-region (point-min) (point-max))
2003 (if mh-adaptive-cmd-note-flag
2004 (mh-set-cmd-note (mh-msg-num-width-to-column (mh-msg-num-width
2006 (setq scan-start (point))
2007 (apply #'mh-exec-cmd-output
2010 "-noclear" "-noheader"
2011 "-width" (window-width)
2013 (goto-char scan-start)
2014 (cond ((looking-at "scan: no messages in")
2015 (keep-lines mh-scan-valid-regexp)) ; Flush random scan lines
2016 ((looking-at (if (mh-variant-p 'mu-mh)
2017 "scan: message set .* does not exist"
2018 "scan: bad message list "))
2019 (keep-lines mh-scan-valid-regexp))
2020 ((looking-at "scan: ")) ; Keep error messages
2022 (keep-lines mh-scan-valid-regexp))) ; Flush random scan lines
2023 (setq mh-seq-list (mh-read-folder-sequences folder nil))
2024 (mh-notate-user-sequences)
2026 (setq mh-mode-line-annotation
2027 (if (equal range '("all"))
2029 mh-partial-folder-mode-line-annotation)))
2030 (mh-make-folder-mode-line))
2031 (message "Scanning %s...done" folder)))
2033 (defun mh-generate-new-cmd-note (folder)
2034 "Fix the `mh-cmd-note' value for this FOLDER.
2036 After doing an `mh-get-new-mail' operation in this FOLDER, at least
2037 one line that looks like a truncated message number was found.
2039 Remove the text added by the last `mh-inc' command. It should be the
2040 messages cur-last. Call `mh-set-cmd-note', adjusting the notation
2041 column with the width of the largest message number in FOLDER.
2043 Reformat the message number width on each line in the buffer and trim
2044 the line length to fit in the window.
2046 Rescan the FOLDER in the range cur-last in order to display the
2047 messages that were removed earlier. They should all fit in the scan
2048 line now with no message truncation."
2050 (let ((maxcol (1- (window-width)))
2051 (old-cmd-note mh-cmd-note)
2054 ;; Nuke all of the lines just added by the last inc
2055 (delete-char (- (point-max) (point)))
2056 ;; Update the current buffer to reflect the new mh-cmd-note
2057 ;; value needed to display messages.
2058 (mh-set-cmd-note (mh-msg-num-width-to-column (mh-msg-num-width folder)))
2059 (setq mh-cmd-note-fmt (concat "%" (format "%d" mh-cmd-note) "d"))
2060 ;; Cleanup the messages that are in the buffer right now
2061 (goto-char (point-min))
2062 (cond ((memq 'unthread mh-view-ops)
2063 (mh-thread-add-spaces (- mh-cmd-note old-cmd-note)))
2064 (t (while (re-search-forward mh-scan-msg-number-regexp nil 0 1)
2065 ;; reformat the number to fix in mh-cmd-note columns
2066 (setq msgnum (string-to-number
2068 (match-beginning 1) (match-end 1))))
2069 (replace-match (format mh-cmd-note-fmt msgnum))
2070 ;; trim the line to fix in the window
2072 (let ((eol (point)))
2073 (move-to-column maxcol)
2074 (if (<= (point) eol)
2075 (delete-char (- eol (point))))))))
2076 ;; now re-read the lost messages
2077 (goto-char (point-max))
2079 (mh-regenerate-headers "cur-last" t)))))
2081 (defun mh-get-new-mail (maildrop-name)
2082 "Read new mail from MAILDROP-NAME into the current buffer.
2083 Return in the current buffer."
2084 (let ((point-before-inc (point))
2085 (folder mh-current-folder)
2086 (new-mail-flag nil))
2087 (with-mh-folder-updating (t)
2089 (message "inc %s -file %s..." folder maildrop-name)
2090 (message "inc %s..." folder))
2091 (setq mh-next-direction 'forward)
2092 (goto-char (point-max))
2093 (mh-remove-cur-notation)
2094 (let ((start-of-inc (point)))
2096 ;; I think MH 5 used "-ms-file" instead of "-file",
2097 ;; which would make inc'ing from maildrops fail.
2098 (mh-exec-cmd-output mh-inc-prog nil folder
2100 "-file" (expand-file-name maildrop-name)
2101 "-width" (window-width)
2103 (mh-exec-cmd-output mh-inc-prog nil
2105 "-width" (window-width)))
2107 (message "inc %s -file %s...done" folder maildrop-name)
2108 (message "inc %s...done" folder))
2109 (goto-char start-of-inc)
2110 (cond ((save-excursion
2111 (re-search-forward "^inc: no mail" nil t))
2112 (message "No new mail%s%s" (if maildrop-name " in " "")
2113 (if maildrop-name maildrop-name "")))
2114 ((and (when mh-folder-view-stack
2115 (let ((saved-text (buffer-substring-no-properties
2116 start-of-inc (point-max))))
2117 (delete-region start-of-inc (point-max))
2118 (unwind-protect (mh-widen t)
2119 (mh-remove-cur-notation)
2120 (goto-char (point-max))
2121 (setq start-of-inc (point))
2123 (goto-char start-of-inc))))
2125 ((re-search-forward "^inc:" nil t) ; Error messages
2126 (error "Error incorporating mail"))
2128 (equal mh-scan-format-file t)
2129 mh-adaptive-cmd-note-flag
2130 ;; Have we reached an edge condition?
2132 (re-search-forward mh-scan-msg-overflow-regexp nil 0 1))
2133 (setq start-of-inc (mh-generate-new-cmd-note folder))
2136 (setq new-mail-flag t)))
2137 (keep-lines mh-scan-valid-regexp) ; Flush random scan lines
2138 (let* ((sequences (mh-read-folder-sequences folder t))
2139 (new-cur (assoc 'cur sequences))
2140 (new-unseen (assoc mh-unseen-seq sequences)))
2141 (unless (assoc 'cur mh-seq-list)
2142 (push (list 'cur) mh-seq-list))
2143 (unless (assoc mh-unseen-seq mh-seq-list)
2144 (push (list mh-unseen-seq) mh-seq-list))
2145 (setcdr (assoc 'cur mh-seq-list) (cdr new-cur))
2146 (setcdr (assoc mh-unseen-seq mh-seq-list) (cdr new-unseen)))
2147 (when (equal (point-max) start-of-inc)
2151 (mh-make-folder-mode-line)
2152 (when (mh-speed-flists-active-p)
2153 (mh-speed-flists t mh-current-folder))
2154 (when (memq 'unthread mh-view-ops)
2155 (mh-thread-inc folder start-of-inc))
2157 (goto-char point-before-inc))
2158 (mh-notate-user-sequences (cons start-of-inc (point-max)))))))
2160 (defun mh-make-folder-mode-line (&optional ignored)
2161 "Set the fields of the mode line for a folder buffer.
2162 The optional argument is now obsolete and IGNORED. It used to be
2163 used to pass in what is now stored in the buffer-local variable
2164 `mh-mode-line-annotation'."
2166 (save-window-excursion
2168 (let ((new-first-msg-num (mh-get-msg-num nil)))
2169 (when (or (not (memq 'unthread mh-view-ops))
2170 (null mh-first-msg-num)
2171 (null new-first-msg-num)
2172 (< new-first-msg-num mh-first-msg-num))
2173 (setq mh-first-msg-num new-first-msg-num)))
2175 (let ((new-last-msg-num (mh-get-msg-num nil)))
2176 (when (or (not (memq 'unthread mh-view-ops))
2177 (null mh-last-msg-num)
2178 (null new-last-msg-num)
2179 (> new-last-msg-num mh-last-msg-num))
2180 (setq mh-last-msg-num new-last-msg-num)))
2181 (setq mh-msg-count (if mh-first-msg-num
2182 (count-lines (point-min) (point-max))
2184 (setq mode-line-buffer-identification
2185 (list (format " {%%b%s} %s msg%s"
2186 (if mh-mode-line-annotation
2187 (format "/%s" mh-mode-line-annotation)
2189 (if (zerop mh-msg-count)
2191 (format "%d" mh-msg-count))
2192 (if (zerop mh-msg-count)
2194 (cond ((> mh-msg-count 1)
2195 (format "s (%d-%d)" mh-first-msg-num
2198 (format " (%d)" mh-first-msg-num))
2200 (mh-logo-display))))
2202 (defun mh-add-sequence-notation (msg internal-seq-flag)
2203 "Add sequence notation to the MSG on the current line.
2204 If INTERNAL-SEQ-FLAG is non-nil, then refontify the scan line if
2205 font-lock is turned on."
2206 (with-mh-folder-updating (t)
2209 (if internal-seq-flag
2211 ;; Change the buffer so that if transient-mark-mode is active
2212 ;; and there is an active region it will get deactivated as in
2213 ;; the case of user sequences.
2214 (mh-notate nil nil mh-cmd-note)
2215 (when font-lock-mode
2216 (font-lock-fontify-region (point) (line-end-position))))
2217 (forward-char (+ mh-cmd-note mh-scan-field-destination-offset))
2218 (let ((stack (gethash msg mh-sequence-notation-history)))
2219 (setf (gethash msg mh-sequence-notation-history)
2220 (cons (char-after) stack)))
2221 (mh-notate nil mh-note-seq
2222 (+ mh-cmd-note mh-scan-field-destination-offset))))))
2224 (defun mh-remove-sequence-notation (msg internal-seq-flag &optional all)
2225 "Remove sequence notation from the MSG on the current line.
2226 If INTERNAL-SEQ-FLAG is non-nil, then `font-lock' was used to
2227 highlight the sequence. In that case, no notation needs to be removed.
2228 Otherwise the effect of inserting `mh-note-seq' needs to be reversed.
2229 If ALL is non-nil, then all sequence marks on the scan line are
2231 (with-mh-folder-updating (t)
2232 ;; This takes care of internal sequences...
2233 (mh-notate nil nil mh-cmd-note)
2234 (unless internal-seq-flag
2235 ;; ... and this takes care of user sequences.
2236 (let ((stack (gethash msg mh-sequence-notation-history)))
2237 (while (and all (cdr stack))
2238 (setq stack (cdr stack)))
2242 (forward-char (+ mh-cmd-note mh-scan-field-destination-offset))
2244 (insert (car stack))))
2245 (setf (gethash msg mh-sequence-notation-history) (cdr stack))))))
2247 (defun mh-remove-cur-notation ()
2248 "Remove old cur notation."
2249 (let ((cur-msg (car (mh-seq-to-msgs 'cur))))
2252 (mh-goto-msg cur-msg t t)
2253 (looking-at mh-scan-cur-msg-number-regexp))
2254 (mh-notate nil ? mh-cmd-note)
2255 (setq overlay-arrow-position nil)))))
2257 (defun mh-remove-all-notation ()
2258 "Remove all notations on all scan lines that MH-E introduces."
2260 (setq overlay-arrow-position nil)
2261 (goto-char (point-min))
2262 (mh-iterate-on-range msg (cons (point-min) (point-max))
2263 (mh-notate nil ? mh-cmd-note)
2264 (mh-remove-sequence-notation msg nil t))
2265 (clrhash mh-sequence-notation-history)))
2268 (defun mh-goto-cur-msg (&optional minimal-changes-flag)
2269 "Position the cursor at the current message.
2270 When optional argument MINIMAL-CHANGES-FLAG is non-nil, the
2271 function doesn't recenter the folder buffer."
2272 (let ((cur-msg (car (mh-seq-to-msgs 'cur))))
2274 (mh-goto-msg cur-msg t t))
2275 (unless minimal-changes-flag
2278 (mh-maybe-show cur-msg)))
2280 (setq overlay-arrow-position nil)
2281 (message "No current message")))))
2283 (defun mh-process-or-undo-commands (folder)
2284 "If FOLDER has outstanding commands, then either process or discard them.
2285 Called by functions like `mh-sort-folder', so also invalidate
2288 (if (mh-outstanding-commands-p)
2289 (if (or mh-do-not-confirm-flag
2291 "Process outstanding deletes and refiles? "))
2292 (mh-process-commands folder)
2296 (mh-invalidate-show-buffer))
2298 (defun mh-process-commands (folder)
2299 "Process outstanding commands for FOLDER.
2301 This function runs `mh-before-commands-processed-hook' before the
2302 commands are processed and `mh-after-commands-processed-hook'
2303 after the commands are processed."
2304 (message "Processing deletes and refiles for %s..." folder)
2306 (with-mh-folder-updating (nil)
2307 ;; Run the before hook -- the refile and delete lists are still valid
2308 (run-hooks 'mh-before-commands-processed-hook)
2310 ;; Update the unseen sequence if it exists
2313 (let ((redraw-needed-flag mh-index-data)
2314 (folders-changed (list mh-current-folder))
2315 (seq-map (and mh-refile-list mh-refile-preserves-sequences-flag
2316 (mh-create-sequence-map mh-seq-list)))
2317 (dest-map (and mh-refile-list mh-refile-preserves-sequences-flag
2318 (make-hash-table))))
2319 ;; Remove invalid scan lines if we are in an index folder and then remove
2320 ;; the real messages
2322 (mh-index-delete-folder-headers)
2323 (setq folders-changed
2324 (append folders-changed (mh-index-execute-commands))))
2326 ;; Then refile messages
2327 (mh-mapc #'(lambda (folder-msg-list)
2328 (let* ((dest-folder (symbol-name (car folder-msg-list)))
2329 (last (car (mh-translate-range dest-folder "last")))
2330 (msgs (cdr folder-msg-list)))
2331 (push dest-folder folders-changed)
2332 (setq redraw-needed-flag t)
2333 (apply #'mh-exec-cmd
2334 "refile" "-src" folder dest-folder
2335 (mh-coalesce-msg-list msgs))
2336 (mh-delete-scan-msgs msgs)
2337 ;; Preserve sequences in destination folder...
2338 (when mh-refile-preserves-sequences-flag
2340 (loop for i from (1+ (or last 0))
2341 for msg in (sort (copy-sequence msgs) #'<)
2342 do (loop for seq-name in (gethash msg seq-map)
2343 do (push i (gethash seq-name dest-map))))
2345 #'(lambda (seq msgs)
2346 ;; Can't be run in the background, since the
2347 ;; current folder is changed by mark this could
2348 ;; lead to a race condition with the next refile.
2349 (apply #'mh-exec-cmd "mark"
2350 "-sequence" (symbol-name seq) dest-folder
2351 "-add" (mapcar #'(lambda (x) (format "%s" x))
2352 (mh-coalesce-msg-list msgs))))
2355 (setq mh-refile-list ())
2357 ;; Now delete messages
2358 (cond (mh-delete-list
2359 (setq redraw-needed-flag t)
2360 (apply 'mh-exec-cmd "rmm" folder
2361 (mh-coalesce-msg-list mh-delete-list))
2362 (mh-delete-scan-msgs mh-delete-list)
2363 (setq mh-delete-list nil)))
2365 ;; Don't need to remove sequences since delete and refile do so.
2367 (if (> (buffer-size) 0)
2368 (mh-define-sequence 'cur (list (or (mh-get-msg-num nil) "last"))))
2370 ;; Redraw folder buffer if needed
2371 (when (and redraw-needed-flag)
2372 (when (mh-speed-flists-active-p)
2373 (apply #'mh-speed-flists t folders-changed))
2374 (cond ((memq 'unthread mh-view-ops) (mh-thread-inc folder (point-max)))
2375 (mh-index-data (mh-index-insert-folder-headers))))
2377 (and (buffer-file-name (get-buffer mh-show-buffer))
2378 (not (file-exists-p (buffer-file-name (get-buffer mh-show-buffer))))
2379 ;; If "inc" were to put a new msg in this file,
2380 ;; we would not notice, so mark it invalid now.
2381 (mh-invalidate-show-buffer))
2383 (setq mh-seq-list (mh-read-folder-sequences mh-current-folder nil))
2384 (mh-remove-all-notation)
2385 (mh-notate-user-sequences)
2387 ;; Run the after hook -- now folders-changed is valid,
2388 ;; but not the lists of specific messages.
2389 (let ((mh-folders-changed folders-changed))
2390 (run-hooks 'mh-after-commands-processed-hook)))
2392 (message "Processing deletes and refiles for %s...done" folder)))
2394 (defun mh-update-unseen ()
2395 "Synchronize the unseen sequence with MH.
2396 Return non-nil iff the MH folder was set.
2397 The hook `mh-unseen-updated-hook' is called after the unseen sequence
2400 (let* ((unseen-seq (mh-find-seq mh-unseen-seq))
2401 (unseen-msgs (mh-seq-msgs unseen-seq)))
2404 (mh-undefine-sequence mh-unseen-seq mh-seen-list)
2405 (run-hooks 'mh-unseen-updated-hook)
2407 (setq unseen-msgs (delq (car mh-seen-list) unseen-msgs))
2408 (setq mh-seen-list (cdr mh-seen-list)))
2409 (setcdr unseen-seq unseen-msgs)
2410 t) ;since we set the folder
2411 (setq mh-seen-list nil)))))
2413 (defun mh-delete-scan-msgs (msgs)
2414 "Delete the scan listing lines for MSGS."
2417 (when (mh-goto-msg (car msgs) t t)
2418 (when (memq 'unthread mh-view-ops)
2419 (mh-thread-forget-message (car msgs)))
2421 (setq msgs (cdr msgs)))))
2423 (defun mh-outstanding-commands-p ()
2424 "Return non-nil if there are outstanding deletes or refiles."
2426 (when (eq major-mode 'mh-show-mode)
2427 (set-buffer mh-show-folder-buffer))
2428 (or mh-delete-list mh-refile-list)))
2430 (defun mh-coalesce-msg-list (messages)
2431 "Given a list of MESSAGES, return a list of message number ranges.
2432 This is the inverse of `mh-read-msg-list', which expands ranges.
2433 Message lists passed to MH programs should be processed by this
2434 function to avoid exceeding system command line argument limits."
2435 (let ((msgs (sort (copy-sequence messages) 'mh-greaterp))
2441 (if (or (not (numberp prev))
2442 (not (equal (car msgs) (1- prev))))
2443 (progn ;non-sequential, flush old range
2444 (if (eq prev range-high)
2445 (setq ranges (cons range-high ranges))
2446 (setq ranges (cons (format "%s-%s" prev range-high) ranges)))
2447 (setq range-high nil))))
2449 (setq range-high (car msgs))) ;start new or first range
2450 (setq prev (car msgs))
2451 (setq msgs (cdr msgs)))
2454 (defun mh-greaterp (msg1 msg2)
2455 "Return the greater of two message indicators MSG1 and MSG2.
2456 Strings are \"smaller\" than numbers.
2457 Valid values are things like \"cur\", \"last\", 1, and 1820."
2464 (string-lessp msg2 msg1))))
2466 (defun mh-lessp (msg1 msg2)
2467 "Return the lesser of two message indicators MSG1 and MSG2.
2468 Strings are \"smaller\" than numbers.
2469 Valid values are things like \"cur\", \"last\", 1, and 1820."
2470 (not (mh-greaterp msg1 msg2)))
2474 ;;; Basic sequence handling
2476 (defun mh-delete-seq-locally (seq)
2477 "Remove MH-E's record of SEQ."
2478 (let ((entry (mh-find-seq seq)))
2479 (setq mh-seq-list (delq entry mh-seq-list))))
2481 (defun mh-read-folder-sequences (folder save-refiles)
2482 "Read and return the predefined sequences for a FOLDER.
2483 If SAVE-REFILES is non-nil, then keep the sequences
2484 that note messages to be refiled."
2487 (mh-mapc (function (lambda (seq) ; Save the refiling sequences
2488 (if (mh-folder-name-p (mh-seq-name seq))
2489 (setq seqs (cons seq seqs)))))
2492 (if (eq 0 (mh-exec-cmd-quiet nil "mark" folder "-list"))
2494 ;; look for name in line of form "cur: 4" or "myseq (private): 23"
2495 (while (re-search-forward "^[^: ]+" nil t)
2496 (setq seqs (cons (mh-make-seq (intern (buffer-substring
2501 (delete-region (point-min) (point))))) ; avoid race with
2505 (defun mh-read-msg-list ()
2506 "Return a list of message numbers from point to the end of the line.
2507 Expands ranges into set of individual numbers."
2509 (end-of-line (save-excursion (end-of-line) (point)))
2511 (while (re-search-forward "[0-9]+" end-of-line t)
2512 (setq num (string-to-number (buffer-substring (match-beginning 0)
2514 (cond ((looking-at "-") ; Message range
2516 (re-search-forward "[0-9]+" end-of-line t)
2517 (let ((num2 (string-to-number
2518 (buffer-substring (match-beginning 0)
2521 (error "Bad message range: %d-%d" num num2))
2522 (while (<= num num2)
2523 (setq msgs (cons num msgs))
2524 (setq num (1+ num)))))
2525 ((not (zerop num)) ;"pick" outputs "0" to mean no match
2526 (setq msgs (cons num msgs)))))
2529 (defun mh-notate-user-sequences (&optional range)
2530 "Mark user-defined sequences in RANGE.
2532 Check the documentation of `mh-interactive-range' to see how
2533 RANGE is read in interactive use; if nil all messages are
2536 (setq range (cons (point-min) (point-max))))
2537 (let ((seqs mh-seq-list)
2538 (msg-hash (make-hash-table)))
2540 (dolist (msg (mh-seq-msgs seq))
2541 (push (car seq) (gethash msg msg-hash))))
2542 (mh-iterate-on-range msg range
2543 (loop for seq in (gethash msg msg-hash)
2544 do (mh-add-sequence-notation msg (mh-internal-seq seq))))))
2546 (defvar mh-internal-seqs '(answered cur deleted forwarded printed))
2548 (defun mh-internal-seq (name)
2549 "Return non-nil if NAME is the name of an internal MH-E sequence."
2550 (or (memq name mh-internal-seqs)
2551 (eq name mh-unseen-seq)
2552 (and (mh-colors-in-use-p) mh-tick-seq (eq name mh-tick-seq))
2553 (eq name mh-previous-seq)
2554 (mh-folder-name-p name)))
2556 (defun mh-valid-seq-p (name)
2557 "Return non-nil if NAME is a valid MH sequence name."
2559 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" (symbol-name name))))
2561 (defun mh-delete-msg-from-seq (range sequence &optional internal-flag)
2562 "Delete RANGE from SEQUENCE.
2564 Check the documentation of `mh-interactive-range' to see how
2565 RANGE is read in interactive use.
2567 In a program, non-nil INTERNAL-FLAG means do not inform MH of the
2569 (interactive (list (mh-interactive-range "Delete")
2570 (mh-read-seq-default "Delete from" t)
2572 (let ((entry (mh-find-seq sequence))
2573 (user-sequence-flag (not (mh-internal-seq sequence)))
2574 (folders-changed (list mh-current-folder))
2577 (mh-iterate-on-range msg range
2579 ;; Calling "mark" repeatedly takes too long. So we will pretend here
2580 ;; that we are just modifying an internal sequence...
2581 (when (memq msg (cdr entry))
2582 (mh-remove-sequence-notation msg (not user-sequence-flag)))
2583 (mh-delete-a-msg-from-seq msg sequence t))
2584 ;; ... and here we will "mark" all the messages at one go.
2585 (unless internal-flag (mh-undefine-sequence sequence msg-list))
2586 (when (and mh-index-data (not internal-flag))
2587 (setq folders-changed
2588 (append folders-changed
2589 (mh-index-delete-from-sequence sequence msg-list))))
2590 (when (and (eq sequence mh-unseen-seq) (mh-speed-flists-active-p))
2591 (apply #'mh-speed-flists t folders-changed)))))
2593 (defun mh-catchup (range)
2594 "Delete RANGE from the \"unseen\" sequence.
2596 Check the documentation of `mh-interactive-range' to see how
2597 RANGE is read in interactive use."
2598 (interactive (list (mh-interactive-range "Catchup"
2599 (cons (point-min) (point-max)))))
2600 (mh-delete-msg-from-seq range mh-unseen-seq))
2602 (defun mh-delete-a-msg-from-seq (msg sequence internal-flag)
2603 "Delete MSG from SEQUENCE.
2604 If INTERNAL-FLAG is non-nil, then do not inform MH of the
2606 (let ((entry (mh-find-seq sequence)))
2607 (when (and entry (memq msg (mh-seq-msgs entry)))
2608 (if (not internal-flag)
2609 (mh-undefine-sequence sequence (list msg)))
2610 (setcdr entry (delq msg (mh-seq-msgs entry))))))
2612 (defun mh-undefine-sequence (seq msgs)
2613 "Remove from the SEQ the list of MSGS."
2614 (when (and (mh-valid-seq-p seq) msgs)
2615 (apply #'mh-exec-cmd "mark" mh-current-folder "-delete"
2616 "-sequence" (symbol-name seq) (mh-coalesce-msg-list msgs))))
2618 (defun mh-define-sequence (seq msgs)
2619 "Define the SEQ to contain the list of MSGS.
2620 Do not mark pseudo-sequences or empty sequences.
2621 Signals an error if SEQ is an invalid name."
2623 (mh-valid-seq-p seq)
2624 (not (mh-folder-name-p seq)))
2626 (mh-exec-cmd-error nil "mark" mh-current-folder "-add" "-zero"
2627 "-sequence" (symbol-name seq)
2628 (mh-coalesce-msg-list msgs)))))
2630 (defun mh-seq-containing-msg (msg &optional include-internal-flag)
2631 "Return a list of the sequences containing MSG.
2632 If INCLUDE-INTERNAL-FLAG non-nil, include MH-E internal sequences
2634 (let ((l mh-seq-list)
2637 (and (memq msg (mh-seq-msgs (car l)))
2638 (or include-internal-flag
2639 (not (mh-internal-seq (mh-seq-name (car l)))))
2640 (setq seqs (cons (mh-seq-name (car l)) seqs)))
2646 ;;; Build mh-folder-mode keymap:
2648 (suppress-keymap mh-folder-mode-map)
2650 ;; Use defalias to make sure the documented primary key bindings
2651 ;; appear in menu lists.
2652 (defalias 'mh-alt-show 'mh-show)
2653 (defalias 'mh-alt-refile-msg 'mh-refile-msg)
2654 (defalias 'mh-alt-send 'mh-send)
2655 (defalias 'mh-alt-visit-folder 'mh-visit-folder)
2657 ;; Save the "b" binding for a future `back'. Maybe?
2658 (gnus-define-keys mh-folder-mode-map
2660 "!" mh-refile-or-write-again
2662 "," mh-header-display
2664 ";" mh-toggle-mh-decode-mime-flag
2665 ">" mh-write-msg-to-file
2667 "E" mh-extract-rejected-mail
2669 "\177" mh-previous-page
2670 "\C-d" mh-delete-msg-no-motion
2671 "\t" mh-index-next-folder
2672 [backtab] mh-index-previous-folder
2673 "\M-\t" mh-index-previous-folder
2676 "\ed" mh-redistribute
2678 "^" mh-alt-refile-msg
2685 "k" mh-delete-subject-or-thread
2687 "n" mh-next-undeleted-msg
2688 "\M-n" mh-next-unread-msg
2690 "p" mh-previous-undeleted-msg
2691 "\M-p" mh-previous-unread-msg
2695 "t" mh-toggle-showing
2697 "v" mh-index-visit-folder
2698 "x" mh-execute-commands
2701 (gnus-define-keys (mh-folder-map "F" mh-folder-mode-map)
2703 "'" mh-index-ticked-messages
2706 "f" mh-alt-visit-folder
2710 "n" mh-index-new-messages
2711 "o" mh-alt-visit-folder
2713 "q" mh-index-sequenced-messages
2714 "r" mh-rescan-folder
2715 "s" mh-search-folder
2717 "v" mh-visit-folder)
2719 (define-key mh-folder-mode-map "I" mh-inc-spool-map)
2721 (gnus-define-keys (mh-junk-map "J" mh-folder-mode-map)
2723 "b" mh-junk-blacklist
2724 "w" mh-junk-whitelist)
2726 (gnus-define-keys (mh-ps-print-map "P" mh-folder-mode-map)
2728 "C" mh-ps-print-toggle-color
2729 "F" mh-ps-print-toggle-faces
2730 "f" mh-ps-print-msg-file
2732 "p" mh-ps-print-msg)
2734 (gnus-define-keys (mh-sequence-map "S" mh-folder-mode-map)
2735 "'" mh-narrow-to-tick
2737 "d" mh-delete-msg-from-seq
2739 "l" mh-list-sequences
2740 "n" mh-narrow-to-seq
2741 "p" mh-put-msg-in-seq
2742 "s" mh-msg-is-in-seq
2745 (gnus-define-keys (mh-thread-map "T" mh-folder-mode-map)
2747 "u" mh-thread-ancestor
2748 "p" mh-thread-previous-sibling
2749 "n" mh-thread-next-sibling
2750 "t" mh-toggle-threads
2751 "d" mh-thread-delete
2752 "o" mh-thread-refile)
2754 (gnus-define-keys (mh-limit-map "/" mh-folder-mode-map)
2755 "'" mh-narrow-to-tick
2758 "f" mh-narrow-to-from
2759 "r" mh-narrow-to-range
2760 "s" mh-narrow-to-subject
2764 (gnus-define-keys (mh-extract-map "X" mh-folder-mode-map)
2766 "s" mh-store-msg ;shar
2767 "u" mh-store-msg) ;uuencode
2769 (gnus-define-keys (mh-digest-map "D" mh-folder-mode-map)
2772 "\177" mh-page-digest-backwards
2773 "b" mh-burst-digest)
2775 (gnus-define-keys (mh-mime-map "K" mh-folder-mode-map)
2777 "a" mh-mime-save-parts
2778 "e" mh-display-with-external-viewer
2779 "i" mh-folder-inline-mime-part
2780 "o" mh-folder-save-mime-part
2781 "t" mh-toggle-mime-buttons
2782 "v" mh-folder-toggle-mime-part
2784 [backtab] mh-prev-button
2785 "\M-\t" mh-prev-button)
2789 (define-key mh-folder-mode-map [button2] 'mh-show-mouse))
2791 (define-key mh-folder-mode-map [mouse-2] 'mh-show-mouse)))
2793 ;; "C-c /" prefix is used in mh-folder-mode by pgp.el and mailcrypt
2799 ;; If you add a new prefix, add appropriate text to the nil key.
2801 ;; In general, messages are grouped logically. Taking the main commands for
2802 ;; example, the first line is "ways to view messages," the second line is
2803 ;; "things you can do with messages", and the third is "composing" messages.
2805 ;; When adding a new prefix, ensure that the help message contains "what" the
2806 ;; prefix is for. For example, if the word "folder" were not present in the
2807 ;; "F" entry, it would not be clear what these commands operated upon.
2808 (defvar mh-help-messages
2809 '((nil "[i]nc, [.]show, [,]show all, [n]ext, [p]revious,\n"
2810 "[d]elete, [o]refile, e[x]ecute,\n"
2811 "[s]end, [r]eply,\n"
2812 "[;]toggle MIME decoding.\n"
2813 "Prefix characters:\n [F]older, [S]equence, [J]unk, MIME [K]eys,"
2814 "\n [T]hread, [/]limit, e[X]tract, [D]igest, [I]nc spools.")
2816 (?F "[l]ist; [v]isit folder;\n"
2817 "[n]ew messages; [']ticked messages; [s]earch; [i]ndexed search;\n"
2818 "[p]ack; [S]ort; [r]escan; [k]ill")
2819 (?P "[p]rint message to [f]ile; old-style [l]pr printing;\n"
2820 "Toggle printing of [C]olors, [F]aces")
2821 (?S "[p]ut message in sequence, [n]arrow, [']narrow to ticked, [w]iden,\n"
2822 "[s]equences, [l]ist,\n"
2823 "[d]elete message from sequence, [k]ill sequence")
2824 (?T "[t]oggle, [d]elete, [o]refile thread")
2825 (?/ "Limit to [c]c, [f]rom, [r]ange, [s]ubject, [t]o; [w]iden")
2826 (?X "un[s]har, [u]udecode message")
2827 (?D "[b]urst digest")
2828 (?K "[v]iew, [i]nline, [o]utput/save MIME part; save [a]ll parts; \n"
2829 "[TAB] next; [SHIFT-TAB] previous")
2830 (?J "[b]lacklist, [w]hitelist message"))
2831 "Key binding cheat sheet.
2833 This is an associative array which is used to show the most common commands.
2834 The key is a prefix char. The value is one or more strings which are
2835 concatenated together and displayed in the minibuffer if ? is pressed after
2836 the prefix character. The special key nil is used to display the
2837 non-prefixed commands.
2839 The substitutions described in `substitute-command-keys' are performed as
2844 (dolist (mess '("^Cursor not pointing to message$"
2845 "^There is no other window$"))
2846 (add-to-list 'debug-ignored-errors mess))
2851 ;; indent-tabs-mode: nil
2852 ;; sentence-end-double-space: nil
2855 ;; arch-tag: cce884de-bd37-4104-9963-e4439d5ed22b
2856 ;;; mh-e.el ends here