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, "s" 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 ;; If Emacs can't find mh-rmail or mh-smail, add the following to ~/.emacs:
42 ;; (require 'mh-autoloads)
44 ;; If you want to customize MH-E before explicitly loading it, add this:
45 ;; (require 'mh-cus-load)
47 ;; MH (Message Handler) is a powerful mail reader.
49 ;; The MH newsgroup is comp.mail.mh; the mailing list is mh-users@ics.uci.edu
50 ;; (send to mh-users-request to be added). See the monthly Frequently Asked
51 ;; Questions posting there for information on getting MH and MH-E:
52 ;; http://www.faqs.org/faqs/mail/mh-faq/part1/preamble.html
54 ;; N.B. MH must have been compiled with the MHE compiler flag or several
55 ;; features necessary for MH-E will be missing from MH commands, specifically
56 ;; the -build switch to repl and forw.
58 ;; MH-E is an Emacs interface to the MH mail system.
60 ;; MH-E is supported in GNU Emacs 21 and 22 as well as XEmacs 21
61 ;; (except for versions 21.5.9-21.5.16), with MH 6.8.4 on, nmh 1.0.4
62 ;; on, and GNU mailutils 0.4 on.
65 ;; mh-e-users@lists.sourceforge.net
66 ;; mh-e-announce@lists.sourceforge.net
67 ;; mh-e-devel@lists.sourceforge.net
69 ;; Subscribe by sending a "subscribe" message to
70 ;; <list>-request@lists.sourceforge.net, or by using the web interface at
71 ;; https://sourceforge.net/mail/?group_id=13357
74 ;; https://sourceforge.net/tracker/?group_id=13357&atid=113357
75 ;; Include the output of M-x mh-version in the bug report unless
76 ;; you're 110% sure we won't ask for it.
79 ;; https://sourceforge.net/tracker/?group_id=13357&atid=363357
82 ;; https://sourceforge.net/tracker/?group_id=13357&atid=213357
86 ;; Original version for Gosling emacs by Brian Reid, Stanford, 1982.
87 ;; Modified by James Larus, BBN, July 1984 and UCB, 1984 & 1985.
88 ;; Rewritten for GNU Emacs, James Larus, 1985.
89 ;; Modified by Stephen Gildea, 1988.
90 ;; Maintenance picked up by Bill Wohler and the
91 ;; SourceForge Crew <http://mh-e.sourceforge.net/>, 2001.
95 ;; Provide functions to the rest of MH-E. However, mh-e.el must not
96 ;; use any definitions in files that require mh-e from mh-loaddefs,
97 ;; for if it does it will introduce a require loop.
98 (require 'mh-loaddefs)
103 (defvar mh-xemacs-flag (featurep 'xemacs)
104 "Non-nil means the current Emacs is XEmacs."))
107 (require 'mh-xemacs))
109 (require 'mh-buffers)
116 ;; Try to keep variables local to a single file. Provide accessors if
117 ;; variables are shared. Use this section as a last resort.
119 (defconst mh-version "7.93+cvs" "Version number of MH-E.")
124 '("/usr/local/nmh/bin" ; nmh default
127 "/usr/bin/mh/" ; Ultrix 4.2, Linux
128 "/usr/new/mh/" ; Ultrix < 4.2
129 "/usr/contrib/mh/bin/" ; BSDI
130 "/usr/pkg/bin/" ; NetBSD
132 "/usr/local/bin/mu-mh/" ; GNU mailutils - default
133 "/usr/bin/mu-mh/") ; GNU mailutils - packaged
134 "List of directories to search for variants of the MH variant.
135 The list `exec-path' is searched in addition to this list.
136 There's no need for users to modify this list. Instead add extra
137 directories to the customizable variable `mh-path'.")
139 (defvar mh-variants nil
140 "List describing known MH variants.
141 Do not access this variable directly as it may not have yet been initialized.
142 Use the function `mh-variants' instead.")
144 (defvar mh-variant-in-use nil
145 "The MH variant currently in use; a string with variant and version number.
146 This differs from `mh-variant' when the latter is set to
150 "Directory containing MH commands, such as inc, repl, and rmm.")
153 (put 'mh-progs 'risky-local-variable t)
156 "Directory containing the MH library.
157 This directory contains, among other things, the components file.")
160 (put 'mh-lib 'risky-local-variable t)
162 (defvar mh-lib-progs nil
163 "Directory containing MH helper programs.
164 This directory contains, among other things, the mhl program.")
167 (put 'mh-lib-progs 'risky-local-variable t)
169 ;; Profile Components
171 (defvar mh-draft-folder nil
172 "Cached value of the \"Draft-Folder:\" MH profile component.
173 Name of folder containing draft messages.
174 Nil means do not use a draft folder.")
177 "Cached value of the \"Inbox:\" MH profile component.
178 Set to \"+inbox\" if no such component.
179 Name of the Inbox folder.")
181 (defvar mh-user-path nil
182 "Cached value of the \"Path:\" MH profile component.
183 User's mail folder directory.")
185 ;; Maps declared here so that they can be used in docstrings.
187 (defvar mh-folder-mode-map (make-keymap)
188 "Keymap for MH-Folder mode.")
190 (defvar mh-folder-seq-tool-bar-map nil
191 "Keymap for MH-Folder tool bar.")
193 (defvar mh-folder-tool-bar-map nil
194 "Keymap for MH-Folder tool bar.")
196 (defvar mh-inc-spool-map (make-sparse-keymap)
197 "Keymap for MH-E's mh-inc-spool commands.")
199 (defvar mh-letter-mode-map (copy-keymap text-mode-map)
200 "Keymap for MH-Letter mode.")
202 (defvar mh-letter-tool-bar-map nil
203 "Keymap for MH-Letter tool bar.")
205 (defvar mh-search-mode-map (make-sparse-keymap)
206 "Keymap for MH-Search mode.")
208 (defvar mh-show-mode-map (make-sparse-keymap)
209 "Keymap MH-Show mode.")
211 (defvar mh-show-seq-tool-bar-map nil
212 "Keymap for MH-Show tool bar.")
214 (defvar mh-show-tool-bar-map nil
215 "Keymap for MH-Show tool bar.")
217 ;; MH-Folder Locals (alphabetical)
219 (defvar mh-arrow-marker nil
220 "Marker for arrow display in fringe.")
222 (defvar mh-colors-available-flag nil
223 "Non-nil means colors are available.")
225 (defvar mh-current-folder nil
226 "Name of current folder, a string.")
228 (defvar mh-delete-list nil
229 "List of message numbers to delete.
230 This variable can be used by
231 `mh-before-commands-processed-hook'.")
233 (defvar mh-folder-view-stack nil
234 "Stack of previous folder views.")
236 (defvar mh-index-data nil
237 "Info about index search results.")
239 (defvar mh-index-previous-search nil)
241 (defvar mh-index-msg-checksum-map nil)
243 (defvar mh-index-checksum-origin-map nil)
245 (defvar mh-index-sequence-search-flag nil)
247 (defvar mh-mode-line-annotation nil
248 "Message range displayed in buffer.")
250 (defvar mh-next-direction 'forward
251 "Direction to move to next message.")
253 (defvar mh-previous-window-config nil
254 "Window configuration before MH-E command.")
256 (defvar mh-refile-list nil
257 "List of folder names in `mh-seq-list'.
258 This variable can be used by
259 `mh-before-commands-processed-hook'.")
261 (defvar mh-seen-list nil
262 "List of displayed messages to be removed from the \"Unseen\" sequence.")
264 (defvar mh-seq-list nil
265 "Alist of this folder's sequences.
266 Elements have the form (SEQUENCE . MESSAGES).")
268 (defvar mh-sequence-notation-history nil
269 "Remember original notation that is overwritten by `mh-note-seq'.")
271 (defvar mh-show-buffer nil
272 "Buffer that displays message for this folder.")
274 (defvar mh-showing-mode nil
275 "If non-nil, show the message in a separate window.")
277 (defvar mh-view-ops nil
278 "Stack of operations that change the folder view.
279 These operations include narrowing or threading.")
281 ;; MH-Show Locals (alphabetical)
283 (defvar mh-globals-hash (make-hash-table)
284 "Keeps track of MIME data on a per buffer basis.")
286 (defvar mh-show-folder-buffer nil
287 "Keeps track of folder whose message is being displayed.")
291 (defvar mh-folders-changed nil
292 "Lists which folders were affected by deletes and refiles.
293 This list will always include the current folder
294 `mh-current-folder'. This variable can be used by
295 `mh-after-commands-processed-hook'.")
297 (defvar mh-mail-header-separator "--------"
298 "*Line used by MH to separate headers from text in messages being composed.
300 This variable should not be used directly in programs. Programs
301 should use `mail-header-separator' instead.
302 `mail-header-separator' is initialized to
303 `mh-mail-header-separator' in `mh-letter-mode'; in other
304 contexts, you may have to perform this initialization yourself.
306 Do not make this a regular expression as it may be the argument
307 to `insert' and it is passed through `regexp-quote' before being
308 used by functions like `re-search-forward'.")
310 (defvar mh-sent-from-folder nil
311 "Folder of msg assoc with this letter.")
313 (defvar mh-sent-from-msg nil
314 "Number of msg assoc with this letter.")
318 (defvar mh-unseen-seq nil
319 "Cached value of the \"Unseen-Sequence:\" MH profile component.
320 Name of the Unseen sequence.")
322 (defvar mh-previous-seq nil
323 "Cached value of the \"Previous-Sequence:\" MH profile component.
324 Name of the Previous sequence.")
326 ;; Etc. (alphabetical)
328 (defvar mh-flists-present-flag nil
329 "Non-nil means that we have \"flists\".")
331 (defvar mh-index-data-file ".mhe_index"
332 "MH-E specific file where index seach info is stored.")
334 (defvar mh-letter-header-field-regexp "^\\([A-Za-z][A-Za-z0-9-]*\\):")
336 (defvar mh-page-to-next-msg-flag nil
337 "Non-nil means next SPC or whatever goes to next undeleted message.")
339 (defvar mh-pgp-support-flag (not (not (locate-library "mml2015")))
340 "Non-nil means PGP support is available.")
342 (defvar mh-signature-separator "-- \n"
343 "Text of a signature separator.
345 A signature separator is used to separate the body of a message
346 from the signature. This can be used by user agents such as MH-E
347 to render the signature differently or to suppress the inclusion
348 of the signature in a reply. Use `mh-signature-separator-regexp'
349 when searching for a separator.")
351 (defvar mh-signature-separator-regexp "^-- $"
352 "This regular expression matches the signature separator.
353 See `mh-signature-separator'.")
355 (defvar mh-thread-scan-line-map nil
356 "Map of message index to various parts of the scan line.")
357 (make-variable-buffer-local 'mh-thread-scan-line-map)
359 (defvar mh-thread-scan-line-map-stack nil
360 "Old map of message index to various parts of the scan line.
361 This is the original map that is stored when the folder is
363 (make-variable-buffer-local 'mh-thread-scan-line-map-stack)
365 (defvar mh-x-mailer-string nil
366 "*String containing the contents of the X-Mailer header field.
367 If nil, this variable is initialized to show the version of MH-E,
368 Emacs, and MH the first time a message is composed.")
372 ;;; MH-E Entry Points
374 (eval-when-compile (require 'gnus))
376 (defmacro mh-macro-expansion-time-gnus-version ()
377 "Return Gnus version available at macro expansion time.
378 The macro evaluates the Gnus version at macro expansion time. If
379 MH-E was compiled then macro expansion happens at compile time."
382 (defun mh-run-time-gnus-version ()
383 "Return Gnus version available at run time."
389 "Display version information about MH-E and the MH mail handling system."
391 (set-buffer (get-buffer-create mh-info-buffer))
394 (insert "MH-E " mh-version "\n\n")
395 ;; MH-E compilation details.
396 (insert "MH-E compilation details:\n")
397 (let* ((compiled-mhe (byte-code-function-p (symbol-function 'mh-version)))
398 (gnus-compiled-version (if compiled-mhe
399 (mh-macro-expansion-time-gnus-version)
401 (insert " Byte compiled:\t\t" (if compiled-mhe "yes" "no") "\n"
402 " Gnus (compile-time):\t" gnus-compiled-version "\n"
403 " Gnus (run-time):\t" (mh-run-time-gnus-version) "\n\n"))
405 (insert (emacs-version) "\n\n")
407 (if mh-variant-in-use
408 (insert mh-variant-in-use "\n"
409 " mh-progs:\t" mh-progs "\n"
410 " mh-lib:\t" mh-lib "\n"
411 " mh-lib-progs:\t" mh-lib-progs "\n\n")
412 (insert "No MH variant detected\n"))
415 (call-process "uname" nil t nil "-a")
417 (goto-char (point-min))
418 (display-buffer mh-info-buffer))
424 (defun mh-list-to-string (l)
425 "Flatten the list L and make every element of the new list into a string."
426 (nreverse (mh-list-to-string-1 l)))
428 (defun mh-list-to-string-1 (l)
429 "Flatten the list L and make every element of the new list into a string."
432 (cond ((null element))
434 (push (symbol-name element) new-list))
436 (push (int-to-string element) new-list))
439 (push element new-list))
441 (setq new-list (nconc (mh-list-to-string-1 element) new-list)))
443 (error "Bad element: %s" element))))
448 ;;; MH-E Process Support
450 (defvar mh-index-max-cmdline-args 500
451 "Maximum number of command line args.")
453 (defun mh-xargs (cmd &rest args)
454 "Partial imitation of xargs.
455 The current buffer contains a list of strings, one on each line.
456 The function will execute CMD with ARGS and pass the first
457 `mh-index-max-cmdline-args' strings to it. This is repeated till
458 all the strings have been used."
459 (goto-char (point-min))
460 (let ((current-buffer (current-buffer)))
462 (let ((out (current-buffer)))
463 (set-buffer current-buffer)
465 (let ((arg-list (reverse args))
467 (while (and (not (eobp)) (< count mh-index-max-cmdline-args))
468 (push (buffer-substring-no-properties (point)
469 (mh-line-end-position))
473 (apply #'call-process cmd nil (list out nil) nil
474 (nreverse arg-list))))
476 (insert-buffer-substring out)))))
478 ;; XXX This should be applied anywhere MH-E calls out to /bin/sh.
479 (defun mh-quote-for-shell (string)
480 "Quote STRING for /bin/sh.
481 Adds double-quotes around entire string and quotes the characters
482 \\, `, and $ with a backslash."
484 (loop for x across string
485 concat (format (if (memq x '(?\\ ?` ?$)) "\\%c" "%c") x))
488 (defun mh-exec-cmd (command &rest args)
489 "Execute mh-command COMMAND with ARGS.
490 The side effects are what is desired. Any output is assumed to be
491 an error and is shown to the user. The output is not read or
494 (set-buffer (get-buffer-create mh-log-buffer))
495 (let* ((initial-size (mh-truncate-log-buffer))
497 (args (mh-list-to-string args)))
498 (apply 'call-process (expand-file-name command mh-progs) nil t nil args)
499 (when (> (buffer-size) initial-size)
502 (insert "Errors when executing: " command)
503 (loop for arg in args do (insert " " arg))
505 (save-window-excursion
506 (switch-to-buffer-other-window mh-log-buffer)
509 (defun mh-exec-cmd-error (env command &rest args)
510 "In environment ENV, execute mh-command COMMAND with ARGS.
511 ENV is nil or a string of space-separated \"var=value\" elements.
512 Signals an error if process does not complete successfully."
514 (set-buffer (get-buffer-create mh-temp-buffer))
516 (let ((process-environment process-environment))
517 ;; XXX: We should purge the list that split-string returns of empty
518 ;; strings. This can happen in XEmacs if leading or trailing spaces
520 (dolist (elem (if (stringp env) (split-string env " ") ()))
521 (push elem process-environment))
522 (mh-handle-process-error
523 command (apply #'call-process (expand-file-name command mh-progs)
524 nil t nil (mh-list-to-string args))))))
526 (defun mh-exec-cmd-daemon (command filter &rest args)
527 "Execute MH command COMMAND in the background.
529 If FILTER is non-nil then it is used to process the output
530 otherwise the default filter `mh-process-daemon' is used. See
531 `set-process-filter' for more details of FILTER.
533 ARGS are passed to COMMAND as command line arguments."
535 (set-buffer (get-buffer-create mh-log-buffer))
536 (mh-truncate-log-buffer))
537 (let* ((process-connection-type nil)
538 (process (apply 'start-process
540 (expand-file-name command mh-progs)
541 (mh-list-to-string args))))
542 (set-process-filter process (or filter 'mh-process-daemon))
545 (defun mh-exec-cmd-env-daemon (env command filter &rest args)
546 "In ennvironment ENV, execute mh-command COMMAND in the background.
548 ENV is nil or a string of space-separated \"var=value\" elements.
549 Signals an error if process does not complete successfully.
551 If FILTER is non-nil then it is used to process the output
552 otherwise the default filter `mh-process-daemon' is used. See
553 `set-process-filter' for more details of FILTER.
555 ARGS are passed to COMMAND as command line arguments."
556 (let ((process-environment process-environment))
557 (dolist (elem (if (stringp env) (split-string env " ") ()))
558 (push elem process-environment))
559 (apply #'mh-exec-cmd-daemon command filter args)))
561 (defun mh-process-daemon (process output)
562 "PROCESS daemon that puts OUTPUT into a temporary buffer.
563 Any output from the process is displayed in an asynchronous
565 (with-current-buffer (get-buffer-create mh-log-buffer)
566 (insert-before-markers output)
567 (display-buffer mh-log-buffer)))
569 (defun mh-exec-cmd-quiet (raise-error command &rest args)
570 "Signal RAISE-ERROR if COMMAND with ARGS fails.
571 Execute MH command COMMAND with ARGS. ARGS is a list of strings.
572 Return at start of mh-temp buffer, where output can be parsed and
574 Returns value of `call-process', which is 0 for success, unless
575 RAISE-ERROR is non-nil, in which case an error is signaled if
576 `call-process' returns non-0."
577 (set-buffer (get-buffer-create mh-temp-buffer))
581 (expand-file-name command mh-progs) nil t nil
583 (goto-char (point-min))
585 (mh-handle-process-error command value)
588 (defun mh-exec-cmd-output (command display &rest args)
589 "Execute MH command COMMAND with DISPLAY flag and ARGS.
590 Put the output into buffer after point.
591 Set mark after inserted text.
592 Output is expected to be shown to user, not parsed by MH-E."
593 (push-mark (point) t)
595 (expand-file-name command mh-progs) nil t display
596 (mh-list-to-string args))
598 ;; The following is used instead of 'exchange-point-and-mark because the
599 ;; latter activates the current region (between point and mark), which
600 ;; turns on highlighting. So prior to this bug fix, doing "inc" would
601 ;; highlight a region containing the new messages, which is undesirable.
602 ;; The bug wasn't seen in emacs21 but still occurred in XEmacs21.4.
603 (mh-exchange-point-and-mark-preserving-active-mark))
606 (eval-when-compile (mh-do-in-xemacs (defvar mark-active)))
608 (defun mh-exchange-point-and-mark-preserving-active-mark ()
609 "Put the mark where point is now, and point where the mark is now.
610 This command works even when the mark is not active, and
611 preserves whether the mark is active or not."
613 (let ((is-active (and (boundp 'mark-active) mark-active)))
614 (let ((omark (mark t)))
616 (error "No mark set in this buffer"))
619 (if (boundp 'mark-active)
620 (setq mark-active is-active))
623 (defun mh-exec-lib-cmd-output (command &rest args)
624 "Execute MH library command COMMAND with ARGS.
625 Put the output into buffer after point.
626 Set mark after inserted text."
627 (apply 'mh-exec-cmd-output (expand-file-name command mh-lib-progs) nil args))
629 (defun mh-handle-process-error (command status)
630 "Raise error if COMMAND returned non-zero STATUS, otherwise return STATUS."
633 (goto-char (point-min))
634 (insert (if (integerp status)
635 (format "%s: exit code %d\n" command status)
636 (format "%s: %s\n" command status)))
638 (let ((error-message (buffer-substring (point-min) (point-max))))
639 (set-buffer (get-buffer-create mh-log-buffer))
640 (mh-truncate-log-buffer)
641 (insert error-message)))
642 (error "%s failed, check buffer %s for error message"
643 command mh-log-buffer)))
649 (defcustom mh-path nil
650 "*Additional list of directories to search for MH.
653 :type '(repeat (directory)))
655 (defun mh-variants ()
656 "Return a list of installed variants of MH on the system.
657 This function looks for MH in `mh-sys-path', `mh-path' and
658 `exec-path'. The format of the list of variants that is returned
659 is described by the variable `mh-variants'."
663 ;; Make a unique list of directories, keeping the given order.
664 ;; We don't want the same MH variant to be listed multiple times.
665 (loop for dir in (append mh-path mh-sys-path exec-path) do
666 (setq dir (file-chase-links (directory-file-name dir)))
667 (add-to-list 'list-unique dir))
668 (loop for dir in (nreverse list-unique) do
669 (when (and dir (file-directory-p dir) (file-readable-p dir))
670 (let ((variant (mh-variant-info dir)))
672 (add-to-list 'mh-variants variant)))))
675 (defun mh-variant-info (dir)
676 "Return MH variant found in DIR, or nil if none present."
678 (let ((tmp-buffer (get-buffer-create mh-temp-buffer)))
679 (set-buffer tmp-buffer)
681 ((mh-variant-mh-info dir))
682 ((mh-variant-nmh-info dir))
683 ((mh-variant-mu-mh-info dir))))))
685 (defun mh-variant-mh-info (dir)
686 "Return info for MH variant in DIR assuming a temporary buffer is setup."
687 ;; MH does not have the -version option.
688 ;; Its version number is included in the output of "-help" as:
690 ;; version: MH 6.8.4 #2[UCI] (burrito) of Fri Jan 15 20:01:39 EST 1999
691 ;; options: [ATHENA] [BIND] [DUMB] [LIBLOCKFILE] [LOCALE] [MAILGROUP] [MHE]
692 ;; [MHRC] [MIME] [MORE='"/usr/bin/sensible-pager"'] [NLINK_HACK]
693 ;; [NORUSERPASS] [OVERHEAD] [POP] [POPSERVICE='"pop-3"'] [RENAME]
694 ;; [RFC1342] [RPATHS] [RPOP] [SENDMTS] [SMTP] [SOCKETS]
695 ;; [SPRINTFTYPE=int] [SVR4] [SYS5] [SYS5DIR] [TERMINFO]
696 ;; [TYPESIG=void] [UNISTD] [UTK] [VSPRINTF]
697 (let ((mhparam (expand-file-name "mhparam" dir)))
698 (when (mh-file-command-p mhparam)
700 (call-process mhparam nil '(t nil) nil "-help")
701 (goto-char (point-min))
702 (when (search-forward-regexp "version: MH \\(\\S +\\)" nil t)
703 (let ((version (format "MH %s" (match-string 1))))
705 (call-process mhparam nil '(t nil) nil "libdir")
706 (goto-char (point-min))
707 (when (search-forward-regexp "^.*$" nil t)
708 (let ((libdir (match-string 0)))
711 (mh-lib-progs ,libdir)
716 (defun mh-variant-mu-mh-info (dir)
717 "Return info for GNU mailutils variant in DIR.
718 This assumes that a temporary buffer is setup."
719 ;; 'mhparam -version' output:
720 ;; mhparam (GNU mailutils 0.3.2)
721 (let ((mhparam (expand-file-name "mhparam" dir)))
722 (when (mh-file-command-p mhparam)
724 (call-process mhparam nil '(t nil) nil "-version")
725 (goto-char (point-min))
726 (when (search-forward-regexp "mhparam (\\(GNU [Mm]ailutils \\S +\\))"
728 (let ((version (match-string 1))
732 (mh-lib-progs ,(mh-profile-component "libdir"))
733 (mh-lib ,(mh-profile-component "etcdir"))
735 (flists ,(file-exists-p
736 (expand-file-name "flists" dir)))))))))
738 (defun mh-variant-nmh-info (dir)
739 "Return info for nmh variant in DIR assuming a temporary buffer is setup."
740 ;; `mhparam -version' outputs:
741 ;; mhparam -- nmh-1.1-RC1 [compiled on chaak at Fri Jun 20 11:03:28 PDT 2003]
742 (let ((mhparam (expand-file-name "mhparam" dir)))
743 (when (mh-file-command-p mhparam)
745 (call-process mhparam nil '(t nil) nil "-version")
746 (goto-char (point-min))
747 (when (search-forward-regexp "mhparam -- nmh-\\(\\S +\\)" nil t)
748 (let ((version (format "nmh %s" (match-string 1)))
752 (mh-lib-progs ,(mh-profile-component "libdir"))
753 (mh-lib ,(mh-profile-component "etcdir"))
755 (flists ,(file-exists-p
756 (expand-file-name "flists" dir)))))))))
758 (defun mh-file-command-p (file)
759 "Return t if file FILE is the name of a executable regular file."
760 (and (file-regular-p file) (file-executable-p file)))
762 (defun mh-variant-set-variant (variant)
763 "Setup the system variables for the MH variant named VARIANT.
764 If VARIANT is a string, use that key in the alist returned by the
765 function `mh-variants'.
766 If VARIANT is a symbol, select the first entry that matches that
769 ((stringp variant) ;e.g. "nmh 1.1-RC1"
770 (when (assoc variant (mh-variants))
771 (let* ((alist (cdr (assoc variant (mh-variants))))
772 (lib-progs (cadr (assoc 'mh-lib-progs alist)))
773 (lib (cadr (assoc 'mh-lib alist)))
774 (progs (cadr (assoc 'mh-progs alist)))
775 (flists (cadr (assoc 'flists alist))))
776 ;;(set-default mh-variant variant)
777 (setq mh-x-mailer-string nil
778 mh-flists-present-flag flists
779 mh-lib-progs lib-progs
782 mh-variant-in-use variant))))
783 ((symbolp variant) ;e.g. 'nmh (pick the first match)
784 (loop for variant-list in (mh-variants)
785 when (eq variant (cadr (assoc 'variant (cdr variant-list))))
786 return (let* ((version (car variant-list))
787 (alist (cdr variant-list))
788 (lib-progs (cadr (assoc 'mh-lib-progs alist)))
789 (lib (cadr (assoc 'mh-lib alist)))
790 (progs (cadr (assoc 'mh-progs alist)))
791 (flists (cadr (assoc 'flists alist))))
792 ;;(set-default mh-variant flavor)
793 (setq mh-x-mailer-string nil
794 mh-flists-present-flag flists
795 mh-lib-progs lib-progs
798 mh-variant-in-use version)
801 (defun mh-variant-p (&rest variants)
802 "Return t if variant is any of VARIANTS.
803 Currently known variants are 'MH, 'nmh, and 'mu-mh."
804 (let ((variant-in-use
805 (cadr (assoc 'variant (assoc mh-variant-in-use (mh-variants))))))
806 (not (null (member variant-in-use variants)))))
808 (defun mh-profile-component (component)
809 "Return COMPONENT value from mhparam, or nil if unset."
811 ;; MH and nmh use -components, Mailutils uses -component. Since MH
812 ;; and nmh work with an unambiguous prefix, the `s' is dropped here.
813 (mh-exec-cmd-quiet nil "mhparam" "-component" component)
814 (mh-profile-component-value component)))
816 (defun mh-profile-component-value (component)
817 "Find and return the value of COMPONENT in the current buffer.
818 Returns nil if the component is not in the buffer."
819 (let ((case-fold-search t))
820 (goto-char (point-min))
821 (cond ((not (re-search-forward (format "^%s:" component) nil t)) nil)
822 ((looking-at "[\t ]*$") nil)
824 (re-search-forward "[\t ]*\\([^\t \n].*\\)$" nil t)
825 (let ((start (match-beginning 1)))
827 (buffer-substring start (point)))))))
829 (defun mh-variant-set (variant)
830 "Set the MH variant to VARIANT.
831 Sets `mh-progs', `mh-lib', `mh-lib-progs' and
832 `mh-flists-present-flag'.
833 If the VARIANT is \"autodetect\", then first try nmh, then MH and
834 finally GNU mailutils."
836 (list (completing-read
838 (mapcar (lambda (x) (list (car x))) (mh-variants))
840 (let ((valid-list (mapcar (lambda (x) (car x)) (mh-variants))))
843 ((eq variant 'autodetect)
845 ((mh-variant-set-variant 'nmh)
846 (message "%s installed as MH variant" mh-variant-in-use))
847 ((mh-variant-set-variant 'mh)
848 (message "%s installed as MH variant" mh-variant-in-use))
849 ((mh-variant-set-variant 'mu-mh)
850 (message "%s installed as MH variant" mh-variant-in-use))
852 (message "No MH variant found on the system"))))
853 ((member variant valid-list)
854 (when (not (mh-variant-set-variant variant))
855 (message "Warning: %s variant not found. Autodetecting..." variant)
856 (mh-variant-set 'autodetect)))
858 (message "Unknown variant; use %s"
859 (mapconcat '(lambda (x) (format "%s" (car x)))
860 (mh-variants) " or "))))))
862 (defcustom mh-variant 'autodetect
863 "*Specifies the variant used by MH-E.
865 The default setting of this option is \"Auto-detect\" which means
866 that MH-E will automatically choose the first of nmh, MH, or GNU
867 mailutils that it finds in the directories listed in
868 `mh-path' (which you can customize), `mh-sys-path', and
869 `exec-path'. If MH-E can't find MH at all, you may have to
870 customize `mh-path' and add the directory in which the command
871 \"mhparam\" is located. If, on the other hand, you have both nmh
872 and mailutils installed (for example) and `mh-variant-in-use' was
873 initialized to nmh but you want to use mailutils, then you can
874 set this option to \"mailutils\".
876 When this variable is changed, MH-E resets `mh-progs', `mh-lib',
877 `mh-lib-progs', `mh-flists-present-flag', and `mh-variant-in-use'
878 accordingly. Prior to version 8, it was often necessary to set
879 some of these variables in \"~/.emacs\"; now it is no longer
880 necessary and can actually cause problems."
882 (const :tag "Auto-detect" autodetect)
883 ,@(mapcar (lambda (x) `(const ,(car x))) (mh-variants)))
884 :set (lambda (symbol value)
885 (set-default symbol value) ;Done in mh-variant-set-variant!
886 (mh-variant-set value))
891 ;;; MH-E Customization
893 ;; All of the defgroups, defcustoms, and deffaces in MH-E are found
894 ;; here. This makes it possible to customize modules that aren't
895 ;; loaded yet. It also makes it easier to organize the customization
898 ;; This section contains the following sub-sections:
900 ;; 1. MH-E Customization Groups
902 ;; These are the customization group definitions. Every group has a
903 ;; associated manual node. The ordering is alphabetical, except for
904 ;; the groups mh-faces and mh-hooks which are last .
906 ;; 2. MH-E Customization
908 ;; These are the actual customization variables. There is a
909 ;; sub-section for each group in the MH-E Customization Groups
910 ;; section, in the same order, separated by page breaks. Within
911 ;; each section, variables are sorted alphabetically.
915 ;; All hooks must be placed in the mh-hook group; in addition, add
916 ;; the group associated with the manual node in which the hook is
917 ;; described. Since the mh-hook group appears near the end of this
918 ;; section, the hooks will appear at the end of these other groups.
922 ;; All faces must be placed in the mh-faces group; in addition, add
923 ;; the group associated with the manual node in which the face is
924 ;; described. Since the mh-faces group appears near the end of this
925 ;; section, the faces will appear at the end of these other groups.
927 (defun mh-customize (&optional delete-other-windows-flag)
928 "Customize MH-E variables.
929 If optional argument DELETE-OTHER-WINDOWS-FLAG is non-nil, other
930 windows in the frame are removed."
932 (customize-group 'mh-e)
933 (when delete-other-windows-flag
934 (delete-other-windows)))
938 ;;; MH-E Customization Groups
941 "Emacs interface to the MH mail system.
942 MH is the Rand Mail Handler. Other implementations include nmh
944 :link '(custom-manual "(mh-e)Top")
947 (defgroup mh-alias nil
949 :link '(custom-manual "(mh-e)Aliases")
953 (defgroup mh-folder nil
954 "Organizing your mail with folders."
956 :link '(custom-manual "(mh-e)Folders")
959 (defgroup mh-folder-selection nil
962 :link '(custom-manual "(mh-e)Folder Selection")
965 (defgroup mh-identity nil
967 :link '(custom-manual "(mh-e)Identities")
968 :prefix "mh-identity-"
972 "Incorporating your mail."
974 :link '(custom-manual "(mh-e)Incorporating Mail")
977 (defgroup mh-junk nil
978 "Dealing with junk mail."
979 :link '(custom-manual "(mh-e)Junk")
983 (defgroup mh-letter nil
986 :link '(custom-manual "(mh-e)Editing Drafts")
989 (defgroup mh-ranges nil
992 :link '(custom-manual "(mh-e)Ranges")
995 (defgroup mh-scan-line-formats nil
997 :link '(custom-manual "(mh-e)Scan Line Formats")
1001 (defgroup mh-search nil
1003 :link '(custom-manual "(mh-e)Searching")
1004 :prefix "mh-search-"
1007 (defgroup mh-sending-mail nil
1010 :link '(custom-manual "(mh-e)Sending Mail")
1013 (defgroup mh-sequences nil
1016 :link '(custom-manual "(mh-e)Sequences")
1019 (defgroup mh-show nil
1020 "Reading your mail."
1022 :link '(custom-manual "(mh-e)Reading Mail")
1025 (defgroup mh-speedbar nil
1028 :link '(custom-manual "(mh-e)Speedbar")
1031 (defgroup mh-thread nil
1033 :prefix "mh-thread-"
1034 :link '(custom-manual "(mh-e)Threading")
1037 (defgroup mh-tool-bar nil
1039 :link '(custom-manual "(mh-e)Tool Bar")
1043 (defgroup mh-hooks nil
1045 :link '(custom-manual "(mh-e)Top")
1049 (defgroup mh-faces nil
1050 "Faces used in MH-E."
1051 :link '(custom-manual "(mh-e)Top")
1058 ;;; Emacs Interface to the MH Mail System (:group mh-e)
1060 ;; See Variant Support, above.
1062 ;;; Aliases (:group 'mh-alias)
1064 (defcustom mh-alias-completion-ignore-case-flag t
1065 "*Non-nil means don't consider case significant in MH alias completion.
1067 As MH ignores case in the aliases, so too does MH-E. However, you
1068 may turn off this option to make case significant which can be
1069 used to segregate completion of your aliases. You might use
1070 lowercase for mailing lists and uppercase for people."
1074 (defcustom mh-alias-expand-aliases-flag nil
1075 "*Non-nil means to expand aliases entered in the minibuffer.
1077 In other words, aliases entered in the minibuffer will be
1078 expanded to the full address in the message draft. By default,
1079 this expansion is not performed."
1083 (defcustom mh-alias-flash-on-comma t
1084 "*Specify whether to flash address or warn on translation.
1086 This option controls the behavior when a [comma] is pressed while
1087 entering aliases or addresses. The default setting flashes the
1088 address associated with an address in the minibuffer briefly, but
1089 does not display a warning if the alias is not found."
1090 :type '(choice (const :tag "Flash but Don't Warn If No Alias" t)
1091 (const :tag "Flash and Warn If No Alias" 1)
1092 (const :tag "Don't Flash Nor Warn If No Alias" nil))
1095 (defcustom mh-alias-insert-file nil
1096 "*Filename used to store a new MH-E alias.
1098 The default setting of this option is \"Use Aliasfile Profile
1099 Component\". This option can also hold the name of a file or a
1100 list a file names. If this option is set to a list of file names,
1101 or the \"Aliasfile:\" profile component contains more than one file
1102 name, MH-E will prompt for one of them when MH-E adds an alias."
1103 :type '(choice (const :tag "Use Aliasfile Profile Component" nil)
1104 (file :tag "Alias File")
1105 (repeat :tag "List of Alias Files" file))
1108 (defcustom mh-alias-insertion-location 'sorted
1109 "Specifies where new aliases are entered in alias files.
1111 This option is set to \"Alphabetical\" by default. If you organize
1112 your alias file in other ways, then adding aliases to the \"Top\"
1113 or \"Bottom\" of your alias file might be more appropriate."
1114 :type '(choice (const :tag "Alphabetical" sorted)
1115 (const :tag "Top" top)
1116 (const :tag "Bottom" bottom))
1119 (defcustom mh-alias-local-users t
1120 "*If on, local users are added to alias completion.
1122 Aliases are created from \"/etc/passwd\" entries with a user ID
1123 larger than a magical number, typically 200. This can be a handy
1124 tool on a machine where you and co-workers exchange messages.
1125 These aliases have the form \"local.first.last\" if a real name is
1126 present in the password file. Otherwise, the alias will have the
1127 form \"local.login\".
1129 If you're on a system with thousands of users you don't know, and
1130 the loading of local aliases slows MH-E down noticeably, then
1131 turn this option off.
1133 This option also takes a string which is executed to generate the
1134 password file. For example, use \"ypcat passwd\" to obtain the
1136 :type '(choice (boolean) (string))
1139 (defcustom mh-alias-local-users-prefix "local."
1140 "*String prefixed to the real names of users from the password file.
1141 This option can also be set to \"Use Login\".
1143 For example, consider the following password file entry:
1145 psg:x:1000:1000:Peter S Galbraith,,,:/home/psg:/bin/tcsh
1147 The following settings of this option will produce the associated
1150 \"local.\" local.peter.galbraith
1151 \"\" peter.galbraith
1154 This option has no effect if variable `mh-alias-local-users' is
1156 :type '(choice (const :tag "Use Login" nil)
1160 (defcustom mh-alias-passwd-gecos-comma-separator-flag t
1161 "*Non-nil means the gecos field in the password file uses a comma separator.
1163 In the example in `mh-alias-local-users-prefix', commas are used
1164 to separate different values within the so-called gecos field.
1165 This is a fairly common usage. However, in the rare case that the
1166 gecos field in your password file is not separated by commas and
1167 whose contents may contain commas, you can turn this option off."
1173 ;;; Organizing Your Mail with Folders (:group 'mh-folder)
1175 (defcustom mh-new-messages-folders t
1176 "Folders searched for the \"unseen\" sequence.
1178 Set this option to \"Inbox\" to search the \"+inbox\" folder or
1179 \"All\" to search all of the top level folders. Otherwise, list
1180 the folders that should be searched with the \"Choose Folders\"
1183 See also `mh-recursive-folders-flag'."
1184 :type '(choice (const :tag "Inbox" t)
1185 (const :tag "All" nil)
1186 (repeat :tag "Choose Folders" (string :tag "Folder")))
1189 (defcustom mh-ticked-messages-folders t
1190 "Folders searched for `mh-tick-seq'.
1192 Set this option to \"Inbox\" to search the \"+inbox\" folder or
1193 \"All\" to search all of the top level folders. Otherwise, list
1194 the folders that should be searched with the \"Choose Folders\"
1197 See also `mh-recursive-folders-flag'."
1198 :type '(choice (const :tag "Inbox" t)
1199 (const :tag "All" nil)
1200 (repeat :tag "Choose Folders" (string :tag "Folder")))
1203 (defcustom mh-large-folder 200
1204 "The number of messages that indicates a large folder.
1206 If a folder is deemed to be large, that is the number of messages
1207 in it exceed this value, then confirmation is needed when it is
1208 visited. Even when `mh-show-threads-flag' is non-nil, the folder
1209 is not automatically threaded, if it is large. If set to nil all
1210 folders are treated as if they are small."
1211 :type '(choice (const :tag "No Limit") integer)
1214 (defcustom mh-recenter-summary-flag nil
1215 "*Non-nil means to recenter the summary window.
1217 If this option is turned on, recenter the summary window when the
1218 show window is toggled off."
1222 (defcustom mh-recursive-folders-flag nil
1223 "*Non-nil means that commands which operate on folders do so recursively."
1227 (defcustom mh-sortm-args nil
1228 "*Additional arguments for \"sortm\"\\<mh-folder-mode-map>.
1230 This option is consulted when a prefix argument is used with
1231 \\[mh-sort-folder]. Normally default arguments to \"sortm\" are
1232 specified in the MH profile. This option may be used to provide
1233 an alternate view. For example, \"'(\"-nolimit\" \"-textfield\"
1234 \"subject\")\" is a useful setting."
1240 ;;; Folder Selection (:group 'mh-folder-selection)
1242 (defcustom mh-default-folder-for-message-function nil
1243 "Function to select a default folder for refiling or \"Fcc:\".
1245 When this function is called, the current buffer contains the message
1246 being refiled and point is at the start of the message. This function
1247 should return the default folder as a string with a leading \"+\"
1248 sign. It can also return nil so that the last folder name is used as
1249 the default, or an empty string to suppress the default entirely."
1251 :group 'mh-folder-selection)
1253 (defcustom mh-default-folder-list nil
1254 "*List of addresses and folders.
1256 The folder name associated with the first address found in this
1257 list is used as the default for `mh-refile-msg' and similar
1258 functions. Each element in this list contains a \"Check Recipient\"
1259 item. If this item is turned on, then the address is checked
1260 against the recipient instead of the sender. This is useful for
1263 See `mh-prompt-for-refile-folder' and `mh-folder-from-address'
1264 for more information."
1265 :type '(repeat (list (regexp :tag "Address")
1266 (string :tag "Folder")
1267 (boolean :tag "Check Recipient")))
1268 :group 'mh-folder-selection)
1270 (defcustom mh-default-folder-must-exist-flag t
1271 "*Non-nil means guessed folder name must exist to be used.
1273 If the derived folder does not exist, and this option is on, then
1274 the last folder name used is suggested. This is useful if you get
1275 mail from various people for whom you have an alias, but file
1276 them all in the same project folder.
1278 See `mh-prompt-for-refile-folder' and `mh-folder-from-address'
1279 for more information."
1281 :group 'mh-folder-selection)
1283 (defcustom mh-default-folder-prefix ""
1284 "*Prefix used for folder names generated from aliases.
1285 The prefix is used to prevent clutter in your mail directory.
1287 See `mh-prompt-for-refile-folder' and `mh-folder-from-address'
1288 for more information."
1290 :group 'mh-folder-selection)
1294 ;;; Identities (:group 'mh-identity)
1297 (unless (fboundp 'mh-identity-make-menu-no-autoload)
1298 (defun mh-identity-make-menu-no-autoload ()
1299 "Temporary definition.
1300 Real definition will take effect when mh-identity is loaded."
1303 (defcustom mh-identity-list nil
1304 "*List of identities.
1306 To customize this option, click on the \"INS\" button and enter a label
1307 such as \"Home\" or \"Work\". Then click on the \"INS\" button with the
1308 label \"Add at least one item below\". Then choose one of the items in
1311 You can specify an alternate \"From:\" header field using the \"From
1312 Field\" menu item. You must include a valid email address. A standard
1313 format is \"First Last <login@@host.domain>\". If you use an initial
1314 with a period, then you must quote your name as in '\"First I. Last\"
1315 <login@@host.domain>'. People usually list the name of the company
1316 where they work using the \"Organization Field\" menu item. Set any
1317 arbitrary header field and value in the \"Other Field\" menu item.
1318 Unless the header field is a standard one, precede the name of your
1319 field's label with \"X-\", as in \"X-Fruit-of-the-Day:\". The value of
1320 \"Attribution Verb\" overrides the setting of
1321 `mh-extract-from-attribution-verb'. Set your signature with the
1322 \"Signature\" menu item. You can specify the contents of
1323 `mh-signature-file-name', a file, or a function. Specify a different
1324 key to sign or encrypt messages with the \"GPG Key ID\" menu item.
1326 You can select the identities you have added via the menu called
1327 \"Identity\" in the MH-Letter buffer. You can also use
1328 \\[mh-insert-identity]. To clear the fields and signature added by the
1329 identity, select the \"None\" identity.
1331 The \"Identity\" menu contains two other items to save you from having
1332 to set the identity on every message. The menu item \"Set Default for
1333 Session\" can be used to set the default identity to the current
1334 identity until you exit Emacs. The menu item \"Save as Default\" sets
1335 the option `mh-identity-default' to the current identity setting. You
1336 can also customize the `mh-identity-default' option in the usual
1338 :type '(repeat (list :tag ""
1339 (string :tag "Label")
1340 (repeat :tag "Add at least one item below"
1342 (cons :tag "From Field"
1344 (string :tag "Value"))
1345 (cons :tag "Organization Field"
1346 (const "Organization")
1347 (string :tag "Value"))
1348 (cons :tag "Other Field"
1349 (string :tag "Field")
1350 (string :tag "Value"))
1351 (cons :tag "Attribution Verb"
1352 (const ":attribution-verb")
1353 (string :tag "Value"))
1354 (cons :tag "Signature"
1355 (const :tag "Signature"
1358 (const :tag "mh-signature-file-name"
1362 (cons :tag "GPG Key ID"
1363 (const :tag "GPG Key ID"
1364 ":pgg-default-user-id")
1365 (string :tag "Value"))))))
1366 :set (lambda (symbol value)
1367 (set-default symbol value)
1368 (mh-identity-make-menu-no-autoload))
1369 :group 'mh-identity)
1371 (defcustom mh-auto-fields-list nil
1372 "List of recipients for which header lines are automatically inserted.
1374 This option can be used to set the identity depending on the
1375 recipient. To customize this option, click on the \"INS\" button and
1376 enter a regular expression for the recipient's address. Click on the
1377 \"INS\" button with the \"Add at least one item below\" label. Then choose
1378 one of the items in the \"Value Menu\".
1380 The \"Identity\" menu item is used to select an identity from those
1381 configured in `mh-identity-list'. All of the information for that
1382 identity will be added if the recipient matches. The \"Fcc Field\" menu
1383 item is used to select a folder that is used in the \"Fcc:\" header.
1384 When you send the message, MH will put a copy of your message in this
1385 folder. The \"Mail-Followup-To Field\" menu item is used to insert an
1386 \"Mail-Followup-To:\" header field with the recipients you provide. If
1387 the recipient's mail user agent supports this header field (as nmh
1388 does), then their replies will go to the addresses listed. This is
1389 useful if their replies go both to the list and to you and you don't
1390 have a mechanism to suppress duplicates. If you reply to someone not
1391 on the list, you must either remove the \"Mail-Followup-To:\" field, or
1392 ensure the recipient is also listed there so that he receives replies
1393 to your reply. Other header fields may be added using the \"Other
1396 These fields can only be added after the recipient is known. Once the
1397 header contains one or more recipients, run the
1398 \\[mh-insert-auto-fields] command or choose the \"Identity -> Insert
1399 Auto Fields\" menu item to insert these fields manually. However, you
1400 can just send the message and the fields will be added automatically.
1401 You are given a chance to see these fields and to confirm them before
1402 the message is actually sent. You can do away with this confirmation
1403 by turning off the option `mh-auto-fields-prompt-flag'.
1405 You should avoid using the same header field in `mh-auto-fields-list'
1406 and `mh-identity-list' definitions that may apply to the same message
1407 as the result is undefined."
1410 (string :tag "Recipient")
1411 (repeat :tag "Add at least one item below"
1413 (cons :tag "Identity"
1418 (function (lambda (arg) `(const ,arg)))
1419 (mapcar 'car mh-identity-list))))
1420 (cons :tag "Fcc Field"
1422 (string :tag "Value"))
1423 (cons :tag "Mail-Followup-To Field"
1424 (const "Mail-Followup-To")
1425 (string :tag "Value"))
1426 (cons :tag "Other Field"
1427 (string :tag "Field")
1428 (string :tag "Value"))))))
1429 :group 'mh-identity)
1431 (defcustom mh-auto-fields-prompt-flag t
1432 "*Non-nil means to prompt before sending if fields inserted.
1433 See `mh-auto-fields-list'."
1435 :group 'mh-identity)
1437 (defcustom mh-identity-default nil
1438 "Default identity to use when `mh-letter-mode' is called.
1439 See `mh-identity-list'."
1442 (cons '(const :tag "None" nil)
1443 (mapcar (function (lambda (arg) `(const ,arg)))
1444 (mapcar 'car mh-identity-list))))
1445 :group 'mh-identity)
1447 (defcustom mh-identity-handlers
1448 '(("From" . mh-identity-handler-top)
1449 (":default" . mh-identity-handler-bottom)
1450 (":attribution-verb" . mh-identity-handler-attribution-verb)
1451 (":signature" . mh-identity-handler-signature)
1452 (":pgg-default-user-id" . mh-identity-handler-gpg-identity))
1453 "Handler functions for fields in `mh-identity-list'.
1455 This option is used to change the way that fields, signatures,
1456 and attributions in `mh-identity-list' are added. To customize
1457 `mh-identity-handlers', replace the name of an existing handler
1458 function associated with the field you want to change with the
1459 name of a function you have written. You can also click on an
1460 \"INS\" button and insert a field of your choice and the name of
1461 the function you have written to handle it.
1463 The \"Field\" field can be any field that you've used in your
1464 `mh-identity-list'. The special fields \":attribution-verb\",
1465 \":signature\", or \":pgg-default-user-id\" are used for the
1466 `mh-identity-list' choices \"Attribution Verb\", \"Signature\", and
1467 \"GPG Key ID\" respectively.
1469 The handler associated with the \":default\" field is used when no
1470 other field matches.
1472 The handler functions are passed two or three arguments: the
1473 FIELD itself (for example, \"From\"), or one of the special
1474 fields (for example, \":signature\"), and the ACTION 'remove or
1475 'add. If the action is 'add, an additional argument
1476 containing the VALUE for the field is given."
1477 :type '(repeat (cons (string :tag "Field") function))
1478 :group 'mh-identity)
1482 ;;; Incorporating Your Mail (:group 'mh-inc)
1484 (defcustom mh-inc-prog "inc"
1485 "*Program to incorporate new mail into a folder.
1487 This program generates a one-line summary for each of the new
1488 messages. Unless it is an absolute pathname, the file is assumed
1489 to be in the `mh-progs' directory. You may also link a file to
1490 \"inc\" that uses a different format. You'll then need to modify
1491 several scan line format variables appropriately."
1496 (unless (fboundp 'mh-inc-spool-make-no-autoload)
1497 (defun mh-inc-spool-make-no-autoload ()
1498 "Temporary definition.
1499 Real definition will take effect when mh-inc is loaded."
1502 (defcustom mh-inc-spool-list nil
1503 "*Alternate spool files.
1505 You can use the `mh-inc-spool-list' variable to direct MH-E to
1506 retrieve mail from arbitrary spool files other than your system
1507 mailbox, file it in folders other than your \"+inbox\", and assign
1508 key bindings to incorporate this mail.
1510 Suppose you are subscribed to the \"mh-e-devel\" mailing list and
1511 you use \"procmail\" to filter this mail into \"~/mail/mh-e\" with
1512 the following recipe in \".procmailrc\":
1516 * ^From mh-e-devel-admin@stop.mail-abuse.org
1519 In order to incorporate \"~/mail/mh-e\" into \"+mh-e\" with an
1520 \"I m\" (mh-inc-spool-mh-e) command, customize this option, and click
1521 on the \"INS\" button. Enter a \"Spool File\" of \"~/mail/mh-e\", a
1522 \"Folder\" of \"mh-e\", and a \"Key Binding\" of \"m\".
1524 You can use \"xbuffy\" to automate the incorporation of this mail
1525 using the Emacs 22 command \"emacsclient\" as follows:
1532 command emacsclient --eval '(mh-inc-spool-mh-e)'
1534 In XEmacs, the command \"gnuclient\" is used in a similar
1536 :type '(repeat (list (file :tag "Spool File")
1537 (string :tag "Folder")
1538 (character :tag "Key Binding")))
1539 :set (lambda (symbol value)
1540 (set-default symbol value)
1541 (mh-inc-spool-make-no-autoload))
1546 ;;; Dealing with Junk Mail (:group 'mh-junk)
1548 (defvar mh-junk-choice nil
1549 "Chosen spam fighting program.")
1551 ;; Available spam filter interfaces
1552 (defvar mh-junk-function-alist
1553 '((spamassassin mh-spamassassin-blacklist mh-spamassassin-whitelist)
1554 (bogofilter mh-bogofilter-blacklist mh-bogofilter-whitelist)
1555 (spamprobe mh-spamprobe-blacklist mh-spamprobe-whitelist))
1556 "Available choices of spam programs to use.
1558 This is an alist. For each element there are functions that
1559 blacklist a message as spam and whitelist a message incorrectly
1560 classified as spam.")
1562 (defun mh-junk-choose (symbol value)
1563 "Choose spam program to use.
1565 The function is always called with SYMBOL bound to
1566 `mh-junk-program' and VALUE bound to the new value of
1567 `mh-junk-program'. The function sets the variable
1568 `mh-junk-choice' in addition to `mh-junk-program'."
1569 (set symbol value) ;XXX shouldn't this be set-default?
1570 (setq mh-junk-choice
1572 (loop for element in mh-junk-function-alist
1573 until (executable-find (symbol-name (car element)))
1574 finally return (car element)))))
1576 (defcustom mh-junk-background nil
1577 "If on, spam programs are run in background.
1579 By default, the programs are run in the foreground, but this can
1580 be slow when junking large numbers of messages. If you have
1581 enough memory or don't junk that many messages at the same time,
1582 you might try turning on this option."
1583 :type '(choice (const :tag "Off" nil)
1584 (const :tag "On" 0))
1587 (defcustom mh-junk-disposition nil
1588 "Disposition of junk mail."
1589 :type '(choice (const :tag "Delete Spam" nil)
1590 (string :tag "Spam Folder"))
1593 (defcustom mh-junk-program nil
1594 "Spam program that MH-E should use.
1596 The default setting of this option is \"Auto-detect\" which means
1597 that MH-E will automatically choose one of SpamAssassin,
1598 bogofilter, or SpamProbe in that order. If, for example, you have
1599 both SpamAssassin and bogofilter installed and you want to use
1600 bogofilter, then you can set this option to \"Bogofilter\"."
1601 :type '(choice (const :tag "Auto-detect" nil)
1602 (const :tag "SpamAssassin" spamassassin)
1603 (const :tag "Bogofilter" bogofilter)
1604 (const :tag "SpamProbe" spamprobe))
1605 :set 'mh-junk-choose
1610 ;;; Editing a Draft (:group 'mh-letter)
1612 (defcustom mh-compose-insertion (if (locate-library "mml") 'mml 'mh)
1613 "Type of tags used when composing MIME messages.
1615 In addition to MH-style directives, MH-E also supports MML (MIME
1616 Meta Language) tags. (see Info node `(emacs-mime)Composing').
1617 This option can be used to choose between them. By default, this
1618 option is set to \"MML\" if it is supported since it provides a
1619 lot more functionality. This option can also be set to \"MH\" if
1620 MH-style directives are preferred."
1621 :type '(choice (const :tag "MML" mml)
1622 (const :tag "MH" mh))
1625 (defcustom mh-compose-skipped-header-fields
1626 '("From" "Organization" "References" "In-Reply-To"
1627 "X-Face" "Face" "X-Image-URL" "X-Mailer")
1628 "List of header fields to skip over when navigating in draft."
1629 :type '(repeat (string :tag "Field"))
1632 (defcustom mh-compose-space-does-completion-flag nil
1633 "*Non-nil means \\<mh-letter-mode-map>\\[mh-letter-complete-or-space] does completion in message header."
1637 (defcustom mh-delete-yanked-msg-window-flag nil
1638 "*Non-nil means delete any window displaying the message.
1640 This deletes the window containing the original message after
1641 yanking it with \\<mh-letter-mode-map>\\[mh-yank-cur-msg] to make
1642 more room on your screen for your reply."
1646 (defcustom mh-extract-from-attribution-verb "wrote:"
1647 "*Verb to use for attribution when a message is yanked by \\<mh-letter-mode-map>\\[mh-yank-cur-msg].
1649 The attribution consists of the sender's name and email address
1650 followed by the content of this option. This option can be set to
1651 \"wrote:\", \"a écrit:\", and \"schrieb:\". You can also use the
1652 \"Custom String\" menu item to enter your own verb."
1653 :type '(choice (const "wrote:")
1656 (string :tag "Custom String"))
1659 (defcustom mh-ins-buf-prefix "> "
1660 "*String to put before each line of a yanked or inserted message.
1662 The prefix \"> \" is the default setting of this option. I
1663 suggest that you not modify this option since it is used by many
1664 mailers and news readers: messages are far easier to read if
1665 several included messages have all been indented by the same
1668 This prefix is not inserted if you use one of the supercite
1669 flavors of `mh-yank-behavior' or you have added a
1670 `mail-citation-hook'."
1674 (defcustom mh-letter-complete-function 'ispell-complete-word
1675 "*Function to call when completing outside of address or folder fields.
1677 In the body of the message,
1678 \\<mh-letter-mode-map>\\[mh-letter-complete] runs this function,
1679 which is set to \"ispell-complete-word\" by default."
1680 :type '(choice function (const nil))
1683 (defcustom mh-letter-fill-column 72
1684 "*Fill column to use in MH Letter mode.
1686 By default, this option is 72 to allow others to quote your
1687 message without line wrapping."
1691 (defcustom mh-mml-method-default (if mh-pgp-support-flag "pgpmime" "none")
1692 "Default method to use in security tags.
1694 This option is used to select between a variety of mail security
1695 mechanisms. The default is \"PGP (MIME)\" if it is supported\;
1696 otherwise, the default is \"None\". Other mechanisms include
1697 vanilla \"PGP\" and \"S/MIME\".
1699 The `pgg' customization group may have some settings which may
1700 interest you (see Info node `(pgg)').
1702 In particular, I turn on the option `pgg-encrypt-for-me' so that
1703 all messages I encrypt are encrypted with my public key as well.
1704 If you keep a copy of all of your outgoing mail with a \"Fcc:\"
1705 header field, this setting is vital so that you can read the mail
1707 :type '(choice (const :tag "PGP (MIME)" "pgpmime")
1708 (const :tag "PGP" "pgp")
1709 (const :tag "S/MIME" "smime")
1710 (const :tag "None" "none"))
1713 (defcustom mh-signature-file-name "~/.signature"
1714 "*Source of user's signature.
1716 By default, the text of your signature is taken from the file
1717 \"~/.signature\". You can read from other sources by changing this
1718 option. This file may contain a vCard in which case an attachment is
1719 added with the vCard.
1721 This option may also be a symbol, in which case that function is
1722 called. You may not want a signature separator to be added for you;
1723 instead you may want to insert one yourself. Options that you may find
1724 useful to do this include `mh-signature-separator' (when inserting a
1725 signature separator) and `mh-signature-separator-regexp' (for finding
1726 said separator). The function `mh-signature-separator-p', which
1727 reports t if the buffer contains a separator, may be useful as well.
1729 The signature is inserted into your message with the command
1730 \\<mh-letter-mode-map>\\[mh-insert-signature] or with the option
1731 `mh-identity-list'."
1735 (defcustom mh-signature-separator-flag t
1736 "*Non-nil means a signature separator should be inserted.
1738 It is not recommended that you change this option since various
1739 mail user agents, including MH-E, use the separator to present
1740 the signature differently, and to suppress the signature when
1741 replying or yanking a letter into a draft."
1745 (defcustom mh-x-face-file "~/.face"
1746 "*File containing face header field to insert in outgoing mail.
1748 If the file starts with either of the strings \"X-Face:\", \"Face:\"
1749 or \"X-Image-URL:\" then the contents are added to the message header
1750 verbatim. Otherwise it is assumed that the file contains the value of
1751 the \"X-Face:\" header field.
1753 The \"X-Face:\" header field, which is a low-resolution, black and
1754 white image, can be generated using the \"compface\" command (see URL
1755 `ftp://ftp.cs.indiana.edu/pub/faces/compface/compface.tar.Z'). The
1756 \"Online X-Face Converter\" is a useful resource for quick conversion
1757 of images into \"X-Face:\" header fields (see URL
1758 `http://www.dairiki.org/xface/').
1760 Use the \"make-face\" script to convert a JPEG image to the higher
1761 resolution, color, \"Face:\" header field (see URL
1762 `http://quimby.gnus.org/circus/face/make-face').
1764 The URL of any image can be used for the \"X-Image-URL:\" field and no
1765 processing of the image is required.
1767 To prevent the setting of any of these header fields, either set
1768 `mh-x-face-file' to nil, or simply ensure that the file defined by
1769 this option doesn't exist."
1773 (defcustom mh-yank-behavior 'attribution
1774 "*Controls which part of a message is yanked by \\<mh-letter-mode-map>\\[mh-yank-cur-msg].
1776 To include the entire message, including the entire header, use
1777 \"Body and Header\". Use \"Body\" to yank just the body without
1778 the header. To yank only the portion of the message following the
1779 point, set this option to \"Below Point\".
1781 Choose \"Invoke supercite\" to pass the entire message and header
1784 If the \"Body With Attribution\" setting is used, then the
1785 message minus the header is yanked and a simple attribution line
1786 is added at the top using the value of the option
1787 `mh-extract-from-attribution-verb'. This is the default.
1789 If the \"Invoke supercite\" or \"Body With Attribution\" settings
1790 are used, the \"-noformat\" argument is passed to the \"repl\"
1791 program to override a \"-filter\" or \"-format\" argument. These
1792 settings also have \"Automatically\" variants that perform the
1793 action automatically when you reply so that you don't need to use
1794 \\[mh-yank-cur-msg] at all. Note that this automatic action is
1795 only performed if the show buffer matches the message being
1796 replied to. People who use the automatic variants tend to turn on
1797 the option `mh-delete-yanked-msg-window-flag' as well so that the
1798 show window is never displayed.
1800 If the show buffer has a region, the option `mh-yank-behavior' is
1801 ignored unless its value is one of Attribution variants in which
1802 case the attribution is added to the yanked region.
1804 If this option is set to one of the supercite flavors, the hook
1805 `mail-citation-hook' is ignored and `mh-ins-buf-prefix' is not
1807 :type '(choice (const :tag "Body and Header" t)
1808 (const :tag "Body" body)
1809 (const :tag "Below Point" nil)
1810 (const :tag "Invoke supercite" supercite)
1811 (const :tag "Invoke supercite, Automatically" autosupercite)
1812 (const :tag "Body With Attribution" attribution)
1813 (const :tag "Body With Attribution, Automatically"
1819 ;;; Ranges (:group 'mh-ranges)
1821 (defcustom mh-interpret-number-as-range-flag t
1822 "*Non-nil means interpret a number as a range.
1824 Since one of the most frequent ranges used is \"last:N\", MH-E
1825 will interpret input such as \"200\" as \"last:200\" if this
1826 option is on (which is the default). If you need to scan just the
1827 message 200, then use the range \"200:200\"."
1833 ;;; Scan Line Formats (:group 'mh-scan-line-formats)
1836 (unless (fboundp 'mh-adaptive-cmd-note-flag-check)
1837 (defun mh-adaptive-cmd-note-flag-check (symbol value)
1838 "Temporary definition.
1839 Real definition, below, uses variables that aren't defined yet."
1840 (set-default symbol value))))
1842 (defcustom mh-adaptive-cmd-note-flag t
1843 "*Non-nil means that the message number width is determined dynamically.
1845 If you've created your own format to handle long message numbers,
1846 you'll be pleased to know you no longer need it since MH-E adapts its
1847 internal format based upon the largest message number if this option
1848 is on (the default). This option may only be turned on when
1849 `mh-scan-format-file' is set to \"Use MH-E scan Format\".
1851 If you prefer fixed-width message numbers, turn off this option and
1852 call `mh-set-cmd-note' with the width specified by your format file
1853 \(see `mh-scan-format-file'). For example, the default width is 4, so
1854 you would use \"(mh-set-cmd-note 4)\"."
1856 :group 'mh-scan-line-formats
1857 :set 'mh-adaptive-cmd-note-flag-check)
1859 (defun mh-scan-format-file-check (symbol value)
1860 "Check if desired setting is legal.
1861 Throw an error if user tries to set `mh-scan-format-file' to
1862 anything but t when `mh-adaptive-cmd-note-flag' is on. Otherwise,
1863 set SYMBOL to VALUE."
1864 (if (and (not (eq value t))
1865 mh-adaptive-cmd-note-flag)
1866 (error "%s %s" "You must turn off `mh-adaptive-cmd-note-flag'"
1867 "unless you use \"Use MH-E scan Format\"")
1868 (set-default symbol value)))
1870 (defcustom mh-scan-format-file t
1871 "Specifies the format file to pass to the scan program.
1873 The default setting for this option is \"Use MH-E scan Format\". This
1874 means that the format string will be taken from the either
1875 `mh-scan-format-mh' or `mh-scan-format-nmh' depending on whether MH or
1876 nmh (or GNU mailutils) is in use. This setting also enables you to
1877 turn on the `mh-adaptive-cmd-note-flag' option.
1879 You can also set this option to \"Use Default scan Format\" to get the
1880 same output as you would get if you ran \"scan\" from the shell. If
1881 you have a format file that you want MH-E to use but not MH, you can
1882 set this option to \"Specify a scan Format File\" and enter the name
1883 of your format file.
1885 If you change the format of the scan lines you'll need to tell MH-E
1886 how to parse the new format. As you will see, quite a lot of variables
1887 are involved to do that. Use \"\\[apropos] RET mh-scan.*regexp\" to
1888 obtain a list of these variables. You will also have to call
1889 `mh-set-cmd-note' if your notations are not in column 4 (columns in
1890 Emacs start with 0)."
1891 :type '(choice (const :tag "Use MH-E scan Format" t)
1892 (const :tag "Use Default scan Format" nil)
1893 (file :tag "Specify a scan Format File"))
1894 :group 'mh-scan-line-formats
1895 :set 'mh-scan-format-file-check)
1897 (defun mh-adaptive-cmd-note-flag-check (symbol value)
1898 "Check if desired setting is legal.
1899 Throw an error if user tries to turn on
1900 `mh-adaptive-cmd-note-flag' when `mh-scan-format-file' isn't t.
1901 Otherwise, set SYMBOL to VALUE."
1903 (not (eq mh-scan-format-file t)))
1904 (error "%s %s" "Can't turn on unless `mh-scan-format-file'"
1905 "is set to \"Use MH-E scan Format\"")
1906 (set-default symbol value)))
1908 (defcustom mh-scan-prog "scan"
1909 "*Program used to scan messages.
1911 The name of the program that generates a listing of one line per
1912 message is held in this option. Unless this variable contains an
1913 absolute pathname, it is assumed to be in the `mh-progs'
1914 directory. You may link another program to `scan' (see
1915 \"mh-profile(5)\") to produce a different type of listing."
1917 :group 'mh-scan-line-formats)
1918 (make-variable-buffer-local 'mh-scan-prog)
1922 ;;; Searching (:group 'mh-search)
1924 (defcustom mh-search-program nil
1925 "Search program that MH-E shall use.
1927 The default setting of this option is \"Auto-detect\" which means
1928 that MH-E will automatically choose one of swish++, swish-e,
1929 mairix, namazu, pick and grep in that order. If, for example, you
1930 have both swish++ and mairix installed and you want to use
1931 mairix, then you can set this option to \"mairix\".
1933 More information about setting up an indexing program to use with
1934 MH-E can be found in the documentation of `mh-search'."
1935 :type '(choice (const :tag "Auto-detect" nil)
1936 (const :tag "swish++" swish++)
1937 (const :tag "swish-e" swish)
1938 (const :tag "mairix" mairix)
1939 (const :tag "namazu" namazu)
1940 (const :tag "pick" pick)
1941 (const :tag "grep" grep))
1946 ;;; Sending Mail (:group 'mh-sending-mail)
1948 (defcustom mh-compose-forward-as-mime-flag t
1949 "*Non-nil means that messages are forwarded as attachments.
1951 By default, this option is on which means that the forwarded
1952 messages are included as attachments. If you would prefer to
1953 forward your messages verbatim (as text, inline), then turn off
1954 this option. Forwarding messages verbatim works well for short,
1955 textual messages, but your recipient won't be able to view any
1956 non-textual attachments that were in the forwarded message. Be
1957 aware that if you have \"forw: -mime\" in your MH profile, then
1958 forwarded messages will always be included as attachments
1959 regardless of the settings of this option."
1961 :group 'mh-sending-mail)
1963 (defcustom mh-compose-letter-function nil
1964 "Invoked when starting a new draft.
1966 However, it is the last function called before you edit your
1967 message. The consequence of this is that you can write a function
1968 to write and send the message for you. This function is passed
1969 three arguments: the contents of the TO, SUBJECT, and CC header
1971 :type '(choice (const nil) function)
1972 :group 'mh-sending-mail)
1974 (defcustom mh-compose-prompt-flag nil
1975 "*Non-nil means prompt for header fields when composing a new draft."
1977 :group 'mh-sending-mail)
1979 (defcustom mh-forward-subject-format "%s: %s"
1980 "*Format string for forwarded message subject.
1982 This option is a string which includes two escapes (\"%s\"). The
1983 first \"%s\" is replaced with the sender of the original message,
1984 and the second one is replaced with the original \"Subject:\"."
1986 :group 'mh-sending-mail)
1988 (defcustom mh-insert-x-mailer-flag t
1989 "*Non-nil means append an \"X-Mailer:\" header field to the header.
1991 This header field includes the version of MH-E and Emacs that you
1992 are using. If you don't want to participate in our marketing, you
1993 can turn this option off."
1995 :group 'mh-sending-mail)
1997 (defcustom mh-redist-full-contents-flag nil
1998 "*Non-nil means the \"dist\" command needs entire letter for redistribution.
2000 This option must be turned on if \"dist\" requires the whole
2001 letter for redistribution, which is the case if \"send\" is
2002 compiled with the BERK option (which many people abhor). If you
2003 find that MH will not allow you to redistribute a message that
2004 has been redistributed before, turn off this option."
2006 :group 'mh-sending-mail)
2008 (defcustom mh-reply-default-reply-to nil
2009 "*Sets the person or persons to whom a reply will be sent.
2011 This option is set to \"Prompt\" by default so that you are
2012 prompted for the recipient of a reply. If you find that most of
2013 the time that you specify \"cc\" when you reply to a message, set
2014 this option to \"cc\". Other choices include \"from\", \"to\", or
2015 \"all\". You can always edit the recipients in the draft."
2016 :type '(choice (const :tag "Prompt" nil)
2021 :group 'mh-sending-mail)
2023 (defcustom mh-reply-show-message-flag t
2024 "*Non-nil means the MH-Show buffer is displayed when replying.
2026 If you include the message automatically, you can hide the
2027 MH-Show buffer by turning off this option.
2029 See also `mh-reply'."
2031 :group 'mh-sending-mail)
2035 ;;; Sequences (:group 'mh-sequences)
2037 ;; If `mh-unpropagated-sequences' becomes a defcustom, add the following to
2038 ;; the docstring: "Additional sequences that should not to be preserved can be
2039 ;; specified by setting `mh-unpropagated-sequences' appropriately." XXX
2041 (defcustom mh-refile-preserves-sequences-flag t
2042 "*Non-nil means that sequences are preserved when messages are refiled.
2044 If a message is in any sequence (except \"Previous-Sequence:\"
2045 and \"cur\") when it is refiled, then it will still be in those
2046 sequences in the destination folder. If this behavior is not
2047 desired, then turn off this option."
2049 :group 'mh-sequences)
2051 (defcustom mh-tick-seq 'tick
2052 "The name of the MH sequence for ticked messages.
2054 You can customize this option if you already use the \"tick\"
2055 sequence for your own use. You can also disable all of the
2056 ticking functions by choosing the \"Disable Ticking\" item but
2057 there isn't much advantage to that."
2058 :type '(choice (const :tag "Disable Ticking" nil)
2060 :group 'mh-sequences)
2062 (defcustom mh-update-sequences-after-mh-show-flag t
2063 "*Non-nil means flush MH sequences to disk after message is shown\\<mh-folder-mode-map>.
2065 Three sequences are maintained internally by MH-E and pushed out
2066 to MH when a message is shown. They include the sequence
2067 specified by your \"Unseen-Sequence:\" profile entry, \"cur\",
2068 and the sequence listed by the option `mh-tick-seq' which is
2069 \"tick\" by default. If you do not like this behavior, turn off
2070 this option. You can then update the state manually with the
2071 \\[mh-execute-commands], \\[mh-quit], or \\[mh-update-sequences]
2074 :group 'mh-sequences)
2078 ;;; Reading Your Mail (:group 'mh-show)
2080 (defcustom mh-bury-show-buffer-flag t
2081 "*Non-nil means show buffer is buried.
2083 One advantage of not burying the show buffer is that one can
2084 delete the show buffer more easily in an electric buffer list
2085 because of its proximity to its associated MH-Folder buffer. Try
2086 running \\[electric-buffer-list] to see what I mean."
2090 (defcustom mh-clean-message-header-flag t
2091 "*Non-nil means remove extraneous header fields.
2093 See also `mh-invisible-header-fields-default' and
2094 `mh-invisible-header-fields'."
2098 (defcustom mh-decode-mime-flag (not (not (locate-library "mm-decode")))
2099 "*Non-nil means attachments are handled\\<mh-folder-mode-map>.
2101 MH-E can handle attachments as well if the Gnus `mm-decode'
2102 library is present. If so, this option will be on. Otherwise,
2103 you'll see the MIME body parts rather than text or attachments.
2104 There isn't much point in turning off this option; however, you
2105 can inspect it if it appears that the body parts are not being
2106 interpreted correctly or toggle it with the command
2107 \\[mh-toggle-mh-decode-mime-flag] to view the raw message.
2109 This option also controls the display of quoted-printable
2110 messages and other graphical widgets. See the options
2111 `mh-graphical-smileys-flag' and `mh-graphical-emphasis-flag'."
2115 (defcustom mh-display-buttons-for-alternatives-flag nil
2116 "*Non-nil means display buttons for all alternative attachments.
2118 Sometimes, a mail program will produce multiple alternatives of
2119 the attachment in increasing degree of faithfulness to the
2120 original content. By default, only the preferred alternative is
2121 displayed. If this option is on, then the preferred part is shown
2122 inline and buttons are shown for each of the other alternatives."
2126 (defcustom mh-display-buttons-for-inline-parts-flag nil
2127 "*Non-nil means display buttons for all inline attachments\\<mh-folder-mode-map>.
2129 The sender can request that attachments should be viewed inline so
2130 that they do not really appear like an attachment at all to the
2131 reader. Most of the time, this is desirable, so by default MH-E
2132 suppresses the buttons for inline attachments. On the other hand, you
2133 may receive code or HTML which the sender has added to his message as
2134 inline attachments so that you can read them in MH-E. In this case, it
2135 is useful to see the buttons so that you know you don't have to cut
2136 and paste the code into a file; you can simply save the attachment.
2138 If you want to make the buttons visible for inline attachments, you
2139 can use the command \\[mh-toggle-mime-buttons] to toggle the
2140 visibility of these buttons. You can turn on these buttons permanently
2141 by turning on this option.
2143 MH-E cannot display all attachments inline however. It can display
2144 text (including HTML) and images."
2148 (defcustom mh-do-not-confirm-flag nil
2149 "*Non-nil means non-reversible commands do not prompt for confirmation.
2151 Commands such as `mh-pack-folder' prompt to confirm whether to
2152 process outstanding moves and deletes or not before continuing.
2153 Turning on this option means that these actions will be
2154 performed--which is usually desired but cannot be
2155 retracted--without question."
2159 (defcustom mh-fetch-x-image-url nil
2160 "*Control fetching of \"X-Image-URL:\" header field image.
2162 Ths option controls the fetching of the \"X-Image-URL:\" header
2163 field image with the following values:
2166 You are prompted before the image is fetched. MH-E will
2167 remember your reply and will either use the already fetched
2168 image the next time the same URL is encountered or silently
2169 skip it if you didn't fetch it the first time. This is a
2173 Images are never fetched and only displayed if they are
2174 already present in the cache. This is the default.
2176 There isn't a value of \"Always Fetch\" for privacy and DOS (denial of
2177 service) reasons. For example, fetching a URL can tip off a spammer
2178 that you've read his email (which is why you shouldn't blindly answer
2179 yes if you've set this option to \"Ask Before Fetching\"). Someone may
2180 also flood your network and fill your disk drive by sending a torrent
2181 of messages, each specifying a unique URL to a very large file.
2183 The cache of images is found in the directory \".mhe-x-image-cache\"
2184 within your MH directory. You can add your own face to the \"From:\"
2185 field too. See Info node `(mh-e)Picture'.
2187 This setting only has effect if the option `mh-show-use-xface-flag' is
2190 :type '(choice (const :tag "Ask Before Fetching" ask)
2191 (const :tag "Never Fetch" nil))
2194 (defcustom mh-graphical-smileys-flag t
2195 "*Non-nil means graphical smileys are displayed.
2197 It is a long standing custom to inject body language using a
2198 cornucopia of punctuation, also known as the \"smileys\". MH-E
2199 can render these as graphical widgets if this option is turned
2200 on, which it is by default. Smileys include patterns such as :-)
2203 This option is disabled if the option `mh-decode-mime-flag' is
2208 (defcustom mh-graphical-emphasis-flag t
2209 "*Non-nil means graphical emphasis is displayed.
2211 A few typesetting features are indicated in ASCII text with
2212 certain characters. If your terminal supports it, MH-E can render
2213 these typesetting directives naturally if this option is turned
2214 on, which it is by default. For example, _underline_ will be
2215 underlined, *bold* will appear in bold, /italics/ will appear in
2216 italics, and so on. See the option `gnus-emphasis-alist' for the
2219 This option is disabled if the option `mh-decode-mime-flag' is
2224 (defcustom mh-highlight-citation-style 'gnus
2225 "Style for highlighting citations.
2227 If the sender of the message has cited other messages in his
2228 message, then MH-E will highlight these citations to emphasize
2229 the sender's actual response. This option can be customized to
2230 change the highlighting style. The \"Multicolor\" method uses a
2231 different color for each indentation while the \"Monochrome\"
2232 method highlights all citations in red. To disable highlighting
2233 of citations entirely, choose \"None\"."
2234 :type '(choice (const :tag "Multicolor" gnus)
2235 (const :tag "Monochrome" font-lock)
2236 (const :tag "None" nil))
2239 ;; Keep fields alphabetized. Mention source, if known.
2240 (defvar mh-invisible-header-fields-internal
2244 "Cancel-Lock:" ; NNTP posts
2245 "Content-" ; RFC 2045
2246 "Delivered-To:" ; Egroups/yahoogroups mailing list manager
2247 "Delivery-Date:" ; MH
2249 "DomainKey-Signature:" ;http://antispam.yahoo.com/domainkeys
2253 "Face:" ; Gnus Face header
2256 "Importance:" ; MS Outlook
2259 "List-" ; Mailman mailing list manager
2260 "List-" ; Unknown mailing list managers
2261 "List-Subscribe:" ; Unknown mailing list managers
2262 "List-Unsubscribe:" ; Unknown mailing list managers
2264 "Mailing-List:" ; Egroups/yahoogroups mailing list manager
2265 "Message-Id:" ; RFC 822
2266 "Mime-Version" ; RFC 2045
2269 "Original-Encoded-Information-Types:" ; X400
2270 "Original-Lines:" ; mail to news
2271 "Original-NNTP-" ; mail to news
2272 "Original-Newsgroups:" ; mail to news
2273 "Original-Path:" ; mail to news
2274 "Original-Received:" ; mail to news
2275 "Original-To:" ; mail to news
2276 "Original-X-" ; mail to news
2278 "P1-Content-Type:" ; X400
2279 "P1-Message-Id:" ; X400
2280 "P1-Recipient:" ; X400
2285 "Received:" ; RFC 822
2286 "Received-SPF:" ; Gmail
2291 "Return-Path:" ; RFC 822
2292 "Sensitivity:" ; MS Outlook
2293 "Status:" ; sendmail
2295 "Ua-Content-Id:" ; X400
2296 ;; "User-Agent:" ; Similar to X-Mailer, so display it.
2300 "X-Accept-Language:"
2301 "X-Accept-Language:" ; Netscape/Mozilla
2303 "X-Administrivia-To:"
2304 "X-AntiAbuse:" ; cPanel
2305 "X-Apparently-From:" ; MS Outlook
2306 "X-Apparently-To:" ; Egroups/yahoogroups mailing list manager
2307 "X-Authenticated-Sender:" ; AT&T Message Center (webmail)
2308 "X-Authentication-Warning:" ; sendmail
2309 "X-Barracuda-" ; Barracuda spam scores
2310 "X-Beenthere:" ; Mailman mailing list manager
2311 "X-Bogosity:" ; bogofilter
2312 "X-BrightmailFiltered:" ; Brightmail
2313 "X-Brightmail-Tracker:" ; Brightmail
2314 "X-Bugzilla-" ; Bugzilla
2316 "X-ContentStamp:" ; NetZero
2320 "X-EFL-Spamscore:" ; MIT alumni spam filtering
2321 "X-ELNK-Trace:" ; Earthlink mailer
2322 "X-Envelope-Date:" ; GNU mailutils
2324 "X-Envelope-Sender:"
2326 "X-Evolution:" ; Evolution mail client
2331 "X-Gnus-Mail-Source:" ; gnus
2332 "X-Greylist:" ; milter-greylist-1.2.1
2333 "X-Habeas-SWE-1:" ; Spam
2334 "X-Habeas-SWE-2:" ; Spam
2335 "X-Habeas-SWE-3:" ; Spam
2336 "X-Habeas-SWE-4:" ; Spam
2337 "X-Habeas-SWE-5:" ; Spam
2338 "X-Habeas-SWE-6:" ; Spam
2339 "X-Habeas-SWE-7:" ; Spam
2340 "X-Habeas-SWE-8:" ; Spam
2341 "X-Habeas-SWE-9:" ; Spam
2342 "X-Hashcash:" ; hashcash
2344 "X-IronPort-AV:" ; IronPort AV
2346 "X-List-Host:" ; Unknown mailing list managers
2347 "X-List-Subscribe:" ; Unknown mailing list managers
2348 "X-List-Unsubscribe:" ; Unknown mailing list managers
2349 "X-Listprocessor-" ; ListProc(tm) by CREN
2350 "X-Listserver:" ; Unknown mailing list managers
2351 "X-Loop:" ; Unknown mailing list managers
2352 "X-Lumos-SenderID:" ; Roving ConstantContact
2353 "X-MAIL-INFO:" ; NetZero
2354 "X-MHE-Checksum:" ; Checksum added during index search
2355 "X-MIME-Autoconverted:" ; sendmail
2357 "X-MS-" ; MS Outlook
2358 "X-Mail-from:" ; fastmail.fm
2359 "X-MailScanner" ; ListProc(tm) by CREN
2360 "X-Mailing-List:" ; Unknown mailing list managers
2361 "X-Mailman-Approved-At:" ; Mailman mailing list manager
2362 "X-Mailman-Version:" ; Mailman mailing list manager
2363 "X-Majordomo:" ; Majordomo mailing list manager
2365 "X-MessageWall-Score:" ; Unknown mailing list manager, AUC TeX
2366 "X-MimeOLE:" ; MS Outlook
2367 "X-Mms-" ; T-Mobile pictures
2368 "X-Mozilla-Status:" ; Netscape/Mozilla
2369 "X-Msmail-" ; MS Outlook
2370 "X-NAI-Spam-" ; Network Associates Inc. SpamKiller
2373 "X-Notes-Item:" ; Lotus Notes Domino structured header
2374 "X-OperatingSystem:"
2375 ;;"X-Operator:" ; Similar to X-Mailer, so display it
2376 "X-Orcl-Content-Type:"
2377 "X-Original-Complaints-To:"
2378 "X-Original-Date:" ; SourceForge mailing list manager
2381 "X-OriginalArrivalTime:" ; Hotmail
2382 "X-Originating-IP:" ; Hotmail
2384 "X-Priority:" ; MS Outlook
2385 "X-Qotd-" ; User added
2390 "X-Resolved-to:" ; fastmail.fm
2391 "X-Return-Path-Hint:" ; Roving ConstantContact
2392 "X-Roving-" ; Roving ConstantContact
2393 "X-SA-Exim-" ; Exim SpamAssassin
2399 "X-Sasl-enc:" ; Apple Mail
2404 "X-Sieve:" ; Sieve filtering
2406 "X-Spam-" ; Spamassassin
2407 "X-SpamBouncer:" ; Spam
2415 "X-USANET-" ; usa.net
2417 "X-VSMLoop:" ; NTMail
2418 "X-Virus-Scanned" ; amavisd-new
2420 "X-WebTV-Signature:"
2421 "X-Wss-Id:" ; Worldtalk gateways
2423 "X-eGroups-" ; Egroups/yahoogroups mailing list manager
2425 "X-submission-address:"
2428 "List of default header fields that are not to be shown.
2430 Do not alter this variable directly. Instead, add entries from
2431 here that you would like to be displayed in
2432 `mh-invisible-header-fields-default' and add entries to hide in
2433 `mh-invisible-header-fields'.")
2436 (unless (fboundp 'mh-invisible-headers)
2437 (defun mh-invisible-headers ()
2438 "Temporary definition.
2439 Real definition, below, uses variables that aren't defined yet."
2442 (defvar mh-delay-invisible-header-generation-flag t
2443 "Non-nil means to delay the generation of invisible header fields.
2444 Because the function `mh-invisible-headers' uses both
2445 `mh-invisible-header-fields' and `mh-invisible-header-fields', it
2446 cannot be run until both variables have been initialized.")
2448 (defcustom mh-invisible-header-fields nil
2449 "*Additional header fields to hide.
2451 Header fields that you would like to hide that aren't listed in
2452 `mh-invisible-header-fields-default' can be added to this option
2453 with a couple of caveats. Regular expressions are not allowed.
2454 Unique fields should have a \":\" suffix; otherwise, the element
2455 can be used to render invisible an entire class of fields that
2456 start with the same prefix. If you think a header field should be
2457 generally ignored, report a bug (see URL
2458 `https://sourceforge.net/tracker/?group_id=13357&atid=113357').
2460 See also `mh-clean-message-header-flag'."
2462 :type '(repeat (string :tag "Header field"))
2463 :set (lambda (symbol value)
2464 (set-default symbol value)
2465 (mh-invisible-headers))
2468 (defcustom mh-invisible-header-fields-default nil
2469 "*List of hidden header fields.
2471 The header fields listed in this option are hidden, although you
2472 can check off any field that you would like to see.
2474 Header fields that you would like to hide that aren't listed can
2475 be added to the option `mh-invisible-header-fields'.
2477 See also `mh-clean-message-header-flag'."
2478 :type `(set ,@(mapcar (lambda (x) `(const ,x))
2479 mh-invisible-header-fields-internal))
2480 :set (lambda (symbol value)
2481 (set-default symbol value)
2482 (mh-invisible-headers))
2485 (defvar mh-invisible-header-fields-compiled nil
2486 "*Regexp matching lines in a message header that are not to be shown.
2487 Do not alter this variable directly. Instead, customize
2488 `mh-invisible-header-fields-default' checking for fields normally
2489 hidden that you wish to display, and add extra entries to hide in
2490 `mh-invisible-header-fields'.")
2492 (defun mh-invisible-headers ()
2493 "Make or remake the variable `mh-invisible-header-fields-compiled'.
2494 Done using `mh-invisible-header-fields-internal' as input, from
2495 which entries from `mh-invisible-header-fields-default' are
2496 removed and entries from `mh-invisible-header-fields' are added."
2497 (let ((fields mh-invisible-header-fields-internal))
2498 (when mh-invisible-header-fields-default
2499 ;; Remove entries from `mh-invisible-header-fields-default'
2501 (loop for x in fields
2502 unless (member x mh-invisible-header-fields-default)
2504 (when (and (boundp 'mh-invisible-header-fields)
2505 mh-invisible-header-fields)
2506 (dolist (x mh-invisible-header-fields)
2507 (unless (member x fields) (setq fields (cons x fields)))))
2509 (setq mh-invisible-header-fields-compiled
2512 ;; workaround for insufficient default
2513 (let ((max-specpdl-size 1000))
2514 (regexp-opt fields t))))
2515 (setq mh-invisible-header-fields-compiled nil))))
2517 ;; Compile invisible header fields.
2518 (mh-invisible-headers)
2520 (defcustom mh-lpr-command-format "lpr -J '%s'"
2521 "*Command used to print\\<mh-folder-mode-map>.
2523 This option contains the Unix command line which performs the
2524 actual printing for the \\[mh-print-msg] command. The string can
2525 contain one escape, \"%s\", which is replaced by the name of the
2526 folder and the message number and is useful for print job names.
2527 I use \"mpage -h'%s' -b Letter -H1of -mlrtb -P\" which produces a
2528 nice header and adds a bit of margin so the text fits within my
2531 This options is not used by the commands \\[mh-ps-print-msg] or
2532 \\[mh-ps-print-msg-file]."
2536 (defcustom mh-max-inline-image-height nil
2537 "*Maximum inline image height if \"Content-Disposition:\" is not present.
2539 Some older mail programs do not insert this needed plumbing to
2540 tell MH-E whether to display the attachments inline or not. If
2541 this is the case, MH-E will display these images inline if they
2542 are smaller than the window. However, you might want to allow
2543 larger images to be displayed inline. To do this, you can change
2544 the options `mh-max-inline-image-width' and
2545 `mh-max-inline-image-height' from their default value of zero to
2546 a large number. The size of your screen is a good choice for
2548 :type '(choice (const nil) integer)
2551 (defcustom mh-max-inline-image-width nil
2552 "*Maximum inline image width if \"Content-Disposition:\" is not present.
2554 Some older mail programs do not insert this needed plumbing to
2555 tell MH-E whether to display the attachments inline or not. If
2556 this is the case, MH-E will display these images inline if they
2557 are smaller than the window. However, you might want to allow
2558 larger images to be displayed inline. To do this, you can change
2559 the options `mh-max-inline-image-width' and
2560 `mh-max-inline-image-height' from their default value of zero to
2561 a large number. The size of your screen is a good choice for
2563 :type '(choice (const nil) integer)
2566 (defcustom mh-mhl-format-file nil
2567 "*Specifies the format file to pass to the \"mhl\" program.
2569 Normally MH-E takes care of displaying messages itself (rather than
2570 calling an MH program to do the work). If you'd rather have \"mhl\"
2571 display the message (within MH-E), change this option from its default
2572 value of \"Use Default mhl Format (Printing Only)\".
2574 You can set this option to \"Use Default mhl Format\" to get the same
2575 output as you would get if you ran \"mhl\" from the shell.
2577 If you have a format file that you want MH-E to use, you can set this
2578 option to \"Specify an mhl Format File\" and enter the name of your
2579 format file. Your format file should specify a non-zero value for
2580 \"overflowoffset\" to allow MH-E to parse the header. Note that
2581 \"mhl\" is always used for printing and forwarding; in this case, the
2582 value of this option is consulted if you have specified a format
2584 :type '(choice (const :tag "Use Default mhl Format (Printing Only)" nil)
2585 (const :tag "Use Default mhl Format" t)
2586 (file :tag "Specify an mhl Format File"))
2589 (defcustom mh-mime-save-parts-default-directory t
2590 "Default directory to use for \\<mh-folder-mode-map>\\[mh-mime-save-parts].
2592 The default value for this option is \"Prompt Always\" so that
2593 you are always prompted for the directory in which to save the
2594 attachments. However, if you usually use the same directory
2595 within a session, then you can set this option to \"Prompt the
2596 First Time\" to avoid the prompt each time. you can make this
2597 directory permanent by choosing \"Directory\" and entering the
2599 :type '(choice (const :tag "Prompt the First Time" nil)
2600 (const :tag "Prompt Always" t)
2604 (defcustom mh-print-background-flag nil
2605 "*Non-nil means messages should be printed in the background\\<mh-folder-mode-map>.
2607 Normally messages are printed in the foreground. If this is slow on
2608 your system, you may elect to turn off this option to print in the
2611 WARNING: If you do this, do not delete the message until it is printed
2612 or else the output may be truncated.
2614 This option is not used by the commands \\[mh-ps-print-msg] or
2615 \\[mh-ps-print-msg-file]."
2619 (defcustom mh-show-maximum-size 0
2620 "*Maximum size of message (in bytes) to display automatically.
2622 This option provides an opportunity to skip over large messages
2623 which may be slow to load. The default value of 0 means that all
2624 message are shown regardless of size."
2628 (defcustom mh-show-use-xface-flag (>= emacs-major-version 21)
2629 "*Non-nil means display face images in MH-show buffers.
2631 MH-E can display the content of \"Face:\", \"X-Face:\", and
2632 \"X-Image-URL:\" header fields. If any of these fields occur in the
2633 header of your message, the sender's face will appear in the \"From:\"
2634 header field. If more than one of these fields appear, then the first
2635 field found in the order \"Face:\", \"X-Face:\", and \"X-Image-URL:\"
2638 The option `mh-show-use-xface-flag' is used to turn this feature on
2639 and off. This feature will be turned on by default if your system
2642 The first header field used, if present, is the Gnus-specific
2643 \"Face:\" field. The \"Face:\" field appeared in GNU Emacs 21 and
2644 XEmacs. For more information, see URL
2645 `http://quimby.gnus.org/circus/face/'. Next is the traditional
2646 \"X-Face:\" header field. The display of this field requires the
2647 \"uncompface\" program (see URL
2648 `ftp://ftp.cs.indiana.edu/pub/faces/compface/compface.tar.z'). Recent
2649 versions of XEmacs have internal support for \"X-Face:\" images. If
2650 your version of XEmacs does not, then you'll need both \"uncompface\"
2651 and the x-face package (see URL `ftp://ftp.jpl.org/pub/elisp/').
2653 Finally, MH-E will display images referenced by the \"X-Image-URL:\"
2654 header field if neither the \"Face:\" nor the \"X-Face:\" fields are
2655 present. The display of the images requires \"wget\" (see URL
2656 `http://www.gnu.org/software/wget/wget.html'), \"fetch\", or \"curl\"
2657 to fetch the image and the \"convert\" program from the ImageMagick
2658 suite (see URL `http://www.imagemagick.org/'). Of the three header
2659 fields this is the most efficient in terms of network usage since the
2660 image doesn't need to be transmitted with every single mail.
2662 The option `mh-fetch-x-image-url' controls the fetching of the
2663 \"X-Image-URL:\" header field image."
2667 (defcustom mh-store-default-directory nil
2668 "*Default directory for \\<mh-folder-mode-map>\\[mh-store-msg].
2670 If you would like to change the initial default directory,
2671 customize this option, change the value from \"Current\" to
2672 \"Directory\", and then enter the name of the directory for storing
2673 the content of these messages."
2674 :type '(choice (const :tag "Current" nil)
2678 (defcustom mh-summary-height nil
2679 "*Number of lines in MH-Folder buffer (including the mode line).
2681 The default value of this option is \"Automatic\" which means
2682 that the MH-Folder buffer will maintain the same proportional
2683 size if the frame is resized. If you'd prefer a fixed height,
2684 then choose the \"Fixed Size\" option and enter the number of
2685 lines you'd like to see."
2686 :type '(choice (const :tag "Automatic" nil)
2687 (integer :tag "Fixed Size"))
2692 ;;; The Speedbar (:group 'mh-speedbar)
2694 (defcustom mh-speed-update-interval 60
2695 "Time between speedbar updates in seconds.
2696 Set to 0 to disable automatic update."
2698 :group 'mh-speedbar)
2702 ;;; Threading (:group 'mh-thread)
2704 (defcustom mh-show-threads-flag nil
2705 "*Non-nil means new folders start in threaded mode.
2707 Threading large number of messages can be time consuming so this
2708 option is turned off by default. If you turn this option on, then
2709 threading will be done only if the number of messages being
2710 threaded is less than `mh-large-folder'."
2716 ;;; The Tool Bar (:group 'mh-tool-bar)
2718 ;; mh-tool-bar-folder-buttons and mh-tool-bar-letter-buttons defined
2719 ;; dynamically in mh-tool-bar.el.
2721 (defcustom mh-tool-bar-search-function 'mh-search
2722 "*Function called by the tool bar search button.
2724 By default, this is set to `mh-search'. You can also choose
2725 \"Other Function\" from the \"Value Menu\" and enter a function
2726 of your own choosing."
2727 :type '(choice (const mh-search)
2728 (function :tag "Other Function"))
2729 :group 'mh-tool-bar)
2731 ;; XEmacs has a couple of extra customizations...
2733 (defcustom mh-xemacs-use-tool-bar-flag mh-xemacs-has-tool-bar-flag
2734 "*If non-nil, use tool bar.
2736 This option controls whether to show the MH-E icons at all. By
2737 default, this option is turned on if the window system supports
2738 tool bars. If your system doesn't support tool bars, then you
2739 won't be able to turn on this option."
2742 :set (lambda (symbol value)
2743 (if (and (eq value t)
2744 (not mh-xemacs-has-tool-bar-flag))
2745 (error "Tool bar not supported"))
2746 (set-default symbol value)))
2748 (defcustom mh-xemacs-tool-bar-position nil
2749 "*Tool bar location.
2751 This option controls the placement of the tool bar along the four
2752 edges of the frame. You can choose from one of \"Same As Default
2753 Tool Bar\", \"Top\", \"Bottom\", \"Left\", or \"Right\". If this
2754 variable is set to anything other than \"Same As Default Tool
2755 Bar\" and the default tool bar is in a different location, then
2756 two tool bars will be displayed: the MH-E tool bar and the
2758 :type '(radio (const :tag "Same As Default Tool Bar" :value nil)
2759 (const :tag "Top" :value top)
2760 (const :tag "Bottom" :value bottom)
2761 (const :tag "Left" :value left)
2762 (const :tag "Right" :value right))
2763 :group 'mh-tool-bar))
2767 ;;; Hooks (:group 'mh-hooks + group where hook described)
2769 (defcustom mh-after-commands-processed-hook nil
2770 "Hook run by \\<mh-folder-mode-map>\\[mh-execute-commands] after performing outstanding refile and delete requests.
2772 Variables that are useful in this hook include
2773 `mh-folders-changed', which lists which folders were affected by
2774 deletes and refiles. This list will always include the current
2775 folder, which is also available in `mh-current-folder'."
2780 (defcustom mh-alias-reloaded-hook nil
2781 "Hook run by `mh-alias-reload' after loading aliases."
2786 (defcustom mh-before-commands-processed-hook nil
2787 "Hook run by \\<mh-folder-mode-map>\\[mh-execute-commands] before performing outstanding refile and delete requests.
2789 Variables that are useful in this hook include `mh-delete-list'
2790 and `mh-refile-list' which can be used to see which changes will
2791 be made to the current folder, `mh-current-folder'."
2796 (defcustom mh-before-quit-hook nil
2797 "Hook run by \\<mh-folder-mode-map>\\[mh-quit] before quitting MH-E.
2799 This hook is called before the quit occurs, so you might use it
2800 to perform any MH-E operations; you could perform some query and
2801 abort the quit or call `mh-execute-commands', for example.
2803 See also `mh-quit-hook'."
2808 (defcustom mh-before-send-letter-hook nil
2809 "Hook run at the beginning of the \\<mh-letter-mode-map>\\[mh-send-letter] command.
2811 For example, if you want to check your spelling in your message
2812 before sending, add the `ispell-message' function."
2814 :options '(ispell-message)
2818 (defcustom mh-delete-msg-hook nil
2819 "Hook run by \\<mh-letter-mode-map>\\[mh-delete-msg] after marking each message for deletion.
2821 For example, a past maintainer of MH-E used this once when he
2822 kept statistics on his mail usage."
2827 (defcustom mh-find-path-hook nil
2828 "Hook run by `mh-find-path' after reading the user's MH profile.
2830 This hook can be used the change the value of the variables that
2831 `mh-find-path' sets if you need to run with different values
2832 between MH and MH-E."
2837 (defcustom mh-folder-mode-hook nil
2838 "Hook run by `mh-folder-mode' when visiting a new folder."
2843 (defcustom mh-forward-hook nil
2844 "Hook run by `mh-forward' on a forwarded letter."
2847 :group 'mh-sending-mail)
2849 (defcustom mh-inc-folder-hook nil
2850 "Hook run by \\<mh-folder-mode-map>\\[mh-inc-folder] after incorporating mail into a folder."
2855 (defcustom mh-insert-signature-hook nil
2856 "Hook run by \\<mh-letter-mode-map>\\[mh-insert-signature] after signature has been inserted.
2858 Hook functions may access the actual name of the file or the
2859 function used to insert the signature with
2860 `mh-signature-file-name'."
2865 (defcustom mh-kill-folder-suppress-prompt-hooks '(mh-search-p)
2866 "Abnormal hook run at the beginning of \\<mh-folder-mode-map>\\[mh-kill-folder].
2868 The hook functions are called with no arguments and should return
2869 a non-nil value to suppress the normal prompt when you remove a
2870 folder. This is useful for folders that are easily regenerated.
2872 The default value of `mh-search-p' suppresses the prompt on
2873 folders generated by searching.
2875 WARNING: Use this hook with care. If there is a bug in your hook
2876 which returns t on \"+inbox\" and you hit \\[mh-kill-folder] by
2877 accident in the \"+inbox\" folder, you will not be happy."
2882 (defcustom mh-letter-mode-hook nil
2883 "Hook run by `mh-letter-mode' on a new letter.
2885 This hook allows you to do some processing before editing a
2886 letter. For example, you may wish to modify the header after
2887 \"repl\" has done its work, or you may have a complicated
2888 \"components\" file and need to tell MH-E where the cursor should
2892 :group 'mh-sending-mail)
2894 (defcustom mh-mh-to-mime-hook nil
2895 "Hook run on the formatted letter by \\<mh-letter-mode-map>\\[mh-mh-to-mime]."
2900 (defcustom mh-search-mode-hook nil
2901 "Hook run upon entry to `mh-search-mode'\\<mh-folder-mode-map>.
2903 If you find that you do the same thing over and over when editing
2904 the search template, you may wish to bind some shortcuts to keys.
2905 This can be done with this hook which is called when
2906 \\[mh-search] is run on a new pattern."
2911 (defcustom mh-quit-hook nil
2912 "Hook run by \\<mh-folder-mode-map>\\[mh-quit] after quitting MH-E.
2914 This hook is not run in an MH-E context, so you might use it to
2915 modify the window setup.
2917 See also `mh-before-quit-hook'."
2922 (defcustom mh-refile-msg-hook nil
2923 "Hook run by \\<mh-folder-mode-map>\\[mh-refile-msg] after marking each message for refiling."
2928 (defcustom mh-show-hook nil
2929 "Hook run after \\<mh-folder-mode-map>\\[mh-show] shows a message.
2931 It is the last thing called after messages are displayed. It's
2932 used to affect the behavior of MH-E in general or when
2933 `mh-show-mode-hook' is too early. See `mh-show-mode-hook'."
2938 (defcustom mh-show-mode-hook nil
2939 "Hook run upon entry to `mh-show-mode'.
2941 This hook is called early on in the process of the message
2942 display. It is usually used to perform some action on the
2943 message's content. See `mh-show-hook'."
2948 (defcustom mh-unseen-updated-hook nil
2949 "Hook run after the unseen sequence has been updated.
2951 The variable `mh-seen-list' can be used by this hook to obtain
2952 the list of messages which were removed from the unseen
2956 :group 'mh-sequences)
2960 ;;; Faces (:group 'mh-faces + group where faces described)
2962 (if (boundp 'facemenu-unlisted-faces)
2963 (add-to-list 'facemenu-unlisted-faces "^mh-"))
2965 ;; Temporary function and data structure used for defining faces.
2966 ;; These will be unbound after the faces are defined.
2967 (defvar mh-min-colors-defined-flag (and (not mh-xemacs-flag)
2968 (>= emacs-major-version 22))
2969 "Non-nil means defface supports min-colors display requirement.")
2971 (defun mh-defface-compat (spec)
2972 "Convert SPEC for defface if necessary to run on older platforms.
2973 Modifies SPEC in place and returns it. See `defface' for the spec definition.
2975 When `mh-min-colors-defined-flag' is nil, this function finds
2976 display entries with \"min-colors\" requirements and either
2977 removes the \"min-colors\" requirement or strips the display
2978 entirely if the display does not support the number of specified
2980 (if mh-min-colors-defined-flag
2982 (let ((cells (mh-display-color-cells))
2984 ;; Remove entries with min-colors, or delete them if we have fewer colors
2985 ;; than they specify.
2986 (loop for entry in (reverse spec) do
2987 (let ((requirement (if (eq (car entry) t)
2989 (assoc 'min-colors (car entry)))))
2991 (when (>= cells (nth 1 requirement))
2992 (setq new-spec (cons (cons (delq requirement (car entry))
2995 (setq new-spec (cons entry new-spec)))))
3000 (defvar mh-inherit-face-flag (assq :inherit custom-face-attributes)
3001 "Non-nil means that the `defface' :inherit keyword is available.
3002 The :inherit keyword is available on all supported versions of
3003 GNU Emacs and XEmacs from at least 21.5.23 on.")
3005 (defvar mh-face-data
3006 '((mh-folder-followup
3007 ((((class color) (background light))
3008 (:foreground "blue3"))
3009 (((class color) (background dark))
3010 (:foreground "LightGoldenRod"))
3013 (mh-folder-msg-number
3014 ((((class color) (min-colors 64) (background light))
3015 (:foreground "snow4"))
3016 (((class color) (min-colors 64) (background dark))
3017 (:foreground "snow3"))
3018 (((class color) (background light))
3019 (:foreground "purple"))
3020 (((class color) (background dark))
3021 (:foreground "cyan"))))
3023 ((((class color) (min-colors 64) (background light))
3024 (:foreground "DarkGoldenrod"))
3025 (((class color) (min-colors 64) (background dark))
3026 (:foreground "LightGoldenrod"))
3028 (:foreground "yellow" :weight light))
3029 (((class grayscale) (background light))
3030 (:foreground "Gray90" :bold t :italic t))
3031 (((class grayscale) (background dark))
3032 (:foreground "DimGray" :bold t :italic t))
3034 (:bold t :italic t))))
3036 ((((class color) (background light))
3037 (:foreground "blue4"))
3038 (((class color) (background dark))
3039 (:foreground "yellow"))
3043 ((((class color) (background light))
3044 (:background "#dddf7e"))
3045 (((class color) (background dark))
3046 (:background "#dddf7e"))
3050 ((((class color) (min-colors 64) (background light))
3051 (:foreground "RosyBrown"))
3052 (((class color) (min-colors 64) (background dark))
3053 (:foreground "LightSalmon"))
3055 (:foreground "green"))
3056 (((class grayscale) (background light))
3057 (:foreground "DimGray" :italic t))
3058 (((class grayscale) (background dark))
3059 (:foreground "LightGray" :italic t))
3062 (mh-letter-header-field
3063 ((((class color) (background light))
3064 (:background "gray90"))
3065 (((class color) (background dark))
3066 (:background "gray10"))
3070 ((((class color) (background light))
3071 (:foreground "dark green" :bold t))
3072 (((class color) (background dark))
3073 (:foreground "indian red" :bold t))
3077 ((((class color) (min-colors 64) (background light))
3078 (:foreground "DarkGoldenrod"))
3079 (((class color) (min-colors 64) (background dark))
3080 (:foreground "LightGoldenrod"))
3082 (:foreground "yellow" :weight light))
3083 (((class grayscale) (background light))
3084 (:foreground "Gray90" :bold t :italic t))
3085 (((class grayscale) (background dark))
3086 (:foreground "DimGray" :bold t :italic t))
3088 (:bold t :italic t))))
3090 ((((class color) (min-colors 64) (background light))
3091 (:foreground "ForestGreen"))
3092 (((class color) (min-colors 64) (background dark))
3093 (:foreground "PaleGreen"))
3095 (:foreground "green"))
3096 (((class grayscale) (background light))
3097 (:foreground "Gray90" :bold t))
3098 (((class grayscale) (background dark))
3099 (:foreground "DimGray" :bold t))
3101 (:bold t :underline t))))
3103 ((((class color) (background light))
3104 (:foreground "red3"))
3105 (((class color) (background dark))
3106 (:foreground "cyan"))
3110 ((((class color) (min-colors 64) (background light))
3111 (:foreground "RosyBrown"))
3112 (((class color) (min-colors 64) (background dark))
3113 (:foreground "LightSalmon"))
3115 (:foreground "green"))
3116 (((class grayscale) (background light))
3117 (:foreground "DimGray" :italic t))
3118 (((class grayscale) (background dark))
3119 (:foreground "LightGray" :italic t))
3122 (mh-show-pgg-bad ((t (:bold t :foreground "DeepPink1"))))
3123 (mh-show-pgg-good ((t (:bold t :foreground "LimeGreen"))))
3124 (mh-show-pgg-unknown ((t (:bold t :foreground "DarkGoldenrod2"))))
3125 (mh-show-signature ((t (:italic t))))
3127 ((((class color) (background light))
3128 (:foreground "SaddleBrown"))
3129 (((class color) (background dark))
3130 (:foreground "burlywood"))
3131 (((class grayscale) (background light))
3132 (:foreground "DimGray" :underline t))
3133 (((class grayscale) (background dark))
3134 (:foreground "LightGray" :underline t))
3135 (t (:underline t))))
3137 ((((class color) (background light))
3138 (:foreground "blue4"))
3139 (((class color) (background dark))
3140 (:foreground "light blue"))))
3141 (mh-speedbar-selected-folder
3142 ((((class color) (background light))
3143 (:foreground "red1" :underline t))
3144 (((class color) (background dark))
3145 (:foreground "red1" :underline t))
3149 (defun mh-face-data (face &optional inherit)
3150 "Return spec for FACE.
3151 If INHERIT is non-nil and `defface' supports the :inherit
3152 keyword, return INHERIT literally; otherwise, return spec for FACE.
3154 This isn't a perfect implementation. In the case that
3155 the :inherit keyword is not supported, any additional attributes
3156 in the inherit parameter are not added to the returned spec."
3157 (if (and inherit mh-inherit-face-flag)
3159 (mh-defface-compat (cadr (assoc face mh-face-data)))))
3161 (defface mh-folder-address
3162 (mh-face-data 'mh-folder-subject '((t (:inherit mh-folder-subject))))
3167 (defface mh-folder-body
3168 (mh-face-data 'mh-folder-msg-number
3170 (:inherit mh-folder-msg-number))
3172 (:inherit mh-folder-msg-number :italic t))))
3177 (defface mh-folder-cur-msg-number
3178 (mh-face-data 'mh-folder-msg-number
3179 '((t (:inherit mh-folder-msg-number :bold t))))
3180 "Current message number face."
3184 (defface mh-folder-date
3185 (mh-face-data 'mh-folder-msg-number '((t (:inherit mh-folder-msg-number))))
3190 (defface mh-folder-deleted
3191 (mh-face-data 'mh-folder-msg-number '((t (:inherit mh-folder-msg-number))))
3192 "Deleted message face."
3196 (defface mh-folder-followup (mh-face-data 'mh-folder-followup)
3201 (defface mh-folder-msg-number (mh-face-data 'mh-folder-msg-number)
3202 "Message number face."
3206 (defface mh-folder-refiled (mh-face-data 'mh-folder-refiled)
3207 "Refiled message face."
3211 (defface mh-folder-sent-to-me-hint
3212 (mh-face-data 'mh-folder-msg-number '((t (:inherit mh-folder-date))))
3213 "Fontification hint face in messages sent directly to us.
3214 The detection of messages sent to us is governed by the scan
3215 format `mh-scan-format-nmh' and the regular expression
3216 `mh-scan-sent-to-me-sender-regexp'."
3220 (defface mh-folder-sent-to-me-sender
3221 (mh-face-data 'mh-folder-followup '((t (:inherit mh-folder-followup))))
3222 "Sender face in messages sent directly to us.
3223 The detection of messages sent to us is governed by the scan
3224 format `mh-scan-format-nmh' and the regular expression
3225 `mh-scan-sent-to-me-sender-regexp'."
3229 (defface mh-folder-subject (mh-face-data 'mh-folder-subject)
3234 (defface mh-folder-tick (mh-face-data 'mh-folder-tick)
3235 "Ticked message face."
3239 (defface mh-folder-to (mh-face-data 'mh-folder-to)
3244 (defface mh-letter-header-field (mh-face-data 'mh-letter-header-field)
3245 "Editable header field value face in draft buffers."
3249 (defface mh-search-folder (mh-face-data 'mh-search-folder)
3250 "Folder heading face in MH-Folder buffers created by searches."
3254 (defface mh-show-cc (mh-face-data 'mh-show-cc)
3255 "Face used to highlight \"cc:\" header fields."
3259 (defface mh-show-date (mh-face-data 'mh-show-date)
3260 "Face used to highlight \"Date:\" header fields."
3264 (defface mh-show-from (mh-face-data 'mh-show-from)
3265 "Face used to highlight \"From:\" header fields."
3269 (defface mh-show-header (mh-face-data 'mh-show-header)
3270 "Face used to deemphasize less interesting header fields."
3274 (defface mh-show-pgg-bad (mh-face-data 'mh-show-pgg-bad)
3275 "Bad PGG signature face."
3279 (defface mh-show-pgg-good (mh-face-data 'mh-show-pgg-good)
3280 "Good PGG signature face."
3284 (defface mh-show-pgg-unknown (mh-face-data 'mh-show-pgg-unknown)
3285 "Unknown or untrusted PGG signature face."
3289 (defface mh-show-signature (mh-face-data 'mh-show-signature)
3294 (defface mh-show-subject
3295 (mh-face-data 'mh-folder-subject '((t (:inherit mh-folder-subject))))
3296 "Face used to highlight \"Subject:\" header fields."
3300 (defface mh-show-to (mh-face-data 'mh-show-to)
3301 "Face used to highlight \"To:\" header fields."
3305 (defface mh-show-xface
3306 (mh-face-data 'mh-show-from '((t (:inherit (mh-show-from highlight)))))
3309 The background and foreground are used in the image."
3313 (defface mh-speedbar-folder (mh-face-data 'mh-speedbar-folder)
3314 "Basic folder face."
3316 :group 'mh-speedbar)
3318 (defface mh-speedbar-folder-with-unseen-messages
3319 (mh-face-data 'mh-speedbar-folder
3320 '((t (:inherit mh-speedbar-folder :bold t))))
3321 "Folder face when folder contains unread messages."
3323 :group 'mh-speedbar)
3325 (defface mh-speedbar-selected-folder
3326 (mh-face-data 'mh-speedbar-selected-folder)
3327 "Selected folder face."
3329 :group 'mh-speedbar)
3331 (defface mh-speedbar-selected-folder-with-unseen-messages
3332 (mh-face-data 'mh-speedbar-selected-folder
3333 '((t (:inherit mh-speedbar-selected-folder :bold t))))
3334 "Selected folder face when folder contains unread messages."
3336 :group 'mh-speedbar)
3338 ;; Get rid of temporary functions and data structures.
3339 (fmakunbound 'mh-defface-compat)
3340 (fmakunbound 'mh-face-data)
3341 (makunbound 'mh-face-data)
3342 (makunbound 'mh-inherit-face-flag)
3343 (makunbound 'mh-min-colors-defined-flag)
3348 ;; indent-tabs-mode: nil
3349 ;; sentence-end-double-space: nil
3352 ;; arch-tag: cce884de-bd37-4104-9963-e4439d5ed22b
3353 ;;; mh-e.el ends here