| blob | 780318d9766a84271c1413205354652a0590fb12 |
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., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, 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...
102 ;;; MH-E Customization Groups
105 "Emacs interface to the MH mail system.
106 MH is the Rand Mail Handler. Other implementations include nmh and GNU
107 mailutils."
112 "Aliases."
118 "Organizing your mail with folders."
124 "Folder selection."
130 "Identities."
136 "Incorporating your mail."
142 "Searching."
148 "Dealing with junk mail."
154 "Editing a draft."
160 "Ranges."
166 "Scan line formats."
172 "Sending mail."
178 "Sequences."
184 "Reading your mail."
190 "The speedbar."
196 "Threading."
202 "The toolbar"
208 "Faces used in MH-E."
215 "MH-E hooks."
220 ;;; Faces
223 "Faces used in scan listing."
230 "Faces used in searching."
237 "Faces used in message drafts."
244 "Faces used in message display."
251 "Faces used in speedbar."
257 \f
259 ;;; Emacs interface to the MH mail system (:group mh-e)
264 "*Specifies the variant used by MH-E.
266 The default setting of this option is `Auto-detect' which means that MH-E will
267 automatically choose the first of nmh, MH, or GNU mailutils that it finds in
268 the directories listed in `mh-path', `mh-sys-path', and `exec-path'. If, for
269 example, you have both nmh and mailutils installed and `mh-variant-in-use' was
270 initialized to nmh but you want to use mailutils, then you can set this option
271 to `mailutils'.
273 When this variable is changed, MH-E resets `mh-progs', `mh-lib',
274 `mh-lib-progs', `mh-flists-present-flag', and `mh-variant-in-use'
275 accordingly."
284 \f
286 ;;; Aliases (:group 'mh-alias)
289 "*Non-nil means don't consider case significant in MH alias completion.
290 As MH ignores case in the aliases, so too does MH-E. However, you may turn
291 this option off to make case significant which can be used to segregate
292 completion of your aliases. You might use lowercase for mailing lists and
293 uppercase for people."
298 "*Non-nil means to expand aliases entered in the minibuffer.
299 In other words, aliases entered in the minibuffer will be expanded to the full
300 address in the message draft. By default, this expansion is not performed."
305 "*Specify whether to flash address or warn on translation.
306 This option controls the behavior when a [comma] is pressed while entering
307 aliases or addresses. The default setting flashes the address associated with
308 an address in the minibuffer briefly, but does not display a warning if the
309 alias is not found."
316 "*Filename used to store a new MH-E alias.
317 The default setting of this option is `Use Aliasfile Profile Component'. This
318 option can also hold the name of a file or a list a file names. If this option
319 is set to a list of file names, or the `Aliasfile:' profile component contains
320 more than one file name, MH-E will prompt for one of them when MH-E adds an
321 alias."
328 "Specifies where new aliases are entered in alias files.
329 This option is set to `Alphabetical' by default. If you organize your alias
330 file in other ways, then adding aliases to the `Top' or `Bottom' of your alias
331 file might be more appropriate."
338 "*If on, local users are added to alias completion.
340 Aliases are created from `/etc/passwd' entries with a user ID larger than
341 a magical number, typically 200. This can be a handy tool on a machine where
342 you and co-workers exchange messages. These aliases have the form
343 `local.first.last' if a real name is present in the password file.
344 Otherwise, the alias will have the form `local.login'.
346 If you're on a system with thousands of users you don't know, and the loading
347 of local aliases slows MH-E down noticeably, then turn this option off.
349 This option also takes a string which is executed to generate the password
355 "*String prefixed to the real names of users from the password file.
356 This option can also be set to `Use Login'.
358 For example, consider the following password file entry:
360 psg:x:1000:1000:Peter S Galbraith,,,:/home/psg:/bin/tcsh
362 The following settings of this option will produce the associated aliases:
366 Use Login psg
368 This option has no effect if variable `mh-alias-local-users' is turned off."
374 "*Non-nil means the gecos field in the password file uses a comma separator.
375 In the example in `mh-alias-local-users-prefix', commas are used to separate
376 different values within the so-called gecos field. This is a fairly common
377 usage. However, in the rare case that the gecos field in your password file is
378 not separated by commas and whose contents may contain commas, you can turn
379 this option off."
383 \f
385 ;;; Organizing Your Mail with Folders (:group 'mh-folder)
391 search all of the top level folders. Otherwise, list the folders that should
394 See also `mh-recursive-folders-flag'."
401 "Folders searched for `mh-tick-seq'.
404 search all of the top level folders. Otherwise, list the folders that should
407 See also `mh-recursive-folders-flag'."
414 "The number of messages that indicates a large folder.
415 If a folder is deemed to be large, that is the number of messages in it exceed
416 this value, then confirmation is needed when it is visited. Even when
417 `mh-show-threads-flag' is non-nil, the folder is not automatically threaded, if
418 it is large. If set to nil all folders are treated as if they are small."
423 "*Non-nil means to recenter the summary window.
424 If this option is turned on, recenter the summary window when the show window
425 is toggled off."
430 "*Non-nil means that commands which operate on folders do so recursively."
437 This option is consulted when a prefix argument is used with
439 the MH profile. This option may be used to provide an alternate view. For
444 \f
446 ;;; Folder Selection (:group 'mh-folder-selection)
449 "Function to select a default folder for refiling or `Fcc'.
450 The current buffer is set to the message being refiled with point at the start
451 of the message. This function should return the default folder as a string
452 with a leading `+' sign. It can also return nil so that the last folder name
453 is used as the default, or an empty string to suppress the default entirely."
458 "*List of addresses and folders.
459 The folder name associated with the first address found in this list is used
460 as the default for `mh-refile-msg' and similar functions. Each element in this
461 list contains a `Check Recipient' item. If this item is turned on, then the
462 address is checked against the recipient instead of the sender. This is useful
463 for mailing lists.
465 See `mh-prompt-for-refile-folder' and `mh-folder-from-address' for more
466 information."
473 "*Non-nil means guessed folder name must exist to be used.
474 If the derived folder does not exist, and this option is on, then the last
475 folder name used is suggested. This is useful if you get mail from various
476 people for whom you have an alias, but file them all in the same project
477 folder.
479 See `mh-prompt-for-refile-folder' and `mh-folder-from-address' for more
480 information."
485 "*Prefix used for folder names generated from aliases.
486 The prefix is used to prevent clutter in your mail directory.
488 See `mh-prompt-for-refile-folder' and `mh-folder-from-address' for more
489 information."
493 \f
495 ;;; Identities (:group 'mh-identity)
498 "*List of identities.
500 To customize this option, click on the `INS' button and enter a label such as
501 `Home' or `Work'. Then click on the `INS' button with the label `Add at least
502 one item below'. Then choose one of the items in the `Value Menu'.
504 You can specify an alternate `From:' header field using the `From Field' menu
505 item. You must include a valid email address. A standard format is `First Last
506 <login@@host.domain>'. If you use an initial with a period, then you must
508 list the name of the company where they work using the `Organization Field'
509 menu item. Set any arbitrary header field and value in the `Other Field' menu
510 item. Unless the header field is a standard one, precede the name of your
511 field's label with `X-', as in `X-Fruit-of-the-Day:'. The value of
512 `Attribution Verb' overrides the setting of
513 `mh-extract-from-attribution-verb'. Set your signature with the `Signature'
514 menu item. You can specify the contents of `mh-signature-file-name', a file,
515 or a function. Specify a different key to sign or encrypt messages with the
516 `GPG Key ID' menu item.
518 You can select the identities you have added via the menu called `Identity' in
520 fields and signature added by the identity, select the `None' identity.
522 The `Identity' menu contains two other items to save you from having to set
523 the identity on every message. The menu item `Set Default for Session' can be
524 used to set the default identity to the current identity until you exit Emacs.
525 The menu item `Save as Default' sets the option `mh-identity-default' to the
526 current identity setting. You can also customize the `mh-identity-default'
527 option in the usual fashion."
549 nil)
560 "List of recipients for which header lines are automatically inserted.
562 This option can be used to set the identity depending on the recipient. To
563 customize this option, click on the `INS' button and enter a regular
564 expression for the recipient's address. Click on the `INS' button with the
565 `Add at least one item below' label. Then choose one of the items in the
566 `Value Menu'.
568 The `Identity' menu item is used to select an identity from those configured
569 in `mh-identity-list'. All of the information for that identity will be added
570 if the recipient matches. The `Fcc Field' menu item is used to select a folder
571 that is used in the `Fcc:' header. When you send the message, MH will put a
572 copy of your message in this folder. The `Mail-Followup-To Field' menu item is
573 used to insert an `Mail-Followup-To:' header field with the recipients you
574 provide. If the recipient's mail user agent supports this header field (as nmh
575 does), then their replies will go to the addresses listed. This is useful if
576 their replies go both to the list and to you and you don't have a mechanism to
577 suppress duplicates. If you reply to someone not on the list, you must either
578 remove the `Mail-Followup-To:' field, or ensure the recipient is also listed
579 there so that he receives replies to your reply. Other header fields may be
580 added using the `Other Field' menu item.
582 These fields can only be added after the recipient is known. Once the header
584 choose the `Identity -> Insert Auto Fields' menu item to insert these fields
585 manually. However, you can just send the message and the fields will be added
586 automatically. You are given a chance to see these fields and to confirm them
587 before the message is actually sent. You can do away with this confirmation by
588 turning off the option `mh-auto-fields-prompt-flag'.
590 You should avoid using the same header field in `mh-auto-fields-list' and
591 `mh-identity-list' definitions that may apply to the same message as the
592 result is undefined."
617 "*Non-nil means to prompt before sending if fields inserted.
618 See `mh-auto-fields-list'."
623 "Default identity to use when `mh-letter-mode' is called.
624 See `mh-identity-list'."
638 "Handler functions for fields in `mh-identity-list'.
640 This option is used to change the way that fields, signatures, and
641 attributions in `mh-identity-list' are added. To customize
642 `mh-identity-handlers', replace the name of an existing handler function
643 associated with the field you want to change with the name of a function you
644 have written. You can also click on an `INS' button and insert a field of your
645 choice and the name of the function you have written to handle it.
647 The `Field' field can be any field that you've used in your
648 `mh-identity-list'. The special fields `:attribution-verb', `:signature', or
649 `:pgg-default-user-id' are used for the `mh-identity-list' choices
650 `Attribution Verb', `Signature', and `GPG Key ID' respectively.
652 The handler associated with the `:default' field is used when no other field
653 matches.
655 The handler functions are passed two or three arguments: the FIELD itself (for
656 example, `From'), or one of the special fields (for example, `:signature'),
657 and the ACTION `'remove' or `'add'. If the action is `'add', an additional
658 argument containing the VALUE for the field is given."
662 \f
664 ;;; Incorporating Your Mail (:group 'mh-inc)
667 "*Program to incorporate new mail into a folder.
669 This program generates a one-line summary for each of the new messages. Unless
670 it is an absolute pathname, the file is assumed to be in the `mh-progs'
671 directory. You may also link a file to `inc' that uses a different format.
672 You'll then need to modify several scan line format variables appropriately."
677 "*Alternate spool files.
679 You can use the `mh-inc-spool-list' variable to direct MH-E to retrieve mail
680 from arbitrary spool files other than your system mailbox, file it in folders
681 other than your `+inbox', and assign key bindings to incorporate this mail.
683 Suppose you are subscribed to the `mh-e-devel' mailing list and you use
684 `procmail' to filter this mail into `~/mail/mh-e' with the following recipe in
685 `.procmailrc':
687 MAILDIR=$HOME/mail
688 :0:
689 * ^From mh-e-devel-admin@stop.mail-abuse.org
690 mh-e
692 In order to incorporate `~/mail/mh-e' into `+mh-e' with an `I m'
693 \(`mh-inc-spool-mh-e'\) command, customize this option, and click on the `INS'
694 button. Enter a `Spool File' of `~/mail/mh-e', a `Folder' of `mh-e', and a
695 `Key Binding' of `m'.
697 You can use `xbuffy' to automate the incorporation of this mail using the
698 `gnudoit' command in the `gnuserv' package as follows:
700 box ~/mail/mh-e
701 title mh-e
702 origMode
703 polltime 10
704 headertime 0
705 command gnudoit -q '(mh-inc-spool-mh-e)'"
712 \f
714 ;;; Searching (:group 'mh-index)
717 "Indexing program that MH-E shall use.
718 The default setting of this option is `Auto-detect' which means that MH-E will
719 automatically choose one of swish++, swish-e, mairix, namazu, pick and grep in
720 that order. If, for example, you have both swish++ and mairix installed and
721 you want to use mairix, then you can set this option to `mairix'.
723 More information about setting up an indexing program to use with MH-E can be
724 found in the documentation of `mh-index-search'."
734 \f
736 ;;; Dealing with Junk Mail (:group 'mh-junk)
738 ;; Spam fighting program chosen
741 ;; Available spam filter interfaces
746 "Available choices of spam programs to use.
747 This is an alist. For each element there are functions that blacklist a message
751 "Choose spam program to use.
752 The function is always called with SYMBOL bound to `mh-junk-program' and VALUE
753 bound to the new value of `mh-junk-program'. The function sets the variable
754 `mh-junk-choice' in addition to `mh-junk-program'."
762 ;; User customizable variables
764 "If on, spam programs are run in background.
765 By default, the programs are run in the foreground, but this can be slow when
766 junking large numbers of messages. If you have enough memory or don't junk
767 that many messages at the same time, you might try turning on this option."
773 "Disposition of junk mail."
779 "Spam program that MH-E should use.
782 will automatically choose one of SpamAssassin, bogofilter, or SpamProbe in
783 that order. If, for example, you have both SpamAssassin and bogofilter
784 installed and you want to use bogofilter, then you can set this option to
793 \f
795 ;;; Editing a Draft (:group 'mh-letter)
798 "Type of tags used when composing MIME messages.
799 In addition to MH-style directives, MH-E also supports MML (MIME Meta
800 Language) tags. (see Info node `(emacs-mime)Composing'). This option can be
802 is supported since it provides a lot more functionality. This option can also
811 "List of header fields to skip over when navigating in draft."
816 "*Non-nil means \\<mh-letter-mode-map>\\[mh-letter-complete-or-space] does completion in message header."
821 "*Non-nil means delete any window displaying the message.
822 This deletes the window containing the original message after yanking it with
824 your reply."
829 "*Verb to use for attribution when a message is yanked by \\<mh-letter-mode-map>\\[mh-yank-cur-msg].
830 The attribution consists of the sender's name and email address followed by
833 to enter your own verb."
841 "*String to put before each line of a yanked or inserted message.
843 not modify this option since it is used by many mailers and news readers:
844 messages are far easier to read if several included messages have all been
845 indented by the same string."
850 "*Function to call when completing outside of address or folder fields.
857 "*Fill column to use in MH Letter mode.
858 By default, this option is 72 to allow others to quote your message without
859 line wrapping."
864 "Default method to use in security tags.
865 This option is used to select between a variety of mail security mechanisms.
869 The `pgg' customization group may have some settings which may interest you
870 \(see Info node `(pgg)').
872 In particular, I set the option `pgg-encrypt-for-me' to t so that all messages
873 I encrypt are encrypted with my public key as well. If you keep a copy of all
875 that you can read the mail you write!"
883 "*Source of user's signature.
886 You can read from other files by changing this option. This file may contain a
887 vCard in which case an attachment is added with the vCard.
889 This option may also be a symbol, in which case that function is called. You
890 may not want a signature separator to be added for you; instead you may want
891 to insert one yourself. Options that you may find useful to do this include
892 `mh-signature-separator' (when inserting a signature separator) and
893 `mh-signature-separator-regexp' (for finding said separator). The function
894 `mh-signature-separator-p', which reports t if the buffer contains a
895 separator, may be useful as well.
897 The signature is inserted into your message with the command
899 option."
904 "*Non-nil means a signature separator should be inserted.
905 It is not recommended that you change this option since various mail user
906 agents, including MH-E, use the separator to present the signature
907 differently, and to suppress the signature when replying or yanking a letter
908 into a draft."
913 "*File containing face header field to insert in outgoing mail.
918 header field.
922 \(see URL `ftp://ftp.cs.indiana.edu/pub/faces/compface/compface.tar.Z').
925 `http://www.dairiki.org/xface/').
929 `http://quimby.gnus.org/circus/face/make-face').
932 processing of the image is required.
934 To prevent the setting of any of these header fields, either set
935 `mh-x-face-file' to nil, or simply ensure that the file defined by this option
936 doesn't exist."
949 supercite.
952 header is yanked and a simple attribution line is added at the top using the
953 value of the `mh-extract-from-attribution-verb' option. This is the default.
960 automatic action is only performed if the show buffer matches the message
961 being replied to. People who use the automatic variants tend to turn on the
962 `mh-delete-yanked-msg-window-flag' option as well so that the show window is
963 never displayed.
965 If the show buffer has a region, the `mh-yank-behavior' option is ignored
966 unless its value is one of Attribution variants in which case the attribution
967 is added to the yanked region."
975 autoattrib))
978 \f
980 ;;; Ranges (:group 'mh-ranges)
983 "*Non-nil means interpret a number as a range.
986 default). If you need to scan just the message 200, then use the range
991 \f
993 ;;; Scan Line Formats (:group 'mh-scan-line-formats)
995 ;;; Forward definition to avoid compiler and runtime error.
999 "Check if desired setting is legal.
1000 Throw an error if user tries to turn on `mh-adaptive-cmd-note-flag' when
1001 `mh-scan-format-file' isn't t. Otherwise, set SYMBOL to VALUE."
1009 "Check if desired setting is legal.
1010 Throw an error if user tries to set `mh-scan-format-file' to anything but t
1011 when `mh-adaptive-cmd-note-flag' is on. Otherwise, set SYMBOL to VALUE."
1019 "*Non-nil means that the message number width is determined dynamically.
1020 If you've created your own format to handle long message numbers, you'll be
1021 pleased to know you no longer need it since MH-E adapts its internal format
1022 based upon the largest message number if this option is on (the default).
1026 If you prefer fixed-width message numbers, turn off this option and call
1027 `mh-set-cmd-note' with the width specified by your format file
1028 \(see `mh-scan-format-file'). For example, the default width is 4, so you would
1035 "Specifies the format file to pass to the scan program.
1038 that the format string will be taken from the either `mh-scan-format-mh' or
1039 `mh-scan-format-nmh' depending on whether MH or nmh (or GNU mailutils) is in
1040 use. This setting also enables you to turn on the `mh-adaptive-cmd-note-flag'
1041 option.
1045 format file that you want MH-E to use but not MH, you can set this option to
1048 If you change the format of the scan lines you'll need to tell MH-E how to
1049 parse the new format. As you will see, quite a lot of variables are involved
1051 variables. You will also have to call `mh-set-cmd-note' if your notations are
1052 not in column 4 (columns in Emacs start with 0)."
1060 "*Program used to scan messages.
1061 The name of the program that generates a listing of one line per message is
1062 held in this option. Unless this variable contains an absolute pathname, it is
1063 assumed to be in the `mh-progs' directory. You may link another program to
1069 \f
1071 ;;; Sending Mail (:group 'mh-sending-mail)
1074 "*Non-nil means that messages are forwarded as attachments.
1076 By default, this option is on which means that the forwarded messages are
1077 included as attachments. If you would prefer to forward your messages verbatim
1078 \(as text, inline), then turn off this option. Forwarding messages verbatim
1079 works well for short, textual messages, but your recipient won't be able to
1080 view any non-textual attachments that were in the forwarded message. Be aware
1082 will always be included as attachments regardless of the settings of this
1083 option."
1088 "Invoked when starting a new draft.
1090 However, it is the last function called before you edit your message. The
1091 consequence of this is that you can write a function to write and send the
1092 message for you. This function is passed three arguments: the contents of the
1093 TO, SUBJECT, and CC header fields."
1098 "*Non-nil means prompt for header fields when composing a new draft."
1103 "*Format string for forwarded message subject.
1106 is replaced with the sender of the original message, and the second one is
1114 This header field includes the version of MH-E and Emacs that you are using.
1115 If you don't want to participate in our marketing, you can turn this option
1116 off."
1125 \(which many people abhor). If you find that MH will not allow you to
1126 redistribute a message that has been redistributed before, turn off this
1127 option."
1132 "*Sets the person or persons to whom a reply will be sent.
1135 recipient of a reply. If you find that most of the time that you specify
1138 the draft."
1147 "*Non-nil means the MH-Show buffer is displayed when replying.
1149 If you include the message automatically, you can hide the MH-Show
1150 buffer by turning off this option.
1152 See also `mh-reply'."
1156 \f
1158 ;;; Sequences (:group 'mh-sequences)
1160 ;;; If `mh-unpropagated-sequences' becomes a defcustom, add the following to
1161 ;;; the docstring: "Additional sequences that should not to be preserved can be
1162 ;;; specified by setting `mh-unpropagated-sequences' appropriately." XXX
1165 "*Non-nil means that sequences are preserved when messages are refiled.
1168 when it is refiled, then it will still be in those sequences in the
1169 destination folder. If this behavior is not desired, then turn off this
1170 option."
1175 "The name of the MH sequence for ticked messages.
1178 your own use. You can also disable all of the ticking functions by choosing
1181 symbol)
1185 "*Non-nil means flush MH sequences to disk after message is shown.
1187 Three sequences are maintained internally by MH-E and pushed out to MH when a
1188 message is shown. They include the sequence specified by your
1191 behavior, turn off this option. You can then update the state manually with
1193 commands."
1197 \f
1199 ;;; Reading Your Mail (:group 'mh-show)
1202 "*Non-nil means show buffer is buried.
1204 One advantage of not burying the show buffer is that one can delete the show
1205 buffer more easily in an electric buffer list because of its proximity to its
1207 I mean."
1212 "*Non-nil means remove extraneous header fields.
1214 See also `mh-invisible-header-fields-default' and
1215 `mh-invisible-header-fields'."
1222 MH-E can handle attachments as well if the Gnus `mm-decode' library is
1223 present. If so, this option will be on. Otherwise, you'll see the MIME body
1224 parts rather than text or attachments. There isn't much point in turning off
1225 this option; however, you can inspect it if it appears that the body parts are
1226 not being interpreted correctly or toggle it with the command
1229 This option also controls the display of quoted-printable messages and other
1230 graphical widgets. See the options `mh-graphical-smileys-flag' and
1231 `mh-graphical-emphasis-flag'."
1236 "*Non-nil means display buttons for all alternative attachments.
1238 Sometimes, a mail program will produce multiple alternatives of the attachment
1239 in increasing degree of faithfulness to the original content. By default, only
1240 the preferred alternative is displayed. If this option is on, then the
1241 preferred part is shown inline and buttons are shown for each of the other
1242 alternatives."
1249 The sender can request that attachments should be viewed inline so that they
1250 do not really appear like an attachment at all to the reader. Most of the
1251 time, this is desirable, so by default MH-E suppresses the buttons for inline
1252 attachments. On the other hand, you may receive code or HTML which the sender
1253 has added to his message as inline attachments so that you can read them in
1254 MH-E. In this case, it is useful to see the buttons so that you know you don't
1255 have to cut and paste the code into a file; you can simply save the
1256 attachment.
1258 If you want to make the buttons visible for inline attachments, you can use
1260 buttons. You can turn on these buttons permanently by turning on this option.
1262 MH-E cannot display all attachments inline however. It can display
1263 text (including HTML) and images."
1268 "*Non-nil means non-reversible commands do not prompt for confirmation.
1270 Commands such as `mh-pack-folder' prompt to confirm whether to process
1271 outstanding moves and deletes or not before continuing. Turning on this option
1272 means that these actions will be performed--which is usually desired but
1273 cannot be retracted--without question."
1281 with the following values:
1283 Ask Before Fetching
1284 You are prompted before the image is fetched. MH-E will remember
1285 your reply and will either use the already fetched image the next
1286 time the same URL is encountered or silently skip it if you didn't
1287 fetch it the first time. This is a good setting.
1289 Never Fetch
1290 Images are never fetched and only displayed if they are already
1291 present in the cache. This is the default.
1294 service) reasons. For example, fetching a URL can tip off a spammer that
1295 you've read his email (which is why you shouldn't blindly answer yes if you've
1297 network and fill your disk drive by sending a torrent of messages, each
1298 specifying a unique URL to a very large file.
1302 Info node `(mh-e)Picture'.
1304 This setting only has effect if the option `mh-show-use-xface-flag' is turned
1305 on."
1312 "*Non-nil means graphical smileys are displayed.
1314 It is a long standing custom to inject body language using a cornucopia of
1316 widgets if this option is turned on, which it is by default. Smileys include
1317 patterns such as :-) and ;-).
1319 This option is disabled if the option `mh-decode-mime-flag' is turned off."
1324 "*Non-nil means graphical emphasis is displayed.
1326 A few typesetting features are indicated in ASCII text with certain
1327 characters. If your terminal supports it, MH-E can render these typesetting
1328 directives naturally if this option is turned on, which it is by default. For
1329 example, _underline_ will be underlined, *bold* will appear in bold, /italics/
1330 will appear in italics, and so on. See the option `gnus-emphasis-alist' for
1331 the whole list.
1333 This option is disabled if the option `mh-decode-mime-flag' is turned off."
1338 "Style for highlighting citations.
1340 If the sender of the message has cited other messages in his message, then
1341 MH-E will highlight these citations to emphasize the sender's actual response.
1342 This option can be customized to change the highlighting style. The
1351 ;; Keep fields alphabetized. Mention source, if known.
1354 "Autoforwarded:"
1355 "Bestservhost:"
1360 "Delivery:"
1362 "Encoding:"
1363 "Envelope-to:"
1364 "Errors-To:"
1370 "Lines:"
1380 "Old-Return-Path:"
1389 "Originator:"
1393 "Path:"
1394 "Precedence:"
1396 "Priority:"
1399 "References:"
1406 "Thread-"
1408 ;; "User-Agent:" ; Similar to X-Mailer, so display it.
1410 "X-Abuse-Info:"
1411 "X-Abuse-and-DMCA-"
1412 "X-Accept-Language:"
1414 "X-Ack:"
1415 "X-Administrivia-To:"
1423 "X-Complaints-To:"
1424 "X-Cron-Env:"
1425 "X-DMCA"
1426 "X-Delivered"
1429 "X-Envelope-From:"
1430 "X-Envelope-Sender:"
1431 "X-Envelope-To:"
1433 "X-Face:"
1435 "X-From-Line"
1458 "X-MIMETrack:"
1465 "X-Message-Id"
1472 "X-No-Archive:"
1474 "X-OperatingSystem:"
1475 ;;"X-Operator:" ; Similar to X-Mailer, so display it
1476 "X-Orcl-Content-Type:"
1477 "X-Original-Complaints-To:"
1479 "X-Original-To:"
1480 "X-Original-Trace:"
1483 "X-Postfilter:"
1486 "X-RM"
1487 "X-Received-Date:"
1488 "X-Received:"
1489 "X-Request-"
1494 "X-SMTP-"
1495 "X-Scanned-By"
1496 "X-Sender:"
1497 "X-Server-Date:"
1498 "X-Server-Uuid:"
1500 "X-Source"
1503 "X-Status"
1504 "X-Submissions-To:"
1505 "X-Telecom-Digest"
1506 "X-Trace:"
1507 "X-UID"
1508 "X-UIDL:"
1510 "X-UserInfo1:"
1513 "X-Vms-To:"
1514 "X-WebTV-Signature:"
1516 "X-Yahoo"
1518 "X-pgp:"
1519 "X-submission-address:"
1522 "List of default header fields that are not to be shown.
1523 Do not alter this variable directly. Instead, add entries from here that you
1524 would like to be displayed in `mh-invisible-header-fields-default'
1528 "*Regexp matching lines in a message header that are not to be shown.
1529 Do not alter this variable directly. Instead, customize
1530 `mh-invisible-header-fields-default' checking for fields normally
1531 hidden that you wish to display, and add extra entries to hide in
1535 "Make or remake the variable `mh-invisible-header-fields-compiled'.
1536 Done using `mh-invisible-header-fields-internal' as input, from which entries
1537 from `mh-invisible-header-fields-default' are removed and entries
1538 from `mh-invisible-header-fields' are added."
1541 ;; Remove entries from `mh-invisible-header-fields-default'
1545 collect x)))
1547 mh-invisible-header-fields)
1553 "^"
1554 ;; workaround for insufficient default
1560 "*List of hidden header fields.
1562 The header fields listed in this option are hidden, although you can check off
1563 any field that you would like to see.
1565 Header fields that you would like to hide that aren't listed can be added to
1566 the option `mh-invisible-header-fields'.
1568 See also `mh-clean-message-header-flag'."
1570 mh-invisible-header-fields-internal))
1577 "*Additional header fields to hide.
1579 Header fields that you would like to hide that aren't listed in
1580 `mh-invisible-header-fields-default' can be added to this option with a couple
1581 of caveats. Regular expressions are not allowed. Unique fields should have a
1582 `:' suffix; otherwise, the element can be used to render invisible an entire
1583 class of fields that start with the same prefix. If you think a header field
1584 should be generally ignored, report a bug (see URL
1585 `https://sourceforge.net/tracker/?group_id=13357&atid=113357').
1587 See also `mh-clean-message-header-flag'."
1598 This option contains the Unix command line which performs the actual printing
1600 which is replaced by the name of the folder and the message number and is
1602 which produces a nice header and adds a bit of margin so the text fits within
1603 my printer's margins.
1613 Some older mail programs do not insert this needed plumbing to tell
1614 MH-E whether to display the attachments inline or not. If this is the
1615 case, MH-E will display these images inline if they are smaller than
1616 the window. However, you might want to allow larger images to be
1617 displayed inline. To do this, you can change the options
1618 `mh-max-inline-image-width' and `mh-max-inline-image-height' from their
1619 default value of zero to a large number. The size of your screen is a
1620 good choice for these numbers."
1627 Some older mail programs do not insert this needed plumbing to tell
1628 MH-E whether to display the attachments inline or not. If this is the
1629 case, MH-E will display these images inline if they are smaller than
1630 the window. However, you might want to allow larger images to be
1631 displayed inline. To do this, you can change the options
1632 `mh-max-inline-image-width' and `mh-max-inline-image-height' from their
1633 default value of zero to a large number. The size of your screen is a
1634 good choice for these numbers."
1641 Normally MH-E takes care of displaying messages itself (rather than calling an
1649 If you have a format file that you want MH-E to use, you can set this option
1653 forwarding; in this case, the value of this option is consulted if you have
1654 specified a format file."
1664 prompted for the directory in which to save the attachments. However, if you
1665 usually use the same directory within a session, then you can set this option
1668 name."
1671 directory)
1677 Normally messages are printed in the foreground. If this is slow on your
1678 system, you may elect to turn off this option to print in the background.
1680 WARNING: If you do this, do not delete the message until it is printed or else
1681 the output may be truncated.
1689 "*Maximum size of message (in bytes) to display automatically.
1691 This option provides an opportunity to skip over large messages which may be
1692 slow to load. The default value of 0 means that all message are shown
1693 regardless of size."
1698 goto-address-highlight-p)
1701 To send a message using the highlighted email address or to view the web page
1702 for the highlighted URL, use the middle mouse button or
1705 See Info node `(mh-e)Sending Mail' to see how to configure Emacs to send the
1706 message using MH-E.
1708 The default value of this option comes from the value of
1709 `goto-address-highlight-p'."
1714 "*Non-nil means display face images in MH-show buffers.
1717 header fields. If any of these fields occur in the header of your message, the
1722 The option `mh-show-use-xface-flag' is used to turn this feature on and off.
1723 This feature will be turned on by default if your system supports it.
1727 see URL `http://quimby.gnus.org/circus/face/'. Next is the traditional
1730 `ftp://ftp.cs.indiana.edu/pub/faces/compface/compface.tar.z'). Recent versions
1733 package (see URL `ftp://ftp.jpl.org/pub/elisp/').
1740 `http://www.imagemagick.org/'). Of the three header fields this is the most
1741 efficient in terms of network usage since the image doesn't need to be
1742 transmitted with every single mail.
1744 The option `mh-fetch-x-image-url' controls the fetching of the
1752 If you would like to change the initial default directory, customize this
1753 option, change the value from `Current' to `Directory', and then enter the
1754 name of the directory for storing the content of these messages."
1756 directory)
1760 "*Number of lines in MH-Folder buffer (including the mode line).
1763 MH-Folder buffer will maintain the same proportional size if the frame is
1765 and enter the number of lines you'd like to see."
1770 \f
1772 ;;; The Speedbar (:group 'mh-speed)
1775 "Time between calls to flists in seconds.
1776 If 0, flists is not called repeatedly."
1781 "Non-nil means flists is used.
1782 If non-nil, flists is executed every `mh-speed-flists-interval' seconds to
1783 update the display of the number of unseen and total messages in each folder.
1784 If resources are limited, this can be set to nil and the speedbar display can
1789 \f
1791 ;;; Threading (:group 'mh-thread)
1794 "*Non-nil means new folders start in threaded mode.
1796 Threading large number of messages can be time consuming so this option is
1797 turned off by default. If you turn this option on, then threading will be done
1798 only if the number of messages being threaded is less than `mh-large-folder'."
1802 \f
1804 ;;; The Toolbar (:group 'mh-toolbar)
1807 "*Function called by the tool-bar search button.
1808 See `mh-search-folder' and `mh-index-search' for details."
1814 ;; Functions called from the tool bar
1816 "Interactively call `mh-tool-bar-search-function'.
1817 Optional argument ARG is not used."
1822 "Call `mh-customize' from the toolbar."
1839 "Generate FUNCTION that replies to RECIPIENT.
1840 If FOLDER-BUFFER-FLAG is nil then the function generated
1841 When INCLUDE-FLAG is non-nil, include message body being replied to."
1844 recipient)
1856 ;; XEmacs has a couple of extra customizations...
1861 t
1862 nil)
1863 "*If non-nil, use toolbar.
1865 This will default to t if you are in an environment that supports
1866 toolbars and xpm."
1871 'default
1872 nil)
1873 "*Where to put the toolbar.
1879 A nil value means do not use a toolbar.
1882 default-toolbar has a different positional setting from the value of
1883 this variable, then two toolbars will be displayed. The MH-E toolbar
1884 and the default-toolbar."
1899 "Test whether a buffer with major mode MODE is present."
1904 return t))
1907 "Define a tool bar for MH-E.
1908 DEFAULTS is the list of buttons that are present by default. It is a list of
1909 lists where the sublists are of the following form:
1911 (:KEYWORD FUNC1 FUNC2 FUNC3 ...)
1913 Here :KEYWORD is one of :folder or :letter. If it is :folder then the default
1914 buttons in the folder and show mode buffers are being specified. If it is
1915 :letter then the default buttons in the letter mode are listed. FUNC1, FUNC2,
1916 FUNC3, ... are the names of the functions that the buttons would execute.
1918 Each element of BUTTONS is a list consisting of four mandatory items and one
1919 optional item as follows:
1921 (FUNCTION MODES ICON DOC &optional ENABLE-EXPR)
1923 where,
1925 FUNCTION is the name of the function that will be executed when the button
1926 is clicked.
1928 MODES is a list of symbols. List elements must be from `folder', `letter' and
1929 `sequence'. If `folder' is present then the button is available in the
1931 where foo is some arbitrary string, then we check if the function
1932 `mh-show-foo' exists. If it exists then that function is used in the show
1933 buffer. Otherwise the original function `mh-foo' is used in the show buffer
1934 as well. Presence of `sequence' is handled similar to the above. The only
1935 difference is that the button is shown only when the folder is narrowed to a
1936 sequence. If `letter' is present in MODES, then the button is available
1937 during draft editing and runs FUNCTION when clicked.
1939 ICON is the icon that is drawn in the button.
1941 DOC is the documentation for the button. It is used in tool-tips and in
1942 providing other help to the user. GNU Emacs uses only the first line of the
1943 string. So the DOC should be formatted such that the first line is useful and
1944 complete without the rest of the string.
1946 Optional item ENABLE-EXPR is an arbitrary lisp expression. If it evaluates
1947 to nil, then the button is deactivated, otherwise it is active. If is in't
1948 present then the button is always active."
1949 ;; The following variable names have been carefully chosen to make code
1950 ;; generation easier. Modifying the names should be done carefully.
1952 show-buttons show-button-setter show-seq-button-setter
1953 letter-buttons letter-docs letter-button-setter
1954 folder-defaults letter-defaults
1955 folder-vectors show-vectors letter-vectors)
1971 full-doc))
1974 functions show-sym)
1979 functions))
1983 name))
1987 functions)))
2035 ;; GNU Emacs tool bar specific code
2037 ;; Tool bar initialization functions
2044 tool-bar-map))
2048 tool-bar-map))
2052 tool-bar-map))
2056 tool-bar-map))))
2063 tool-bar-map))))
2064 ;; Custom setter functions
2066 "Construct toolbar for `mh-folder-mode' and `mh-show-mode'."
2070 "Construct toolbar for `mh-letter-mode'."
2073 ;; XEmacs specific code
2077 for vector in folder-vectors
2081 for vector in show-vectors
2085 for vector in letter-vectors
2090 ;; Custom setter functions
2106 ;; Initialize toolbar
2108 "Install toolbar in MODE."
2116 mh-xemacs-has-toolbar-flag)
2135 ;; Declare customizable toolbars
2137 'mh-tool-bar-folder-buttons
2139 "Choose buttons to include in MH-E folder/show toolbar."
2142 for y in folder-docs
2145 'mh-tool-bar-letter-buttons
2147 "Choose buttons to include in MH-E letter toolbar."
2150 for y in letter-docs
2154 ((:folder mh-inc-folder mh-mime-save-parts mh-previous-undeleted-msg
2155 mh-page-msg mh-next-undeleted-msg mh-delete-msg mh-refile-msg
2156 mh-undo mh-execute-commands mh-toggle-tick mh-reply
2157 mh-alias-grab-from-field mh-send mh-rescan-folder
2158 mh-tool-bar-search mh-visit-folder
2159 mh-tool-bar-customize mh-tool-bar-folder-help mh-widen)
2160 (:letter mh-send-letter mh-compose-insertion ispell-message save-buffer
2161 undo kill-region menu-bar-kill-ring-save yank mh-fully-kill-draft
2162 mh-tool-bar-customize mh-tool-bar-letter-help))
2163 ;; Folder/Show buffer buttons
2165 "Incorporate new mail in Inbox
2166 This button runs `mh-inc-folder' which drags any
2169 "Save MIME parts from this message
2170 This button runs `mh-mime-save-parts' which saves a message's
2173 "Go to the previous undeleted message
2210 ;; Letter buffer buttons
2223 ;; Common buttons
2229 ;; Folder narrowed to sequence buttons
2233 \f
2235 ;;; Hooks (:group 'mh-hooks + group where hook described)
2238 "*Hook for modifying a citation just inserted in the mail buffer.
2239 You can gain full control over the appearance of the included text by setting
2240 this hook to a function that modifies it. This hook is ignored if the option
2241 `mh-yank-behavior' is set to one of the supercite flavors. Otherwise, this
2242 option controls how much of the message is passed to the hook. The function
2243 can find the citation between point and mark and it should leave point and
2244 mark around the modified citation text for the next hook function. The
2245 standard prefix `mh-ins-buf-prefix' is not added if this hook is set.
2247 For example, if you use the hook function trivial-cite (which is NOT part of
2249 `http://shasta.cs.uiuc.edu/~lrclause/tc.html')."
2256 "Invoked by `mh-alias-reload' after reloading aliases."
2263 See also `mh-quit-hook'."
2270 For example, if you want to check your spelling in your message before
2271 sending, add the `ispell-message' function."
2278 "Invoked after marking each message for deletion.
2280 For example, a past maintainer of MH-E used this once when he kept statistics
2281 on his mail usage."
2293 "Invoked by `mh-find-path' after reading the user's MH profile."
2299 "Invoked in `mh-folder-mode' on a new folder."
2305 "Invoked when the folder actions (such as moves and deletes) are performed.
2306 Variables that are useful in this hook include `mh-delete-list' and
2307 `mh-refile-list' which can be used to see which changes are being made to
2308 current folder, `mh-current-folder'."
2327 This hook is a list of functions to be called, with no arguments, which should
2328 return a value of non-nil if you should not be asked if you're sure that you
2329 want to remove the folder. This is useful for folders that are easily
2330 regenerated.
2332 The default value of `mh-index-p' suppresses the prompt on folders generated
2333 by an index search.
2335 WARNING: Use this hook with care. If there is a bug in your hook which returns
2337 in the +inbox buffer, you will not be happy."
2343 "Invoked after signature has been inserted.
2344 This hook may access the actual name of the file or the function used to
2345 insert the signature with `mh-signature-file-name'."
2351 "Invoked by `mh-letter-mode' on a new letter."
2357 "Invoked upon entry to `mh-pick-mode'."
2364 See also `mh-before-quit-hook'."
2370 "Invoked after marking each message for refiling."
2378 It is the last thing called after messages are displayed. It's used to affect
2379 the behavior of MH-E in general or when `mh-show-mode-hook' is too early."
2385 "Invoked upon entry to `mh-show-mode'.
2387 This hook is called early on in the process of the message display. It is
2388 usually used to perform some action on the message's content."
2394 "Invoked after the unseen sequence has been updated.
2395 The variable `mh-seen-list' can be used to obtain the list of messages which
2396 will be removed from the unseen sequence."
2401 \f
2403 ;;; Faces (:group 'mh-*-faces + group where faces described)
2405 ;;; Faces Used in Scan Listing (:group 'mh-folder-faces)
2423 "Face used to highlight body text in MH-Folder buffers."
2432 ;; (:underline t) ;Use this for underlining
2433 )
2440 "Face used for the current message line in MH-Folder buffers."
2459 "Face used to highlight the current message in MH-Folder buffers."
2471 "Face used to highlight the date in MH-Folder buffers."
2483 "Face used to highlight Re: subject text in MH-Folder buffers."
2495 "Face used to highlight the message number in MH-Folder buffers."
2518 "Face used to highlight refiled messages in MH-Folder buffers."
2532 "Face used to highlight subject text in MH-Folder buffers."
2542 "Face used to show ticked messages."
2569 "Face used to highlight the To: string in MH-Folder buffers."
2572 \f
2574 ;;; Faces Used in Searching (:group 'mh-index-faces)
2585 "Face used to highlight folders in MH-Index buffers."
2588 \f
2590 ;;; Faces Used in Message Drafts (:group 'mh-letter-faces)
2599 "Face used to display header fields in draft buffers."
2602 \f
2604 ;;; Faces Used in Message Display (:group 'mh-show-faces)
2622 "Face used to highlight cc: header fields."
2641 "Face used to highlight the Date: header field."
2660 "Face used to deemphasize unspecified header fields."
2668 "Face used to highlight a good PGG signature."
2672 "Face used to highlight a PGG signature whose status is unknown.
2677 "Face used to highlight a PGG signature whose status is unknown.
2678 This face is also used for a signature when the signer is untrusted."
2686 "Face used to highlight a bad PGG signature."
2692 "Face used to highlight the message signature."
2709 "Face used to highlight the To: header field."
2721 "Face used to highlight the From: header field."
2727 "Face used to display the X-Face image.
2728 The background and foreground is used in the image."
2735 \f
2737 ;;; Faces Used in Speedbar (:group 'mh-speed-faces)
2744 "Face used for folders in the speedbar buffer."
2754 "Face used for the current folder."
2760 "Face used for folders in the speedbar buffer which have unread messages."
2766 "Face used for the current folder when it has unread messages."
2769 ;;; Local Variables:
2770 ;;; indent-tabs-mode: nil
2771 ;;; sentence-end-double-space: nil
2772 ;;; End:
2774 ;;; arch-tag: 778d2a20-82e2-4276-be9d-309386776a68
2775 ;;; mh-customize.el ends here