| blob | 541411643910d4c83228bcae0ddde307df60b0f1 |
1 ;;; mh-customize.el --- MH-E customization
3 ;; Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
5 ;; Author: Bill Wohler <wohler@newt.com>
6 ;; Maintainer: Bill Wohler <wohler@newt.com>
7 ;; Keywords: mail
8 ;; See: mh-e.el
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; All of the defgroups, defcustoms, and deffaces in MH-E are found
30 ;; here. This makes it possible to customize modules that aren't loaded
31 ;; yet. It also makes it easier to organize the customization groups.
33 ;; This file contains the following sections:
34 ;;
35 ;; 1. MH-E Customization Groups
36 ;;
37 ;; These are the customization group definitions. Every group has a
38 ;; associated manual node. The ordering is alphabetical, except for the
39 ;; groups mh-faces and mh-hooks which are last .
40 ;;
41 ;; 2. MH-E Customization
42 ;;
43 ;; These are the actual customization variables. There is a sub-section for
44 ;; each group in the MH-E Customization Groups section, in the same order,
45 ;; separated by page breaks. Within each section, variables are sorted
46 ;; alphabetically.
47 ;;
48 ;; 3. Hooks
49 ;;
50 ;; All hooks must be placed in the mh-hook group; in addition, add the
51 ;; group associated with the manual node in which the hook is described.
52 ;; Since the mh-hook group appears near the end of this file, the hooks
53 ;; will appear at the end of these other groups.
54 ;;
55 ;; 4. Faces
56 ;;
57 ;; Create a new face group if necessary; in this case, add the group
58 ;; associated with the manual node in which the faces are described to the
59 ;; faces' group definition. Since the face groups appear last, the face
60 ;; groups will appear at the end of these other groups.
61 ;;
62 ;;; Change Log:
64 ;;; Code:
79 ;; XXX: Functions autoloaded from the following files are used to initialize
80 ;; customizable variables. They are require'd here, since otherwise the
81 ;; corresponding .elc would be loaded at compile time.
87 "Customize MH-E variables.
88 If optional argument DELETE-OTHER-WINDOWS-FLAG is non-nil, other windows in
89 the frame are removed."
95 \f
97 ;;; For compiler warnings...
101 ;;; MH-E Customization Groups
104 "Emacs interface to the MH mail system.
105 MH is the Rand Mail Handler. Other implementations include nmh and GNU
106 mailutils."
111 "Aliases."
117 "Organizing your mail with folders."
123 "Folder selection."
129 "Identities."
135 "Incorporating your mail."
141 "Searching."
147 "Dealing with junk mail."
153 "Editing a draft."
159 "Ranges."
165 "Scan line formats."
171 "Sending mail."
177 "Sequences."
183 "Reading your mail."
189 "The speedbar."
195 "The toolbar"
201 "Faces used in MH-E."
208 "MH-E hooks."
213 ;;; Faces
216 "Faces used in scan listing."
223 "Faces used in searching."
230 "Faces used in message drafts."
237 "Faces used in message display."
244 "Faces used in speedbar."
250 \f
252 ;;; Emacs interface to the MH mail system (:group mh)
257 "*Specifies the variant used by MH-E.
259 The default setting of this option is `Auto-detect' which means that MH-E will
260 automatically choose the first of nmh, MH, or GNU mailutils that it finds in
261 the directories listed in `mh-path', `mh-sys-path', and `exec-path'. If, for
262 example, you have both nmh and mailutils installed and `mh-variant-in-use' was
263 initialized to nmh but you want to use mailutils, then you can set this option
264 to `mailutils'.
266 When this variable is changed, MH-E resets `mh-progs', `mh-lib',
267 `mh-lib-progs', `mh-flists-present-flag', and `mh-variant-in-use'
268 accordingly."
277 \f
279 ;;; Aliases (:group 'mh-alias)
282 "*Non-nil means don't consider case significant in MH alias completion.
283 As MH ignores case in the aliases, so too does MH-E. However, you may turn
284 this option off to make case significant which can be used to segregate
285 completion of your aliases. You might use lowercase for mailing lists and
286 uppercase for people."
291 "*Non-nil means to expand aliases entered in the minibuffer.
292 In other words, aliases entered in the minibuffer will be expanded to the full
293 address in the message draft. By default, this expansion is not performed."
298 "*Specify whether to flash address or warn on translation.
299 This option controls the behavior when a [comma] is pressed while entering
300 aliases or addresses. The default setting flashes the address associated with
301 an address in the minibuffer briefly, but does not display a warning if the
302 alias is not found."
309 "*Filename used to store a new MH-E alias.
310 The default setting of this option is `Use Aliasfile Profile Component'. This
311 option can also hold the name of a file or a list a file names. If this option
312 is set to a list of file names, or the `Aliasfile:' profile component contains
313 more than one file name, MH-E will prompt for one of them when MH-E adds an
314 alias."
321 "Specifies where new aliases are entered in alias files.
322 This option is set to `Alphabetical' by default. If you organize your alias
323 file in other ways, then adding aliases to the `Top' or `Bottom' of your alias
324 file might be more appropriate."
331 "*If on, local users are added to alias completion.
333 Aliases are created from `/etc/passwd' entries with a user ID larger than
334 a magical number, typically 200. This can be a handy tool on a machine where
335 you and co-workers exchange messages. These aliases have the form
336 `local.first.last' if a real name is present in the password file.
337 Otherwise, the alias will have the form `local.login'.
339 If you're on a system with thousands of users you don't know, and the loading
340 of local aliases slows MH-E down noticeably, then turn this option off.
342 This option also takes a string which is executed to generate the password
348 "*String prepended to the real names of users from the password file.
349 This option can also be set to `Use Login'.
351 For example, consider the following password file entry:
353 psg:x:1000:1000:Peter S Galbraith,,,:/home/psg:/bin/tcsh
355 The following settings of this option will produce the associated aliases:
359 Use Login psg
361 This option has no effect if variable `mh-alias-local-users' is turned off."
367 "*Non-nil means the gecos field in the password file uses a comma separator.
368 In the example in `mh-alias-local-users-prefix', commas are used to separate
369 different values within the so-called gecos field. This is a fairly common
370 usage. However, in the rare case that the gecos field in your password file is
371 not separated by commas and whose contents may contain commas, you can turn
372 this option off."
376 \f
378 ;;; Organizing Your Mail with Folders (:group 'mh-folder)
381 "*Non-nil means to recenter the summary window.
382 If this option is turned on, recenter the summary window when the show window
383 is toggled off."
387 \f
389 ;;; Folder Selection (:group 'mh-folder-selection)
392 "Function to select a default folder for refiling or `Fcc'.
393 The current buffer is set to the message being refiled with point at the start
394 of the message. This function should return the default folder as a string
395 with a leading `+' sign. It can also return nil so that the last folder name
396 is used as the default, or an empty string to suppress the default entirely."
401 "*List of addresses and folders.
402 The folder name associated with the first address found in this list is used
403 as the default for `mh-refile-msg' and similar functions. Each element in this
404 list contains a `Check Recipient' item. If this item is turned on, then the
405 address is checked against the recipient instead of the sender. This is useful
406 for mailing lists.
408 See `mh-prompt-for-refile-folder' and `mh-folder-from-address' for more
409 information."
416 "*Non-nil means guessed folder name must exist to be used.
417 If the derived folder does not exist, and this option is on, then the last
418 folder name used is suggested. This is useful if you get mail from various
419 people for whom you have an alias, but file them all in the same project
420 folder.
422 See `mh-prompt-for-refile-folder' and `mh-folder-from-address' for more
423 information."
428 "*Prefix used for folder names generated from aliases.
429 The prefix is used to prevent clutter in your mail directory.
431 See `mh-prompt-for-refile-folder' and `mh-folder-from-address' for more
432 information."
436 \f
438 ;;; Identities (:group 'mh-identity)
441 "*List of identities.
443 To customize this option, click on the `INS' button and enter a label such as
444 `Home' or `Work'. Then click on the `INS' button with the label `Add at least
445 one item below'. Then choose one of the items in the `Value Menu'.
447 You can specify an alternate `From:' header field using the `From Field' menu
448 item. You must include a valid email address. A standard format is `First Last
449 <login@@host.domain>'. If you use an initial with a period, then you must
451 list the name of the company where they work using the `Organization Field'
452 menu item. Set any arbitrary header field and value in the `Other Field' menu
453 item. Unless the header field is a standard one, precede the name of your
454 field's label with `X-', as in `X-Fruit-of-the-Day:'. The value of
455 `Attribution Verb' overrides the setting of
456 `mh-extract-from-attribution-verb'. Set your signature with the `Signature'
457 menu item. You can specify the contents of `mh-signature-file-name', a file,
458 or a function. Specify a different key to sign or encrypt messages with the
459 `GPG Key ID' menu item.
461 You can select the identities you have added via the menu called `Identity' in
463 fields and signature added by the identity, select the `None' identity.
465 The `Identity' menu contains two other items to save you from having to set
466 the identity on every message. The menu item `Set Default for Session' can be
467 used to set the default identity to the current identity until you exit Emacs.
468 The menu item `Save as Default' sets the option `mh-identity-default' to the
469 current identity setting. You can also customize the `mh-identity-default'
470 option in the usual fashion."
492 nil)
503 "List of recipients for which header lines are automatically inserted.
505 This option can be used to set the identity depending on the recipient. To
506 customize this option, click on the `INS' button and enter a regular
507 expression for the recipient's address. Click on the `INS' button with the
508 `Add at least one item below' label. Then choose one of the items in the
509 `Value Menu'.
511 The `Identity' menu item is used to select an identity from those configured
512 in `mh-identity-list'. All of the information for that identity will be added
513 if the recipient matches. The `Fcc Field' menu item is used to select a folder
514 that is used in the `Fcc:' header. When you send the message, MH will put a
515 copy of your message in this folder. The `Mail-Followup-To Field' menu item is
516 used to insert an `Mail-Followup-To:' header field with the recipients you
517 provide. If the recipient's mail user agent supports this header field (as nmh
518 does), then their replies will go to the addresses listed. This is useful if
519 their replies go both to the list and to you and you don't have a mechanism to
520 suppress duplicates. If you reply to someone not on the list, you must either
521 remove the `Mail-Followup-To:' field, or ensure the recipient is also listed
522 there so that he receives replies to your reply. Other header fields may be
523 added using the `Other Field' menu item.
525 These fields can only be added after the recipient is known. Once the header
527 choose the `Identity -> Insert Auto Fields' menu item to insert these fields
528 manually. However, you can just send the message and the fields will be added
529 automatically. You are given a chance to see these fields and to confirm them
530 before the message is actually sent. You can do away with this confirmation by
531 turning off the option `mh-auto-fields-prompt-flag'.
533 You should avoid using the same header field in `mh-auto-fields-list' and
534 `mh-identity-list' definitions that may apply to the same message as the
535 result is undefined."
560 "*Non-nil means to prompt before sending if fields inserted.
561 See `mh-auto-fields-list'."
566 "Default identity to use when `mh-letter-mode' is called.
567 See `mh-identity-list'."
581 "Handler functions for fields in `mh-identity-list'.
583 This option is used to change the way that fields, signatures, and
584 attributions in `mh-identity-list' are added. To customize
585 `mh-identity-handlers', replace the name of an existing handler function
586 associated with the field you want to change with the name of a function you
587 have written. You can also click on an `INS' button and insert a field of your
588 choice and the name of the function you have written to handle it.
590 The `Field' field can be any field that you've used in your
591 `mh-identity-list'. The special fields `:attribution-verb', `:signature', or
592 `:pgg-default-user-id' are used for the `mh-identity-list' choices
593 `Attribution Verb', `Signature', and `GPG Key ID' respectively.
595 The handler associated with the `:default' field is used when no other field
596 matches.
598 The handler functions are passed two or three arguments: the FIELD itself (for
599 example, `From'), or one of the special fields (for example, `:signature'),
600 and the ACTION `'remove' or `'add'. If the action is `'add', an additional
601 argument containing the VALUE for the field is given."
605 \f
607 ;;; Incorporating Your Mail (:group 'mh-inc)
610 "*Program to incorporate new mail into a folder.
612 This program generates a one-line summary for each of the new messages. Unless
613 it is an absolute pathname, the file is assumed to be in the `mh-progs'
614 directory. You may also link a file to `inc' that uses a different format.
615 You'll then need to modify several scan line format variables appropriately."
620 "*Alternate spool files.
622 You can use the `mh-inc-spool-list' variable to direct MH-E to retrieve mail
623 from arbitrary spool files other than your system mailbox, file it in folders
624 other than your `+inbox', and assign key bindings to incorporate this mail.
626 Suppose you are subscribed to the `mh-e-devel' mailing list and you use
627 `procmail' to filter this mail into `~/mail/mh-e' with the following recipe in
628 `.procmailrc':
630 MAILDIR=$HOME/mail
631 :0:
632 * ^From mh-e-devel-admin@stop.mail-abuse.org
633 mh-e
635 In order to incorporate `~/mail/mh-e' into `+mh-e' with an `I m'
636 \(`mh-inc-spool-mh-e'\) command, customize this option, and click on the `INS'
637 button. Enter a `Spool File' of `~/mail/mh-e', a `Folder' of `mh-e', and a
638 `Key Binding' of `m'.
640 You can use `xbuffy' to automate the incorporation of this mail using the
641 `gnudoit' command in the `gnuserv' package as follows:
643 box ~/mail/mh-e
644 title mh-e
645 origMode
646 polltime 10
647 headertime 0
648 command gnudoit -q '(mh-inc-spool-mh-e)'"
655 \f
657 ;;; Searching (:group 'mh-index)
662 search all of the top level folders. Otherwise, list the folders that should
665 See also `mh-recursive-folders-flag'."
672 "Indexing program that MH-E shall use.
673 The default setting of this option is `Auto-detect' which means that MH-E will
674 automatically choose one of swish++, swish-e, mairix, namazu, pick and grep in
675 that order. If, for example, you have both swish++ and mairix installed and
676 you want to use mairix, then you can set this option to `mairix'.
678 More information about setting up an indexing program to use with MH-E can be
679 found in the documentation of `mh-index-search'."
690 "Folders searched for `mh-tick-seq'.
692 search all of the top level folders. Otherwise, list the folders that should
695 See also `mh-recursive-folders-flag'."
701 \f
703 ;;; Dealing with Junk Mail (:group 'mh-junk)
705 ;; Spam fighting program chosen
708 ;; Available spam filter interfaces
713 "Available choices of spam programs to use.
714 This is an alist. For each element there are functions that blacklist a message
718 "Choose spam program to use.
719 The function is always called with SYMBOL bound to `mh-junk-program' and VALUE
720 bound to the new value of `mh-junk-program'. The function sets the variable
721 `mh-junk-choice' in addition to `mh-junk-program'."
729 ;; User customizable variables
731 "If on, spam programs are run in background.
732 By default, the programs are run in the foreground, but this can be slow when
733 junking large numbers of messages. If you have enough memory or don't junk
734 that many messages at the same time, you might try turning on this option."
740 "Disposition of junk mail."
746 "Spam program that MH-E should use.
749 will automatically choose one of SpamAssassin, Bogofilter, or SpamProbe in
750 that order. If, for example, you have both SpamAssassin and Bogofilter
751 installed and you want to use BogoFilter, then you can set this option to
760 \f
762 ;;; Editing a Draft (:group 'mh-letter)
765 "Type of MIME message directives in messages.
767 By default, this option is set to `Gnus' if it is supported. This option can
768 also be set manually to `mhn' if mhn directives are preferred."
776 "List of header fields to skip over when navigating in draft."
781 "*Non-nil means that <SPC> does completion in message header."
786 "*Non-nil means delete any window displaying the message.
787 If this option is on, yanking the current message into a draft letter with
789 message."
794 "*Verb to use for attribution when a message is yanked by \\<mh-letter-mode-map>\\[mh-yank-cur-msg]."
802 "*String to put before each non-blank line of a yanked or inserted message.
803 Used when the message is inserted into an outgoing letter
809 "*Function to call when completing outside of address or folder fields.
810 By default, this is set to `ispell-complete-word'."
815 "*Fill column to use in `mh-letter-mode'.
816 This is usually less than in other text modes because email messages get
817 quoted by some prefix (sometimes many times) when they are replied to,
818 and it's best to avoid quoted lines that span more than 80 columns."
823 "Default method to use in security directives."
831 "*Source of user's signature.
833 By default, the text of your signature is taken from the file `~/.signature'.
834 You can read from other files by changing this option. This file may contain a
835 vCard in which case an attachment is added with the vCard.
837 This option may also be a symbol, in which case that function is called. You
838 may not want a signature separator to be added for you; instead you may want
839 to insert one yourself. Variables that you may find useful to do this include
840 `mh-signature-separator' (when inserting a signature separator) and
841 `mh-signature-separator-regexp' (for finding said separator). The function
842 `mh-signature-separator-p', which reports t if the buffer contains a
843 separator, may be useful as well.
845 The signature is inserted into your message with the command
847 option."
852 "*Non-nil means a signature separator should be inserted.
853 It is not recommended that you change this option since various mail user
854 agents, including MH-E, use the separator to present the signature
855 differently, and to suppress the signature when replying or yanking a letter
856 into a draft."
861 "*File containing face header field to insert in outgoing mail.
863 If the file starts with either of the strings `X-Face:', `Face:' or
864 `X-Image-URL:' then the contents are added to the message header verbatim.
865 Otherwise it is assumed that the file contains the value of the `X-Face:'
866 header field.
868 The `X-Face:' header field, which is a low-resolution, black and white image,
869 can be generated using the `compface' command, which can be obtained from
872 quick conversion of images into `X-Face:' header fields.
874 Use the `make-face' script (http://quimby.gnus.org/circus/face/make-face) to
875 convert a JPEG image to the higher resolution, color, `Face:' header field.
877 The URL of any image can be used for the `X-Image-URL:' field and no
878 processing of the image is required.
880 To prevent the setting of any of these header fields, either set
881 `mh-x-face-file' to nil, or simply ensure that the file defined by this option
882 doesn't exist."
888 If t, include the entire message, with full headers. This is historically
889 here for use with supercite, but is now deprecated in favor of the setting
890 `supercite' below.
892 If the symbol `body', then yank the message minus the header.
894 If the symbol `supercite', include the entire message, with full headers.
895 This also causes the invocation of `sc-cite-original' without the setting
896 of `mail-citation-hook', now deprecated practice.
898 If the symbol `autosupercite', do as for `supercite' automatically when
899 show buffer matches the message being replied-to. When this option is used,
900 the -noformat switch is passed to the repl program to override a -filter or
901 -format switch.
903 If the symbol `attribution', then yank the message minus the header and add
904 a simple attribution line at the top.
906 If the symbol `autoattrib', do as for `attribution' automatically when show
907 buffer matches the message being replied-to. You can make sure this is
908 always the case by setting `mh-reply-show-message-flag' to t (which is the
909 default) and optionally `mh-delete-yanked-msg-window-flag' to t as well such
910 that the show window is never displayed. When the `autoattrib' option is
911 used, the -noformat switch is passed to the repl program to override a
912 -filter or -format switch.
914 If nil, yank only the portion of the message following the point.
916 If the show buffer has a region, this variable is ignored unless its value is
917 one of `attribution' or `autoattrib' in which case the attribution is added
918 to the yanked region."
926 autoattrib))
929 \f
931 ;;; Ranges (:group 'mh-ranges)
934 "Non-nil means interpret a number as a range.
935 If the variable is non-nil, and you use an integer, N, when asked for a
940 \f
942 ;;; Scan Line Formats (:group 'mh-scan-line-formats)
945 "*Non-nil means that the message number width is determined dynamically.
946 This is done once when a folder is first opened by running scan on the last
947 message of the folder. The message number for the last message is extracted
948 and its width calculated. This width is used when calling `mh-set-cmd-note'.
950 If you prefer fixed-width message numbers, set this variable to nil and call
951 `mh-set-cmd-note' with the width specified by the scan format in
952 `mh-scan-format-file'. For example, the default width is 4, so you would use
958 "Specifies the format file to pass to the scan program.
959 If t, the format string will be taken from the either `mh-scan-format-mh'
960 or `mh-scan-format-nmh' depending on whether MH or nmh is in use.
961 If nil, the default scan output will be used.
963 If you customize the scan format, you may need to modify a few variables
964 containing regexps that MH-E uses to identify specific portions of the output.
965 Use `M-x apropos RET mh-scan.*regexp' to obtain a list of these variables. You
966 may also have to call `mh-set-cmd-note' with the width of your message
967 numbers. See also `mh-adaptive-cmd-note-flag'."
974 "*Program to run to generate one-line-per-message listing of a folder.
976 for relative to the `mh-progs' directory unless it is an absolute pathname."
981 \f
983 ;;; Sending Mail (:group 'mh-sending-mail)
986 "Non-nil means that messages are forwarded as a MIME part."
991 "Invoked when setting up a letter draft.
992 It is passed three arguments: TO recipients, SUBJECT, and CC recipients."
997 "*Non-nil means prompt for header fields when composing a new draft."
1002 "*Format to generate the Subject: line contents for a forwarded message.
1003 The two string arguments to the format are the sender of the original
1004 message and the original subject line."
1009 "*Non-nil means append an X-Mailer field to the header."
1014 "*Sets the person or persons to whom a reply will be sent.
1015 If nil, prompt for recipient. If non-nil, then \\<mh-folder-mode-map>`\\[mh-reply]' will use this
1026 The setting of this variable determines whether the MH `show-buffer' is
1027 displayed with the current message when using `mh-reply' without a prefix
1028 argument. Set it to nil if you already include the message automatically
1029 in your draft using
1030 repl: -filter repl.filter
1031 in your ~/.mh_profile file."
1035 \f
1037 ;;; Sequences (:group 'mh-sequences)
1039 ;;; If `mh-unpropagated-sequences' becomes a defcustom, add the following to
1040 ;;; the docstring: "Additional sequences that should not to be preserved can be
1041 ;;; specified by setting `mh-unpropagated-sequences' appropriately." XXX
1044 "*Non-nil means that sequences are preserved when messages are refiled.
1045 If this variable is non-nil and a message belonging to a sequence other than
1046 cur or Previous-Sequence (see mh-profile 5) is refiled then it is put in the
1047 same sequence in the destination folder."
1052 "The name of the MH sequence for ticked messages.
1053 You would change this option if you already use the `tick' sequence for your
1054 own use. You can also disable all of the ticking functions by choosing the
1055 `Disable Ticking' item but there isn't much advantage to that."
1057 symbol)
1061 "*Non-nil means flush MH sequences to disk after message is shown.
1062 Three sequences are maintained internally by MH-E and pushed out to MH when a
1063 message is shown. They include the sequence specified by your
1064 `Unseen-Sequence:' profile entry, `cur', and the sequence listed by
1065 the `mh-tick-seq' option which is `tick' by default.
1066 If you do not like this behavior, set this option to nil. You can then update
1067 the state manually with the \\<mh-folder-mode-map>`\\[mh-execute-commands]', `\\[mh-quit]', or `\\[mh-update-sequences]' commands."
1071 \f
1073 ;;; Reading Your Mail (:group 'mh-show)
1076 "*Non-nil means that the displayed show buffer for a folder is buried."
1081 "*Non-nil means remove extraneous header fields.
1082 The header fields listed in the `mh-invisible-header-fields-default' option
1083 are hidden, although you can check off any field that you would like to see.
1084 Header fields that you would like to hide that aren't listed can be added to
1085 the `mh-invisible-header-fields' option."
1090 "*Non-nil means that Gnus is used to show MIME attachments with Gnus."
1095 "*Non-nil means display buttons for all MIME alternatives.
1096 Default behavior is to display only the preferred alternative. If this
1097 variable is non-nil, then the preferred part is shown inline and buttons
1098 are shown for each of the other alternatives."
1103 "*Non-nil means display buttons for all inline MIME parts.
1104 If non-nil, buttons are displayed for all MIME parts. Inline parts start off
1105 in displayed state but they can be hidden by clicking the button. If nil no
1106 buttons are shown for inline parts."
1111 "*Non-nil means do not prompt for confirmation.
1112 Commands such as `mh-pack-folder' prompt to confirm whether to process
1113 outstanding moves and deletes or not before continuing. A non-nil setting will
1114 perform the action--which is usually desired but cannot be retracted--without
1115 question."
1120 "*Control fetching of `X-Image-URL:' header field image.
1122 to avoid this setting for privacy and DOS (denial of service) reasons. For
1123 example, fetching a URL can tip off a spammer that you've read his email.
1124 Someone may also flood your network and fill your disk drive by sending a
1125 torrent of messages, each specifying a unique URL to a very large file.
1128 fetched. MH-E will remember your reply and will either use the already fetched
1129 image the next time the same URL is encountered or silently skip it if you
1130 didn't fetch it the first time. This is the default.
1133 if they are already present in the cache.
1135 The cache of images is found in the directory `.mhe-x-image-cache' within your
1136 MH directory. To see how you can add your own face to the `From:' field, see
1137 `mh-x-face-file'.
1139 This setting only has effect if `mh-show-use-xface-flag' is non-nil."
1147 "*Non-nil means graphical smileys are displayed.
1148 Non-nil means that small graphics will be used in the show buffer instead of
1149 patterns like :-), ;-) etc. The setting only has effect if
1150 `mh-decode-mime-flag' is non-nil."
1155 "*Non-nil means graphical emphasis is displayed.
1156 Non-nil means that _underline_ will be underlined, *bold* will appear in bold,
1157 /italic/ will appear in italic etc. See `gnus-emphasis-alist' for the whole
1158 list. The setting only has effect if `mh-decode-mime-flag' is non-nil."
1163 "How to highlight citations in show buffers.
1164 The gnus method uses a different color for each indentation."
1170 ;; Keep fields alphabetized. Mention source, if known.
1173 "Autoforwarded:"
1174 "Bestservhost:"
1179 "Delivery:"
1181 "Encoding:"
1182 "Envelope-to:"
1183 "Errors-To:"
1189 "Lines:"
1199 "Old-Return-Path:"
1208 "Originator:"
1212 "Path:"
1213 "Precedence:"
1215 "Priority:"
1217 "References:"
1224 "Thread-"
1226 ;; "User-Agent:" ; Similar to X-Mailer, so display it.
1228 "X-Abuse-Info:"
1229 "X-Abuse-and-DMCA-"
1230 "X-Accept-Language:"
1232 "X-Ack:"
1233 "X-Administrivia-To:"
1240 "X-Complaints-To:"
1241 "X-Cron-Env:"
1242 "X-DMCA"
1243 "X-Delivered"
1246 "X-Envelope-From:"
1247 "X-Envelope-Sender:"
1248 "X-Envelope-To:"
1250 "X-Face:"
1252 "X-From-Line"
1275 "X-MIMETrack:"
1282 "X-Message-Id"
1289 "X-No-Archive:"
1291 "X-OperatingSystem:"
1292 ;;"X-Operator:" ; Similar to X-Mailer, so display it
1293 "X-Orcl-Content-Type:"
1294 "X-Original-Complaints-To:"
1296 "X-Original-To:"
1297 "X-Original-Trace:"
1300 "X-Postfilter:"
1303 "X-RM"
1304 "X-Received-Date:"
1305 "X-Received:"
1306 "X-Request-"
1311 "X-SMTP-"
1312 "X-Scanned-By"
1313 "X-Sender:"
1314 "X-Server-Date:"
1315 "X-Server-Uuid:"
1317 "X-Source"
1320 "X-Status"
1321 "X-Submissions-To:"
1322 "X-Telecom-Digest"
1323 "X-Trace:"
1324 "X-UID"
1325 "X-UIDL:"
1327 "X-UserInfo1:"
1329 "X-Vms-To:"
1330 "X-WebTV-Signature:"
1332 "X-Yahoo"
1334 "X-pgp:"
1335 "X-submission-address:"
1338 "List of default header fields that are not to be shown.
1339 Do not alter this variable directly. Instead, add entries from here that you
1340 would like to be displayed in `mh-invisible-header-fields-default'
1344 "*Regexp matching lines in a message header that are not to be shown.
1345 Do not alter this variable directly. Instead, customize
1346 `mh-invisible-header-fields-default' checking for fields normally
1347 hidden that you wish to display, and add extra entries to hide in
1351 "Make or remake the variable `mh-invisible-header-fields-compiled'.
1352 Done using `mh-invisible-header-fields-internal' as input, from which entries
1353 from `mh-invisible-header-fields-default' are removed and entries
1354 from `mh-invisible-header-fields' are added."
1357 ;; Remove entries from `mh-invisible-header-fields-default'
1361 collect x)))
1363 mh-invisible-header-fields)
1369 "^"
1370 ;; workaround for insufficient default
1376 "*List of hidden header fields.
1377 The header fields listed in this option are hidden, although you can check off
1378 any field that you would like to see. Header fields that you would like to
1379 hide that aren't listed can be added to the `mh-invisible-header-fields'
1380 option.
1382 See also `mh-clean-message-header-flag'."
1384 mh-invisible-header-fields-internal))
1391 "*Additional header fields to hide.
1392 Header fields that you would like to hide that aren't listed in
1393 `mh-invisible-header-fields-default' can be added to this option with a couple
1394 of caveats. Regular expressions are not allowed. Unique fields should have a
1395 `:' suffix; otherwise, the element can be used to render invisible an entire
1396 class of fields that start with the same prefix.
1398 See also `mh-clean-message-header-flag'."
1407 "*Format for Unix command that prints a message.
1408 The string should be a Unix command line, with the string '%s' where
1409 the job's name (folder and message number) should appear. The formatted
1415 "*Maximum inline image height if Content-Disposition is not present.
1416 If nil, image will be displayed if its height is smaller than the height of
1417 the window."
1422 "*Maximum inline image width if Content-Disposition is not present.
1423 If nil, image will be displayed if its width is smaller than the width of the
1424 window."
1429 "Default directory to use for `mh-mime-save-parts'.
1430 If nil, prompt and set for next time the command is used during same session.
1431 If t, prompt always"
1434 directory)
1438 "*Non-nil means messages should be printed in the background.
1439 WARNING: do not delete the messages until printing is finished;
1440 otherwise, your output may be truncated."
1445 "*Non-nil means that commands which operate on folders do so recursively."
1450 "*Maximum size of message (in bytes) to display automatically.
1451 Provides an opportunity to skip over large messages which may be slow to load.
1452 Use a value of 0 to display all messages automatically regardless of size."
1457 "Non-nil means new folders start in threaded mode.
1458 Threading large number of messages can be time consuming. So if the flag is
1459 non-nil then threading will be done only if the number of messages being
1460 threaded is less than `mh-large-folder'."
1464 ;; Use goto-addr if it was already loaded (which probably sets this
1465 ;; variable to t), or if this variable is otherwise set to t.
1467 goto-address-highlight-p)
1468 "*Non-nil means highlight URLs and email addresses.
1469 The `goto-addr' module is used."
1474 "*Non-nil means display face images in `mh-show-mode'.
1476 MH-E can display the content of `Face:', `X-Face:', and `X-Image-URL:' header
1477 fields. If any of these fields occur in the header of your message, the
1478 sender's face will appear in the `From:' header field. If more than one of
1479 these fields appear, then the first field found in the order `Face:',
1480 `X-Face:', and `X-Image-URL:' will be used. Note that versions of GNU Emacs
1481 prior to 21.1 don't support the display of inline images, so face images are
1482 not displayed in these versions.
1484 The option `mh-show-use-xface-flag' is used to turn this feature on and off.
1485 This feature will be turned on by default if your system supports it.
1487 The first header field used, if present, is the Gnus-specific `Face:' field.
1488 The `Face:' field appeared in GNU Emacs 21 and XEmacs. For more information,
1489 see http://quimby.gnus.org/circus/face/. Next is the traditional `X-Face:'
1490 header field. The display of this field requires the `uncompface' program
1491 which can be obtained from
1492 ftp://ftp.cs.indiana.edu/pub/faces/compface/compface.tar.Z. Recent versions of
1493 XEmacs have internal support for `X-Face:' images. If your version of XEmacs
1494 does not, then you'll need both `uncompface' and the x-face package which is
1495 available at ftp://ftp.jpl.org/pub/elisp/.
1497 Finally, MH-E will display images referenced by the `X-Image-URL:' header
1498 field if neither the `Face:' nor the `X-Face:' fields are present. The display
1499 of the images requires `wget' (available from
1500 http://www.gnu.org/software/wget/wget.html), `fetch', or `curl' to fetch the
1501 image and the `convert' program from the ImageMagick suite, available from
1502 http://www.imagemagick.org/. Of the three header fields this is the most
1503 efficient in terms of network usage since the image doesn't need to be
1504 transmitted with every single mail.
1506 The option `mh-fetch-x-image-url' controls the fetching of the `X-Image-URL:'
1507 header field image."
1513 A directory name string, or nil to use current directory."
1515 directory)
1519 "*Number of lines in MH-Folder window (including the mode line)."
1525 "*Name of format file to be used by mhl to show and print messages.
1526 A value of t means use the default format file.
1527 nil means don't use mhl to format messages when showing; mhl is still used,
1528 with the default format file, to format messages when printing them.
1529 The format used should specify a non-zero value for overflowoffset so
1530 the message continues to conform to RFC 822 and MH-E can parse the headers."
1535 \f
1537 ;;; The Speedbar (:group 'mh-speed)
1540 "The number of messages that indicates a large folder.
1541 If a folder is deemed to be large, that is the number of messages in it exceed
1542 this value, then confirmation is needed when it is visited. Even when
1543 `mh-show-threads-flag' is non-nil, the folder is not automatically threaded, if
1544 it is large. If set to nil all folders are treated as if they are small."
1549 "Time between calls to flists in seconds.
1550 If 0, flists is not called repeatedly."
1555 "Non-nil means flists is used.
1556 If non-nil, flists is executed every `mh-speed-flists-interval' seconds to
1557 update the display of the number of unseen and total messages in each folder.
1558 If resources are limited, this can be set to nil and the speedbar display can
1563 \f
1565 ;;; The Toolbar (:group 'mh-toolbar)
1568 "*Function called by the tool-bar search button.
1569 See `mh-search-folder' and `mh-index-search' for details."
1575 ;; Functions called from the tool bar
1577 "Interactively call `mh-tool-bar-search-function'.
1578 Optional argument ARG is not used."
1583 "Call `mh-customize' from the toolbar."
1600 "Generate FUNCTION that replies to RECIPIENT.
1601 If FOLDER-BUFFER-FLAG is nil then the function generated
1602 When INCLUDE-FLAG is non-nil, include message body being replied to."
1605 recipient)
1617 ;; XEmacs has a couple of extra customizations...
1622 t
1623 nil)
1624 "*If non-nil, use toolbar.
1626 This will default to t if you are in an environment that supports
1627 toolbars and xpm."
1632 'default
1633 nil)
1634 "*Where to put the toolbar.
1640 A nil value means do not use a toolbar.
1643 default-toolbar has a different positional setting from the value of
1644 this variable, then two toolbars will be displayed. The MH-E toolbar
1645 and the default-toolbar."
1660 "Define a tool bar for MH-E.
1661 DEFAULTS is the list of buttons that are present by default. It is a list of
1662 lists where the sublists are of the following form:
1664 (:KEYWORD FUNC1 FUNC2 FUNC3 ...)
1666 Here :KEYWORD is one of :folder or :letter. If it is :folder then the default
1667 buttons in the folder and show mode buffers are being specified. If it is
1668 :letter then the default buttons in the letter mode are listed. FUNC1, FUNC2,
1669 FUNC3, ... are the names of the functions that the buttons would execute.
1671 Each element of BUTTONS is a list consisting of four mandatory items and one
1672 optional item as follows:
1674 (FUNCTION MODES ICON DOC &optional ENABLE-EXPR)
1676 where,
1678 FUNCTION is the name of the function that will be executed when the button
1679 is clicked.
1681 MODES is a list of symbols. List elements must be from `folder', `letter' and
1682 `sequence'. If `folder' is present then the button is available in the
1684 where foo is some arbitrary string, then we check if the function
1685 `mh-show-foo' exists. If it exists then that function is used in the show
1686 buffer. Otherwise the original function `mh-foo' is used in the show buffer
1687 as well. Presence of `sequence' is handled similar to the above. The only
1688 difference is that the button is shown only when the folder is narrowed to a
1689 sequence. If `letter' is present in MODES, then the button is available
1690 during draft editing and runs FUNCTION when clicked.
1692 ICON is the icon that is drawn in the button.
1694 DOC is the documentation for the button. It is used in tool-tips and in
1695 providing other help to the user. GNU Emacs uses only the first line of the
1696 string. So the DOC should be formatted such that the first line is useful and
1697 complete without the rest of the string.
1699 Optional item ENABLE-EXPR is an arbitrary lisp expression. If it evaluates
1700 to nil, then the button is deactivated, otherwise it is active. If is in't
1701 present then the button is always active."
1702 ;; The following variable names have been carefully chosen to make code
1703 ;; generation easier. Modifying the names should be done carefully.
1705 show-buttons show-button-setter show-seq-button-setter
1706 letter-buttons letter-docs letter-button-setter
1707 folder-defaults letter-defaults
1708 folder-vectors show-vectors letter-vectors)
1724 full-doc))
1727 functions show-sym)
1732 functions))
1736 name))
1740 functions)))
1788 ;; GNU Emacs tool bar specific code
1790 ;; Custom setter functions
1792 "Construct toolbar for `mh-folder-mode' and `mh-show-mode'."
1797 tool-bar-map))
1801 tool-bar-map))
1805 tool-bar-map))
1809 tool-bar-map)))
1811 "Construct toolbar for `mh-letter-mode'."
1816 tool-bar-map))))
1817 ;; XEmacs specific code
1821 for vector in folder-vectors
1825 for vector in show-vectors
1829 for vector in letter-vectors
1834 ;; Custom setter functions
1850 ;; Initialize toolbar
1852 "Install toolbar in MODE."
1860 mh-xemacs-has-toolbar-flag)
1879 ;; Declare customizable toolbars
1881 'mh-tool-bar-folder-buttons
1883 "Choose buttons to include in MH-E folder/show toolbar."
1886 for y in folder-docs
1889 'mh-tool-bar-letter-buttons
1891 "Choose buttons to include in MH-E letter toolbar."
1894 for y in letter-docs
1898 ((:folder mh-inc-folder mh-mime-save-parts mh-previous-undeleted-msg
1899 mh-page-msg mh-next-undeleted-msg mh-delete-msg mh-refile-msg
1900 mh-undo mh-execute-commands mh-toggle-tick mh-reply
1901 mh-alias-grab-from-field mh-send mh-rescan-folder
1902 mh-tool-bar-search mh-visit-folder
1903 mh-tool-bar-customize mh-tool-bar-folder-help mh-widen)
1904 (:letter mh-send-letter mh-compose-insertion ispell-message save-buffer
1905 undo kill-region menu-bar-kill-ring-save yank mh-fully-kill-draft
1906 mh-tool-bar-customize mh-tool-bar-letter-help))
1907 ;; Folder/Show buffer buttons
1909 "Incorporate new mail in Inbox
1910 This button runs `mh-inc-folder' which drags any
1913 "Save MIME parts from this message
1914 This button runs `mh-mime-save-parts' which saves a message's
1917 "Go to the previous undeleted message
1954 ;; Letter buffer buttons
1967 ;; Common buttons
1973 ;; Folder narrowed to sequence buttons
1977 \f
1979 ;;; Hooks (:group 'mh-hooks + group where hook described)
1982 "*Hook for modifying a citation just inserted in the mail buffer.
1983 Each hook function can find the citation between point and mark.
1984 And each hook function should leave point and mark around the citation
1985 text as modified.
1987 If this hook is entirely empty (nil), the text of the message is inserted
1988 with `mh-ins-buf-prefix' prefixed to each line.
1990 See also the variable `mh-yank-from-start-of-msg', which controls how
1991 much of the message passed to the hook.
1993 This hook was historically provided to set up supercite. You may now leave
1994 this nil and set up supercite by setting the variable
1995 `mh-yank-from-start-of-msg' to 'supercite or, for more automatic insertion,
1996 to 'autosupercite.
1998 The hook 'trivial-cite is NOT part of Emacs. It is provided from tc.el,
1999 available here:
2000 http://shasta.cs.uiuc.edu/~lrclause/tc.html
2001 If you use it, customize `mh-yank-from-start-of-msg' to
2009 "Invoked by `mh-alias-reload' after reloading aliases."
2016 See also `mh-quit-hook'."
2028 "Invoked after marking each message for deletion."
2040 "Invoked by `mh-find-path' after reading the user's MH profile."
2046 "Invoked in `mh-folder-mode' on a new folder."
2052 "Invoked when the folder actions (such as moves and deletes) are performed.
2053 Variables that are useful in this hook include `mh-delete-list' and
2054 `mh-refile-list' which can be used to see which changes are being made to
2055 current folder, `mh-current-folder'."
2073 This hook is a list of functions to be called, with no arguments, which should
2074 return a value of non-nil if you should not be asked if you're sure that you
2075 want to remove the folder. This is useful for folders that are easily
2076 regenerated.
2078 The default value of `mh-index-p' suppresses the prompt on folders generated
2079 by an index search.
2081 WARNING: Use this hook with care. If there is a bug in your hook which returns
2083 in the +inbox buffer, you will not be happy."
2089 "Invoked after signature has been inserted.
2090 This hook may access the actual name of the file or the function used to
2091 insert the signature with `mh-signature-file-name'."
2097 "Invoked in `mh-letter-mode' on a new letter."
2103 "Invoked upon entry to `mh-pick-mode'."
2110 See also `mh-before-quit-hook'."
2116 "Invoked after marking each message for refiling."
2128 "Invoked upon entry to `mh-show-mode'."
2134 "Invoked after the unseen sequence has been updated.
2135 The variable `mh-seen-list' can be used to obtain the list of messages which
2136 will be removed from the unseen sequence."
2141 \f
2143 ;;; Faces (:group 'mh-*-faces + group where faces described)
2145 ;;; Faces Used in Scan Listing (:group 'mh-folder-faces)
2156 "Face used to highlight body text in MH-Folder buffers."
2166 ;; (:underline t) ;Use this for underlining
2167 )
2171 "Face used for the current message line in MH-Folder buffers."
2183 "Face used to highlight the current message in MH-Folder buffers."
2195 "Face used to highlight the date in MH-Folder buffers."
2207 "Face used to highlight Re: subject text in MH-Folder buffers."
2219 "Face used to highlight the message number in MH-Folder buffers."
2237 "Face used to highlight refiled messages in MH-Folder buffers."
2251 "Face used to highlight subject text in MH-Folder buffers."
2258 "Face used to show ticked messages."
2278 "Face used to highlight the To: string in MH-Folder buffers."
2281 \f
2283 ;;; Faces Used in Searching (:group 'mh-index-faces)
2294 "Face used to highlight folders in MH-Index buffers."
2297 \f
2299 ;;; Faces Used in Message Drafts (:group 'mh-letter-faces)
2307 "Face used to display header fields in draft buffers."
2310 \f
2312 ;;; Faces Used in Message Display (:group 'mh-show-faces)
2325 "Face used to highlight cc: header fields."
2337 "Face used to highlight the Date: header field."
2349 "Face used to deemphasize unspecified header fields."
2356 "Face used to highlight a good PGG signature."
2360 "Face used to highlight a PGG signature whose status is unknown.
2364 "Face used to highlight a PGG signature whose status is unknown.
2365 This face is also used for a signature when the signer is untrusted."
2372 "Face used to highlight a bad PGG signature."
2377 "Face used to highlight the message signature."
2392 "Face used to highlight the To: header field."
2404 "Face used to highlight the From: header field."
2409 "Face used to display the X-Face image.
2410 The background and foreground is used in the image."
2417 \f
2419 ;;; Faces Used in Speedbar (:group 'mh-speed-faces)
2426 "Face used for folders in the speedbar buffer."
2435 "Face used for the current folder."
2440 "Face used for folders in the speedbar buffer which have unread messages."
2445 "Face used for the current folder when it has unread messages."
2448 ;;; Local Variables:
2449 ;;; indent-tabs-mode: nil
2450 ;;; sentence-end-double-space: nil
2451 ;;; End:
2453 ;;; arch-tag: 778d2a20-82e2-4276-be9d-309386776a68
2454 ;;; mh-customize.el ends here