7 version 1.5.20 (2009-06-14)
11 ?All mail clients suck. This one just sucks less.? ? me, circa 1995
13 -------------------------------------------------------------------------------
22 4. Mutt Online Resources
23 5. Contributing to Mutt
24 6. Typograhical Conventions
40 3. Moving Around in Menus
41 4. Editing Input Fields
48 5.1. The Message Index
51 5.4. Miscellaneous Functions
56 6.2. Editing the Message Header
57 6.3. Sending Cryptographically Signed/Encrypted Messages
58 6.4. Sending Format=Flowed Messages
60 7. Forwarding and Bouncing Mail
65 1. Location of Initialization Files
66 2. Syntax of Initialization Files
68 4. Defining/Using Aliases
69 5. Changing the Default Key Bindings
70 6. Defining Aliases for Character Sets
71 7. Setting Variables Based Upon Mailbox
73 9. Using Color and Mono Video Attributes
74 10. Message Header Display
76 10.1. Selecting Headers
77 10.2. Ordering Displayed Headers
79 11. Alternative Addresses
81 13. Using Multiple Spool Mailboxes
82 14. Monitoring Incoming Mail
83 15. User-Defined Headers
84 16. Specify Default Save Mailbox
85 17. Specify Default Fcc: Mailbox When Composing
86 18. Specify Default Save Filename and Default Fcc: Mailbox at Once
87 19. Change Settings Based Upon Message Recipients
88 20. Change Settings Before Formatting a Message
89 21. Choosing the Cryptographic Key of the Recipient
90 22. Adding Key Sequences to the Keyboard Buffer
91 23. Executing Functions
94 26. Setting and Querying Variables
98 26.3. User-Defined Variables
100 27. Reading Initialization Commands From Another File
111 1. Regular Expressions
112 2. Patterns: Searching, Limiting and Tagging
114 2.1. Pattern Modifier
116 2.3. Nesting and Boolean Operators
117 2.4. Searching by Date
122 4.1. Message Matching in Hooks
124 5. External Address Queries
127 8. Handling Mailing Lists
128 9. Handling multiple folders
131 10.1. Linking Threads
132 10.2. Breaking Threads
134 11. Delivery Status Notification (DSN) Support
135 12. Start a WWW Browser on URLs
138 5. Mutt's MIME Support
140 1. Using MIME in Mutt
142 1.1. Viewing MIME Messages in the Pager
143 1.2. The Attachment Menu
144 1.3. The Compose Menu
146 2. MIME Type Configuration with mime.types
147 3. MIME Viewer Configuration with Mailcap
149 3.1. The Basics of the Mailcap File
150 3.2. Secure Use of Mailcap
151 3.3. Advanced Mailcap Usage
152 3.4. Example Mailcap Files
155 5. MIME Multipart/Alternative
156 6. Attachment Searching and Counting
163 1.1. Enabling/Disabling Features
170 4.1. The IMAP Folder Browser
174 6. Managing Multiple Accounts
181 8. Exact Address Generation
182 9. Sending Anonymous Messages via Mixmaster
184 7. Security Considerations
190 3.1. Message-Id: headers
191 3.2. mailto:-style Links
193 4. External Applications
195 8. Performance Tuning
197 1. Reading and Writing Mailboxes
198 2. Reading Messages from Remote Folders
199 3. Searching and Limiting
203 1. Command-Line Options
204 2. Configuration Commands
205 3. Configuration Variables
208 3.2. abort_unmodified
217 3.11. assumed_charset
228 3.22. bounce_delivered
229 3.23. braille_friendly
230 3.24. certificate_file
232 3.26. check_mbox_size
234 3.28. collapse_unread
239 3.33. connect_timeout
242 3.36. crypt_autoencrypt
245 3.39. crypt_autosmime
246 3.40. crypt_replyencrypt
247 3.41. crypt_replysign
248 3.42. crypt_replysignencrypted
249 3.43. crypt_timestamp
250 3.44. crypt_use_gpgme
252 3.46. crypt_verify_sig
257 3.51. digest_collapse
259 3.53. dotlock_program
262 3.56. duplicate_threads
267 3.61. envelope_from_address
277 3.71. forward_decrypt
286 3.80. header_cache_compress
287 3.81. header_cache_pagesize
292 3.86. hide_thread_subject
293 3.87. hide_top_limited
294 3.88. hide_top_missing
297 3.91. honor_disposition
298 3.92. honor_followup_to
300 3.94. ignore_linear_white_space
301 3.95. ignore_list_reply_to
302 3.96. imap_authenticators
303 3.97. imap_check_subscribed
304 3.98. imap_delim_chars
307 3.101. imap_keepalive
308 3.102. imap_list_subscribed
313 3.107. imap_pipeline_depth
314 3.108. imap_servernoise
316 3.110. implicit_autoview
318 3.112. include_onlyfirst
326 3.120. mailcap_sanitize
327 3.121. maildir_header_cache_verify
337 3.131. message_cache_clean
338 3.132. message_cachedir
339 3.133. message_format
343 3.137. mh_seq_flagged
344 3.138. mh_seq_replied
347 3.141. mime_forward_decode
348 3.142. mime_forward_rest
349 3.143. mix_entry_format
357 3.151. pager_index_lines
359 3.153. pgp_auto_decode
360 3.154. pgp_autoinline
361 3.155. pgp_check_exit
362 3.156. pgp_clearsign_command
363 3.157. pgp_decode_command
364 3.158. pgp_decrypt_command
365 3.159. pgp_encrypt_only_command
366 3.160. pgp_encrypt_sign_command
367 3.161. pgp_entry_format
368 3.162. pgp_export_command
369 3.163. pgp_getkeys_command
371 3.165. pgp_ignore_subkeys
372 3.166. pgp_import_command
373 3.167. pgp_list_pubring_command
374 3.168. pgp_list_secring_command
377 3.171. pgp_replyinline
378 3.172. pgp_retainable_sigs
379 3.173. pgp_show_unusable
381 3.175. pgp_sign_command
383 3.177. pgp_strict_enc
385 3.179. pgp_use_gpg_agent
386 3.180. pgp_verify_command
387 3.181. pgp_verify_key_command
391 3.185. pop_auth_try_all
392 3.186. pop_authenticators
393 3.187. pop_checkinterval
400 3.194. post_indent_string
424 3.218. reverse_realname
425 3.219. rfc2047_parameters
431 3.225. score_threshold_delete
432 3.226. score_threshold_flag
433 3.227. score_threshold_read
434 3.228. search_context
446 3.240. smime_ask_cert_label
447 3.241. smime_ca_location
448 3.242. smime_certificates
449 3.243. smime_decrypt_command
450 3.244. smime_decrypt_use_default_key
451 3.245. smime_default_key
452 3.246. smime_encrypt_command
453 3.247. smime_encrypt_with
454 3.248. smime_get_cert_command
455 3.249. smime_get_cert_email_command
456 3.250. smime_get_signer_cert_command
457 3.251. smime_import_cert_command
458 3.252. smime_is_default
460 3.254. smime_pk7out_command
461 3.255. smime_sign_command
462 3.256. smime_sign_opaque_command
464 3.258. smime_verify_command
465 3.259. smime_verify_opaque_command
466 3.260. smtp_authenticators
474 3.268. spam_separator
476 3.270. ssl_ca_certificates_file
477 3.271. ssl_client_cert
479 3.273. ssl_min_dh_prime_bits
484 3.278. ssl_usesystemcerts
485 3.279. ssl_verify_dates
486 3.280. ssl_verify_host
490 3.284. strict_threads
493 3.287. thorough_search
494 3.288. thread_received
501 3.295. uncollapse_jump
504 3.298. use_envelope_from
537 2. About This Document
541 1.1. Typographical conventions for special terms
542 2.1. Most common navigation keys in entry-based menus
543 2.2. Most common navigation keys in page-based menus
544 2.3. Most common line editor keys
545 2.4. Most common message index keys
546 2.5. Message status flags
547 2.6. Message recipient flags
548 2.7. Most common pager keys
549 2.8. ANSI escape sequences
551 2.10. Most common thread mode keys
552 2.11. Most common mail sending keys
553 2.12. Most common compose menu keys
554 2.13. PGP key menu flags
555 3.1. Symbolic key names
556 4.1. POSIX regular expression character classes
557 4.2. Regular expression repetition operators
558 4.3. GNU regular expression extensions
559 4.4. Pattern modifiers
560 4.5. Simple search keywords
562 9.1. Command line options
563 9.2. Default generic Function Bindings
564 9.3. Default index Function Bindings
565 9.4. Default pager Function Bindings
566 9.5. Default alias Function Bindings
567 9.6. Default query Function Bindings
568 9.7. Default attach Function Bindings
569 9.8. Default compose Function Bindings
570 9.9. Default postpone Function Bindings
571 9.10. Default browser Function Bindings
572 9.11. Default pgp Function Bindings
573 9.12. Default smime Function Bindings
574 9.13. Default mix Function Bindings
575 9.14. Default editor Function Bindings
579 3.1. Multiple configuration commands per line
580 3.2. Commenting configuration files
581 3.3. Escaping quotes in congfiguration files
582 3.4. Splitting long configuration commands over several lines
583 3.5. Using external command's output in configuration files
584 3.6. Using environment variables in configuration files
585 3.7. Configuring external alias files
586 3.8. Setting sort method based on mailbox name
588 3.10. Configuring header display order
589 3.11. Defining custom headers
590 3.12. Using %-expandos in save-hook
591 3.13. Embedding push in folder-hook
592 3.14. Configuring spam detection
593 3.15. Using user-defined variables for config file readability
594 3.16. Using user-defined variables for backing up other config option values
595 3.17. Deferring user-defined variable expansion to runtime
596 3.18. Using external filters in format strings
597 4.1. Matching all addresses in address lists
598 4.2. Using boolean operators in patterns
599 4.3. Specifying a default hook
600 5.1. Attachment counting
602 6.2. Managing multiple accounts
604 Chapter 1. Introduction
611 4. Mutt Online Resources
612 5. Contributing to Mutt
613 6. Typograhical Conventions
616 Mutt is a small but very powerful text-based MIME mail client. Mutt is highly
617 configurable, and is well suited to the mail power user with advanced features
618 like key bindings, keyboard macros, mail threading, regular expression searches
619 and a powerful pattern matching language for selecting groups of messages.
623 The official homepage can be found at http://www.mutt.org/.
627 To subscribe to one of the following mailing lists, send a message with the
628 word subscribe in the body to list-name-request@mutt.org.
630 * <mutt-announce-request@mutt.org> -- low traffic list for announcements
632 * <mutt-users-request@mutt.org> -- help, bug reports and feature requests
634 * <mutt-dev-request@mutt.org> -- development mailing list
638 All messages posted to mutt-announce are automatically forwarded to mutt-users,
639 so you do not need to be subscribed to both lists.
643 Mutt releases can be downloaded from ftp://ftp.mutt.org/mutt/. For a list of
644 mirror sites, please refer to http://www.mutt.org/download.html.
646 For nightly tarballs and version control access, please refer to the Mutt
649 4. Mutt Online Resources
653 The official Mutt bug tracking system can be found at http://bugs.mutt.org/
657 An (unofficial) wiki can be found at http://wiki.mutt.org/.
661 For the IRC user community, visit channel #mutt on irc.freenode.net.
665 For USENET, see the newsgroup comp.mail.mutt.
667 5. Contributing to Mutt
669 There are various ways to contribute to the Mutt project.
671 Especially for new users it may be helpful to meet other new and experienced
672 users to chat about Mutt, talk about problems and share tricks.
674 Since translations of Mutt into other languages are highly appreciated, the
675 Mutt developers always look for skilled translators that help improve and
676 continue to maintain stale translations.
678 For contributing code patches for new features and bug fixes, please refer to
679 the developer pages at http://dev.mutt.org/ for more details.
681 6. Typograhical Conventions
683 This section lists typographical conventions followed throughout this manual.
684 See table Table 1.1, ?Typographical conventions for special terms? for
685 typographical conventions for special terms.
687 Table 1.1. Typographical conventions for special terms
689 +------------------------------------------------------+
690 | Item | Refers to... |
691 |--------------+---------------------------------------|
692 |printf(3) |UNIX manual pages, execute man 3 printf|
693 |--------------+---------------------------------------|
694 |<PageUp> |named keys |
695 |--------------+---------------------------------------|
696 |<create-alias>|named Mutt function |
697 |--------------+---------------------------------------|
698 |^G |Control+G key combination |
699 |--------------+---------------------------------------|
700 |$mail_check |Mutt configuration option |
701 |--------------+---------------------------------------|
702 |$HOME |environment variable |
703 +------------------------------------------------------+
706 Examples are presented as:
710 Within command synopsis, curly brackets (?{}?) denote a set of options of which
711 one is mandatory, square brackets (?[]?) denote optional arguments, three dots
712 denote that the argument may be repeated arbitrary times.
716 Mutt is Copyright ? 1996-2009 Michael R. Elkins <me@mutt.org> and others.
718 This program is free software; you can redistribute it and/or modify it under
719 the terms of the GNU General Public License as published by the Free Software
720 Foundation; either version 2 of the License, or (at your option) any later
723 This program is distributed in the hope that it will be useful, but WITHOUT ANY
724 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
725 PARTICULAR PURPOSE. See the GNU General Public License for more details.
727 You should have received a copy of the GNU General Public License along with
728 this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
729 Street, Fifth Floor, Boston, MA 02110-1301, USA.
731 Chapter 2. Getting Started
746 3. Moving Around in Menus
747 4. Editing Input Fields
754 5.1. The Message Index
757 5.4. Miscellaneous Functions
762 6.2. Editing the Message Header
763 6.3. Sending Cryptographically Signed/Encrypted Messages
764 6.4. Sending Format=Flowed Messages
766 7. Forwarding and Bouncing Mail
769 This section is intended as a brief overview of how to use Mutt. There are many
770 other features which are described elsewhere in the manual. There is even more
771 information available in the Mutt FAQ and various web pages. See the Mutt
772 homepage for more details.
774 The keybindings described in this section are the defaults as distributed. Your
775 local system administrator may have altered the defaults for your site. You can
776 always type ??? in any menu to display the current bindings.
778 The first thing you need to do is invoke Mutt, simply by typing mutt at the
779 command line. There are various command-line options, see either the Mutt man
780 page or the reference.
784 Mutt is a text-based application which interacts with users through different
785 menus which are mostly line-/entry-based or page-based. A line-based menu is
786 the so-called ?index? menu (listing all messages of the currently opened
787 folder) or the ?alias? menu (allowing you to select recipients from a list).
788 Examples for page-based menus are the ?pager? (showing one message at a time)
789 or the ?help? menu listing all available key bindings.
791 The user interface consists of a context sensitive help line at the top, the
792 menu's contents followed by a context sensitive status line and finally the
793 command line. The command line is used to display informational and error
794 messages as well as for prompts and for entering interactive commands.
796 Mutt is configured through variables which, if the user wants to permanently
797 use a non-default value, are written to configuration files. Mutt supports a
798 rich config file syntax to make even complex configuration files readable and
801 Because Mutt allows for customizing almost all key bindings, there are
802 so-called ?functions? which can be executed manually (using the command line)
803 or in macros. Macros allow the user to bind a sequence of commands to a single
804 key or a short key sequence instead of repeating a sequence of actions over and
807 Many commands (such as saving or copying a message to another folder) can be
808 applied to a single message or a set of messages (so-called ?tagged? messages).
809 To help selecting messages, Mutt provides a rich set of message patterns (such
810 as recipients, sender, body contents, date sent/received, etc.) which can be
811 combined into complex expressions using the boolean and and or operations as
812 well as negating. These patterns can also be used to (for example) search for
813 messages or to limit the index to show only matching messages.
815 Mutt supports a ?hook? concept which allows the user to execute arbitrary
816 configuration commands and functions in certain situations such as entering a
817 folder, starting a new message or replying to an existing one. These hooks can
818 be used to highly customize Mutt's behaviour including managing multiple
819 identities, customizing the display for a folder or even implementing
820 auto-archiving based on a per-folder basis and much more.
822 Besides an interactive mode, Mutt can also be used as a command-line tool only
823 send messages. It also supports a mailx(1)-compatible interface, see Table 9.1,
824 ?Command line options? for a complete list of command-line options.
830 The index is the screen that you usually see first when you start Mutt. It
831 gives an overview over your emails in the currently opened mailbox. By default,
832 this is your system mailbox. The information you see in the index is a list of
833 emails, each with its number on the left, its flags (new email, important
834 email, email that has been forwarded or replied to, tagged email, ...), the
835 date when email was sent, its sender, the email size, and the subject.
836 Additionally, the index also shows thread hierarchies: when you reply to an
837 email, and the other person replies back, you can see the other's person email
838 in a "sub-tree" below. This is especially useful for personal email between a
839 group of people or when you've subscribed to mailing lists.
843 The pager is responsible for showing the email content. On the top of the pager
844 you have an overview over the most important email headers like the sender, the
845 recipient, the subject, and much more information. How much information you
846 actually see depends on your configuration, which we'll describe below.
848 Below the headers, you see the email body which usually contains the message.
849 If the email contains any attachments, you will see more information about them
850 below the email body, or, if the attachments are text files, you can view them
851 directly in the pager.
853 To give the user a good overview, it is possible to configure Mutt to show
854 different things in the pager with different colors. Virtually everything that
855 can be described with a regular expression can be colored, e.g. URLs, email
856 addresses or smileys.
860 The file browser is the interface to the local or remote file system. When
861 selecting a mailbox to open, the browser allows custom sorting of items,
862 limiting the items shown by a regular expression and a freely adjustable format
863 of what to display in which way. It also allows for easy navigation through the
864 file system when selecting file(s) to attach to a message, select multiple
865 files to attach and many more.
869 The help screen is meant to offer a quick help to the user. It lists the
870 current configuration of key bindings and their associated commands including a
871 short description, and currently unbound functions that still need to be
872 associated with a key binding (or alternatively, they can be called via the
873 Mutt command prompt).
877 The compose menu features a split screen containing the information which
878 really matter before actually sending a message by mail: who gets the message
879 as what (recipients and who gets what kind of copy). Additionally, users may
880 set security options like deciding whether to sign, encrypt or sign and encrypt
881 a message with/for what keys. Also, it's used to attach messages, to re-edit
882 any attachment including the message itself.
886 The alias menu is used to help users finding the recipients of messages. For
887 users who need to contact many people, there's no need to remember addresses or
888 names completely because it allows for searching, too. The alias mechanism and
889 thus the alias menu also features grouping several addresses by a shorter
890 nickname, the actual alias, so that users don't have to select each single
895 As will be later discussed in detail, Mutt features a good and stable MIME
896 implementation, that is, it supports sending and receiving messages of
897 arbitrary MIME types. The attachment menu displays a message's structure in
898 detail: what content parts are attached to which parent part (which gives a
899 true tree structure), which type is of what type and what size. Single parts
900 may saved, deleted or modified to offer great and easy access to message's
903 3. Moving Around in Menus
905 The most important navigation keys common to line- or entry-based menus are
906 shown in Table 2.1, ?Most common navigation keys in entry-based menus? and in
907 Table 2.2, ?Most common navigation keys in page-based menus? for page-based
910 Table 2.1. Most common navigation keys in entry-based menus
912 +------------------------------------------------------------------------+
913 | Key | Function | Description |
914 |-------------+----------------+-----------------------------------------|
915 |j or <Down> |<next-entry> |move to the next entry |
916 |-------------+----------------+-----------------------------------------|
917 |k or <Up> |<previous-entry>|move to the previous entry |
918 |-------------+----------------+-----------------------------------------|
919 |z or <PageDn>|<page-down> |go to the next page |
920 |-------------+----------------+-----------------------------------------|
921 |Z or <PageUp>|<page-up> |go to the previous page |
922 |-------------+----------------+-----------------------------------------|
923 |= or <Home> |<first-entry> |jump to the first entry |
924 |-------------+----------------+-----------------------------------------|
925 |* or <End> |<last-entry> |jump to the last entry |
926 |-------------+----------------+-----------------------------------------|
927 |q |<quit> |exit the current menu |
928 |-------------+----------------+-----------------------------------------|
929 |? |<help> |list all keybindings for the current menu|
930 +------------------------------------------------------------------------+
933 Table 2.2. Most common navigation keys in page-based menus
935 +-------------------------------------------------------------+
936 | Key | Function | Description |
937 |----------------------+---------------+----------------------|
938 |J or <Return> |<next-line> |scroll down one line |
939 |----------------------+---------------+----------------------|
940 |<Backspace> |<previous-line>|sroll up one line |
941 |----------------------+---------------+----------------------|
942 |K, <Space> or <PageDn>|<next-page> |move to the next page |
943 |----------------------+---------------+----------------------|
944 |- or <PageUp> |<previous-page>|move the previous page|
945 |----------------------+---------------+----------------------|
946 |<Home> |<top> |move to the top |
947 |----------------------+---------------+----------------------|
948 |<End> |<bottom> |move to the bottom |
949 +-------------------------------------------------------------+
952 4. Editing Input Fields
956 Mutt has a built-in line editor for inputting text, e.g. email addresses or
957 filenames. The keys used to manipulate text input are very similar to those of
958 Emacs. See Table 2.3, ?Most common line editor keys? for a full reference of
959 available functions, their default key bindings, and short descriptions.
961 Table 2.3. Most common line editor keys
963 +---------------------------------------------------------------------+
964 | Key | Function | Description |
965 |--------------+-----------------+------------------------------------|
966 |^A or <Home> |<bol> |move to the start of the line |
967 |--------------+-----------------+------------------------------------|
968 |^B or <Left> |<backward-char> |move back one char |
969 |--------------+-----------------+------------------------------------|
970 |Esc B |<backward-word> |move back one word |
971 |--------------+-----------------+------------------------------------|
972 |^D or <Delete>|<delete-char> |delete the char under the cursor |
973 |--------------+-----------------+------------------------------------|
974 |^E or <End> |<eol> |move to the end of the line |
975 |--------------+-----------------+------------------------------------|
976 |^F or <Right> |<forward-char> |move forward one char |
977 |--------------+-----------------+------------------------------------|
978 |Esc F |<forward-word> |move forward one word |
979 |--------------+-----------------+------------------------------------|
980 |<Tab> |<complete> |complete filename or alias |
981 |--------------+-----------------+------------------------------------|
982 |^T |<complete-query> |complete address with query |
983 |--------------+-----------------+------------------------------------|
984 |^K |<kill-eol> |delete to the end of the line |
985 |--------------+-----------------+------------------------------------|
986 |Esc d |<kill-eow> |delete to the end of the word |
987 |--------------+-----------------+------------------------------------|
988 |^W |<kill-word> |kill the word in front of the cursor|
989 |--------------+-----------------+------------------------------------|
990 |^U |<kill-line> |delete entire line |
991 |--------------+-----------------+------------------------------------|
992 |^V |<quote-char> |quote the next typed key |
993 |--------------+-----------------+------------------------------------|
994 |<Up> |<history-up> |recall previous string from history |
995 |--------------+-----------------+------------------------------------|
996 |<Down> |<history-down> |recall next string from history |
997 |--------------+-----------------+------------------------------------|
998 |<BackSpace> |<backspace> |kill the char in front of the cursor|
999 |--------------+-----------------+------------------------------------|
1000 |Esc u |<upcase-word> |convert word to upper case |
1001 |--------------+-----------------+------------------------------------|
1002 |Esc l |<downcase-word> |convert word to lower case |
1003 |--------------+-----------------+------------------------------------|
1004 |Esc c |<capitalize-word>|capitalize the word |
1005 |--------------+-----------------+------------------------------------|
1007 |--------------+-----------------+------------------------------------|
1008 |<Return> |n/a |finish editing |
1009 +---------------------------------------------------------------------+
1012 You can remap the editor functions using the bind command. For example, to make
1013 the <Delete> key delete the character in front of the cursor rather than under,
1016 bind editor <delete> backspace
1020 Mutt maintains a history for the built-in editor. The number of items is
1021 controlled by the $history variable and can be made persistent using an
1022 external file specified using $history_file. You may cycle through them at an
1023 editor prompt by using the <history-up> and/or <history-down> commands. But
1024 notice that Mutt does not remember the currently entered text, it only cycles
1025 through history and wraps around at the end or beginning.
1027 Mutt maintains several distinct history lists, one for each of the following
1032 * addresses and aliases
1042 Mutt automatically filters out consecutively repeated items from the history.
1043 It also mimics the behavior of some shells by ignoring items starting with a
1044 space. The latter feature can be useful in macros to not clobber the history's
1045 valuable entries with unwanted entries.
1049 Similar to many other mail clients, there are two modes in which mail is read
1050 in Mutt. The first is a list of messages in the mailbox, which is called the
1051 ?index? menu in Mutt. The second mode is the display of the message contents.
1052 This is called the ?pager.?
1054 The next few sections describe the functions provided in each of these modes.
1056 5.1. The Message Index
1058 Common keys used to navigate through and manage messages in the index are shown
1059 in Table 2.4, ?Most common message index keys?. How messages are presented in
1060 the index menu can be customized using the $index_format variable.
1062 Table 2.4. Most common message index keys
1064 +----------------------------------------------------+
1065 | Key | Description |
1066 |--------+-------------------------------------------|
1067 |c |change to a different mailbox |
1068 |--------+-------------------------------------------|
1069 |Esc c |change to a folder in read-only mode |
1070 |--------+-------------------------------------------|
1071 |C |copy the current message to another mailbox|
1072 |--------+-------------------------------------------|
1073 |Esc C |decode a message and copy it to a folder |
1074 |--------+-------------------------------------------|
1075 |Esc s |decode a message and save it to a folder |
1076 |--------+-------------------------------------------|
1077 |D |delete messages matching a pattern |
1078 |--------+-------------------------------------------|
1079 |d |delete the current message |
1080 |--------+-------------------------------------------|
1081 |F |mark as important |
1082 |--------+-------------------------------------------|
1083 |l |show messages matching a pattern |
1084 |--------+-------------------------------------------|
1085 |N |mark message as new |
1086 |--------+-------------------------------------------|
1087 |o |change the current sort method |
1088 |--------+-------------------------------------------|
1089 |O |reverse sort the mailbox |
1090 |--------+-------------------------------------------|
1091 |q |save changes and exit |
1092 |--------+-------------------------------------------|
1094 |--------+-------------------------------------------|
1095 |T |tag messages matching a pattern |
1096 |--------+-------------------------------------------|
1097 |t |toggle the tag on a message |
1098 |--------+-------------------------------------------|
1099 |Esc t |toggle tag on entire message thread |
1100 |--------+-------------------------------------------|
1101 |U |undelete messages matching a pattern |
1102 |--------+-------------------------------------------|
1103 |u |undelete-message |
1104 |--------+-------------------------------------------|
1105 |v |view-attachments |
1106 |--------+-------------------------------------------|
1107 |x |abort changes and exit |
1108 |--------+-------------------------------------------|
1109 |<Return>|display-message |
1110 |--------+-------------------------------------------|
1111 |<Tab> |jump to the next new or unread message |
1112 |--------+-------------------------------------------|
1113 |@ |show the author's full e-mail address |
1114 |--------+-------------------------------------------|
1115 |$ |save changes to mailbox |
1116 |--------+-------------------------------------------|
1118 |--------+-------------------------------------------|
1119 |Esc / |search-reverse |
1120 |--------+-------------------------------------------|
1121 |^L |clear and redraw the screen |
1122 |--------+-------------------------------------------|
1123 |^T |untag messages matching a pattern |
1124 +----------------------------------------------------+
1127 In addition to who sent the message and the subject, a short summary of the
1128 disposition of each message is printed beside the message number. Zero or more
1129 of the ?flags? in Table 2.5, ?Message status flags? may appear, some of which
1130 can be turned on or off using these functions: <set-flag> and <clear-flag>
1131 bound by default to ?w? and ?W? respectively.
1133 Furthermore, the flags in Table 2.6, ?Message recipient flags? reflect who the
1134 message is addressed to. They can be customized with the $to_chars variable.
1136 Table 2.5. Message status flags
1138 +------------------------------------------------------------------+
1139 |Flag| Description |
1140 |----+-------------------------------------------------------------|
1141 |D |message is deleted (is marked for deletion) |
1142 |----+-------------------------------------------------------------|
1143 |d |message has attachments marked for deletion |
1144 |----+-------------------------------------------------------------|
1145 |K |contains a PGP public key |
1146 |----+-------------------------------------------------------------|
1147 |N |message is new |
1148 |----+-------------------------------------------------------------|
1149 |O |message is old |
1150 |----+-------------------------------------------------------------|
1151 |P |message is PGP encrypted |
1152 |----+-------------------------------------------------------------|
1153 |r |message has been replied to |
1154 |----+-------------------------------------------------------------|
1155 |S |message is signed, and the signature is successfully verified|
1156 |----+-------------------------------------------------------------|
1157 |s |message is signed |
1158 |----+-------------------------------------------------------------|
1159 |! |message is flagged |
1160 |----+-------------------------------------------------------------|
1161 |* |message is tagged |
1162 +------------------------------------------------------------------+
1165 Table 2.6. Message recipient flags
1167 +------------------------------------------------------+
1168 |Flag| Description |
1169 |----+-------------------------------------------------|
1170 |+ |message is to you and you only |
1171 |----+-------------------------------------------------|
1172 |T |message is to you, but also to or cc'ed to others|
1173 |----+-------------------------------------------------|
1174 |C |message is cc'ed to you |
1175 |----+-------------------------------------------------|
1176 |F |message is from you |
1177 |----+-------------------------------------------------|
1178 |L |message is sent to a subscribed mailing list |
1179 +------------------------------------------------------+
1184 By default, Mutt uses its builtin pager to display the contents of messages (an
1185 external pager such as less(1) can be configured, see $pager variable). The
1186 pager is very similar to the Unix program less(1) though not nearly as
1189 Table 2.7. Most common pager keys
1191 +---------------------------------------------------------------------------+
1192 | Key | Description |
1193 |--------+------------------------------------------------------------------|
1194 |<Return>|go down one line |
1195 |--------+------------------------------------------------------------------|
1196 |<Space> |display the next page (or next message if at the end of a message)|
1197 |--------+------------------------------------------------------------------|
1198 |- |go back to the previous page |
1199 |--------+------------------------------------------------------------------|
1200 |n |search for next match |
1201 |--------+------------------------------------------------------------------|
1202 |S |skip beyond quoted text |
1203 |--------+------------------------------------------------------------------|
1204 |T |toggle display of quoted text |
1205 |--------+------------------------------------------------------------------|
1206 |? |show keybindings |
1207 |--------+------------------------------------------------------------------|
1208 |/ |regular expression search |
1209 |--------+------------------------------------------------------------------|
1210 |Esc / |backward regular expression search |
1211 |--------+------------------------------------------------------------------|
1212 |\ |toggle highlighting of search matches |
1213 |--------+------------------------------------------------------------------|
1214 |^ |jump to the top of the message |
1215 +---------------------------------------------------------------------------+
1218 In addition to key bindings in Table 2.7, ?Most common pager keys?, many of the
1219 functions from the index menu are also available in the pager, such as
1220 <delete-message> or <copy-message> (this is one advantage over using an
1221 external pager to view messages).
1223 Also, the internal pager supports a couple other advanced features. For one, it
1224 will accept and translate the ?standard? nroff sequences for bold and
1225 underline. These sequences are a series of either the letter, backspace (?^H?),
1226 the letter again for bold or the letter, backspace, ?_? for denoting underline.
1227 Mutt will attempt to display these in bold and underline respectively if your
1228 terminal supports them. If not, you can use the bold and underline color
1229 objects to specify a color or mono attribute for them.
1231 Additionally, the internal pager supports the ANSI escape sequences for
1232 character attributes. Mutt translates them into the correct color and character
1233 settings. The sequences Mutt supports are:
1237 where Ps can be one of the codes shown in Table 2.8, ?ANSI escape sequences?.
1239 Table 2.8. ANSI escape sequences
1241 +--------------------------------------------------------------------------+
1242 |Escape code| Description |
1243 |-----------+--------------------------------------------------------------|
1244 |0 |All attributes off |
1245 |-----------+--------------------------------------------------------------|
1247 |-----------+--------------------------------------------------------------|
1249 |-----------+--------------------------------------------------------------|
1251 |-----------+--------------------------------------------------------------|
1252 |7 |Reverse video on |
1253 |-----------+--------------------------------------------------------------|
1254 |3<color> |Foreground color is <color> (see Table 2.9, ?Color sequences?)|
1255 |-----------+--------------------------------------------------------------|
1256 |4<color> |Background color is <color> (see Table 2.9, ?Color sequences?)|
1257 +--------------------------------------------------------------------------+
1260 Table 2.9. Color sequences
1262 +-------------------+
1263 |Color code | Color |
1264 |-----------+-------|
1266 |-----------+-------|
1268 |-----------+-------|
1270 |-----------+-------|
1272 |-----------+-------|
1274 |-----------+-------|
1276 |-----------+-------|
1278 |-----------+-------|
1280 +-------------------+
1283 Mutt uses these attributes for handling text/enriched messages, and they can
1284 also be used by an external autoview script for highlighting purposes.
1288 If you change the colors for your display, for example by changing the color
1289 associated with color2 for your xterm, then that color will be used instead of
1294 Note that the search commands in the pager take regular expressions, which are
1295 not quite the same as the more complex patterns used by the search command in
1296 the index. This is because patterns are used to select messages by criteria
1297 whereas the pager already displays a selected message.
1301 So-called ?threads? provide a hierarchy of messages where replies are linked to
1302 their parent message(s). This organizational form is extremely useful in
1303 mailing lists where different parts of the discussion diverge. Mutt displays
1304 threads as a tree structure.
1306 In Mutt, when a mailbox is sorted by threads, there are a few additional
1307 functions available in the index and pager modes as shown in Table 2.10, ?Most
1308 common thread mode keys?.
1310 Table 2.10. Most common thread mode keys
1312 +-------------------------------------------------------------------------+
1313 | Key | Function | Description |
1314 |-----+--------------------+----------------------------------------------|
1315 |^D |<delete-thread> |delete all messages in the current thread |
1316 |-----+--------------------+----------------------------------------------|
1317 |^U |<undelete-thread> |undelete all messages in the current thread |
1318 |-----+--------------------+----------------------------------------------|
1319 |^N |<next-thread> |jump to the start of the next thread |
1320 |-----+--------------------+----------------------------------------------|
1321 |^P |<previous-thread> |jump to the start of the previous thread |
1322 |-----+--------------------+----------------------------------------------|
1323 |^R |<read-thread> |mark the current thread as read |
1324 |-----+--------------------+----------------------------------------------|
1325 |Esc d|<delete-subthread> |delete all messages in the current subthread |
1326 |-----+--------------------+----------------------------------------------|
1327 |Esc u|<undelete-subthread>|undelete all messages in the current subthread|
1328 |-----+--------------------+----------------------------------------------|
1329 |Esc n|<next-subthread> |jump to the start of the next subthread |
1330 |-----+--------------------+----------------------------------------------|
1331 |Esc p|<previous-subthread>|jump to the start of the previous subthread |
1332 |-----+--------------------+----------------------------------------------|
1333 |Esc r|<read-subthread> |mark the current subthread as read |
1334 |-----+--------------------+----------------------------------------------|
1335 |Esc t|<tag-thread> |toggle the tag on the current thread |
1336 |-----+--------------------+----------------------------------------------|
1337 |Esc v|<collapse-thread> |toggle collapse for the current thread |
1338 |-----+--------------------+----------------------------------------------|
1339 |Esc V|<collapse-all> |toggle collapse for all threads |
1340 |-----+--------------------+----------------------------------------------|
1341 |P |<parent-message> |jump to parent message in thread |
1342 +-------------------------------------------------------------------------+
1345 Collapsing a thread displays only the first message in the thread and hides the
1346 others. This is useful when threads contain so many messages that you can only
1347 see a handful of threads on the screen. See %M in $index_format. For example,
1348 you could use ?%?M?(#%03M)&(%4l)?? in $index_format to optionally display the
1349 number of hidden messages if the thread is collapsed. The %?<char>?<if-part>&
1350 <else-part>? syntax is explained in detail in format string conditionals.
1352 Technically, every reply should contain a list of its parent messages in the
1353 thread tree, but not all do. In these cases, Mutt groups them by subject which
1354 can be controlled using the $strict_threads variable.
1356 5.4. Miscellaneous Functions
1358 In addition, the index and pager menus have these interesting functions:
1360 <create-alias> (default: a)
1362 Creates a new alias based upon the current message (or prompts for a new
1363 one). Once editing is complete, an alias command is added to the file
1364 specified by the $alias_file variable for future use
1368 Mutt does not read the $alias_file upon startup so you must explicitly
1371 <check-traditional-pgp> (default: Esc P)
1373 This function will search the current message for content signed or
1374 encrypted with PGP the ?traditional? way, that is, without proper MIME
1375 tagging. Technically, this function will temporarily change the MIME
1376 content types of the body parts containing PGP data; this is similar to the
1377 <edit-type> function's effect.
1381 This command (available in the index and pager) allows you to edit the raw
1382 current message as it's present in the mail folder. After you have finished
1383 editing, the changed message will be appended to the current folder, and
1384 the original message will be marked for deletion; if the message is
1385 unchanged it won't be replaced.
1387 <edit-type> (default: ^E on the attachment menu, and in the pager and index
1388 menus; ^T on the compose menu)
1390 This command is used to temporarily edit an attachment's content type to
1391 fix, for instance, bogus character set parameters. When invoked from the
1392 index or from the pager, you'll have the opportunity to edit the top-level
1393 attachment's content type. On the attachment menu, you can change any
1394 attachment's content type. These changes are not persistent, and get lost
1395 upon changing folders.
1397 Note that this command is also available on the compose menu. There, it's
1398 used to fine-tune the properties of attachments you are going to send.
1400 <enter-command> (default: ?:?)
1402 This command is used to execute any command you would normally put in a
1403 configuration file. A common use is to check the settings of variables, or
1404 in conjunction with macros to change settings on the fly.
1406 <extract-keys> (default: ^K)
1408 This command extracts PGP public keys from the current or tagged message(s)
1409 and adds them to your PGP public key ring.
1411 <forget-passphrase> (default: ^F)
1413 This command wipes the passphrase(s) from memory. It is useful, if you
1414 misspelled the passphrase.
1416 <list-reply> (default: L)
1418 Reply to the current or tagged message(s) by extracting any addresses which
1419 match the regular expressions given by the lists or subscribe commands, but
1420 also honor any Mail-Followup-To header(s) if the $honor_followup_to
1421 configuration variable is set. Using this when replying to messages posted
1422 to mailing lists helps avoid duplicate copies being sent to the author of
1423 the message you are replying to.
1425 <pipe-message> (default: |)
1427 Asks for an external Unix command and pipes the current or tagged message
1428 (s) to it. The variables $pipe_decode, $pipe_split, $pipe_sep and $wait_key
1429 control the exact behavior of this function.
1431 <resend-message> (default: Esc e)
1433 Mutt takes the current message as a template for a new message. This
1434 function is best described as "recall from arbitrary folders". It can
1435 conveniently be used to forward MIME messages while preserving the original
1436 mail structure. Note that the amount of headers included here depends on
1437 the value of the $weed variable.
1439 This function is also available from the attachment menu. You can use this
1440 to easily resend a message which was included with a bounce message as a
1441 message/rfc822 body part.
1443 <shell-escape> (default: !)
1445 Asks for an external Unix command and executes it. The $wait_key can be
1446 used to control whether Mutt will wait for a key to be pressed when the
1447 command returns (presumably to let the user read the output of the
1448 command), based on the return status of the named command. If no command is
1449 given, an interactive shell is executed.
1451 <toggle-quoted> (default: T)
1453 The pager uses the $quote_regexp variable to detect quoted text when
1454 displaying the body of the message. This function toggles the display of
1455 the quoted material in the message. It is particularly useful when being
1456 interested in just the response and there is a large amount of quoted text
1459 <skip-quoted> (default: S)
1461 This function will go to the next line of non-quoted text which comes after
1462 a line of quoted text in the internal pager.
1468 The bindings shown in Table 2.11, ?Most common mail sending keys? are available
1469 in the index and pager to start a new message.
1471 Table 2.11. Most common mail sending keys
1473 +----------------------------------------------------+
1474 | Key | Function | Description |
1475 |-----+-------------+--------------------------------|
1476 |m |<compose> |compose a new message |
1477 |-----+-------------+--------------------------------|
1478 |r |<reply> |reply to sender |
1479 |-----+-------------+--------------------------------|
1480 |g |<group-reply>|reply to all recipients |
1481 |-----+-------------+--------------------------------|
1482 |L |<list-reply> |reply to mailing list address |
1483 |-----+-------------+--------------------------------|
1484 |f |<forward> |forward message |
1485 |-----+-------------+--------------------------------|
1486 |b |<bounce> |bounce (remail) message |
1487 |-----+-------------+--------------------------------|
1488 |Esc k|<mail-key> |mail a PGP public key to someone|
1489 +----------------------------------------------------+
1492 Bouncing a message sends the message as-is to the recipient you specify.
1493 Forwarding a message allows you to add comments or modify the message you are
1494 forwarding. These items are discussed in greater detail in the next section ?
1495 Forwarding and Bouncing Mail.?
1497 Mutt will then enter the compose menu and prompt you for the recipients to
1498 place on the ?To:? header field when you hit m to start a new message. Next, it
1499 will ask you for the ?Subject:? field for the message, providing a default if
1500 you are replying to or forwarding a message. You again have the chance to
1501 adjust recipients, subject, and security settings right before actually sending
1502 the message. See also $askcc, $askbcc, $autoedit, $bounce, $fast_reply, and
1503 $include for changing how and if Mutt asks these questions.
1505 When replying, Mutt fills these fields with proper values depending on the
1506 reply type. The types of replying supported are:
1510 Reply to the author directly.
1514 Reply to the author as well to all recipients except you; this consults
1519 Reply to all mailing list addresses found, either specified via
1520 configuration or auto-detected. See Section 12, ?Mailing Lists? for
1523 After getting recipients for new messages, forwards or replies, Mutt will then
1524 automatically start your $editor on the message body. If the $edit_headers
1525 variable is set, the headers will be at the top of the message in your editor.
1526 Any messages you are replying to will be added in sort order to the message,
1527 with appropriate $attribution, $indent_string and $post_indent_string. When
1528 forwarding a message, if the $mime_forward variable is unset, a copy of the
1529 forwarded message will be included. If you have specified a $signature, it will
1530 be appended to the message.
1532 Once you have finished editing the body of your mail message, you are returned
1533 to the compose menu providing the functions shown in Table 2.12, ?Most common
1534 compose menu keys? to modify, send or postpone the message.
1536 Table 2.12. Most common compose menu keys
1538 +----------------------------------------------------------------------+
1539 | Key | Function | Description |
1540 |-----+-------------------+--------------------------------------------|
1541 |a |<attach-file> |attach a file |
1542 |-----+-------------------+--------------------------------------------|
1543 |A |<attach-message> |attach message(s) to the message |
1544 |-----+-------------------+--------------------------------------------|
1545 |Esc k|<attach-key> |attach a PGP public key |
1546 |-----+-------------------+--------------------------------------------|
1547 |d |<edit-description> |edit description on attachment |
1548 |-----+-------------------+--------------------------------------------|
1549 |D |<detach-file> |detach a file |
1550 |-----+-------------------+--------------------------------------------|
1551 |t |<edit-to> |edit the To field |
1552 |-----+-------------------+--------------------------------------------|
1553 |Esc f|<edit-from> |edit the From field |
1554 |-----+-------------------+--------------------------------------------|
1555 |r |<edit-reply-to> |edit the Reply-To field |
1556 |-----+-------------------+--------------------------------------------|
1557 |c |<edit-cc> |edit the Cc field |
1558 |-----+-------------------+--------------------------------------------|
1559 |b |<edit-bcc> |edit the Bcc field |
1560 |-----+-------------------+--------------------------------------------|
1561 |y |<send-message> |send the message |
1562 |-----+-------------------+--------------------------------------------|
1563 |s |<edit-subject> |edit the Subject |
1564 |-----+-------------------+--------------------------------------------|
1565 |S |<smime-menu> |select S/MIME options |
1566 |-----+-------------------+--------------------------------------------|
1567 |f |<edit-fcc> |specify an ?Fcc? mailbox |
1568 |-----+-------------------+--------------------------------------------|
1569 |p |<pgp-menu> |select PGP options |
1570 |-----+-------------------+--------------------------------------------|
1571 |P |<postpone-message> |postpone this message until later |
1572 |-----+-------------------+--------------------------------------------|
1573 |q |<quit> |quit (abort) sending the message |
1574 |-----+-------------------+--------------------------------------------|
1575 |w |<write-fcc> |write the message to a folder |
1576 |-----+-------------------+--------------------------------------------|
1577 |i |<ispell> |check spelling (if available on your system)|
1578 |-----+-------------------+--------------------------------------------|
1579 |^F |<forget-passphrase>|wipe passphrase(s) from memory |
1580 +----------------------------------------------------------------------+
1583 The compose menu is also used to edit the attachments for a message which can
1584 be either files or other messages. The <attach-message> function to will prompt
1585 you for a folder to attach messages from. You can now tag messages in that
1586 folder and they will be attached to the message you are sending.
1590 Note that certain operations like composing a new mail, replying, forwarding,
1591 etc. are not permitted when you are in that folder. The %r in $status_format
1592 will change to a ?A? to indicate that you are in attach-message mode.
1594 6.2. Editing the Message Header
1596 When editing the header because of $edit_headers being set, there are a several
1597 pseudo headers available which will not be included in sent messages but
1598 trigger special Mutt behavior.
1600 6.2.1. Fcc: Pseudo Header
1606 as a header, Mutt will pick up filename just as if you had used the <edit-fcc>
1607 function in the compose menu. It can later be changed from the compose menu.
1609 6.2.2. Attach: Pseudo Header
1611 You can also attach files to your message by specifying
1613 Attach: filename [ description ]
1615 where filename is the file to attach and description is an optional string to
1616 use as the description of the attached file. Spaces in filenames have to be
1617 escaped using backslash (?\?). The file can be removed as well as more added
1618 from the compose menu.
1620 6.2.3. Pgp: Pseudo Header
1622 If you want to use PGP, you can specify
1624 Pgp: [ E | S | S<id> ]
1626 ?E? selects encryption, ?S? selects signing and ?S<id>? selects signing with
1627 the given key, setting $pgp_sign_as permanently. The selection can later be
1628 changed in the compose menu.
1630 6.2.4. In-Reply-To: Header
1632 When replying to messages, the In-Reply-To: header contains the Message-Id of
1633 the message(s) you reply to. If you remove or modify its value, Mutt will not
1634 generate a References: field, which allows you to create a new message thread,
1635 for example to create a new message to a mailing list without having to enter
1636 the mailing list's address.
1638 6.3. Sending Cryptographically Signed/Encrypted Messages
1640 If you have told Mutt to PGP or S/MIME encrypt a message, it will guide you
1641 through a key selection process when you try to send the message. Mutt will not
1642 ask you any questions about keys which have a certified user ID matching one of
1643 the message recipients' mail addresses. However, there may be situations in
1644 which there are several keys, weakly certified user ID fields, or where no
1645 matching keys can be found.
1647 In these cases, you are dropped into a menu with a list of keys from which you
1648 can select one. When you quit this menu, or Mutt can't find any matching keys,
1649 you are prompted for a user ID. You can, as usually, abort this prompt using ^
1650 G. When you do so, Mutt will return to the compose screen.
1652 Once you have successfully finished the key selection, the message will be
1653 encrypted using the selected public keys when sent out.
1655 Most fields of the entries in the key selection menu (see also
1656 $pgp_entry_format) have obvious meanings. But some explanations on the
1657 capabilities, flags, and validity fields are in order.
1659 The flags sequence (?%f?) will expand to one of the flags in Table 2.13, ?PGP
1662 Table 2.13. PGP key menu flags
1664 +-------------------------------------------------------+
1665 |Flag| Description |
1666 |----+--------------------------------------------------|
1667 |R |The key has been revoked and can't be used. |
1668 |----+--------------------------------------------------|
1669 |X |The key is expired and can't be used. |
1670 |----+--------------------------------------------------|
1671 |d |You have marked the key as disabled. |
1672 |----+--------------------------------------------------|
1673 |c |There are unknown critical self-signature packets.|
1674 +-------------------------------------------------------+
1677 The capabilities field (?%c?) expands to a two-character sequence representing
1678 a key's capabilities. The first character gives the key's encryption
1679 capabilities: A minus sign (?-?) means that the key cannot be used for
1680 encryption. A dot (?.?) means that it's marked as a signature key in one of the
1681 user IDs, but may also be used for encryption. The letter ?e? indicates that
1682 this key can be used for encryption.
1684 The second character indicates the key's signing capabilities. Once again, a
1685 ?-? implies ?not for signing?, ?.? implies that the key is marked as an
1686 encryption key in one of the user-ids, and ?s? denotes a key which can be used
1689 Finally, the validity field (?%t?) indicates how well-certified a user-id is. A
1690 question mark (???) indicates undefined validity, a minus character (?-?) marks
1691 an untrusted association, a space character means a partially trusted
1692 association, and a plus character (?+?) indicates complete validity.
1694 6.4. Sending Format=Flowed Messages
1698 format=flowed-style messages (or f=f for short) are text/plain messages that
1699 consist of paragraphs which a receiver's mail client may reformat to its own
1700 needs which mostly means to customize line lengths regardless of what the
1701 sender sent. Technically this is achieved by letting lines of a ?flowable?
1702 paragraph end in spaces except for the last line.
1704 While for text-mode clients like Mutt it's the best way to assume only a
1705 standard 80x25 character cell terminal, it may be desired to let the receiver
1706 decide completely how to view a message.
1710 Mutt only supports setting the required format=flowed MIME parameter on
1711 outgoing messages if the $text_flowed variable is set, specifically it does not
1712 add the trailing spaces.
1714 After editing the initial message text and before entering the compose menu,
1715 Mutt properly space-stuffes the message. Space-stuffing is required by RfC3676
1716 defining format=flowed and means to prepend a space to:
1718 * all lines starting with a space
1720 * lines starting with the word ?From? followed by space
1722 * all lines starting with ?>? which is not intended to be a quote character
1726 Mutt only supports space-stuffing for the first two types of lines but not for
1727 the third: It is impossible to safely detect whether a leading > character
1728 starts a quote or not. Furthermore, Mutt only applies space-stuffing once after
1729 the initial edit is finished.
1731 All leading spaces are to be removed by receiving clients to restore the
1732 original message prior to further processing.
1734 6.4.3. Editor Considerations
1736 As Mutt provides no additional features to compose f=f messages, it's
1737 completely up to the user and his editor to produce proper messages. Please
1738 consider your editor's documentation if you intend to send f=f messages.
1740 Please note that when editing messages from the compose menu several times
1741 before really sending a mail, it's up to the user to ensure that the message is
1742 properly space-stuffed.
1744 For example, vim provides the w flag for its formatoptions setting to assist in
1745 creating f=f messages, see :help fo-table for details.
1747 7. Forwarding and Bouncing Mail
1749 Bouncing and forwarding let you send an existing message to recipients that you
1750 specify. Bouncing a message sends a verbatim copy of a message to alternative
1751 addresses as if they were the message's original recipients specified in the
1752 Bcc header. Forwarding a message, on the other hand, allows you to modify the
1753 message before it is resent (for example, by adding your own comments).
1754 Bouncing is done using the <bounce> function and forwarding using the <forward>
1755 function bound to ?b? and ?f? respectively.
1757 Forwarding can be done by including the original message in the new message's
1758 body (surrounded by indicating lines) or including it as a MIME attachment,
1759 depending on the value of the $mime_forward variable. Decoding of attachments,
1760 like in the pager, can be controlled by the $forward_decode and
1761 $mime_forward_decode variables, respectively. The desired forwarding format may
1762 depend on the content, therefore $mime_forward is a quadoption which, for
1763 example, can be set to ?ask-no?.
1765 The inclusion of headers is controlled by the current setting of the $weed
1766 variable, unless $mime_forward is set.
1768 Editing the message to forward follows the same procedure as sending or
1769 replying to a message does.
1773 At times it is desirable to delay sending a message that you have already begun
1774 to compose. When the <postpone-message> function is used in the compose menu,
1775 the body of your message and attachments are stored in the mailbox specified by
1776 the $postponed variable. This means that you can recall the message even if you
1777 exit Mutt and then restart it at a later time.
1779 Once a message is postponed, there are several ways to resume it. From the
1780 command line you can use the ?-p? option, or if you compose a new message from
1781 the index or pager you will be prompted if postponed messages exist. If
1782 multiple messages are currently postponed, the postponed menu will pop up and
1783 you can select which message you would like to resume.
1787 If you postpone a reply to a message, the reply setting of the message is only
1788 updated when you actually finish the message and send it. Also, you must be in
1789 the same folder with the message you replied to for the status of the message
1792 See also the $postpone quad-option.
1794 Chapter 3. Configuration
1798 1. Location of Initialization Files
1799 2. Syntax of Initialization Files
1801 4. Defining/Using Aliases
1802 5. Changing the Default Key Bindings
1803 6. Defining Aliases for Character Sets
1804 7. Setting Variables Based Upon Mailbox
1806 9. Using Color and Mono Video Attributes
1807 10. Message Header Display
1809 10.1. Selecting Headers
1810 10.2. Ordering Displayed Headers
1812 11. Alternative Addresses
1814 13. Using Multiple Spool Mailboxes
1815 14. Monitoring Incoming Mail
1816 15. User-Defined Headers
1817 16. Specify Default Save Mailbox
1818 17. Specify Default Fcc: Mailbox When Composing
1819 18. Specify Default Save Filename and Default Fcc: Mailbox at Once
1820 19. Change Settings Based Upon Message Recipients
1821 20. Change Settings Before Formatting a Message
1822 21. Choosing the Cryptographic Key of the Recipient
1823 22. Adding Key Sequences to the Keyboard Buffer
1824 23. Executing Functions
1827 26. Setting and Querying Variables
1829 26.1. Variable Types
1831 26.3. User-Defined Variables
1833 27. Reading Initialization Commands From Another File
1842 1. Location of Initialization Files
1844 While the default configuration (or ?preferences?) make Mutt usable right out
1845 of the box, it is often desirable to tailor Mutt to suit your own tastes. When
1846 Mutt is first invoked, it will attempt to read the ?system? configuration file
1847 (defaults set by your local system administrator), unless the ?-n? command line
1848 option is specified. This file is typically /usr/local/share/mutt/Muttrc or /
1849 etc/Muttrc. Mutt will next look for a file named .muttrc in your home
1850 directory. If this file does not exist and your home directory has a
1851 subdirectory named .mutt, Mutt tries to load a file named .mutt/muttrc.
1853 .muttrc is the file where you will usually place your commands to configure
1856 In addition, Mutt supports version specific configuration files that are parsed
1857 instead of the default files as explained above. For instance, if your system
1858 has a Muttrc-0.88 file in the system configuration directory, and you are
1859 running version 0.88 of Mutt, this file will be sourced instead of the Muttrc
1860 file. The same is true of the user configuration file, if you have a file
1861 .muttrc-0.88.6 in your home directory, when you run Mutt version 0.88.6, it
1862 will source this file instead of the default .muttrc file. The version number
1863 is the same which is visible using the ?-v? command line switch or using the
1864 show-version key (default: V) from the index menu.
1866 2. Syntax of Initialization Files
1868 An initialization file consists of a series of commands. Each line of the file
1869 may contain one or more commands. When multiple commands are used, they must be
1870 separated by a semicolon (?;?).
1872 Example 3.1. Multiple configuration commands per line
1874 set realname='Mutt user' ; ignore x-
1877 The hash mark, or pound sign (?#?), is used as a ?comment? character. You can
1878 use it to annotate your initialization file. All text after the comment
1879 character to the end of the line is ignored.
1881 Example 3.2. Commenting configuration files
1883 my_hdr X-Disclaimer: Why are you listening to me? # This is a comment
1886 Single quotes (?'?) and double quotes (?"?) can be used to quote strings which
1887 contain spaces or other special characters. The difference between the two
1888 types of quotes is similar to that of many popular shell programs, namely that
1889 a single quote is used to specify a literal string (one that is not interpreted
1890 for shell variables or quoting with a backslash [see next paragraph]), while
1891 double quotes indicate a string for which should be evaluated. For example,
1892 backticks are evaluated inside of double quotes, but not for single quotes.
1894 ?\? quotes the next character, just as in shells such as bash and zsh. For
1895 example, if want to put quotes ?"? inside of a string, you can use ?\? to force
1896 the next character to be a literal instead of interpreted character.
1898 Example 3.3. Escaping quotes in congfiguration files
1900 set realname="Michael \"MuttDude\" Elkins"
1903 ?\\? means to insert a literal ?\? into the line. ?\n? and ?\r? have their
1904 usual C meanings of linefeed and carriage-return, respectively.
1906 A ?\? at the end of a line can be used to split commands over multiple lines as
1907 it ?escapes? the line end, provided that the split points don't appear in the
1908 middle of command names. Lines are first concatenated before interpretation so
1909 that a multi-line can be commented by commenting out the first line only.
1911 Example 3.4. Splitting long configuration commands over several lines
1913 set status_format="some very \
1918 It is also possible to substitute the output of a Unix command in an
1919 initialization file. This is accomplished by enclosing the command in backticks
1920 (``). In Example 3.5, ?Using external command's output in configuration files?,
1921 the output of the Unix command ?uname -a? will be substituted before the line
1922 is parsed. Since initialization files are line oriented, only the first line of
1923 output from the Unix command will be substituted.
1925 Example 3.5. Using external command's output in configuration files
1927 my_hdr X-Operating-System: `uname -a`
1930 Both environment variables and Mutt variables can be accessed by prepending ?$?
1931 to the name of the variable. For example,
1933 Example 3.6. Using environment variables in configuration files
1935 set record=+sent_on_$HOSTNAME
1938 will cause Mutt to save outgoing messages to a folder named ?sent_on_kremvax?
1939 if the environment variable $HOSTNAME is set to ?kremvax.? (See $record for
1942 Mutt expands the variable when it is assigned, not when it is used. If the
1943 value of a variable on the right-hand side of an assignment changes after the
1944 assignment, the variable on the left-hand side will not be affected.
1946 The commands understood by Mutt are explained in the next paragraphs. For a
1947 complete list, see the command reference.
1949 All configuration files are expected to be in the current locale as specified
1950 by the $charset variable which doesn't have a default value since it's
1951 determined by Mutt at startup. If a configuration file is not encoded in the
1952 same character set the $config_charset variable should be used: all lines
1953 starting with the next are recoded from $config_charset to $charset.
1955 This mechanism should be avoided if possible as it has the following
1958 * These variables should be set early in a configuration file with $charset
1959 preceding $config_charset so Mutt knows what character set to convert to.
1961 * If $config_charset is set, it should be set in each configuration file
1962 because the value is global and not per configuration file.
1964 * Because Mutt first recodes a line before it attempts to parse it, a
1965 conversion introducing question marks or other characters as part of errors
1966 (unconvertable characters, transliteration) may introduce syntax errors or
1967 silently change the meaning of certain tokens (e.g. inserting question
1968 marks into regular expressions).
1974 group [ -group name ...] { -rx expr ... | -addr expr ... }
1975 ungroup [ -group name ...] { * | -rx expr ... | -addr expr ... }
1977 group is used to directly add either addresses or regular expressions to the
1978 specified group or groups. The different categories of arguments to the group
1979 command can be in any order. The flags -rx and -addr specify what the following
1980 strings (that cannot begin with a hyphen) should be interpreted as: either a
1981 regular expression or an email address, respectively.
1983 These address groups can also be created implicitly by the alias, lists,
1984 subscribe and alternates commands by specifying the optional -group option.
1986 Once defined, these address groups can be used in patterns to search for and
1987 limit the display to messages matching a group.
1989 ungroup is used to remove addresses or regular expressions from the specified
1990 group or groups. The syntax is similar to the group command, however the
1991 special character * can be used to empty a group of all of its contents.
1993 4. Defining/Using Aliases
1997 alias [ -group name ...] key address [ address ...]
1998 unalias [ -group name ...] { * | key ... }
2000 It's usually very cumbersome to remember or type out the address of someone you
2001 are communicating with. Mutt allows you to create ?aliases? which map a short
2002 string to a full address.
2006 If you want to create an alias for more than one address, you must separate the
2007 addresses with a comma (?,?).
2009 The optional -group argument to alias causes the aliased address(es) to be
2010 added to the named group.
2012 To remove an alias or aliases (?*? means all aliases):
2014 alias muttdude me@cs.hmc.edu (Michael Elkins)
2015 alias theguys manny, moe, jack
2017 Unlike other mailers, Mutt doesn't require aliases to be defined in a special
2018 file. The alias command can appear anywhere in a configuration file, as long as
2019 this file is sourced. Consequently, you can have multiple alias files, or you
2020 can have all aliases defined in your .muttrc.
2022 On the other hand, the <create-alias> function can use only one file, the one
2023 pointed to by the $alias_file variable (which is ?/.muttrc by default). This
2024 file is not special either, in the sense that Mutt will happily append aliases
2025 to any file, but in order for the new aliases to take effect you need to
2026 explicitly source this file too.
2028 Example 3.7. Configuring external alias files
2030 source /usr/local/share/Mutt.aliases
2031 source ~/.mail_aliases
2032 set alias_file=~/.mail_aliases
2035 To use aliases, you merely use the alias at any place in Mutt where Mutt
2036 prompts for addresses, such as the To: or Cc: prompt. You can also enter
2037 aliases in your editor at the appropriate headers if you have the $edit_headers
2040 In addition, at the various address prompts, you can use the tab character to
2041 expand a partial alias to the full alias. If there are multiple matches, Mutt
2042 will bring up a menu with the matching aliases. In order to be presented with
2043 the full list of aliases, you must hit tab without a partial alias, such as at
2044 the beginning of the prompt or after a comma denoting multiple addresses.
2046 In the alias menu, you can select as many aliases as you want with the
2047 select-entry key (default: <Return>), and use the exit key (default: q) to
2048 return to the address prompt.
2050 5. Changing the Default Key Bindings
2054 bind map key function
2056 This command allows you to change the default key bindings (operation invoked
2057 when pressing a key).
2059 map specifies in which menu the binding belongs. Multiple maps may be specified
2060 by separating them with commas (no additional whitespace is allowed). The
2061 currently defined maps are:
2065 This is not a real menu, but is used as a fallback for all of the other
2066 menus except for the pager and editor modes. If a key is not defined in
2067 another menu, Mutt will look for a binding to use in this menu. This allows
2068 you to bind a key to a certain function in multiple menus instead of having
2069 multiple bind statements to accomplish the same task.
2073 The alias menu is the list of your personal aliases as defined in your
2074 .muttrc. It is the mapping from a short alias name to the full email
2075 address(es) of the recipient(s).
2079 The attachment menu is used to access the attachments on received messages.
2083 The browser is used for both browsing the local directory structure, and
2084 for listing all of your incoming mailboxes.
2088 The editor is the line-based editor the user enters text data.
2092 The index is the list of messages contained in a mailbox.
2096 The compose menu is the screen used when sending a new message.
2100 The pager is the mode used to display message/attachment data, and help
2105 The pgp menu is used to select the OpenPGP keys used to encrypt outgoing
2110 The smime menu is used to select the OpenSSL certificates used to encrypt
2115 The postpone menu is similar to the index menu, except is used when
2116 recalling a message the user was composing, but saved until later.
2120 The query menu is the browser for results returned by $query_command.
2124 The mixmaster screen is used to select remailer options for outgoing
2125 messages (if Mutt is compiled with Mixmaster support).
2127 key is the key (or key sequence) you wish to bind. To specify a control
2128 character, use the sequence \Cx, where x is the letter of the control character
2129 (for example, to specify control-A use ?\Ca?). Note that the case of x as well
2130 as \C is ignored, so that \CA, \Ca, \cA and \ca are all equivalent. An
2131 alternative form is to specify the key as a three digit octal number prefixed
2132 with a ?\? (for example \177 is equivalent to \c?). In addition, key may be a
2133 symbolic name as shown in Table 3.1, ?Symbolic key names?.
2135 Table 3.1. Symbolic key names
2137 +---------------------------------+
2138 |Symbolic name| Meaning |
2139 |-------------+-------------------|
2141 |-------------+-------------------|
2143 |-------------+-------------------|
2144 |<backtab> |backtab / shift-tab|
2145 |-------------+-------------------|
2146 |\r |carriage return |
2147 |-------------+-------------------|
2149 |-------------+-------------------|
2151 |-------------+-------------------|
2153 |-------------+-------------------|
2155 |-------------+-------------------|
2156 |<down> |down arrow |
2157 |-------------+-------------------|
2158 |<left> |left arrow |
2159 |-------------+-------------------|
2160 |<right> |right arrow |
2161 |-------------+-------------------|
2162 |<pageup> |Page Up |
2163 |-------------+-------------------|
2164 |<pagedown> |Page Down |
2165 |-------------+-------------------|
2166 |<backspace> |Backspace |
2167 |-------------+-------------------|
2169 |-------------+-------------------|
2171 |-------------+-------------------|
2173 |-------------+-------------------|
2175 |-------------+-------------------|
2177 |-------------+-------------------|
2179 |-------------+-------------------|
2180 |<space> |Space bar |
2181 |-------------+-------------------|
2182 |<f1> |function key 1 |
2183 |-------------+-------------------|
2184 |<f10> |function key 10 |
2185 +---------------------------------+
2188 key does not need to be enclosed in quotes unless it contains a space (???) or
2191 function specifies which action to take when key is pressed. For a complete
2192 list of functions, see the reference. The special function <noop> unbinds the
2193 specified key sequence.
2195 6. Defining Aliases for Character Sets
2199 charset-hook alias charset
2200 iconv-hook charset local-charset
2202 The charset-hook command defines an alias for a character set. This is useful
2203 to properly display messages which are tagged with a character set name not
2206 The iconv-hook command defines a system-specific name for a character set. This
2207 is helpful when your systems character conversion library insists on using
2208 strange, system-specific names for character sets.
2210 7. Setting Variables Based Upon Mailbox
2214 folder-hook [!]regexp command
2216 It is often desirable to change settings based on which mailbox you are
2217 reading. The folder-hook command provides a method by which you can execute any
2218 configuration command. regexp is a regular expression specifying in which
2219 mailboxes to execute command before loading. If a mailbox matches multiple
2220 folder-hooks, they are executed in the order given in the .muttrc.
2224 If you use the ?!? shortcut for $spoolfile at the beginning of the pattern, you
2225 must place it inside of double or single quotes in order to distinguish it from
2226 the logical not operator for the expression.
2230 Settings are not restored when you leave the mailbox. For example, a command
2231 action to perform is to change the sorting method based upon the mailbox being
2234 folder-hook mutt "set sort=threads"
2236 However, the sorting method is not restored to its previous value when reading
2237 a different mailbox. To specify a default command, use the pattern ?.? before
2238 other folder-hooks adjusting a value on a per-folder basis because folder-hooks
2239 are evaluated in the order given in the configuration file.
2241 The following example will set the sort variable to date-sent for all folders
2242 but to threads for all folders containing ?mutt? in their name.
2244 Example 3.8. Setting sort method based on mailbox name
2246 folder-hook . "set sort=date-sent"
2247 folder-hook mutt "set sort=threads"
2254 macro menu key sequence [ description ]
2256 Macros are useful when you would like a single key to perform a series of
2257 actions. When you press key in menu menu, Mutt will behave as if you had typed
2258 sequence. So if you have a common sequence of commands you type, you can create
2259 a macro to execute those commands with a single key or fewer keys.
2261 menu is the map which the macro will be bound in. Multiple maps may be
2262 specified by separating multiple menu arguments by commas. Whitespace may not
2263 be used in between the menu arguments and the commas separating them.
2265 key and sequence are expanded by the same rules as the key bindings with some
2266 additions. The first is that control characters in sequence can also be
2267 specified as ^x. In order to get a caret (?^?) you need to use ^^. Secondly, to
2268 specify a certain key such as up or to invoke a function directly, you can use
2269 the format <key name> and <function name>. For a listing of key names see the
2270 section on key bindings. Functions are listed in the reference.
2272 The advantage with using function names directly is that the macros will work
2273 regardless of the current key bindings, so they are not dependent on the user
2274 having particular key definitions. This makes them more robust and portable,
2275 and also facilitates defining of macros in files used by more than one user
2276 (e.g., the system Muttrc).
2278 Optionally you can specify a descriptive text after sequence, which is shown in
2279 the help screens if they contain a description.
2283 Macro definitions (if any) listed in the help screen(s), are silently truncated
2284 at the screen width, and are not wrapped.
2286 9. Using Color and Mono Video Attributes
2290 color object foreground background
2291 color { header | body } foreground background regexp
2292 color index foreground background pattern
2293 uncolor { index | header | body } { * | pattern ... }
2295 If your terminal supports color, you can spice up Mutt by creating your own
2296 color scheme. To define the color of an object (type of information), you must
2297 specify both a foreground color and a background color (it is not possible to
2298 only specify one or the other).
2300 header and body match regexp in the header/body of a message, index matches
2301 pattern (see Section 2, ?Patterns: Searching, Limiting and Tagging?) in the
2304 object can be one of:
2308 * bold (hiliting bold patterns in the body of messages)
2310 * error (error messages printed by Mutt)
2312 * hdrdefault (default color of the message header in the pager)
2314 * indicator (arrow or bar used to indicate the current item in a menu)
2316 * markers (the ?+? markers at the beginning of wrapped lines in the pager)
2318 * message (informational messages)
2322 * quoted (text matching $quote_regexp in the body of a message)
2324 * quoted1, quoted2, ..., quotedN (higher levels of quoting)
2326 * search (hiliting of words in the pager)
2330 * status (mode lines used to display info about the mailbox or message)
2332 * tilde (the ??? used to pad blank lines in the pager)
2334 * tree (thread tree drawn in the message index and attachment menu)
2336 * underline (hiliting underlined patterns in the body of messages)
2338 foreground and background can be one of the following:
2360 foreground can optionally be prefixed with the keyword bright to make the
2361 foreground color boldfaced (e.g., brightred).
2363 If your terminal supports it, the special keyword default can be used as a
2364 transparent color. The value brightdefault is also valid. If Mutt is linked
2365 against the S-Lang library, you also need to set the $COLORFGBG environment
2366 variable to the default colors of your terminal for this to work; for example
2367 (for Bourne-like shells):
2369 set COLORFGBG="green;black"
2374 The S-Lang library requires you to use the lightgray and brown keywords instead
2375 of white and yellow when setting this variable.
2379 The uncolor command can be applied to the index, header and body objects only.
2380 It removes entries from the list. You must specify the same pattern specified
2381 in the color command for it to be removed. The pattern ?*? is a special token
2382 which means to clear the color list of all entries.
2384 Mutt also recognizes the keywords color0, color1, ?, colorN-1 (N being the
2385 number of colors supported by your terminal). This is useful when you remap the
2386 colors for your display (for example by changing the color associated with
2387 color2 for your xterm), since color names may then lose their normal meaning.
2389 If your terminal does not support color, it is still possible change the video
2390 attributes through the use of the ?mono? command. Usage:
2392 mono object attribute
2393 mono { header | body } attribute regexp
2394 mono index attribute pattern
2395 unmono { index | header | body } { * | pattern ... }
2397 For object, see the color command. attribute can be one of the following:
2409 10. Message Header Display
2411 10.1. Selecting Headers
2415 ignore pattern [ pattern ...]
2416 unignore { * | pattern ... }
2418 Messages often have many header fields added by automatic processing systems,
2419 or which may not seem useful to display on the screen. This command allows you
2420 to specify header fields which you don't normally want to see in the pager.
2422 You do not need to specify the full header field name. For example, ?ignore
2423 content-? will ignore all header fields that begin with the pattern ?content-?.
2424 ?ignore *? will ignore all headers.
2426 To remove a previously added token from the list, use the ?unignore? command.
2427 The ?unignore? command will make Mutt display headers with the given pattern.
2428 For example, if you do ?ignore x-? it is possible to ?unignore x-mailer?.
2430 ?unignore *? will remove all tokens from the ignore list.
2432 Example 3.9. Header weeding
2434 # Sven's draconian header weeding
2436 unignore from date subject to cc
2437 unignore organization organisation x-mailer: x-newsreader: x-mailing-list:
2441 10.2. Ordering Displayed Headers
2445 hdr_order header [ header ...]
2446 unhdr_order { * | header ... }
2448 With the hdr_order command you can specify an order in which Mutt will attempt
2449 to present these headers to you when viewing messages.
2451 ?unhdr_order *? will clear all previous headers from the order list, thus
2452 removing the header order effects set by the system-wide startup file.
2454 Example 3.10. Configuring header display order
2456 hdr_order From Date: From: To: Cc: Subject:
2459 11. Alternative Addresses
2463 alternates [ -group name ...] regexp [ regexp ...]
2464 unalternates [ -group name ...] { * | regexp ... }
2466 With various functions, Mutt will treat messages differently, depending on
2467 whether you sent them or whether you received them from someone else. For
2468 instance, when replying to a message that you sent to a different party, Mutt
2469 will automatically suggest to send the response to the original message's
2470 recipients ? responding to yourself won't make much sense in many cases. (See
2473 Many users receive e-mail under a number of different addresses. To fully use
2474 Mutt's features here, the program must be able to recognize what e-mail
2475 addresses you receive mail under. That's the purpose of the alternates command:
2476 It takes a list of regular expressions, each of which can identify an address
2477 under which you receive e-mail.
2479 As addresses are matched using regular expressions and not exact strict
2480 comparisons, you should make sure you specify your addresses as precise as
2481 possible to avoid mismatches. For example, if you specify:
2483 alternates user@example
2485 Mutt will consider ?some-user@example? as being your address, too which may not
2486 be desired. As a solution, in such cases addresses should be specified as:
2488 alternates '^user@example$'
2490 The -group flag causes all of the subsequent regular expressions to be added to
2493 The unalternates command can be used to write exceptions to alternates
2494 patterns. If an address matches something in an alternates command, but you
2495 nonetheless do not think it is from you, you can list a more precise pattern
2496 under an unalternates command.
2498 To remove a regular expression from the alternates list, use the unalternates
2499 command with exactly the same regexp. Likewise, if the regexp for an alternates
2500 command matches an entry on the unalternates list, that unalternates entry will
2501 be removed. If the regexp for unalternates is ?*?, all entries on alternates
2508 lists [ -group name ...] regexp [ regexp ...]
2509 unlists [ -group name ...] { * | regexp ... }
2510 subscribe [ -group name ...] regexp [ regexp ...]
2511 unsubscribe [ -group name ...] { * | regexp ... }
2513 Mutt has a few nice features for handling mailing lists. In order to take
2514 advantage of them, you must specify which addresses belong to mailing lists,
2515 and which mailing lists you are subscribed to. Mutt also has limited support
2516 for auto-detecting mailing lists: it supports parsing mailto: links in the
2517 common List-Post: header which has the same effect as specifying the list
2518 address via the lists command (except the group feature). Once you have done
2519 this, the <list-reply> function will work for all known lists. Additionally,
2520 when you send a message to a subscribed list, Mutt will add a Mail-Followup-To
2521 header to tell other users' mail user agents not to send copies of replies to
2522 your personal address.
2526 The Mail-Followup-To header is a non-standard extension which is not supported
2527 by all mail user agents. Adding it is not bullet-proof against receiving
2528 personal CCs of list messages. Also note that the generation of the
2529 Mail-Followup-To header is controlled by the $followup_to configuration
2530 variable since it's common practice on some mailing lists to send Cc upons
2531 replies (which is more a group- than a list-reply).
2533 More precisely, Mutt maintains lists of patterns for the addresses of known and
2534 subscribed mailing lists. Every subscribed mailing list is known. To mark a
2535 mailing list as known, use the list command. To mark it as subscribed, use
2538 You can use regular expressions with both commands. To mark all messages sent
2539 to a specific bug report's address on Debian's bug tracking system as list
2540 mail, for instance, you could say
2542 subscribe [0-9]*.*@bugs.debian.org
2544 as it's often, it's sufficient to just give a portion of the list's e-mail
2547 Specify as much of the address as you need to to remove ambiguity. For example,
2548 if you've subscribed to the Mutt mailing list, you will receive mail addressed
2549 to mutt-users@mutt.org. So, to tell Mutt that this is a mailing list, you could
2550 add lists mutt-users@ to your initialization file. To tell Mutt that you are
2551 subscribed to it, add subscribe mutt-users to your initialization file instead.
2552 If you also happen to get mail from someone whose address is
2553 mutt-users@example.com, you could use lists ^mutt-users@mutt\\.org$ or
2554 subscribe ^mutt-users@mutt\\.org$ to match only mail from the actual list.
2556 The -group flag adds all of the subsequent regular expressions to the named
2559 The ?unlists? command is used to remove a token from the list of known and
2560 subscribed mailing-lists. Use ?unlists *? to remove all tokens.
2562 To remove a mailing list from the list of subscribed mailing lists, but keep it
2563 on the list of known mailing lists, use unsubscribe.
2565 13. Using Multiple Spool Mailboxes
2569 mbox-hook [!]pattern mailbox
2571 This command is used to move read messages from a specified mailbox to a
2572 different mailbox automatically when you quit or change folders. pattern is a
2573 regular expression specifying the mailbox to treat as a ?spool? mailbox and
2574 mailbox specifies where mail should be saved when read.
2576 Unlike some of the other hook commands, only the first matching pattern is used
2577 (it is not possible to save read mail in more than a single mailbox).
2579 14. Monitoring Incoming Mail
2583 mailboxes mailbox [ mailbox ...]
2584 unmailboxes { * | mailbox ... }
2586 This command specifies folders which can receive mail and which will be checked
2587 for new messages periodically.
2589 folder can either be a local file or directory (Mbox/Mmdf or Maildir/Mh). If
2590 Mutt was built with POP and/or IMAP support, folder can also be a POP/IMAP
2591 folder URL. The URL syntax is described in Section 1.2, ?URL Syntax?, POP and
2592 IMAP are described in Section 3, ?POP3 Support? and Section 4, ?IMAP Support?
2595 Mutt provides a number of advanced features for handling (possibly many)
2596 folders and new mail within them, please refer to Section 9, ?Handling multiple
2597 folders? for details (including in what situations and how often Mutt checks
2600 The ?unmailboxes? command is used to remove a token from the list of folders
2601 which receive mail. Use ?unmailboxes *? to remove all tokens.
2605 The folders in the mailboxes command are resolved when the command is executed,
2606 so if these names contain shortcut characters (such as ?=? and ?!?), any
2607 variable definition that affects these characters (like $folder and $spoolfile)
2608 should be set before the mailboxes command. If none of these shorcuts are used,
2609 a local path should be absolute as otherwise Mutt tries to find it relative to
2610 the directory from where Mutt was started which may not always be desired.
2612 For Mbox and Mmdf folders, new mail is detected by comparing access and/or
2613 modification times of files: Mutt assumes a folder has new mail if it wasn't
2614 accessed after it was last modified. Utilities like biff or frm or any other
2615 program which accesses the mailbox might cause Mutt to never detect new mail
2616 for that mailbox if they do not properly reset the access time. Other possible
2617 causes of Mutt not detecting new mail in these folders are backup tools
2618 (updating access times) or filesystems mounted without access time update
2621 In cases where new mail detection for Mbox or Mmdf folders appears to be
2622 unreliable, the $check_mbox_size option can be used to make Mutt track and
2623 consult file sizes for new mail detection instead which won't work for
2624 size-neutral changes.
2626 15. User-Defined Headers
2631 unmy_hdr { * | field ... }
2633 The my_hdr command allows you to create your own header fields which will be
2634 added to every message you send and appear in the editor if $edit_headers is
2637 For example, if you would like to add an ?Organization:? header field to all of
2638 your outgoing messages, you can put the command something like shown in
2639 Example 3.11, ?Defining custom headers? in your .muttrc.
2641 Example 3.11. Defining custom headers
2643 my_hdr Organization: A Really Big Company, Anytown, USA
2648 Space characters are not allowed between the keyword and the colon (?:?). The
2649 standard for electronic mail (RFC2822) says that space is illegal there, so
2650 Mutt enforces the rule.
2652 If you would like to add a header field to a single message, you should either
2653 set the $edit_headers variable, or use the <edit-headers> function (default:
2654 ?E?) in the compose menu so that you can edit the header of your message along
2657 To remove user defined header fields, use the unmy_hdr command. You may specify
2658 an asterisk (?*?) to remove all header fields, or the fields to remove. For
2659 example, to remove all ?To? and ?Cc? header fields, you could use:
2663 16. Specify Default Save Mailbox
2667 save-hook [!]pattern mailbox
2669 This command is used to override the default mailbox used when saving messages.
2670 mailbox will be used as the default if the message matches pattern, see Message
2671 Matching in Hooks for information on the exact format.
2673 To provide more flexibility and good defaults, Mutt applies the expandos of
2674 $index_format to mailbox after it was expanded.
2676 Example 3.12. Using %-expandos in save-hook
2678 # default: save all to ~/Mail/<author name>
2679 save-hook . ~/Mail/%F
2681 # save from me@turing.cs.hmc.edu and me@cs.hmc.edu to $folder/elkins
2682 save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
2684 # save from aol.com to $folder/spam
2685 save-hook aol\\.com$ +spam
2688 Also see the fcc-save-hook command.
2690 17. Specify Default Fcc: Mailbox When Composing
2694 fcc-hook [!]pattern mailbox
2696 This command is used to save outgoing mail in a mailbox other than $record.
2697 Mutt searches the initial list of message recipients for the first matching
2698 regexp and uses mailbox as the default Fcc: mailbox. If no match is found the
2699 message will be saved to $record mailbox.
2701 To provide more flexibility and good defaults, Mutt applies the expandos of
2702 $index_format to mailbox after it was expanded.
2704 See Message Matching in Hooks for information on the exact format of pattern.
2706 fcc-hook [@.]aol\\.com$ +spammers
2708 ...will save a copy of all messages going to the aol.com domain to the
2709 `+spammers' mailbox by default. Also see the fcc-save-hook command.
2711 18. Specify Default Save Filename and Default Fcc: Mailbox at Once
2715 fcc-save-hook [!]pattern mailbox
2717 This command is a shortcut, equivalent to doing both a fcc-hook and a save-hook
2718 with its arguments, including %-expansion on mailbox according to $index_format
2721 19. Change Settings Based Upon Message Recipients
2725 reply-hook [!]pattern command
2726 send-hook [!]pattern command
2727 send2-hook [!]pattern command
2729 These commands can be used to execute arbitrary configuration commands based
2730 upon recipients of the message. pattern is used to match the message, see
2731 Message Matching in Hooks for details. command is executed when pattern
2734 reply-hook is matched against the message you are replying to, instead of the
2735 message you are sending. send-hook is matched against all messages, both new
2740 reply-hooks are matched before the send-hook, regardless of the order specified
2741 in the user's configuration file.
2743 send2-hook is matched every time a message is changed, either by editing it, or
2744 by using the compose menu to change its recipients or subject. send2-hook is
2745 executed after send-hook, and can, e.g., be used to set parameters such as the
2746 $sendmail variable depending on the message's sender address.
2748 For each type of send-hook or reply-hook, when multiple matches occur, commands
2749 are executed in the order they are specified in the .muttrc (for that type of
2752 Example: send-hook mutt "set mime_forward signature=''"
2754 Another typical use for this command is to change the values of the
2755 $attribution, $signature and $locale variables in order to change the language
2756 of the attributions and signatures based upon the recipients.
2760 send-hook's are only executed once after getting the initial list of
2761 recipients. Adding a recipient after replying or editing the message will not
2762 cause any send-hook to be executed, similarily if $autoedit is set (as then the
2763 initial list of recipients is empty). Also note that my_hdr commands which
2764 modify recipient headers, or the message's subject, don't have any effect on
2765 the current message when executed from a send-hook.
2767 20. Change Settings Before Formatting a Message
2771 message-hook [!]pattern command
2773 This command can be used to execute arbitrary configuration commands before
2774 viewing or formatting a message based upon information about the message.
2775 command is executed if the pattern matches the message to be displayed. When
2776 multiple matches occur, commands are executed in the order they are specified
2779 See Message Matching in Hooks for information on the exact format of pattern.
2783 message-hook ~A 'set pager=builtin'
2784 message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""'
2786 21. Choosing the Cryptographic Key of the Recipient
2790 crypt-hook pattern keyid
2792 When encrypting messages with PGP/GnuPG or OpenSSL, you may want to associate a
2793 certain key with a given e-mail address automatically, either because the
2794 recipient's public key can't be deduced from the destination address, or
2795 because, for some reasons, you need to override the key Mutt would normally
2796 use. The crypt-hook command provides a method by which you can specify the ID
2797 of the public key to be used when encrypting messages to a certain recipient.
2799 The meaning of keyid is to be taken broadly in this context: You can either put
2800 a numerical key ID here, an e-mail address, or even just a real name.
2802 22. Adding Key Sequences to the Keyboard Buffer
2808 This command adds the named string to the keyboard buffer. The string may
2809 contain control characters, key names and function names like the sequence
2810 string in the macro command. You may use it to automatically run a sequence of
2811 commands at startup, or when entering certain folders. For example,
2812 Example 3.13, ?Embedding push in folder-hook? shows how to automatically
2813 collapse all threads when entering a folder.
2815 Example 3.13. Embedding push in folder-hook
2817 folder-hook . 'push <collapse-all>'
2820 23. Executing Functions
2824 exec function [ function ...]
2826 This command can be used to execute any function. Functions are listed in the
2827 function reference. ?execfunction? is equivalent to ?push <function>?.
2834 unscore { * | pattern ... }
2836 The score commands adds value to a message's score if pattern matches it.
2837 pattern is a string in the format described in the patterns section (note: For
2838 efficiency reasons, patterns which scan information not available in the index,
2839 such as ?b, ?B or ?h, may not be used). value is a positive or negative
2840 integer. A message's final score is the sum total of all matching score
2841 entries. However, you may optionally prefix value with an equal sign (?=?) to
2842 cause evaluation to stop at a particular entry if there is a match. Negative
2843 final scores are rounded up to 0.
2845 The unscore command removes score entries from the list. You must specify the
2846 same pattern specified in the score command for it to be removed. The pattern
2847 ?*? is a special token which means to clear the list of all score entries.
2854 nospam { * | pattern }
2856 Mutt has generalized support for external spam-scoring filters. By defining
2857 your spam patterns with the spam and nospam commands, you can limit, search,
2858 and sort your mail based on its spam attributes, as determined by the external
2859 filter. You also can display the spam attributes in your index display using
2860 the %H selector in the $index_format variable. (Tip: try %?H?[%H] ? to display
2861 spam tags only when they are defined for a given message.)
2863 Your first step is to define your external filter's spam patterns using the
2864 spam command. pattern should be a regular expression that matches a header in a
2865 mail message. If any message in the mailbox matches this regular expression, it
2866 will receive a ?spam tag? or ?spam attribute? (unless it also matches a nospam
2867 pattern ? see below.) The appearance of this attribute is entirely up to you,
2868 and is governed by the format parameter. format can be any static text, but it
2869 also can include back-references from the pattern expression. (A regular
2870 expression ?back-reference? refers to a sub-expression contained within
2871 parentheses.) %1 is replaced with the first back-reference in the regex, %2
2872 with the second, etc.
2874 To match spam tags, mutt needs the corresponding header information which is
2875 always the case for local and POP folders but not for IMAP in the default
2876 configuration. Depending on the spam header to be analyzed, $imap_headers may
2877 need to be adjusted.
2879 If you're using multiple spam filters, a message can have more than one
2880 spam-related header. You can define spam patterns for each filter you use. If a
2881 message matches two or more of these patterns, and the $spam_separator variable
2882 is set to a string, then the message's spam tag will consist of all the format
2883 strings joined together, with the value of $spam_separator separating them.
2885 For example, suppose one uses DCC, SpamAssassin, and PureMessage, then the
2886 configuration might look like in Example 3.14, ?Configuring spam detection?.
2888 Example 3.14. Configuring spam detection
2890 spam "X-DCC-.*-Metrics:.*(....)=many" "90+/DCC-%1"
2891 spam "X-Spam-Status: Yes" "90+/SA"
2892 spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM"
2893 set spam_separator=", "
2896 If then a message is received that DCC registered with ?many? hits under the
2897 ?Fuz2? checksum, and that PureMessage registered with a 97% probability of
2898 being spam, that message's spam tag would read 90+/DCC-Fuz2, 97/PM. (The four
2899 characters before ?=many? in a DCC report indicate the checksum used ? in this
2902 If the $spam_separator variable is unset, then each spam pattern match
2903 supersedes the previous one. Instead of getting joined format strings, you'll
2904 get only the last one to match.
2906 The spam tag is what will be displayed in the index when you use %H in the
2907 $index_format variable. It's also the string that the ?H pattern-matching
2908 expression matches against for <search> and <limit> functions. And it's what
2909 sorting by spam attribute will use as a sort key.
2911 That's a pretty complicated example, and most people's actual environments will
2912 have only one spam filter. The simpler your configuration, the more effective
2913 Mutt can be, especially when it comes to sorting.
2915 Generally, when you sort by spam tag, Mutt will sort lexically ? that is, by
2916 ordering strings alphanumerically. However, if a spam tag begins with a number,
2917 Mutt will sort numerically first, and lexically only when two numbers are equal
2918 in value. (This is like UNIX's sort -n.) A message with no spam attributes at
2919 all ? that is, one that didn't match any of your spam patterns ? is sorted at
2920 lowest priority. Numbers are sorted next, beginning with 0 and ranging upward.
2921 Finally, non-numeric strings are sorted, with ?a? taking lower priority than
2922 ?z?. Clearly, in general, sorting by spam tags is most effective when you can
2923 coerce your filter to give you a raw number. But in case you can't, Mutt can
2924 still do something useful.
2926 The nospam command can be used to write exceptions to spam patterns. If a
2927 header pattern matches something in a spam command, but you nonetheless do not
2928 want it to receive a spam tag, you can list a more precise pattern under a
2931 If the pattern given to nospam is exactly the same as the pattern on an
2932 existing spam list entry, the effect will be to remove the entry from the spam
2933 list, instead of adding an exception. Likewise, if the pattern for a spam
2934 command matches an entry on the nospam list, that nospam entry will be removed.
2935 If the pattern for nospam is ?*?, all entries on both lists will be removed.
2936 This might be the default action if you use spam and nospam in conjunction with
2939 You can have as many spam or nospam commands as you like. You can even do your
2940 own primitive spam detection within Mutt ? for example, if you consider all
2941 mail from MAILER-DAEMON to be spam, you can use a spam command like this:
2943 spam "^From: .*MAILER-DAEMON" "999"
2945 26. Setting and Querying Variables
2947 26.1. Variable Types
2949 Mutt supports these types of configuration variables:
2953 A boolean expression, either ?yes? or ?no?.
2957 A signed integer number in the range -32768 to 32767.
2965 A specialized string for representing paths including support for mailbox
2966 shortcuts (see Section 7, ?Mailbox Shortcuts?) as well as tilde (???) for a
2967 user's home directory and more.
2971 Like a boolean but triggers a prompt when set to ?ask-yes? or ?ask-no? with
2972 ?yes? and ?no? preselected respectively.
2976 A specialized string allowing only particular words as values depending on
2981 A regular expression, see Section 1, ?Regular Expressions? for an
2986 Specifies the type of folder to use: mbox, mmdf, mh or maildir. Currently
2987 only used to determine the type for newly created folders.
2991 An e-mail address either with or without realname. The older
2992 ?user@example.org (Joe User)? form is supported but strongly deprecated.
2996 Arbitrary text, see Section 26.3, ?User-Defined Variables? for details.
3000 The following commands are available to manipulate and query variables:
3004 set { [ no | inv ] variable | variable=value } [...]
3005 toggle variable [ variable ...]
3006 unset variable [ variable ...]
3007 reset variable [ variable ...]
3009 This command is used to set (and unset) configuration variables. There are four
3010 basic types of variables: boolean, number, string and quadoption. boolean
3011 variables can be set (true) or unset (false). number variables can be assigned
3012 a positive integer value. string variables consist of any number of printable
3013 characters and must be enclosed in quotes if they contain spaces or tabs. You
3014 may also use the escape sequences ?\n? and ?\t? for newline and tab,
3015 respectively. quadoption variables are used to control whether or not to be
3016 prompted for certain actions, or to specify a default action. A value of yes
3017 will cause the action to be carried out automatically as if you had answered
3018 yes to the question. Similarly, a value of no will cause the action to be
3019 carried out as if you had answered ?no.? A value of ask-yes will cause a prompt
3020 with a default answer of ?yes? and ask-no will provide a default answer of
3023 Prefixing a variable with ?no? will unset it. Example: set noaskbcc.
3025 For boolean variables, you may optionally prefix the variable name with inv to
3026 toggle the value (on or off). This is useful when writing macros. Example: set
3029 The toggle command automatically prepends the inv prefix to all specified
3032 The unset command automatically prepends the no prefix to all specified
3035 Using the <enter-command> function in the index menu, you can query the value
3036 of a variable by prefixing the name of the variable with a question mark:
3040 The question mark is actually only required for boolean and quadoption
3043 The reset command resets all given variables to the compile time defaults
3044 (hopefully mentioned in this manual). If you use the command set and prefix the
3045 variable with ?&? this has the same behavior as the reset command.
3047 With the reset command there exists the special variable ?all?, which allows
3048 you to reset all variables to their system defaults.
3050 26.3. User-Defined Variables
3052 26.3.1. Introduction
3054 Along with the variables listed in the Configuration variables section, Mutt
3055 supports user-defined variables with names starting with my_ as in, for
3058 The set command either creates a custom my_ variable or changes its value if it
3059 does exist already. The unset and reset commands remove the variable entirely.
3061 Since user-defined variables are expanded in the same way that environment
3062 variables are (except for the shell-escape command and backtick expansion),
3063 this feature can be used to make configuration files more readable.
3067 The following example defines and uses the variable my_cfgdir to abbreviate the
3068 calls of the source command:
3070 Example 3.15. Using user-defined variables for config file readability
3072 set my_cfgdir = $HOME/mutt/config
3074 source $my_cfgdir/hooks
3075 source $my_cfgdir/macros
3076 # more source commands...
3079 A custom variable can also be used in macros to backup the current value of
3080 another variable. In the following example, the value of the $delete is changed
3081 temporarily while its original value is saved as my_delete. After the macro has
3082 executed all commands, the original value of $delete is restored.
3084 Example 3.16. Using user-defined variables for backing up other config option
3088 <enter-command>set my_delete=$delete<enter>\
3089 <enter-command>set delete=yes<enter>\
3091 <enter-command>set delete=$my_delete<enter>'
3094 Since Mutt expands such values already when parsing the configuration file(s),
3095 the value of $my_delete in the last example would be the value of $delete
3096 exactly as it was at that point during parsing the configuration file. If
3097 another statement would change the value for $delete later in the same or
3098 another file, it would have no effect on $my_delete. However, the expansion can
3099 be deferred to runtime, as shown in the next example, when escaping the dollar
3102 Example 3.17. Deferring user-defined variable expansion to runtime
3104 macro pager <PageDown> "\
3105 <enter-command> set my_old_pager_stop=\$pager_stop pager_stop<Enter>\
3107 <enter-command> set pager_stop=\$my_old_pager_stop<Enter>\
3108 <enter-command> unset my_old_pager_stop<Enter>"
3111 Note that there is a space between <enter-command> and the set configuration
3112 command, preventing Mutt from recording the macro's commands into its history.
3114 27. Reading Initialization Commands From Another File
3120 This command allows the inclusion of initialization commands from other files.
3121 For example, I place all of my aliases in ?/.mail_aliases so that I can make my
3122 ?/.muttrc readable and keep my aliases private.
3124 If the filename begins with a tilde (???), it will be expanded to the path of
3125 your home directory.
3127 If the filename ends with a vertical bar (?|?), then filename is considered to
3128 be an executable program from which to read input (eg. source ?/bin/myscript|).
3134 unhook { * | hook-type }
3136 This command permits you to flush hooks you have previously defined. You can
3137 either remove all hooks by giving the ?*? character as an argument, or you can
3138 remove all hooks of a specific type by saying something like unhook send-hook.
3144 Format strings are a general concept you'll find in several locations through
3145 the Mutt configuration, especially in the $index_format, $pager_format,
3146 $status_format, and other related variables. These can be very straightforward,
3147 and it's quite possible you already know how to use them.
3149 The most basic format string element is a percent symbol followed by another
3150 character. For example, %s represents a message's Subject: header in the
3151 $index_format variable. The ?expandos? available are documented with each
3152 format variable, but there are general modifiers available with all formatting
3153 expandos, too. Those are our concern here.
3155 Some of the modifiers are borrowed right out of C (though you might know them
3156 from Perl, Python, shell, or another language). These are the [-]m.n modifiers,
3157 as in %-12.12s. As with such programming languages, these modifiers allow you
3158 to specify the minimum and maximum size of the resulting string, as well as its
3159 justification. If the ?-? sign follows the percent, the string will be
3160 left-justified instead of right-justified. If there's a number immediately
3161 following that, it's the minimum amount of space the formatted string will
3162 occupy ? if it's naturally smaller than that, it will be padded out with
3163 spaces. If a decimal point and another number follow, that's the maximum space
3164 allowable ? the string will not be permitted to exceed that width, no matter
3165 its natural size. Each of these three elements is optional, so that all these
3166 are legal format strings: %-12s, %4c, %.15F and %-12.15L.
3168 Mutt adds some other modifiers to format strings. If you use an equals symbol
3169 (=) as a numeric prefix (like the minus above), it will force the string to be
3170 centered within its minimum space range. For example, %=14y will reserve 14
3171 characters for the %y expansion ? that's the X-Label: header, in $index_format.
3172 If the expansion results in a string less than 14 characters, it will be
3173 centered in a 14-character space. If the X-Label for a message were ?test?,
3174 that expansion would look like ? test ?.
3176 There are two very little-known modifiers that affect the way that an expando
3177 is replaced. If there is an underline (?_?) character between any format
3178 modifiers (as above) and the expando letter, it will expands in all lower case.
3179 And if you use a colon (?:?), it will replace all decimal points with
3184 Depending on the format string variable, some of its sequences can be used to
3185 optionally print a string if their value is nonzero. For example, you may only
3186 want to see the number of flagged messages if such messages exist, since zero
3187 is not particularly meaningful. To optionally print a string based upon one of
3188 the above sequences, the following construct is used:
3190 %?<sequence_char>?<optional_string>?
3192 where sequence_char is an expando, and optional_string is the string you would
3193 like printed if sequence_char is nonzero. optional_string may contain other
3194 sequences as well as normal text, but you may not nest optional strings.
3196 Here is an example illustrating how to optionally print the number of new
3197 messages in a mailbox in $status_format:
3199 %?n?%n new messages.?
3201 You can also switch between two strings using the following construct:
3203 %?<sequence_char>?<if_string>&<else_string>?
3205 If the value of sequence_char is non-zero, if_string will be expanded,
3206 otherwise else_string will be expanded.
3210 Any format string ending in a vertical bar (?|?) will be expanded and piped
3211 through the first word in the string, using spaces as separator. The string
3212 returned will be used for display. If the returned string ends in %, it will be
3213 passed through the formatter a second time. This allows the filter to generate
3214 a replacement format string including % expandos.
3216 All % expandos in a format string are expanded before the script is called so
3219 Example 3.18. Using external filters in format strings
3221 set status_format="script.sh '%r %f (%L)'|"
3224 will make Mutt expand %r, %f and %L before calling the script. The example also
3225 shows that arguments can be quoted: the script will receive the expanded string
3226 between the single quotes as the only argument.
3228 A practical example is the mutt_xtitle script installed in the samples
3229 subdirectory of the Mutt documentation: it can be used as filter for
3230 $status_format to set the current terminal's title, if supported.
3234 In most format strings, Mutt supports different types of padding using special
3239 When this occurs, Mutt will fill the rest of the line with the character X.
3240 For example, filling the rest of the line with dashes is done by setting:
3242 set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"
3246 Since the previous expando stops at the end of line, there must be a way to
3247 fill the gap between two items via the %>X expando: it puts as many
3248 characters X in between two items so that the rest of the line will be
3249 right-justified. For example, to not put the version string and hostname
3250 the above example on the left but on the right and fill the gap with
3251 spaces, one might use (note the space after %>):
3253 set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)"
3257 Normal right-justification will print everything to the left of the %>,
3258 displaying padding and whatever lies to the right only if there's room. By
3259 contrast, ?soft-fill? gives priority to the right-hand side, guaranteeing
3260 space to display it and showing padding only if there's still room. If
3261 necessary, soft-fill will eat text leftwards to make room for rightward
3262 text. For example, to right-justify the subject making sure as much as
3263 possible of it fits on screen, one might use (note two spaces after %* :
3264 the second ensures there's a space between the truncated right-hand side
3267 set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s"
3269 Chapter 4. Advanced Usage
3273 1. Regular Expressions
3274 2. Patterns: Searching, Limiting and Tagging
3276 2.1. Pattern Modifier
3277 2.2. Simple Searches
3278 2.3. Nesting and Boolean Operators
3279 2.4. Searching by Date
3284 4.1. Message Matching in Hooks
3286 5. External Address Queries
3288 7. Mailbox Shortcuts
3289 8. Handling Mailing Lists
3290 9. Handling multiple folders
3293 10.1. Linking Threads
3294 10.2. Breaking Threads
3296 11. Delivery Status Notification (DSN) Support
3297 12. Start a WWW Browser on URLs
3300 1. Regular Expressions
3302 All string patterns in Mutt including those in more complex patterns must be
3303 specified using regular expressions (regexp) in the ?POSIX extended? syntax
3304 (which is more or less the syntax used by egrep and GNU awk). For your
3305 convenience, we have included below a brief description of this syntax.
3307 The search is case sensitive if the pattern contains at least one upper case
3308 letter, and case insensitive otherwise.
3312 ?\? must be quoted if used for a regular expression in an initialization
3315 A regular expression is a pattern that describes a set of strings. Regular
3316 expressions are constructed analogously to arithmetic expressions, by using
3317 various operators to combine smaller expressions.
3321 The regular expression can be enclosed/delimited by either " or ' which is
3322 useful if the regular expression includes a white-space character. See Syntax
3323 of Initialization Files for more information on " and ' delimiter processing.
3324 To match a literal " or ' you must preface it with \ (backslash).
3326 The fundamental building blocks are the regular expressions that match a single
3327 character. Most characters, including all letters and digits, are regular
3328 expressions that match themselves. Any metacharacter with special meaning may
3329 be quoted by preceding it with a backslash.
3331 The period ?.? matches any single character. The caret ?^? and the dollar sign
3332 ?$? are metacharacters that respectively match the empty string at the
3333 beginning and end of a line.
3335 A list of characters enclosed by ?[? and ?]? matches any single character in
3336 that list; if the first character of the list is a caret ?^? then it matches
3337 any character not in the list. For example, the regular expression [0123456789]
3338 matches any single digit. A range of ASCII characters may be specified by
3339 giving the first and last characters, separated by a hyphen ?-?. Most
3340 metacharacters lose their special meaning inside lists. To include a literal ?]
3341 ? place it first in the list. Similarly, to include a literal ?^? place it
3342 anywhere but first. Finally, to include a literal hyphen ?-? place it last.
3344 Certain named classes of characters are predefined. Character classes consist
3345 of ?[:?, a keyword denoting the class, and ?:]?. The following classes are
3346 defined by the POSIX standard in Table 4.1, ?POSIX regular expression character
3349 Table 4.1. POSIX regular expression character classes
3351 +-----------------------------------------------------------------------------+
3352 |Character | Description |
3354 |----------+------------------------------------------------------------------|
3355 |[:alnum:] |Alphanumeric characters |
3356 |----------+------------------------------------------------------------------|
3357 |[:alpha:] |Alphabetic characters |
3358 |----------+------------------------------------------------------------------|
3359 |[:blank:] |Space or tab characters |
3360 |----------+------------------------------------------------------------------|
3361 |[:cntrl:] |Control characters |
3362 |----------+------------------------------------------------------------------|
3363 |[:digit:] |Numeric characters |
3364 |----------+------------------------------------------------------------------|
3365 |[:graph:] |Characters that are both printable and visible. (A space is |
3366 | |printable, but not visible, while an ?a? is both) |
3367 |----------+------------------------------------------------------------------|
3368 |[:lower:] |Lower-case alphabetic characters |
3369 |----------+------------------------------------------------------------------|
3370 |[:print:] |Printable characters (characters that are not control characters) |
3371 |----------+------------------------------------------------------------------|
3372 |[:punct:] |Punctuation characters (characters that are not letter, digits, |
3373 | |control characters, or space characters) |
3374 |----------+------------------------------------------------------------------|
3375 |[:space:] |Space characters (such as space, tab and formfeed, to name a few) |
3376 |----------+------------------------------------------------------------------|
3377 |[:upper:] |Upper-case alphabetic characters |
3378 |----------+------------------------------------------------------------------|
3379 |[:xdigit:]|Characters that are hexadecimal digits |
3380 +-----------------------------------------------------------------------------+
3383 A character class is only valid in a regular expression inside the brackets of
3388 Note that the brackets in these class names are part of the symbolic names, and
3389 must be included in addition to the brackets delimiting the bracket list. For
3390 example, [[:digit:]] is equivalent to [0-9].
3392 Two additional special sequences can appear in character lists. These apply to
3393 non-ASCII character sets, which can have single symbols (called collating
3394 elements) that are represented with more than one character, as well as several
3395 characters that are equivalent for collating or sorting purposes:
3399 A collating symbol is a multi-character collating element enclosed in ?[.?
3400 and ?.]?. For example, if ?ch? is a collating element, then [[.ch.]] is a
3401 regexp that matches this collating element, while [ch] is a regexp that
3402 matches either ?c? or ?h?.
3406 An equivalence class is a locale-specific name for a list of characters
3407 that are equivalent. The name is enclosed in ?[=? and ?=]?. For example,
3408 the name ?e? might be used to represent all of ??? ??? and ?e?. In this
3409 case, [[=e=]] is a regexp that matches any of ???, ??? and ?e?.
3411 A regular expression matching a single character may be followed by one of
3412 several repetition operators described in Table 4.2, ?Regular expression
3413 repetition operators?.
3415 Table 4.2. Regular expression repetition operators
3417 +-----------------------------------------------------------------------------+
3418 |Operator| Description |
3419 |--------+--------------------------------------------------------------------|
3420 |? |The preceding item is optional and matched at most once |
3421 |--------+--------------------------------------------------------------------|
3422 |* |The preceding item will be matched zero or more times |
3423 |--------+--------------------------------------------------------------------|
3424 |+ |The preceding item will be matched one or more times |
3425 |--------+--------------------------------------------------------------------|
3426 |{n} |The preceding item is matched exactly n times |
3427 |--------+--------------------------------------------------------------------|
3428 |{n,} |The preceding item is matched n or more times |
3429 |--------+--------------------------------------------------------------------|
3430 |{,m} |The preceding item is matched at most m times |
3431 |--------+--------------------------------------------------------------------|
3432 |{n,m} |The preceding item is matched at least n times, but no more than m |
3434 +-----------------------------------------------------------------------------+
3437 Two regular expressions may be concatenated; the resulting regular expression
3438 matches any string formed by concatenating two substrings that respectively
3439 match the concatenated subexpressions.
3441 Two regular expressions may be joined by the infix operator ?|?; the resulting
3442 regular expression matches any string matching either subexpression.
3444 Repetition takes precedence over concatenation, which in turn takes precedence
3445 over alternation. A whole subexpression may be enclosed in parentheses to
3446 override these precedence rules.
3450 If you compile Mutt with the included regular expression engine, the following
3451 operators may also be used in regular expressions as described in Table 4.3,
3452 ?GNU regular expression extensions?.
3454 Table 4.3. GNU regular expression extensions
3456 +-----------------------------------------------------------------------------+
3457 |Expression| Description |
3458 |----------+------------------------------------------------------------------|
3459 |\\y |Matches the empty string at either the beginning or the end of a |
3461 |----------+------------------------------------------------------------------|
3462 |\\B |Matches the empty string within a word |
3463 |----------+------------------------------------------------------------------|
3464 |\\< |Matches the empty string at the beginning of a word |
3465 |----------+------------------------------------------------------------------|
3466 |\\> |Matches the empty string at the end of a word |
3467 |----------+------------------------------------------------------------------|
3468 |\\w |Matches any word-constituent character (letter, digit, or |
3470 |----------+------------------------------------------------------------------|
3471 |\\W |Matches any character that is not word-constituent |
3472 |----------+------------------------------------------------------------------|
3473 |\\` |Matches the empty string at the beginning of a buffer (string) |
3474 |----------+------------------------------------------------------------------|
3475 |\\' |Matches the empty string at the end of a buffer |
3476 +-----------------------------------------------------------------------------+
3479 Please note however that these operators are not defined by POSIX, so they may
3480 or may not be available in stock libraries on various systems.
3482 2. Patterns: Searching, Limiting and Tagging
3484 2.1. Pattern Modifier
3486 Many of Mutt's commands allow you to specify a pattern to match (limit,
3487 tag-pattern, delete-pattern, etc.). Table 4.4, ?Pattern modifiers? shows
3488 several ways to select messages.
3490 Table 4.4. Pattern modifiers
3492 +-----------------------------------------------------------------------------+
3493 | Pattern | Description |
3495 |---------+-------------------------------------------------------------------|
3497 |---------+-------------------------------------------------------------------|
3498 |~b EXPR |messages which contain EXPR in the message body |
3499 |---------+-------------------------------------------------------------------|
3500 | |messages which contain STRING in the message body. If IMAP is |
3501 |=b STRING|enabled, searches for STRING on the server, rather than downloading|
3502 | |each message and searching it locally. |
3503 |---------+-------------------------------------------------------------------|
3504 |~B EXPR |messages which contain EXPR in the whole message |
3505 |---------+-------------------------------------------------------------------|
3506 |~c EXPR |messages carbon-copied to EXPR |
3507 |---------+-------------------------------------------------------------------|
3508 |%c GROUP |messages carbon-copied to any member of GROUP |
3509 |---------+-------------------------------------------------------------------|
3510 |~C EXPR |messages either to: or cc: EXPR |
3511 |---------+-------------------------------------------------------------------|
3512 |%C GROUP |messages either to: or cc: to any member of GROUP |
3513 |---------+-------------------------------------------------------------------|
3514 |~d [MIN]-|messages with ?date-sent? in a Date range |
3516 |---------+-------------------------------------------------------------------|
3517 |~D |deleted messages |
3518 |---------+-------------------------------------------------------------------|
3519 |~e EXPR |messages which contains EXPR in the ?Sender? field |
3520 |---------+-------------------------------------------------------------------|
3521 |%e GROUP |messages which contain a member of GROUP in the ?Sender? field |
3522 |---------+-------------------------------------------------------------------|
3523 |~E |expired messages |
3524 |---------+-------------------------------------------------------------------|
3525 |~F |flagged messages |
3526 |---------+-------------------------------------------------------------------|
3527 |~f EXPR |messages originating from EXPR |
3528 |---------+-------------------------------------------------------------------|
3529 |%f GROUP |messages originating from any member of GROUP |
3530 |---------+-------------------------------------------------------------------|
3531 |~g |cryptographically signed messages |
3532 |---------+-------------------------------------------------------------------|
3533 |~G |cryptographically encrypted messages |
3534 |---------+-------------------------------------------------------------------|
3535 |~h EXPR |messages which contain EXPR in the message header |
3536 |---------+-------------------------------------------------------------------|
3537 |~H EXPR |messages with a spam attribute matching EXPR |
3538 |---------+-------------------------------------------------------------------|
3539 |~i EXPR |messages which match EXPR in the ?Message-ID? field |
3540 |---------+-------------------------------------------------------------------|
3541 |~k |messages which contain PGP key material |
3542 |---------+-------------------------------------------------------------------|
3543 |~L EXPR |messages either originated or received by EXPR |
3544 |---------+-------------------------------------------------------------------|
3545 |%L GROUP |message either originated or received by any member of GROUP |
3546 |---------+-------------------------------------------------------------------|
3547 |~l |messages addressed to a known mailing list |
3548 |---------+-------------------------------------------------------------------|
3549 |~m [MIN]-|messages in the range MIN to MAX *) |
3551 |---------+-------------------------------------------------------------------|
3552 |~n [MIN]-|messages with a score in the range MIN to MAX *) |
3554 |---------+-------------------------------------------------------------------|
3556 |---------+-------------------------------------------------------------------|
3558 |---------+-------------------------------------------------------------------|
3559 |~p |messages addressed to you (consults alternates) |
3560 |---------+-------------------------------------------------------------------|
3561 |~P |messages from you (consults alternates) |
3562 |---------+-------------------------------------------------------------------|
3563 |~Q |messages which have been replied to |
3564 |---------+-------------------------------------------------------------------|
3565 |~r [MIN]-|messages with ?date-received? in a Date range |
3567 |---------+-------------------------------------------------------------------|
3568 |~R |read messages |
3569 |---------+-------------------------------------------------------------------|
3570 |~s EXPR |messages having EXPR in the ?Subject? field. |
3571 |---------+-------------------------------------------------------------------|
3572 |~S |superseded messages |
3573 |---------+-------------------------------------------------------------------|
3574 |~t EXPR |messages addressed to EXPR |
3575 |---------+-------------------------------------------------------------------|
3576 |~T |tagged messages |
3577 |---------+-------------------------------------------------------------------|
3578 |~u |messages addressed to a subscribed mailing list |
3579 |---------+-------------------------------------------------------------------|
3580 |~U |unread messages |
3581 |---------+-------------------------------------------------------------------|
3582 |~v |messages part of a collapsed thread. |
3583 |---------+-------------------------------------------------------------------|
3584 |~V |cryptographically verified messages |
3585 |---------+-------------------------------------------------------------------|
3586 |~x EXPR |messages which contain EXPR in the ?References? or ?In-Reply-To? |
3588 |---------+-------------------------------------------------------------------|
3589 |~X [MIN]-|messages with MIN to MAX attachments *) |
3591 |---------+-------------------------------------------------------------------|
3592 |~y EXPR |messages which contain EXPR in the ?X-Label? field |
3593 |---------+-------------------------------------------------------------------|
3594 |~z [MIN]-|messages with a size in the range MIN to MAX *) **) |
3596 |---------+-------------------------------------------------------------------|
3597 |~= |duplicated messages (see $duplicate_threads) |
3598 |---------+-------------------------------------------------------------------|
3599 |~$ |unreferenced messages (requires threaded view) |
3600 |---------+-------------------------------------------------------------------|
3601 |~(PATTERN|messages in threads containing messages matching PATTERN, e.g. all |
3602 |) |threads containing messages from you: ~(~P) |
3603 +-----------------------------------------------------------------------------+
3606 Where EXPR is a regular expression.
3608 *) The forms ?<[MAX]?, ?>[MIN]?, ?[MIN]-? and ?-[MAX]? are allowed, too.
3610 **) The suffixes ?K? and ?M? are allowed to specify kilobyte and megabyte
3613 Special attention has to be payed when using regular expressions inside of
3614 patterns. Specifically, Mutt's parser for these patterns will strip one level
3615 of backslash (?\?), which is normally used for quoting. If it is your intention
3616 to use a backslash in the regular expression, you will need to use two
3617 backslashes instead (?\\?). You can force Mutt to treat EXPR as a simple string
3618 instead of a regular expression by using = instead of ? in the pattern name.
3619 For example, =b *.* will find all messages that contain the literal string
3620 ?*.*?. Simple string matches are less powerful than regular expressions but can
3621 be considerably faster. This is especially true for IMAP folders, because
3622 string matches can be performed on the server instead of by fetching every
3623 message. IMAP treats =h specially: it must be of the form ?header: substring?
3624 and will not partially match header names. The substring part may be omitted if
3625 you simply wish to find messages containing a particular header without regard
3628 Patterns matching lists of addresses (notably c, C, p, P and t) match if there
3629 is at least one match in the whole list. If you want to make sure that all
3630 elements of that list match, you need to prefix your pattern with ?^?. This
3631 example matches all mails which only has recipients from Germany.
3633 Example 4.1. Matching all addresses in address lists
3638 2.2. Simple Searches
3640 Mutt supports two versions of so called ?simple searches?. These are issued if
3641 the query entered for searching, limiting and similar operations does not seem
3642 to contain a valid pattern modifier (i.e. it does not contain one of these
3643 characters: ???, ?=? or ?%?). If the query is supposed to contain one of these
3644 special characters, they must be escaped by prepending a backslash (?\?).
3646 The first type is by checking whether the query string equals a keyword
3647 case-insensitively from Table 4.5, ?Simple search keywords?: If that is the
3648 case, Mutt will use the shown pattern modifier instead. If a keyword would
3649 conflict with your search keyword, you need to turn it into a regular
3650 expression to avoid matching the keyword table. For example, if you want to
3651 find all messages matching ?flag? (using $simple_search) but don't want to
3652 match flagged messages, simply search for ?[f]lag?.
3654 Table 4.5. Simple search keywords
3656 +-------------------------+
3657 |Keyword|Pattern modifier |
3658 |-------+-----------------|
3660 |-------+-----------------|
3662 |-------+-----------------|
3664 |-------+-----------------|
3666 |-------+-----------------|
3668 |-------+-----------------|
3670 |-------+-----------------|
3672 |-------+-----------------|
3674 |-------+-----------------|
3676 |-------+-----------------|
3678 |-------+-----------------|
3680 +-------------------------+
3683 The second type of simple search is to build a complex search pattern using
3684 $simple_search as a template. Mutt will insert your query properly quoted and
3685 search for the composed complex query.
3687 2.3. Nesting and Boolean Operators
3689 Logical AND is performed by specifying more than one criterion. For example:
3693 would select messages which contain the word ?mutt? in the list of recipients
3694 and that have the word ?elkins? in the ?From? header field.
3696 Mutt also recognizes the following operators to create more complex search
3699 * ! ? logical NOT operator
3701 * | ? logical OR operator
3703 * () ? logical grouping operator
3705 Here is an example illustrating a complex search pattern. This pattern will
3706 select all messages which do not contain ?mutt? in the ?To? or ?Cc? field and
3707 which are from ?elkins?.
3709 Example 4.2. Using boolean operators in patterns
3711 !(~t mutt|~c mutt) ~f elkins
3714 Here is an example using white space in the regular expression (note the ' and
3715 " delimiters). For this to match, the mail's subject must match the ?^Junk
3716 +From +Me$? and it must be from either ?Jim +Somebody? or ?Ed +SomeoneElse?:
3718 '~s "^Junk +From +Me$" ~f ("Jim +Somebody"|"Ed +SomeoneElse")'
3722 If a regular expression contains parenthesis, or a vertical bar ("|"), you must
3723 enclose the expression in double or single quotes since those characters are
3724 also used to separate different parts of Mutt's pattern language. For example:
3725 ~f "me@(mutt\.org|cs\.hmc\.edu)" Without the quotes, the parenthesis wouldn't
3726 end. This would be separated to two OR'd patterns: ?f me@(mutt\.org and cs\.hmc
3727 \.edu). They are never what you want.
3729 2.4. Searching by Date
3731 Mutt supports two types of dates, absolute and relative.
3733 2.4.1. Absolute Dates
3735 Dates must be in DD/MM/YY format (month and year are optional, defaulting to
3736 the current month and year). An example of a valid range of dates is:
3738 Limit to messages matching: ~d 20/1/95-31/10
3740 If you omit the minimum (first) date, and just specify ?-DD/MM/YY?, all
3741 messages before the given date will be selected. If you omit the maximum
3742 (second) date, and specify ?DD/MM/YY-?, all messages after the given date will
3743 be selected. If you specify a single date with no dash (?-?), only messages
3744 sent on the given date will be selected.
3746 You can add error margins to absolute dates. An error margin is a sign (+ or
3747 -), followed by a digit, followed by one of the units in Table 4.6, ?Date
3748 units?. As a special case, you can replace the sign by a ?*? character, which
3749 is equivalent to giving identical plus and minus error margins.
3751 Table 4.6. Date units
3766 Example: To select any messages two weeks around January 15, 2001, you'd use
3767 the following pattern:
3769 Limit to messages matching: ~d 15/1/2001*2w
3771 2.4.2. Relative Dates
3773 This type of date is relative to the current date, and may be specified as:
3775 * >offset for messages older than offset units
3777 * <offset for messages newer than offset units
3779 * =offset for messages exactly offset units old
3781 offset is specified as a positive number with one of the units from Table 4.6,
3784 Example: to select messages less than 1 month old, you would use
3786 Limit to messages matching: ~d <1m
3790 All dates used when searching are relative to the local time zone, so unless
3791 you change the setting of your $index_format to include a %[...] format, these
3792 are not the dates shown in the main index.
3796 Sometimes it is desirable to perform an operation on a group of messages all at
3797 once rather than one at a time. An example might be to save messages to a
3798 mailing list to a separate folder, or to delete all messages with a given
3799 subject. To tag all messages matching a pattern, use the <tag-pattern>
3800 function, which is bound to ?shift-T? by default. Or you can select individual
3801 messages by hand using the <tag-message> function, which is bound to ?t? by
3802 default. See patterns for Mutt's pattern matching syntax.
3804 Once you have tagged the desired messages, you can use the ?tag-prefix?
3805 operator, which is the ?;? (semicolon) key by default. When the ?tag-prefix?
3806 operator is used, the next operation will be applied to all tagged messages if
3807 that operation can be used in that manner. If the $auto_tag variable is set,
3808 the next operation applies to the tagged messages automatically, without
3809 requiring the ?tag-prefix?.
3811 In macros or push commands, you can use the <tag-prefix-cond> operator. If
3812 there are no tagged messages, Mutt will ?eat? the rest of the macro to abort
3813 it's execution. Mutt will stop ?eating? the macro when it encounters the
3814 <end-cond> operator; after this operator the rest of the macro will be executed
3819 A hook is a concept found in many other programs which allows you to execute
3820 arbitrary commands before performing some operation. For example, you may wish
3821 to tailor your configuration based upon which mailbox you are reading, or to
3822 whom you are sending mail. In the Mutt world, a hook consists of a regular
3823 expression or pattern along with a configuration option/command. See:
3851 for specific details on each type of hook available.
3855 If a hook changes configuration settings, these changes remain effective until
3856 the end of the current Mutt session. As this is generally not desired, a
3857 ?default? hook needs to be added before all other hooks of that type to restore
3858 configuration defaults.
3860 Example 4.3. Specifying a ?default? hook
3862 send-hook . 'unmy_hdr From:'
3863 send-hook ~C'^b@b\.b$' my_hdr from: c@c.c
3866 In Example 4.3, ?Specifying a default hook?, by default the value of $from and
3867 $realname is not overridden. When sending messages either To: or Cc: to
3868 <b@b.b>, the From: header is changed to <c@c.c>.
3870 4.1. Message Matching in Hooks
3872 Hooks that act upon messages (message-hook, reply-hook, send-hook, send2-hook,
3873 save-hook, fcc-hook) are evaluated in a slightly different manner. For the
3874 other types of hooks, a regular expression is sufficient. But in dealing with
3875 messages a finer grain of control is needed for matching since for different
3876 purposes you want to match different criteria.
3878 Mutt allows the use of the search pattern language for matching messages in
3879 hook commands. This works in exactly the same way as it would when limiting or
3880 searching the mailbox, except that you are restricted to those operators which
3881 match information Mutt extracts from the header of the message (i.e., from, to,
3882 cc, date, subject, etc.).
3884 For example, if you wanted to set your return address based upon sending mail
3885 to a specific address, you could do something like:
3887 send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt User <user@host>'
3889 which would execute the given command when sending mail to me@cs.hmc.edu.
3891 However, it is not required that you write the pattern to match using the full
3892 searching language. You can still specify a simple regular expression like the
3893 other hooks, in which case Mutt will translate your pattern into the full
3894 language, using the translation specified by the $default_hook variable. The
3895 pattern is translated at the time the hook is declared, so the value of
3896 $default_hook that is in effect at that time will be used.
3898 5. External Address Queries
3900 Mutt supports connecting to external directory databases such as LDAP, ph/qi,
3901 bbdb, or NIS through a wrapper script which connects to Mutt using a simple
3902 interface. Using the $query_command variable, you specify the wrapper command
3903 to use. For example:
3905 set query_command = "mutt_ldap_query.pl '%s'"
3907 The wrapper script should accept the query on the command-line. It should
3908 return a one line message, then each matching response on a single line, each
3909 line containing a tab separated address then name then some other optional
3910 information. On error, or if there are no matching addresses, return a non-zero
3911 exit code and a one line error message.
3913 An example multiple response output:
3915 Searching database ... 20 entries ... 3 matching:
3916 me@cs.hmc.edu Michael Elkins mutt dude
3917 blong@fiction.net Brandon Long mutt and more
3918 roessler@does-not-exist.org Thomas Roessler mutt pgp
3920 There are two mechanisms for accessing the query function of Mutt. One is to do
3921 a query from the index menu using the <query> function (default: Q). This will
3922 prompt for a query, then bring up the query menu which will list the matching
3923 responses. From the query menu, you can select addresses to create aliases, or
3924 to mail. You can tag multiple addresses to mail, start a new query, or have a
3925 new query appended to the current responses.
3927 The other mechanism for accessing the query function is for address completion,
3928 similar to the alias completion. In any prompt for address entry, you can use
3929 the <complete-query> function (default: ^T) to run a query based on the current
3930 address you have typed. Like aliases, Mutt will look for what you have typed
3931 back to the last space or comma. If there is a single response for that query,
3932 Mutt will expand the address in place. If there are multiple responses, Mutt
3933 will activate the query menu. At the query menu, you can select one or more
3934 addresses to be added to the prompt.
3938 Mutt supports reading and writing of four different local mailbox formats:
3939 mbox, MMDF, MH and Maildir. The mailbox type is autodetected, so there is no
3940 need to use a flag for different mailbox types. When creating new mailboxes,
3941 Mutt uses the default specified with the $mbox_type variable. A short
3942 description of the formats follows.
3944 mbox. This is a widely used mailbox format for UNIX. All messages are stored in
3945 a single file. Each message has a line of the form:
3947 From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST
3949 to denote the start of a new message (this is often referred to as the ?From_?
3950 line). The mbox format requires mailbox locking, is prone to mailbox corruption
3951 with concurrently writing clients or misinterpreted From_ lines. Depending on
3952 the environment, new mail detection can be unreliable. Mbox folders are fast to
3953 open and easy to archive.
3955 MMDF. This is a variant of the mbox format. Each message is surrounded by lines
3956 containing ?^A^A^A^A? (four control-A's). The same problems as for mbox apply
3957 (also with finding the right message separator as four control-A's may appear
3960 MH. A radical departure from mbox and MMDF, a mailbox consists of a directory
3961 and each message is stored in a separate file. The filename indicates the
3962 message number (however, this is may not correspond to the message number Mutt
3963 displays). Deleted messages are renamed with a comma (?,?) prepended to the
3964 filename. Mutt detects this type of mailbox by looking for either .mh_sequences
3965 or .xmhcache files (needed to distinguish normal directories from MH
3966 mailboxes). MH is more robust with concurrent clients writing the mailbox, but
3967 still may suffer from lost flags; message corruption is less likely to occur
3968 than with mbox/mmdf. It's usually slower to open compared to mbox/mmdf since
3969 many small files have to be read (Mutt provides Section 7.1, ?Header Caching?
3970 to greatly speed this process up). Depending on the environment, MH is not very
3971 disk-space efficient.
3973 Maildir. The newest of the mailbox formats, used by the Qmail MTA (a
3974 replacement for sendmail). Similar to MH, except that it adds three
3975 subdirectories of the mailbox: tmp, new and cur. Filenames for the messages are
3976 chosen in such a way they are unique, even when two programs are writing the
3977 mailbox over NFS, which means that no file locking is needed and corruption is
3978 very unlikely. Maildir maybe slower to open without caching in Mutt, it too is
3979 not very disk-space efficient depending on the environment. Since no additional
3980 files are used for metadata (which is embedded in the message filenames) and
3981 Maildir is locking-free, it's easy to sync across different machines using
3982 file-level synchronization tools.
3984 7. Mailbox Shortcuts
3986 There are a number of built in shortcuts which refer to specific mailboxes.
3987 These shortcuts can be used anywhere you are prompted for a file or mailbox
3988 path or in path-related configuration variables. Note that these only work at
3989 the beginning of a string.
3991 * ! ? refers to your $spoolfile (incoming) mailbox
3993 * > ? refers to your $mbox file
3995 * < ? refers to your $record file
3997 * ^ ? refers to the current mailbox
3999 * - or !! ? refers to the file you've last visited
4001 * ? ? refers to your home directory
4003 * = or + ? refers to your $folder directory
4005 * @alias ? refers to the default save folder as determined by the address of
4008 For example, to store a copy of outgoing messages in the folder they were
4009 composed in, a folder-hook can be used to set $record:
4011 folder-hook . 'set record=^'
4013 8. Handling Mailing Lists
4015 Mutt has a few configuration options that make dealing with large amounts of
4016 mail easier. The first thing you must do is to let Mutt know what addresses you
4017 consider to be mailing lists (technically this does not have to be a mailing
4018 list, but that is what it is most often used for), and what lists you are
4019 subscribed to. This is accomplished through the use of the lists and subscribe
4020 commands in your .muttrc.
4022 Now that Mutt knows what your mailing lists are, it can do several things, the
4023 first of which is the ability to show the name of a list through which you
4024 received a message (i.e., of a subscribed list) in the index menu display. This
4025 is useful to distinguish between personal and list mail in the same mailbox. In
4026 the $index_format variable, the expando ?%L? will print the string ?To <list>?
4027 when ?list? appears in the ?To? field, and ?Cc <list>? when it appears in the
4028 ?Cc? field (otherwise it prints the name of the author).
4030 Often times the ?To? and ?Cc? fields in mailing list messages tend to get quite
4031 large. Most people do not bother to remove the author of the message they reply
4032 to from the list, resulting in two or more copies being sent to that person.
4033 The <list-reply> function, which by default is bound to ?L? in the index menu
4034 and pager, helps reduce the clutter by only replying to the known mailing list
4035 addresses instead of all recipients (except as specified by Mail-Followup-To,
4038 Mutt also supports the Mail-Followup-To header. When you send a message to a
4039 list of recipients which includes one or several subscribed mailing lists, and
4040 if the $followup_to option is set, Mutt will generate a Mail-Followup-To header
4041 which contains all the recipients to whom you send this message, but not your
4042 address. This indicates that group-replies or list-replies (also known as
4043 ?followups?) to this message should only be sent to the original recipients of
4044 the message, and not separately to you - you'll receive your copy through one
4045 of the mailing lists you are subscribed to.
4047 Conversely, when group-replying or list-replying to a message which has a
4048 Mail-Followup-To header, Mutt will respect this header if the
4049 $honor_followup_to configuration variable is set. Using list-reply will in this
4050 case also make sure that the reply goes to the mailing list, even if it's not
4051 specified in the list of recipients in the Mail-Followup-To.
4055 When header editing is enabled, you can create a Mail-Followup-To header
4056 manually. Mutt will only auto-generate this header if it doesn't exist when you
4059 The other method some mailing list admins use is to generate a ?Reply-To? field
4060 which points back to the mailing list address rather than the author of the
4061 message. This can create problems when trying to reply directly to the author
4062 in private, since most mail clients will automatically reply to the address
4063 given in the ?Reply-To? field. Mutt uses the $reply_to variable to help decide
4064 which address to use. If set to ask-yes or ask-no, you will be prompted as to
4065 whether or not you would like to use the address given in the ?Reply-To? field,
4066 or reply directly to the address given in the ?From? field. When set to yes,
4067 the ?Reply-To? field will be used when present.
4069 The ?X-Label:? header field can be used to further identify mailing lists or
4070 list subject matter (or just to annotate messages individually). The
4071 $index_format variable's ?%y? and ?%Y? expandos can be used to expand
4072 ?X-Label:? fields in the index, and Mutt's pattern-matcher can match regular
4073 expressions to ?X-Label:? fields with the ??y? selector. ?X-Label:? is not a
4074 standard message header field, but it can easily be inserted by procmail and
4075 other mail filtering agents.
4077 Lastly, Mutt has the ability to sort the mailbox into threads. A thread is a
4078 group of messages which all relate to the same subject. This is usually
4079 organized into a tree-like structure where a message and all of its replies are
4080 represented graphically. If you've ever used a threaded news client, this is
4081 the same concept. It makes dealing with large volume mailing lists easier
4082 because you can easily delete uninteresting threads and quickly find topics of
4085 9. Handling multiple folders
4087 Mutt supports setups with multiple folders, allowing all of them to be
4088 monitored for new mail (see Section 14, ?Monitoring Incoming Mail? for
4091 When in the index menu and being idle (also see $timeout), Mutt periodically
4092 checks for new mail in all folders which have been configured via the mailboxes
4093 command. The interval depends on the folder type: for local/IMAP folders it
4094 consults $mail_check and $pop_checkinterval for POP folders.
4096 Outside the index menu the directory browser supports checking for new mail
4097 using the <check-new> function which is unbound by default. Pressing TAB will
4098 bring up a menu showing the files specified by the mailboxes command, and
4099 indicate which contain new messages. Mutt will automatically enter this mode
4100 when invoked from the command line with the -y option.
4102 For the pager, index and directory browser menus, Mutt contains the
4103 <buffy-list> function (bound to ?.? by default) which will print a list of
4104 folders with new mail in the command line at the bottom of the screen.
4106 For the index, by default Mutt displays the number of mailboxes with new mail
4107 in the status bar, please refer to the $status_format variable for details.
4109 When changing folders, Mutt fills the prompt with the first folder from the
4110 mailboxes list containing new mail (if any), pressing space will cycle through
4111 folders with new mail.
4115 Mutt has the ability to dynamically restructure threads that are broken either
4116 by misconfigured software or bad behavior from some correspondents. This allows
4117 to clean your mailboxes from these annoyances which make it hard to follow a
4120 10.1. Linking Threads
4122 Some mailers tend to ?forget? to correctly set the ?In-Reply-To:? and
4123 ?References:? headers when replying to a message. This results in broken
4124 discussions because Mutt has not enough information to guess the correct
4125 threading. You can fix this by tagging the reply, then moving to the parent
4126 message and using the <link-threads> function (bound to & by default). The
4127 reply will then be connected to this parent message.
4129 You can also connect multiple children at once, tagging them and using the
4130 <tag-prefix> command (';') or the $auto_tag option.
4132 10.2. Breaking Threads
4134 On mailing lists, some people are in the bad habit of starting a new discussion
4135 by hitting ?reply? to any message from the list and changing the subject to a
4136 totally unrelated one. You can fix such threads by using the <break-thread>
4137 function (bound by default to #), which will turn the subthread starting from
4138 the current message into a whole different thread.
4140 11. Delivery Status Notification (DSN) Support
4142 RFC1894 defines a set of MIME content types for relaying information about the
4143 status of electronic mail messages. These can be thought of as ?return
4146 To support DSN, there are two variables. $dsn_notify is used to request
4147 receipts for different results (such as failed message, message delivered,
4148 etc.). $dsn_return requests how much of your message should be returned with
4149 the receipt (headers or full message).
4151 When using $sendmail for mail delivery, you need to use either Berkeley
4152 sendmail 8.8.x (or greater) a MTA supporting DSN command line options
4153 compatible to Sendmail: The -N and -R options can be used by the mail client to
4154 make requests as to what type of status messages should be returned. Please
4155 consider your MTA documentation whether DSN is supported.
4157 For SMTP delivery using $smtp_url, it depends on the capabilities announced by
4158 the server whether Mutt will attempt to request DSN or not.
4160 12. Start a WWW Browser on URLs
4162 If a message contains URLs, it is efficient to get a menu with all the URLs and
4163 start a WWW browser on one of them. This functionality is provided by the
4164 external urlview program which can be retrieved at ftp://ftp.mutt.org/mutt/
4165 contrib/ and the configuration commands:
4167 macro index \cb |urlview\n
4168 macro pager \cb |urlview\n
4172 This section documents various features that fit nowhere else.
4174 Address normalization
4176 Mutt normalizes all e-mail addresses to the simplest form possible. If an
4177 address contains a realname, the form Joe User <joe@example.com> is used
4178 and the pure e-mail address without angle brackets otherwise, i.e. just
4181 This normalization affects all headers Mutt generates including aliases.
4183 Initial folder selection
4185 The folder Mutt opens at startup is determined as follows: the folder
4186 specified in the $MAIL environment variable if present. Otherwise, the
4187 value of $MAILDIR is taken into account. If that isn't present either, Mutt
4188 takes the user's mailbox in the mailspool as determined at compile-time
4189 (which may also reside in the home directory). The $spoolfile setting
4190 overrides this selection. Highest priority has the mailbox given with the
4191 -f command line option.
4193 Chapter 5. Mutt's MIME Support
4197 1. Using MIME in Mutt
4199 1.1. Viewing MIME Messages in the Pager
4200 1.2. The Attachment Menu
4201 1.3. The Compose Menu
4203 2. MIME Type Configuration with mime.types
4204 3. MIME Viewer Configuration with Mailcap
4206 3.1. The Basics of the Mailcap File
4207 3.2. Secure Use of Mailcap
4208 3.3. Advanced Mailcap Usage
4209 3.4. Example Mailcap Files
4212 5. MIME Multipart/Alternative
4213 6. Attachment Searching and Counting
4216 Quite a bit of effort has been made to make Mutt the premier text-mode MIME
4217 MUA. Every effort has been made to provide the functionality that the
4218 discerning MIME user requires, and the conformance to the standards wherever
4219 possible. When configuring Mutt for MIME, there are two extra types of
4220 configuration files which Mutt uses. One is the mime.types file, which contains
4221 the mapping of file extensions to IANA MIME types. The other is the mailcap
4222 file, which specifies the external commands to use for handling specific MIME
4225 1. Using MIME in Mutt
4227 There are three areas/menus in Mutt which deal with MIME, they are the pager
4228 (while viewing a message), the attachment menu and the compose menu.
4230 1.1. Viewing MIME Messages in the Pager
4232 When you select a message from the index and view it in the pager, Mutt decodes
4233 the message to a text representation. Mutt internally supports a number of MIME
4234 types, including text/plain, text/enriched, message/rfc822, and message/news.
4235 In addition, the export controlled version of Mutt recognizes a variety of PGP
4236 MIME types, including PGP/MIME and application/pgp.
4238 Mutt will denote attachments with a couple lines describing them. These lines
4241 [-- Attachment #1: Description --]
4242 [-- Type: text/plain, Encoding: 7bit, Size: 10000 --]
4244 Where the Description is the description or filename given for the attachment,
4245 and the Encoding is one of 7bit/8bit/quoted-printable/base64/binary.
4247 If Mutt cannot deal with a MIME type, it will display a message like:
4249 [-- image/gif is unsupported (use 'v' to view this part) --]
4251 1.2. The Attachment Menu
4253 The default binding for <view-attachments> is ?v?, which displays the
4254 attachment menu for a message. The attachment menu displays a list of the
4255 attachments in a message. From the attachment menu, you can save, print, pipe,
4256 delete, and view attachments. You can apply these operations to a group of
4257 attachments at once, by tagging the attachments and by using the <tag-prefix>
4258 operator. You can also reply to the current message from this menu, and only
4259 the current attachment (or the attachments tagged) will be quoted in your
4260 reply. You can view attachments as text, or view them using the mailcap viewer
4263 Finally, you can apply the usual message-related functions (like
4264 <resend-message>, and the <reply> and <forward> functions) to attachments of
4265 type message/rfc822.
4267 See the help on the attachment menu for more information.
4269 1.3. The Compose Menu
4271 The compose menu is the menu you see before you send a message. It allows you
4272 to edit the recipient list, the subject, and other aspects of your message. It
4273 also contains a list of the attachments of your message, including the main
4274 body. From this menu, you can print, copy, filter, pipe, edit, compose, review,
4275 and rename an attachment or a list of tagged attachments. You can also
4276 modifying the attachment information, notably the type, encoding and
4279 Attachments appear as follows:
4281 - 1 [text/plain, 7bit, 1K] /tmp/mutt-euler-8082-0 <no description>
4282 2 [applica/x-gunzip, base64, 422K] ~/src/mutt-0.85.tar.gz <no description>
4284 The '-' denotes that Mutt will delete the file after sending (or postponing, or
4285 canceling) the message. It can be toggled with the <toggle-unlink> command
4286 (default: u). The next field is the MIME content-type, and can be changed with
4287 the <edit-type> command (default: ^T). The next field is the encoding for the
4288 attachment, which allows a binary message to be encoded for transmission on
4289 7bit links. It can be changed with the <edit-encoding> command (default: ^E).
4290 The next field is the size of the attachment, rounded to kilobytes or
4291 megabytes. The next field is the filename, which can be changed with the
4292 <rename-file> command (default: R). The final field is the description of the
4293 attachment, and can be changed with the <edit-description> command (default:
4296 2. MIME Type Configuration with mime.types
4298 When you add an attachment to your mail message, Mutt searches your personal
4299 mime.types file at ${HOME}/.mime.types, and then the system mime.types file at
4300 /usr/local/share/mutt/mime.types or /etc/mime.types
4302 The mime.types file consist of lines containing a MIME type and a space
4303 separated list of extensions. For example:
4305 application/postscript ps eps
4307 audio/x-aiff aif aifc aiff
4309 A sample mime.types file comes with the Mutt distribution, and should contain
4310 most of the MIME types you are likely to use.
4312 If Mutt can not determine the mime type by the extension of the file you
4313 attach, it will look at the file. If the file is free of binary information,
4314 Mutt will assume that the file is plain text, and mark it as text/plain. If the
4315 file contains binary information, then Mutt will mark it as application/
4316 octet-stream. You can change the MIME type that Mutt assigns to an attachment
4317 by using the <edit-type> command from the compose menu (default: ^T). The MIME
4318 type is actually a major mime type followed by the sub-type, separated by a '/
4319 '. 6 major types: application, text, image, video, audio, and model have been
4320 approved after various internet discussions. Mutt recognizes all of these if
4321 the appropriate entry is found in the mime.types file. It also recognizes other
4322 major mime types, such as the chemical type that is widely used in the
4323 molecular modeling community to pass molecular data in various forms to various
4324 molecular viewers. Non-recognized mime types should only be used if the
4325 recipient of the message is likely to be expecting such attachments.
4327 3. MIME Viewer Configuration with Mailcap
4329 Mutt supports RFC 1524 MIME Configuration, in particular the Unix specific
4330 format specified in Appendix A of RFC 1524. This file format is commonly
4331 referred to as the mailcap format. Many MIME compliant programs utilize the
4332 mailcap format, allowing you to specify handling for all MIME types in one
4333 place for all programs. Programs known to use this format include Firefox, lynx
4336 In order to handle various MIME types that Mutt can not handle internally, Mutt
4337 parses a series of external configuration files to find an external handler.
4338 The default search string for these files is a colon delimited list containing
4339 the following files:
4343 2. $PKGDATADIR/mailcap
4345 3. $SYSCONFDIR/mailcap
4351 6. /usr/local/etc/mailcap
4353 where $HOME is your home directory. The $PKGDATADIR and the $SYSCONFDIR
4354 directories depend on where Mutt is installed: the former is the default for
4355 shared data, the latter for system configuration files.
4357 The default search path can be obtained by running the following command:
4359 mutt -nF /dev/null -Q mailcap_path
4361 In particular, the metamail distribution will install a mailcap file, usually
4362 as /usr/local/etc/mailcap, which contains some baseline entries.
4364 3.1. The Basics of the Mailcap File
4366 A mailcap file consists of a series of lines which are comments, blank, or
4369 A comment line consists of a # character followed by anything you want.
4371 A blank line is blank.
4373 A definition line consists of a content type, a view command, and any number of
4374 optional fields. Each field of a definition line is divided by a semicolon ';'
4377 The content type is specified in the MIME standard type/subtype method. For
4378 example, text/plain, text/html, image/gif, etc. In addition, the mailcap format
4379 includes two formats for wildcards, one using the special '*' subtype, the
4380 other is the implicit wild, where you only include the major type. For example,
4381 image/*, or video, will match all image types and video types, respectively.
4383 The view command is a Unix command for viewing the type specified. There are
4384 two different types of commands supported. The default is to send the body of
4385 the MIME message to the command on stdin. You can change this behavior by using
4386 %s as a parameter to your view command. This will cause Mutt to save the body
4387 of the MIME message to a temporary file, and then call the view command with
4388 the %s replaced by the name of the temporary file. In both cases, Mutt will
4389 turn over the terminal to the view program until the program quits, at which
4390 time Mutt will remove the temporary file if it exists.
4392 So, in the simplest form, you can send a text/plain message to the external
4393 pager more on stdin:
4397 Or, you could send the message as a file:
4401 Perhaps you would like to use lynx to interactively view a text/html message:
4405 In this case, lynx does not support viewing a file from stdin, so you must use
4410 Some older versions of lynx contain a bug where they will check the mailcap
4411 file for a viewer for text/html. They will find the line which calls lynx, and
4412 run it. This causes lynx to continuously spawn itself to view the object.
4414 On the other hand, maybe you don't want to use lynx interactively, you just
4415 want to have it convert the text/html to text/plain, then you can use:
4417 text/html; lynx -dump %s | more
4419 Perhaps you wish to use lynx to view text/html files, and a pager on all other
4420 text formats, then you would use the following:
4425 This is the simplest form of a mailcap file.
4427 3.2. Secure Use of Mailcap
4429 The interpretation of shell meta-characters embedded in MIME parameters can
4430 lead to security problems in general. Mutt tries to quote parameters in
4431 expansion of %s syntaxes properly, and avoids risky characters by substituting
4432 them, see the $mailcap_sanitize variable.
4434 Although Mutt's procedures to invoke programs with mailcap seem to be safe,
4435 there are other applications parsing mailcap, maybe taking less care of it.
4436 Therefore you should pay attention to the following rules:
4438 Keep the %-expandos away from shell quoting. Don't quote them with single or
4439 double quotes. Mutt does this for you, the right way, as should any other
4440 program which interprets mailcap. Don't put them into backtick expansions. Be
4441 highly careful with eval statements, and avoid them if possible at all. Trying
4442 to fix broken behavior with quotes introduces new leaks - there is no
4443 alternative to correct quoting in the first place.
4445 If you have to use the %-expandos' values in context where you need quoting or
4446 backtick expansions, put that value into a shell variable and reference the
4447 shell variable where necessary, as in the following example (using $charset
4448 inside the backtick expansion is safe, since it is not itself subject to any
4451 text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \
4452 && test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1
4454 3.3. Advanced Mailcap Usage
4456 3.3.1. Optional Fields
4458 In addition to the required content-type and view command fields, you can add
4459 semi-colon ';' separated fields to set flags and other options. Mutt recognizes
4460 the following optional fields:
4464 This flag tells Mutt that the command passes possibly large amounts of text
4465 on stdout. This causes Mutt to invoke a pager (either the internal pager or
4466 the external pager defined by the pager variable) on the output of the view
4467 command. Without this flag, Mutt assumes that the command is interactive.
4468 One could use this to replace the pipe to more in the lynx -dump example in
4471 text/html; lynx -dump %s ; copiousoutput
4473 This will cause lynx to format the text/html output as text/plain and Mutt
4474 will use your standard pager to display the results.
4478 Mutt uses this flag when viewing attachments with auto_view, in order to
4479 decide whether it should honor the setting of the $wait_key variable or
4480 not. When an attachment is viewed using an interactive program, and the
4481 corresponding mailcap entry has a needsterminal flag, Mutt will use
4482 $wait_key and the exit status of the program to decide if it will ask you
4483 to press a key after the external program has exited. In all other
4484 situations it will not prompt you for a key.
4488 This flag specifies the command to use to create a new attachment of a
4489 specific MIME type. Mutt supports this from the compose menu.
4491 composetyped=<command>
4493 This flag specifies the command to use to create a new attachment of a
4494 specific MIME type. This command differs from the compose command in that
4495 Mutt will expect standard MIME headers on the data. This can be used to
4496 specify parameters, filename, description, etc. for a new attachment. Mutt
4497 supports this from the compose menu.
4501 This flag specifies the command to use to print a specific MIME type. Mutt
4502 supports this from the attachment and compose menus.
4506 This flag specifies the command to use to edit a specific MIME type. Mutt
4507 supports this from the compose menu, and also uses it to compose new
4508 attachments. Mutt will default to the defined editor for text attachments.
4510 nametemplate=<template>
4512 This field specifies the format for the file denoted by %s in the command
4513 fields. Certain programs will require a certain file extension, for
4514 instance, to correctly view a file. For instance, lynx will only interpret
4515 a file as text/html if the file ends in .html. So, you would specify lynx
4516 as a text/html viewer with a line in the mailcap file like:
4518 text/html; lynx %s; nametemplate=%s.html
4522 This field specifies a command to run to test whether this mailcap entry
4523 should be used. The command is defined with the command expansion rules
4524 defined in the next section. If the command returns 0, then the test
4525 passed, and Mutt uses this entry. If the command returns non-zero, then the
4526 test failed, and Mutt continues searching for the right entry. Note that
4527 the content-type must match before Mutt performs the test. For example:
4529 text/html; firefox -remote 'openURL(%s)' ; test=RunningX
4532 In this example, Mutt will run the program RunningX which will return 0 if
4533 the X Window manager is running, and non-zero if it isn't. If RunningX
4534 returns 0, then Mutt will call firefox to display the text/html object. If
4535 RunningX doesn't return 0, then Mutt will go on to the next entry and use
4536 lynx to display the text/html object.
4540 When searching for an entry in the mailcap file, Mutt will search for the most
4541 useful entry for its purpose. For instance, if you are attempting to print an
4542 image/gif, and you have the following entries in your mailcap file, Mutt will
4543 search for an entry with the print command:
4546 image/gif; ; print= anytopnm %s | pnmtops | lpr; \
4549 Mutt will skip the image/* entry and use the image/gif entry with the print
4552 In addition, you can use this with auto_view to denote two commands for viewing
4553 an attachment, one to be viewed automatically, the other to be viewed
4554 interactively from the attachment menu. In addition, you can then use the test
4555 feature to determine which viewer to use interactively depending on your
4558 text/html; firefox -remote 'openURL(%s)' ; test=RunningX
4559 text/html; lynx %s; nametemplate=%s.html
4560 text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput
4562 For auto_view, Mutt will choose the third entry because of the copiousoutput
4563 tag. For interactive viewing, Mutt will run the program RunningX to determine
4564 if it should use the first entry. If the program returns non-zero, Mutt will
4565 use the second entry for interactive viewing.
4567 3.3.3. Command Expansion
4569 The various commands defined in the mailcap files are passed to the /bin/sh
4570 shell using the system(3) function. Before the command is passed to /bin/sh -c,
4571 it is parsed to expand various special parameters with information from Mutt.
4572 The keywords Mutt expands are:
4576 As seen in the basic mailcap section, this variable is expanded to a
4577 filename specified by the calling program. This file contains the body of
4578 the message to view/print/edit or where the composing program should place
4579 the results of composition. In addition, the use of this keyword causes
4580 Mutt to not pass the body of the message to the view/print/edit program on
4585 Mutt will expand %t to the text representation of the content type of the
4586 message in the same form as the first parameter of the mailcap definition
4587 line, ie text/html or image/gif.
4591 Mutt will expand this to the value of the specified parameter from the
4592 Content-Type: line of the mail message. For instance, if Your mail message
4595 Content-Type: text/plain; charset=iso-8859-1
4597 then Mutt will expand %{charset} to iso-8859-1. The default metamail
4598 mailcap file uses this feature to test the charset to spawn an xterm using
4599 the right charset to view the message.
4603 This will be replaced by a %
4605 Mutt does not currently support the %F and %n keywords specified in RFC 1524.
4606 The main purpose of these parameters is for multipart messages, which is
4607 handled internally by Mutt.
4609 3.4. Example Mailcap Files
4611 This mailcap file is fairly simple and standard:
4613 # I'm always running X :)
4614 video/*; xanim %s > /dev/null
4615 image/*; xv %s > /dev/null
4617 # I'm always running firefox (if my computer had more memory, maybe)
4618 text/html; firefox -remote 'openURL(%s)'
4620 This mailcap file shows quite a number of examples:
4622 # Use xanim to view all videos Xanim produces a header on startup,
4623 # send that to /dev/null so I don't see it
4624 video/*; xanim %s > /dev/null
4626 # Send html to a running firefox by remote
4627 text/html; firefox -remote 'openURL(%s)'; test=RunningFirefox
4629 # If I'm not running firefox but I am running X, start firefox on the
4631 text/html; firefox %s; test=RunningX
4633 # Else use lynx to view it as text
4636 # This version would convert the text/html to text/plain
4637 text/html; lynx -dump %s; copiousoutput
4639 # I use enscript to print text in two columns to a page
4640 text/*; more %s; print=enscript -2Gr %s
4642 # Firefox adds a flag to tell itself to view jpegs internally
4643 image/jpeg;xv %s; x-mozilla-flags=internal
4645 # Use xv to view images if I'm running X
4646 # In addition, this uses the \ to extend the line and set my editor
4648 image/*;xv %s; test=RunningX; \
4651 # Convert images to text using the netpbm tools
4652 image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm |
4653 pbmtoascii -1x2 ) 2>&1 ; copiousoutput
4655 # Send excel spreadsheets to my NT box
4656 application/ms-excel; open.pl %s
4662 auto-view mimetype [ mimetype ...]
4663 unauto-view { * | mimetype ... }
4665 In addition to explicitly telling Mutt to view an attachment with the MIME
4666 viewer defined in the mailcap file, Mutt has support for automatically viewing
4667 MIME attachments while in the pager.
4669 To work, you must define a viewer in the mailcap file which uses the
4670 copiousoutput option to denote that it is non-interactive. Usually, you also
4671 use the entry to convert the attachment to a text representation which you can
4674 You then use the auto_view .muttrc command to list the content-types that you
4675 wish to view automatically. For instance, if you set it to:
4677 auto_view text/html application/x-gunzip \
4678 application/postscript image/gif application/x-tar-gz
4680 Mutt could use the following mailcap entries to automatically view attachments
4683 text/html; lynx -dump %s; copiousoutput; nametemplate=%s.html
4684 image/*; anytopnm %s | pnmscale -xsize 80 -ysize 50 | ppmtopgm | \
4685 pgmtopbm | pbmtoascii ; copiousoutput
4686 application/x-gunzip; gzcat; copiousoutput
4687 application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput
4688 application/postscript; ps2ascii %s; copiousoutput
4690 unauto_view can be used to remove previous entries from the autoview list. This
4691 can be used with message-hook to autoview messages based on size, etc. ?
4692 unauto_view *? will remove all previous entries.
4694 5. MIME Multipart/Alternative
4696 Mutt has some heuristics for determining which attachment of a multipart/
4697 alternative type to display. First, Mutt will check the alternative_order list
4698 to determine if one of the available types is preferred. It consists of a
4699 number of mimetypes in order, including support for implicit and explicit
4700 wildcards, for example:
4702 alternative_order text/enriched text/plain text application/postscript image/*
4704 Next, Mutt will check if any of the types have a defined auto_view, and use
4705 that. Failing that, Mutt will look for any text type. As a last attempt, Mutt
4706 will look for any type it knows how to handle.
4708 To remove a MIME type from the alternative_order list, use the
4709 unalternative_order command.
4711 6. Attachment Searching and Counting
4713 If you ever lose track of attachments in your mailboxes, Mutt's
4714 attachment-counting and -searching support might be for you. You can make your
4715 message index display the number of qualifying attachments in each message, or
4716 search for messages by attachment count. You also can configure what kinds of
4717 attachments qualify for this feature with the attachments and unattachments
4720 In order to provide this information, Mutt needs to fully MIME-parse all
4721 messages affected first. This can slow down operation especially for remote
4722 mail folders such as IMAP because all messages have to be downloaded first
4723 regardless whether the user really wants to view them or not.
4727 attachments { + | - }disposition mime-type
4728 unattachments { + | - }disposition mime-type
4731 disposition is the attachment's Content-Disposition type ? either inline or
4732 attachment. You can abbreviate this to I or A.
4734 Disposition is prefixed by either a + symbol or a - symbol. If it's a +, you're
4735 saying that you want to allow this disposition and MIME type to qualify. If
4736 it's a -, you're saying that this disposition and MIME type is an exception to
4737 previous + rules. There are examples below of how this is useful.
4739 mime-type is, unsurprisingly, the MIME type of the attachment you want to
4740 affect. A MIME type is always of the format major/minor, where major describes
4741 the broad category of document you're looking at, and minor describes the
4742 specific type within that category. The major part of mime-type must be literal
4743 text (or the special token ?*?), but the minor part may be a regular
4744 expression. (Therefore, ?*/.*? matches any MIME type.)
4746 The MIME types you give to the attachments directive are a kind of pattern.
4747 When you use the attachments directive, the patterns you specify are added to a
4748 list. When you use unattachments, the pattern is removed from the list. The
4749 patterns are not expanded and matched to specific MIME types at this time ?
4750 they're just text in a list. They're only matched when actually evaluating a
4753 Some examples might help to illustrate. The examples that are not commented out
4754 define the default configuration of the lists.
4756 Example 5.1. Attachment counting
4758 ## Removing a pattern from a list removes that pattern literally. It
4759 ## does not remove any type matching the pattern.
4761 ## attachments +A */.*
4762 ## attachments +A image/jpeg
4763 ## unattachments +A */.*
4765 ## This leaves "attached" image/jpeg files on the allowed attachments
4766 ## list. It does not remove all items, as you might expect, because the
4767 ## second */.* is not a matching expression at this time.
4769 ## Remember: "unattachments" only undoes what "attachments" has done!
4770 ## It does not trigger any matching on actual messages.
4773 ## Qualify any MIME part with an "attachment" disposition, EXCEPT for
4774 ## text/x-vcard and application/pgp parts. (PGP parts are already known
4775 ## to mutt, and can be searched for with ~g, ~G, and ~k.)
4777 ## I've added x-pkcs7 to this, since it functions (for S/MIME)
4778 ## analogously to PGP signature attachments. S/MIME isn't supported
4779 ## in a stock mutt build, but we can still treat it specially here.
4782 attachments -A text/x-vcard application/pgp.*
4783 attachments -A application/x-pkcs7-.*
4785 ## Discount all MIME parts with an "inline" disposition, unless they're
4786 ## text/plain. (Why inline a text/plain part unless it's external to the
4789 attachments +I text/plain
4791 ## These two lines make Mutt qualify MIME containers. (So, for example,
4792 ## a message/rfc822 forward will count as an attachment.) The first
4793 ## line is unnecessary if you already have "attach-allow */.*", of
4794 ## course. These are off by default! The MIME elements contained
4795 ## within a message/* or multipart/* are still examined, even if the
4796 ## containers themseves don't qualify.
4798 #attachments +A message/.* multipart/.*
4799 #attachments +I message/.* multipart/.*
4801 ## You probably don't really care to know about deleted attachments.
4802 attachments -A message/external-body
4803 attachments -I message/external-body
4806 Entering the command ?attachments ?? as a command will list your current
4807 settings in Muttrc format, so that it can be pasted elsewhere.
4813 mime-lookup mimetype [ mimetype ...]
4814 unmime-lookup { * | mimetype ... }
4816 Mutt's mime_lookup list specifies a list of mime-types that should not be
4817 treated according to their mailcap entry. This option is designed to deal with
4818 binary types such as application/octet-stream. When an attachment's mime-type
4819 is listed in mime_lookup, then the extension of the filename will be compared
4820 to the list of extensions in the mime.types file. The mime-type associated with
4821 this extension will then be used to process the attachment according to the
4822 rules in the mailcap file and according to any other configuration options
4823 (such as auto_view) specified. Common usage would be:
4825 mime_lookup application/octet-stream application/X-Lotus-Manuscript
4827 In addition, the unmime_lookup command may be used to disable this feature for
4828 any particular mime-type if it had been set, for example, in a global .muttrc.
4830 Chapter 6. Optional Features
4836 1.1. Enabling/Disabling Features
4843 4.1. The IMAP Folder Browser
4847 6. Managing Multiple Accounts
4854 8. Exact Address Generation
4855 9. Sending Anonymous Messages via Mixmaster
4859 1.1. Enabling/Disabling Features
4861 Mutt supports several of optional features which can be enabled or disabled at
4862 compile-time by giving the configure script certain arguments. These are listed
4863 in the ?Optional features? section of the configure --help output.
4865 Which features are enabled or disabled can later be determined from the output
4866 of mutt -v. If a compile option starts with ?+? it is enabled and disabled if
4867 prefixed with ?-?. For example, if Mutt was compiled using GnuTLS for encrypted
4868 communication instead of OpenSSL, mutt -v would contain:
4870 -USE_SSL_OPENSSL +USE_SSL_GNUTLS
4874 Mutt optionally supports the IMAP, POP3 and SMTP protocols which require to
4875 access servers using URLs. The canonical syntax for specifying URLs in Mutt is
4876 (an item enclosed in [] means it is optional and may be omitted):
4878 proto[s]://[username[:password]@]server[:port]/[path]
4880 proto is the communication protocol: imap for IMAP, pop for POP3 and smtp for
4881 SMTP. If ?s? for ?secure communication? is appended, Mutt will attempt to
4882 establish an encrypted communication using SSL or TLS.
4884 Since all protocols supported by Mutt support/require authentication, login
4885 credentials may be specified in the URL. This has the advantage that multiple
4886 IMAP, POP3 or SMTP servers may be specified (which isn't possible using, for
4887 example, $imap_user). The username may contain the ?@? symbol being used by
4888 many mail systems as part of the login name. A password can be given, too but
4889 is not recommended if the URL is specified in a configuration file on disk.
4891 If no port number is given, Mutt will use the system's default for the given
4892 protocol (usually consulting /etc/services).
4894 The optional path is only relevant for IMAP.
4899 imaps://user@host/INBOX/Sent
4900 smtp://user@host:587/
4905 If Mutt is compiled with IMAP, POP3 and/or SMTP support, it can also be
4906 compiled with support for SSL or TLS using either OpenSSL or GnuTLS ( by
4907 running the configure script with the --enable-ssl=... option for OpenSSL or
4908 --enable-gnutls=... for GnuTLS). Mutt can then attempt to encrypt communication
4909 with remote servers if these protocols are suffixed with ?s? for ?secure
4914 If Mutt is compiled with POP3 support (by running the configure script with the
4915 --enable-pop flag), it has the ability to work with mailboxes located on a
4916 remote POP3 server and fetch mail for local browsing.
4918 Remote POP3 servers can be accessed using URLs with the pop protocol for
4919 unencrypted and pops for encrypted communication, see Section 1.2, ?URL Syntax?
4922 Polling for new mail is more expensive over POP3 than locally. For this reason
4923 the frequency at which Mutt will check for mail remotely can be controlled by
4924 the $pop_checkinterval variable, which defaults to every 60 seconds.
4926 POP is read-only which doesn't allow for some features like editing messages or
4927 changing flags. However, using Section 7.1, ?Header Caching? and Section 7.2,
4928 ?Body Caching? Mutt simulates the new/old/read flags as well as flagged and
4929 replied. Mutt applies some logic on top of remote messages but cannot change
4930 them so that modifications of flags are lost when messages are downloaded from
4931 the POP server (either by Mutt or other tools).
4933 Another way to access your POP3 mail is the <fetch-mail> function (default: G).
4934 It allows to connect to $pop_host, fetch all your new mail and place it in the
4935 local $spoolfile. After this point, Mutt runs exactly as if the mail had always
4940 If you only need to fetch all messages to a local mailbox you should consider
4941 using a specialized program, such as fetchmail(1), getmail(1) or similar.
4945 If Mutt was compiled with IMAP support (by running the configure script with
4946 the --enable-imap flag), it has the ability to work with folders located on a
4949 You can access the remote inbox by selecting the folder by its URL (see
4950 Section 1.2, ?URL Syntax? for details) using the imap or imaps protocol.
4951 Alternatively, a pine-compatible notation is also supported, ie {[username@]
4952 imapserver[:port][/ssl]}path/to/folder
4954 Note that not all servers use ?/? as the hierarchy separator. Mutt should
4955 correctly notice which separator is being used by the server and convert paths
4958 When browsing folders on an IMAP server, you can toggle whether to look at only
4959 the folders you are subscribed to, or all folders with the toggle-subscribed
4960 command. See also the $imap_list_subscribed variable.
4962 Polling for new mail on an IMAP server can cause noticeable delays. So, you'll
4963 want to carefully tune the $mail_check and $timeout variables. Reasonable
4969 with relatively good results even over slow modem lines.
4973 Note that if you are using mbox as the mail store on UW servers prior to
4974 v12.250, the server has been reported to disconnect a client if another client
4975 selects the same folder.
4977 4.1. The IMAP Folder Browser
4979 As of version 1.2, Mutt supports browsing mailboxes on an IMAP server. This is
4980 mostly the same as the local file browser, with the following differences:
4982 * In lieu of file permissions, Mutt displays the string ?IMAP?, possibly
4983 followed by the symbol ?+?, indicating that the entry contains both
4984 messages and subfolders. On Cyrus-like servers folders will often contain
4985 both messages and subfolders.
4987 * For the case where an entry can contain both messages and subfolders, the
4988 selection key (bound to enter by default) will choose to descend into the
4989 subfolder view. If you wish to view the messages in that folder, you must
4990 use view-file instead (bound to space by default).
4992 * You can create, delete and rename mailboxes with the <create-mailbox>,
4993 <delete-mailbox>, and <rename-mailbox> commands (default bindings: C, d and
4994 r, respectively). You may also <subscribe> and <unsubscribe> to mailboxes
4995 (normally these are bound to s and u, respectively).
4999 Mutt supports four authentication methods with IMAP servers: SASL, GSSAPI,
5000 CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add NTLM
5001 authentication for you poor exchange users out there, but it has yet to be
5002 integrated into the main tree). There is also support for the pseudo-protocol
5003 ANONYMOUS, which allows you to log in to a public IMAP server without having an
5004 account. To use ANONYMOUS, simply make your username blank or ?anonymous?.
5006 SASL is a special super-authenticator, which selects among several protocols
5007 (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the most secure method
5008 available on your host and the server. Using some of these methods (including
5009 DIGEST-MD5 and possibly GSSAPI), your entire session will be encrypted and
5010 invisible to those teeming network snoops. It is the best option if you have
5011 it. To use it, you must have the Cyrus SASL library installed on your system
5012 and compile Mutt with the --with-sasl flag.
5014 Mutt will try whichever methods are compiled in and available on the server, in
5015 the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, LOGIN.
5017 There are a few variables which control authentication:
5019 * $imap_user - controls the username under which you request authentication
5020 on the IMAP server, for all authenticators. This is overridden by an
5021 explicit username in the mailbox path (ie by using a mailbox name of the
5024 * $imap_pass - a password which you may preset, used by all authentication
5025 methods where a password is needed.
5027 * $imap_authenticators - a colon-delimited list of IMAP authentication
5028 methods to try, in the order you wish to try them. If specified, this
5029 overrides Mutt's default (attempt everything, in the order listed above).
5033 Besides supporting traditional mail delivery through a sendmail-compatible
5034 program, Mutt supports delivery through SMTP if it was configured and built
5037 If the configuration variable $smtp_url is set, Mutt will contact the given
5038 SMTP server to deliver messages; if it is unset, Mutt will use the program
5039 specified by $sendmail.
5041 For details on the URL syntax, please see Section 1.2, ?URL Syntax?.
5043 The built-in SMTP support supports encryption (the smtps protocol using SSL or
5044 TLS) as well as SMTP authentication using SASL. The authentication mechanisms
5045 for SASL are specified in $smtp_authenticators defaulting to an empty list
5046 which makes Mutt try all available methods from most-secure to least-secure.
5048 6. Managing Multiple Accounts
5052 account-hook pattern command
5054 If you happen to have accounts on multiple IMAP, POP and/or SMTP servers, you
5055 may find managing all the authentication settings inconvenient and error-prone.
5056 The account-hook command may help. This hook works like folder-hook but is
5057 invoked whenever Mutt needs to access a remote mailbox (including inside the
5058 folder browser), not just when you open the mailbox. This includes (for
5059 example) polling for new mail, storing Fcc messages and saving messages to a
5060 folder. As a consequence, account-hook should only be used to set
5061 connection-related settings such as passwords or tunnel commands but not
5062 settings such as sender address or name (because in general it should be
5063 considered unpredictable which account-hook was last used).
5067 account-hook . 'unset imap_user; unset imap_pass; unset tunnel'
5068 account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo'
5069 account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'
5070 account-hook smtp://user@host3/ 'set tunnel="ssh host3 /usr/libexec/smtpd"'
5072 To manage multiple accounts with, for example, different values of $record or
5073 sender addresses, folder-hook has to be be used together with the mailboxes
5076 Example 6.2. Managing multiple accounts
5078 mailboxes imap://user@host1/INBOX
5079 folder-hook imap://user@host1/ 'set folder=imap://host1/ ; set record=+INBOX/Sent'
5081 mailboxes imap://user@host2/INBOX
5082 folder-hook imap://user@host2/ 'set folder=imap://host2/ ; set record=+INBOX/Sent'
5085 In example Example 6.2, ?Managing multiple accounts? the folders are defined
5086 using mailboxes so Mutt polls them for new mail. Each folder-hook triggers when
5087 one mailbox below each IMAP account is opened and sets $folder to the account's
5088 root folder. Next, it sets $record to the INBOX/Sent folder below the newly set
5089 $folder. Please notice that the value the ?+? mailbox shortcut refers to
5090 depends on the current value of $folder and therefore has to be set separatedly
5091 per account. Setting other values like $from or $signature is analogous to
5096 Mutt contains two types of local caching: (1) the so-called ?header caching?
5097 and (2) the so-called ?body caching? which are both described in this section.
5099 Header caching is optional as it depends on external libraries, body caching is
5100 always enabled if Mutt is compiled with POP and/or IMAP support as these use it
5101 (body caching requires no external library).
5105 Mutt provides optional support for caching message headers for the following
5106 types of folders: IMAP, POP, Maildir and MH. Header caching greatly improves
5107 speed because for remote folders, headers usually only need to be downloaded
5108 once. For Maildir and MH, reading the headers from a single file is much faster
5109 than looking at possibly thousands of single files (since Maildir and MH use
5110 one file per message.)
5112 Header caching can be enabled via the configure script and the --enable-hcache
5113 option. It's not turned on by default because external database libraries are
5114 required: one of tokyocabinet, qdbm, gdbm or bdb must be present.
5116 If enabled, $header_cache can be used to either point to a file or a directory.
5117 If set to point to a file, one database file for all folders will be used
5118 (which may result in lower performance), but one file per folder if it points
5123 Both cache methods can be combined using the same directory for storage (and
5124 for IMAP/POP even provide meaningful file names) which simplifies manual
5127 In addition to caching message headers only, Mutt can also cache whole message
5128 bodies. This results in faster display of messages for POP and IMAP folders
5129 because messages usually have to be downloaded only once.
5131 For configuration, the variable $message_cachedir must point to a directory.
5132 There, Mutt will create a hierarchy of subdirectories named like:
5133 proto:user@hostname where proto is either ?pop? or ?imap.? Within there for
5134 each folder, Mutt stores messages in single files. All files can be removed as
5135 needed if the consumed disk space becomes an issue as Mutt will silently fetch
5136 missing items again.
5140 Mutt does not (yet) support maintenance features for header cache database
5141 files so that files have to be removed in case they grow too big. It depends on
5142 the database library used for header caching whether disk space freed by
5143 removing messages is re-used.
5145 For body caches, Mutt can keep the local cache in sync with the remote mailbox
5146 if the $message_cache_clean variable is set. Cleaning means to remove messages
5147 from the cache which are no longer present in the mailbox which only happens
5148 when other mail clients or instances of Mutt using a different body cache
5149 location delete messages (Mutt itself removes deleted messages from the cache
5150 when syncing a mailbox). As cleaning can take a noticeable amount of time, it
5151 should not be set in general but only occasionally.
5153 8. Exact Address Generation
5155 Mutt supports the ?Name <user@host>? address syntax for reading and writing
5156 messages, the older ?user@host (Name)? syntax is only supported when reading
5157 messages. The --enable-exact-address switch can be given to configure to build
5158 it with write-support for the latter syntax. EXACT_ADDRESS in the output of
5159 mutt -v indicates whether it's supported.
5161 9. Sending Anonymous Messages via Mixmaster
5163 You may also have compiled Mutt to co-operate with Mixmaster, an anonymous
5164 remailer. Mixmaster permits you to send your messages anonymously using a chain
5165 of remailers. Mixmaster support in Mutt is for mixmaster version 2.04 (beta 45
5166 appears to be the latest) and 2.03. It does not support earlier versions or the
5167 later so-called version 3 betas, of which the latest appears to be called
5170 To use it, you'll have to obey certain restrictions. Most important, you cannot
5171 use the Cc and Bcc headers. To tell Mutt to use mixmaster, you have to select a
5172 remailer chain, using the mix function on the compose menu.
5174 The chain selection screen is divided into two parts. In the (larger) upper
5175 part, you get a list of remailers you may use. In the lower part, you see the
5176 currently selected chain of remailers.
5178 You can navigate in the chain using the <chain-prev> and <chain-next>
5179 functions, which are by default bound to the left and right arrows and to the h
5180 and l keys (think vi keyboard bindings). To insert a remailer at the current
5181 chain position, use the <insert> function. To append a remailer behind the
5182 current chain position, use <select-entry> or <append>. You can also delete
5183 entries from the chain, using the corresponding function. Finally, to abandon
5184 your changes, leave the menu, or <accept> them pressing (by default) the Return
5187 Note that different remailers do have different capabilities, indicated in the
5188 %c entry of the remailer menu lines (see $mix_entry_format). Most important is
5189 the ?middleman? capability, indicated by a capital ?M?: This means that the
5190 remailer in question cannot be used as the final element of a chain, but will
5191 only forward messages to other mixmaster remailers. For details on the other
5192 capabilities, please have a look at the mixmaster documentation.
5194 Chapter 7. Security Considerations
5200 3. Information Leaks
5202 3.1. Message-Id: headers
5203 3.2. mailto:-style Links
5205 4. External Applications
5207 First of all, Mutt contains no security holes included by intention but may
5208 contain unknown security holes. As a consequence, please run Mutt only with as
5209 few permissions as possible. Especially, do not run Mutt as the super user.
5211 When configuring Mutt, there're some points to note about secure setups so
5212 please read this chapter carefully.
5216 Although Mutt can be told the various passwords for accounts, please never
5217 store passwords in configuration files. Besides the fact that the system's
5218 operator can always read them, you could forget to mask it out when reporting a
5219 bug or asking for help via a mailing list. Even worse, your mail including your
5220 password could be archived by internet search engines, mail-to-news gateways
5221 etc. It may already be too late before you notice your mistake.
5225 Mutt uses many temporary files for viewing messages, verifying digital
5226 signatures, etc. As long as being used, these files are visible by other users
5227 and maybe even readable in case of misconfiguration. Also, a different location
5228 for these files may be desired which can be changed via the $tmpdir variable.
5230 3. Information Leaks
5232 3.1. Message-Id: headers
5234 Message-Id: headers contain a local part that is to be created in a unique
5235 fashion. In order to do so, Mutt will ?leak? some information to the outside
5236 world when sending messages: the generation of this header includes a step
5237 counter which is increased (and rotated) with every message sent. In a longer
5238 running mutt session, others can make assumptions about your mailing habbits
5239 depending on the number of messages sent. If this is not desired, the header
5240 can be manually provided using $edit_headers (though not recommended).
5242 3.2. mailto:-style Links
5244 As Mutt be can be set up to be the mail client to handle mailto: style links in
5245 websites, there're security considerations, too. Arbitrary header fields can be
5246 embedded in these links which could override existing header fields or attach
5247 arbitrary files using the Attach: psuedoheader. This may be problematic if the
5248 $edit-headers variable is unset, i.e. the user doesn't want to see header
5249 fields while editing the message and doesn't pay enough attention to the
5250 compose menu's listing of attachments.
5252 For example, following a link like
5254 mailto:joe@host?Attach=~/.gnupg/secring.gpg
5256 will send out the user's private gnupg keyring to joe@host if the user doesn't
5257 follow the information on screen carefully enough.
5259 4. External Applications
5261 Mutt in many places has to rely on external applications or for convenience
5262 supports mechanisms involving external applications.
5264 One of these is the mailcap mechanism as defined by RfC1524. Details about a
5265 secure use of the mailcap mechanisms is given in Section 3.2, ?Secure Use of
5268 Besides the mailcap mechanism, Mutt uses a number of other external utilities
5269 for operation, for example to provide crypto support, in backtick expansion in
5270 configuration files or format string filters. The same security considerations
5271 apply for these as for tools involved via mailcap.
5273 Chapter 8. Performance Tuning
5277 1. Reading and Writing Mailboxes
5278 2. Reading Messages from Remote Folders
5279 3. Searching and Limiting
5281 1. Reading and Writing Mailboxes
5283 Mutt's performance when reading mailboxes can be improved in two ways:
5285 1. For remote folders (IMAP and POP) as well as folders using one-file-per
5286 message storage (Maildir and MH), Mutt's performance can be greatly
5287 improved using header caching. using a single database per folder.
5289 2. Mutt provides the $read_inc and $write_inc variables to specify at which
5290 rate to update progress counters. If these values are too low, Mutt may
5291 spend more time on updating the progress counter than it spends on actually
5292 reading/writing folders.
5294 For example, when opening a maildir folder with a few thousand messages,
5295 the default value for $read_inc may be too low. It can be tuned on on a
5296 folder-basis using folder-hooks:
5298 # use very high $read_inc to speed up reading hcache'd maildirs
5299 folder-hook . 'set read_inc=1000'
5300 # use lower value for reading slower remote IMAP folders
5301 folder-hook ^imap 'set read_inc=100'
5302 # use even lower value for reading even slower remote POP folders
5303 folder-hook ^pop 'set read_inc=1'
5305 These settings work on a per-message basis. However, as messages may greatly
5306 differ in size and certain operations are much faster than others, even
5307 per-folder settings of the increment variables may not be desirable as they
5308 produce either too few or too much progress updates. Thus, Mutt allows to limit
5309 the number of progress updates per second it'll actually send to the terminal
5310 using the $time_inc variable.
5312 2. Reading Messages from Remote Folders
5314 Reading messages from remote folders such as IMAP an POP can be slow especially
5315 for large mailboxes since Mutt only caches a very limited number of recently
5316 viewed messages (usually 10) per session (so that it will be gone for the next
5319 To improve performance and permanently cache whole messages, please refer to
5320 Mutt's so-called body caching for details.
5322 3. Searching and Limiting
5324 When searching mailboxes either via a search or a limit action, for some
5325 patterns Mutt distinguishes between regular expression and string searches. For
5326 regular expressions, patterns are prefixed with ??? and with ?=? for string
5329 Even though a regular expression search is fast, it's several times slower than
5330 a pure string search which is noticeable especially on large folders. As a
5331 consequence, a string search should be used instead of a regular expression
5332 search if the user already knows enough about the search pattern.
5334 For example, when limiting a large folder to all messages sent to or by an
5335 author, it's much faster to search for the initial part of an e-mail address
5336 via =Luser@ instead of ?Luser@. This is especially true for searching message
5337 bodies since a larger amount of input has to be searched.
5339 As for regular expressions, a lower case string search pattern makes Mutt
5340 perform a case-insensitive search except for IMAP (because for IMAP Mutt
5341 performs server-side searches which don't support case-insensivity).
5343 Chapter 9. Reference
5347 1. Command-Line Options
5348 2. Configuration Commands
5349 3. Configuration Variables
5351 3.1. abort_nosubject
5352 3.2. abort_unmodified
5361 3.11. assumed_charset
5362 3.12. attach_charset
5372 3.22. bounce_delivered
5373 3.23. braille_friendly
5374 3.24. certificate_file
5376 3.26. check_mbox_size
5378 3.28. collapse_unread
5379 3.29. compose_format
5380 3.30. config_charset
5383 3.33. connect_timeout
5386 3.36. crypt_autoencrypt
5388 3.38. crypt_autosign
5389 3.39. crypt_autosmime
5390 3.40. crypt_replyencrypt
5391 3.41. crypt_replysign
5392 3.42. crypt_replysignencrypted
5393 3.43. crypt_timestamp
5394 3.44. crypt_use_gpgme
5396 3.46. crypt_verify_sig
5401 3.51. digest_collapse
5402 3.52. display_filter
5403 3.53. dotlock_program
5406 3.56. duplicate_threads
5411 3.61. envelope_from_address
5420 3.70. forward_decode
5421 3.71. forward_decrypt
5423 3.73. forward_format
5430 3.80. header_cache_compress
5431 3.81. header_cache_pagesize
5436 3.86. hide_thread_subject
5437 3.87. hide_top_limited
5438 3.88. hide_top_missing
5441 3.91. honor_disposition
5442 3.92. honor_followup_to
5444 3.94. ignore_linear_white_space
5445 3.95. ignore_list_reply_to
5446 3.96. imap_authenticators
5447 3.97. imap_check_subscribed
5448 3.98. imap_delim_chars
5451 3.101. imap_keepalive
5452 3.102. imap_list_subscribed
5457 3.107. imap_pipeline_depth
5458 3.108. imap_servernoise
5460 3.110. implicit_autoview
5462 3.112. include_onlyfirst
5463 3.113. indent_string
5470 3.120. mailcap_sanitize
5471 3.121. maildir_header_cache_verify
5472 3.122. maildir_trash
5479 3.129. menu_move_off
5481 3.131. message_cache_clean
5482 3.132. message_cachedir
5483 3.133. message_format
5487 3.137. mh_seq_flagged
5488 3.138. mh_seq_replied
5489 3.139. mh_seq_unseen
5491 3.141. mime_forward_decode
5492 3.142. mime_forward_rest
5493 3.143. mix_entry_format
5499 3.149. pager_context
5501 3.151. pager_index_lines
5503 3.153. pgp_auto_decode
5504 3.154. pgp_autoinline
5505 3.155. pgp_check_exit
5506 3.156. pgp_clearsign_command
5507 3.157. pgp_decode_command
5508 3.158. pgp_decrypt_command
5509 3.159. pgp_encrypt_only_command
5510 3.160. pgp_encrypt_sign_command
5511 3.161. pgp_entry_format
5512 3.162. pgp_export_command
5513 3.163. pgp_getkeys_command
5514 3.164. pgp_good_sign
5515 3.165. pgp_ignore_subkeys
5516 3.166. pgp_import_command
5517 3.167. pgp_list_pubring_command
5518 3.168. pgp_list_secring_command
5520 3.170. pgp_mime_auto
5521 3.171. pgp_replyinline
5522 3.172. pgp_retainable_sigs
5523 3.173. pgp_show_unusable
5525 3.175. pgp_sign_command
5526 3.176. pgp_sort_keys
5527 3.177. pgp_strict_enc
5529 3.179. pgp_use_gpg_agent
5530 3.180. pgp_verify_command
5531 3.181. pgp_verify_key_command
5535 3.185. pop_auth_try_all
5536 3.186. pop_authenticators
5537 3.187. pop_checkinterval
5542 3.192. pop_reconnect
5544 3.194. post_indent_string
5549 3.199. print_command
5553 3.203. query_command
5566 3.216. reverse_alias
5568 3.218. reverse_realname
5569 3.219. rfc2047_parameters
5575 3.225. score_threshold_delete
5576 3.226. score_threshold_flag
5577 3.227. score_threshold_read
5578 3.228. search_context
5581 3.231. sendmail_wait
5586 3.236. simple_search
5590 3.240. smime_ask_cert_label
5591 3.241. smime_ca_location
5592 3.242. smime_certificates
5593 3.243. smime_decrypt_command
5594 3.244. smime_decrypt_use_default_key
5595 3.245. smime_default_key
5596 3.246. smime_encrypt_command
5597 3.247. smime_encrypt_with
5598 3.248. smime_get_cert_command
5599 3.249. smime_get_cert_email_command
5600 3.250. smime_get_signer_cert_command
5601 3.251. smime_import_cert_command
5602 3.252. smime_is_default
5604 3.254. smime_pk7out_command
5605 3.255. smime_sign_command
5606 3.256. smime_sign_opaque_command
5607 3.257. smime_timeout
5608 3.258. smime_verify_command
5609 3.259. smime_verify_opaque_command
5610 3.260. smtp_authenticators
5618 3.268. spam_separator
5620 3.270. ssl_ca_certificates_file
5621 3.271. ssl_client_cert
5622 3.272. ssl_force_tls
5623 3.273. ssl_min_dh_prime_bits
5625 3.275. ssl_use_sslv2
5626 3.276. ssl_use_sslv3
5627 3.277. ssl_use_tlsv1
5628 3.278. ssl_usesystemcerts
5629 3.279. ssl_verify_dates
5630 3.280. ssl_verify_host
5632 3.282. status_format
5633 3.283. status_on_top
5634 3.284. strict_threads
5637 3.287. thorough_search
5638 3.288. thread_received
5645 3.295. uncollapse_jump
5648 3.298. use_envelope_from
5678 1. Command-Line Options
5680 Running mutt with no arguments will make Mutt attempt to read your spool
5681 mailbox. However, it is possible to read other mailboxes and to send messages
5682 from the command line as well.
5684 Table 9.1. Command line options
5686 +-----------------------------------------------------------------------------+
5687 |Option| Description |
5688 |------+----------------------------------------------------------------------|
5689 |-A |expand an alias |
5690 |------+----------------------------------------------------------------------|
5691 |-a |attach a file to a message |
5692 |------+----------------------------------------------------------------------|
5693 |-b |specify a blind carbon-copy (BCC) address |
5694 |------+----------------------------------------------------------------------|
5695 |-c |specify a carbon-copy (Cc) address |
5696 |------+----------------------------------------------------------------------|
5697 |-D |print the value of all Mutt variables to stdout |
5698 |------+----------------------------------------------------------------------|
5699 |-e |specify a config command to be run after initialization files are read|
5700 |------+----------------------------------------------------------------------|
5701 |-f |specify a mailbox to load |
5702 |------+----------------------------------------------------------------------|
5703 |-F |specify an alternate file to read initialization commands |
5704 |------+----------------------------------------------------------------------|
5705 |-h |print help on command line options |
5706 |------+----------------------------------------------------------------------|
5707 |-H |specify a draft file from which to read a header and body |
5708 |------+----------------------------------------------------------------------|
5709 |-i |specify a file to include in a message composition |
5710 |------+----------------------------------------------------------------------|
5711 |-m |specify a default mailbox type |
5712 |------+----------------------------------------------------------------------|
5713 |-n |do not read the system Muttrc |
5714 |------+----------------------------------------------------------------------|
5715 |-p |recall a postponed message |
5716 |------+----------------------------------------------------------------------|
5717 |-Q |query a configuration variable |
5718 |------+----------------------------------------------------------------------|
5719 |-R |open mailbox in read-only mode |
5720 |------+----------------------------------------------------------------------|
5721 |-s |specify a subject (enclose in quotes if it contains spaces) |
5722 |------+----------------------------------------------------------------------|
5723 |-v |show version number and compile-time definitions |
5724 |------+----------------------------------------------------------------------|
5725 |-x |simulate the mailx(1) compose mode |
5726 |------+----------------------------------------------------------------------|
5727 |-y |show a menu containing the files specified by the mailboxes command |
5728 |------+----------------------------------------------------------------------|
5729 |-z |exit immediately if there are no messages in the mailbox |
5730 |------+----------------------------------------------------------------------|
5731 |-Z |open the first folder with new message, exit immediately if none |
5732 +-----------------------------------------------------------------------------+
5735 To read messages in a mailbox
5737 mutt [-nz] [-F muttrc ] [-m type ] [-f mailbox ]
5739 To compose a new message
5741 mutt [-n] [-F muttrc ] [-c address ] [-i filename ] [-s subject ] [ -a file
5742 [...] -- ] address ...
5744 Mutt also supports a ?batch? mode to send prepared messages. Simply redirect
5745 input from the file you wish to send. For example,
5747 mutt -s "data set for run #2" professor@bigschool.edu < ?/run2.dat
5749 will send a message to <professor@bigschool.edu> with a subject of ?data set
5750 for run #2?. In the body of the message will be the contents of the file ??/
5753 All files passed with -a file will be attached as a MIME part to the message.
5754 To attach a single or several files, use ?--? to separate files and recipient
5757 mutt -a image.png -- some@one.org
5761 mutt -a *.png -- some@one.org
5765 The -a option must be last in the option list.
5767 2. Configuration Commands
5769 The following are the commands understood by Mutt:
5771 * account-hook pattern command
5773 * alias [ -group name ...] key address [ address ...]
5774 unalias [ -group name ...] { * | key ... }
5776 * alternates [ -group name ...] regexp [ regexp ...]
5777 unalternates [ -group name ...] { * | regexp ... }
5779 * alternative-order mimetype [ mimetype ...]
5780 unalternative-order { * | mimetype ... }
5782 * attachments { + | - }disposition mime-type
5783 unattachments { + | - }disposition mime-type
5785 * auto-view mimetype [ mimetype ...]
5786 unauto-view { * | mimetype ... }
5788 * bind map key function
5790 * charset-hook alias charset
5792 * iconv-hook charset local-charset
5794 * color object foreground background
5795 color { header | body } foreground background regexp
5796 color index foreground background pattern
5797 uncolor { index | header | body } { * | pattern ... }
5799 * crypt-hook pattern keyid
5801 * exec function [ function ...]
5803 * fcc-hook [!]pattern mailbox
5805 * fcc-save-hook [!]pattern mailbox
5807 * folder-hook [!]regexp command
5809 * group [ -group name ...] { -rx expr ... | -addr expr ... }
5810 ungroup [ -group name ...] { * | -rx expr ... | -addr expr ... }
5812 * hdr_order header [ header ...]
5813 unhdr_order { * | header ... }
5815 * ignore pattern [ pattern ...]
5816 unignore { * | pattern ... }
5818 * lists [ -group name ] regexp [ regexp ...]
5819 unlists [ -group name ...] { * | regexp ... }
5821 * macro menu key sequence [ description ]
5823 * mailboxes mailbox [ mailbox ...]
5824 unmailboxes { * | mailbox ... }
5826 * mbox-hook [!]pattern mailbox
5828 * message-hook [!]pattern command
5830 * mime-lookup mimetype [ mimetype ...]
5831 unmime-lookup { * | mimetype ... }
5833 * mono object attribute
5834 mono { header | body } attribute regexp
5835 mono index attribute pattern
5836 unmono { index | header | body } { * | pattern ... }
5839 unmy_hdr { * | field ... }
5843 * save-hook [!]pattern mailbox
5845 * score pattern value
5846 unscore { * | pattern ... }
5848 * reply-hook [!]pattern command
5850 * send-hook [!]pattern command
5852 * send2-hook [!]pattern command
5854 * set { [ no | inv ] variable | variable=value } [...]
5855 toggle variable [ variable ...]
5856 unset variable [ variable ...]
5857 reset variable [ variable ...]
5861 * spam pattern format
5862 nospam { * | pattern }
5864 * subscribe [ -group name ...] regexp [ regexp ...]
5865 unsubscribe [ -group name ...] { * | regexp ... }
5867 * unhook { * | hook-type }
5869 3. Configuration Variables
5871 3.1. abort_nosubject
5876 If set to yes, when composing messages and no subject is given at the subject
5877 prompt, composition will be aborted. If set to no, composing messages with no
5878 subject given at the subject prompt will never be aborted.
5880 3.2. abort_unmodified
5885 If set to yes, composition will automatically abort after editing the message
5886 body if no changes are made to the file (this check only happens after the
5887 first edit of the file). When set to no, composition will never be aborted.
5892 Default: ??/.muttrc?
5894 The default file in which to save aliases created by the <create-alias>
5895 function. Entries added to this file are encoded in the character set specified
5896 by $config_charset if it is set or the current character set otherwise.
5898 Note: Mutt will not automatically source this file; you must explicitly use the
5899 ?source? command for it to be executed in case this option points to a
5900 dedicated alias file.
5902 The default for this option is the currently used muttrc file, or ??/.muttrc?
5903 if no user muttrc was found.
5908 Default: ?%4n %2f %t %-10a %r?
5910 Specifies the format of the data displayed for the ?alias? menu. The following
5911 printf(3)-style sequences are available:
5913 +-----------------------------------------------------------------+
5915 |--+--------------------------------------------------------------|
5916 |%f|flags - currently, a ?d? for an alias marked for deletion |
5917 |--+--------------------------------------------------------------|
5919 |--+--------------------------------------------------------------|
5920 |%r|address which alias expands to |
5921 |--+--------------------------------------------------------------|
5922 |%t|character which indicates if the alias is tagged for inclusion|
5923 +-----------------------------------------------------------------+
5930 Controls whether 8-bit data is converted to 7-bit using either Quoted-
5931 Printable or Base64 encoding when sending mail.
5938 Controls whether ANSI color codes in messages (and color tags in rich text
5939 messages) are to be interpreted. Messages containing these codes are rare, but
5940 if this option is set, their text will be colored accordingly. Note that this
5941 may override your color choices, and even present a security problem, since a
5942 message could include a line like
5944 [-- PGP output follows ...
5946 and give it the same color as your attachment color (see also $crypt_timestamp
5954 When set, an arrow (?->?) will be used to indicate the current entry in menus
5955 instead of highlighting the whole line. On slow network or modem links this
5956 will make response faster because there is less that has to be redrawn on the
5957 screen when moving to the next or previous entries in the menu.
5964 If set, Mutt will use plain ASCII characters when displaying thread and
5965 attachment trees, instead of the default ACS characters.
5972 If set, Mutt will prompt you for blind-carbon-copy (Bcc) recipients before
5973 editing an outgoing message.
5980 If set, Mutt will prompt you for carbon-copy (Cc) recipients before editing the
5981 body of an outgoing message.
5983 3.11. assumed_charset
5988 This variable is a colon-separated list of character encoding schemes for
5989 messages without character encoding indication. Header field values and message
5990 body content without character encoding indication would be assumed that they
5991 are written in one of this list. By default, all the header fields and message
5992 body without any charset indication are assumed to be in ?us-ascii?.
5994 For example, Japanese users might prefer this:
5996 set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
5998 However, only the first content is valid for the message body.
6000 3.12. attach_charset
6005 This variable is a colon-separated list of character encoding schemes for text
6006 file attachments. Mutt uses this setting to guess which encoding files being
6007 attached are encoded in to convert them to a proper character set given in
6010 If unset, the value of $charset will be used instead. For example, the
6011 following configuration would work for Japanese text handling:
6013 set attach_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
6015 Note: for Japanese users, ?iso-2022-*? must be put at the head of the value as
6016 shown above if included.
6021 Default: ?%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] ?
6023 This variable describes the format of the ?attachment? menu. The following
6024 printf(3)-style sequences are understood:
6026 +-----------------------------------------------------------------------------+
6028 |---+-------------------------------------------------------------------------|
6029 |%c |requires charset conversion (?n? or ?c?) |
6030 |---+-------------------------------------------------------------------------|
6032 |---+-------------------------------------------------------------------------|
6034 |---+-------------------------------------------------------------------------|
6035 |%e |MIME content-transfer-encoding |
6036 |---+-------------------------------------------------------------------------|
6038 |---+-------------------------------------------------------------------------|
6039 |%I |disposition (?I? for inline, ?A? for attachment) |
6040 |---+-------------------------------------------------------------------------|
6041 |%m |major MIME type |
6042 |---+-------------------------------------------------------------------------|
6044 |---+-------------------------------------------------------------------------|
6045 |%n |attachment number |
6046 |---+-------------------------------------------------------------------------|
6047 |%Q |?Q?, if MIME part qualifies for attachment counting |
6048 |---+-------------------------------------------------------------------------|
6050 |---+-------------------------------------------------------------------------|
6052 |---+-------------------------------------------------------------------------|
6053 |%T |graphic tree characters |
6054 |---+-------------------------------------------------------------------------|
6055 |%u |unlink (=to delete) flag |
6056 |---+-------------------------------------------------------------------------|
6057 |%X |number of qualifying MIME parts in this part and its children (please see|
6058 | |the ?attachments? section for possible speed effects) |
6059 |---+-------------------------------------------------------------------------|
6060 |%>X|right justify the rest of the string and pad with character ?X? |
6061 |---+-------------------------------------------------------------------------|
6062 |%|X|pad to the end of the line with character ?X? |
6063 |---+-------------------------------------------------------------------------|
6064 |%*X|soft-fill with character ?X? as pad |
6065 +-----------------------------------------------------------------------------+
6067 For an explanation of ?soft-fill?, see the $index_format documentation.
6074 The separator to add between attachments when operating (saving, printing,
6075 piping, etc) on a list of tagged attachments.
6082 If this variable is unset, when operating (saving, printing, piping, etc) on a
6083 list of tagged attachments, Mutt will concatenate the attachments and will
6084 operate on them as a single attachment. The $attach_sep separator is added
6085 after each attachment. When set, Mutt will operate on the attachments one by
6091 Default: ?On %d, %n wrote:?
6093 This is the string that will precede a message which has been included in a
6094 reply. For a full listing of defined printf(3)-like sequences see the section
6102 When set, functions in the index menu which affect a message will be applied to
6103 all tagged messages (if there are any). When unset, you must first use the
6104 <tag-prefix> function (bound to ?;? by default) to make the next function apply
6105 to all tagged messages.
6112 When set along with $edit_headers, Mutt will skip the initial send-menu
6113 (prompting for subject and recipients) and allow you to immediately begin
6114 editing the body of your message. The send-menu may still be accessed once you
6115 have finished editing the body of your message.
6117 Note: when this option is set, you cannot use send-hooks that depend on the
6118 recipients when composing a new (non-reply) message, as the initial list of
6119 recipients is empty.
6121 Also see $fast_reply.
6128 When this variable is set, mutt will beep when an error occurs.
6135 When this variable is set, mutt will beep whenever it prints a message
6136 notifying you of new mail. This is independent of the setting of the $beep
6144 Controls whether you will be asked to confirm bouncing messages. If set to yes
6145 you don't get asked if you want to bounce a message. Setting this variable to
6146 no is not generally useful, and thus not recommended, because you are unable to
6149 3.22. bounce_delivered
6154 When this variable is set, mutt will include Delivered-To headers when bouncing
6155 messages. Postfix users may wish to unset this variable.
6157 3.23. braille_friendly
6162 When this variable is set, mutt will place the cursor at the beginning of the
6163 current line in menus, even when the $arrow_cursor variable is unset, making it
6164 easier for blind persons using Braille displays to follow these menus. The
6165 option is unset by default because many visual terminals don't permit making
6166 the cursor invisible.
6168 3.24. certificate_file
6171 Default: ??/.mutt_certificates?
6173 This variable specifies the file where the certificates you trust are saved.
6174 When an unknown certificate is encountered, you are asked if you accept it or
6175 not. If you accept it, the certificate can also be saved in this file and
6176 further connections are automatically accepted.
6178 You can also manually add CA certificates in this file. Any server certificate
6179 that is signed with one of these CA certificates is also automatically
6184 set certificate_file=~/.mutt/certificates
6191 Character set your terminal uses to display and enter textual data. It is also
6192 the fallback for $send_charset.
6194 Upon startup Mutt tries to derive this value from environment variables such as
6197 Note: It should only be set in case Mutt isn't abled to determine the character
6200 3.26. check_mbox_size
6205 When this variable is set, mutt will use file size attribute instead of access
6206 time when checking for new mail in mbox and mmdf folders.
6208 This variable is unset by default and should only be enabled when new mail
6209 detection for these folder types is unreliable or doesn't work.
6211 Note that enabling this variable should happen before any ?mailboxes?
6212 directives occur in configuration files regarding mbox or mmdf folders because
6213 mutt needs to determine the initial new mail status of such a mailbox by
6214 performing a fast mailbox scan when it is defined. Afterwards the new mail
6215 status is tracked by file size changes.
6222 Note: this option only affects maildir and MH style mailboxes.
6224 When set, Mutt will check for new mail delivered while the mailbox is open.
6225 Especially with MH mailboxes, this operation can take quite some time since it
6226 involves scanning the directory and checking each file to see if it has already
6227 been looked at. If this variable is unset, no check for new mail is performed
6228 while the mailbox is open.
6230 3.28. collapse_unread
6235 When unset, Mutt will not collapse a thread if it contains any unread messages.
6237 3.29. compose_format
6240 Default: ?-- Mutt: Compose [Approx. msg size: %l Atts: %a]%>-?
6242 Controls the format of the status line displayed in the ?compose? menu. This
6243 string is similar to $status_format, but has its own set of printf(3)-like
6246 +-----------------------------------------------------+
6247 |%a|total number of attachments |
6248 |--+--------------------------------------------------|
6249 |%h|local hostname |
6250 |--+--------------------------------------------------|
6251 |%l|approximate size (in bytes) of the current message|
6252 |--+--------------------------------------------------|
6253 |%v|Mutt version string |
6254 +-----------------------------------------------------+
6256 See the text describing the $status_format option for more information on how
6257 to set $compose_format.
6259 3.30. config_charset
6264 When defined, Mutt will recode commands in rc files from this encoding to the
6265 current character set as specified by $charset and aliases written to
6266 $alias_file from the current character set.
6268 Please note that if setting $charset it must be done before setting
6271 Recoding should be avoided as it may render unconvertable characters as
6272 question marks which can lead to undesired side effects (for example in regular
6280 When set, Mutt will prompt for confirmation when appending messages to an
6288 When set, Mutt will prompt for confirmation when saving messages to a mailbox
6289 which does not yet exist before creating it.
6291 3.33. connect_timeout
6296 Causes Mutt to timeout a network connection (for IMAP, POP or SMTP) after this
6297 many seconds if the connection is not able to be established. A negative value
6298 causes Mutt to wait indefinitely for the connection attempt to succeed.
6303 Default: ?text/plain?
6305 Sets the default Content-Type for the body of newly composed messages.
6312 This variable controls whether or not copies of your outgoing messages will be
6313 saved for later references. Also see $record, $save_name, $force_name and ?
6316 3.36. crypt_autoencrypt
6321 Setting this variable will cause Mutt to always attempt to PGP encrypt outgoing
6322 messages. This is probably only useful in connection to the ?send-hook?
6323 command. It can be overridden by use of the pgp menu, when encryption is not
6324 required or signing is requested as well. If $smime_is_default is set, then
6325 OpenSSL is used instead to create S/MIME messages and settings can be
6326 overridden by use of the smime menu instead. (Crypto only)
6333 This variable controls whether or not mutt may automatically enable PGP
6334 encryption/signing for messages. See also $crypt_autoencrypt,
6335 $crypt_replyencrypt, $crypt_autosign, $crypt_replysign and $smime_is_default.
6337 3.38. crypt_autosign
6342 Setting this variable will cause Mutt to always attempt to cryptographically
6343 sign outgoing messages. This can be overridden by use of the pgp menu, when
6344 signing is not required or encryption is requested as well. If
6345 $smime_is_default is set, then OpenSSL is used instead to create S/MIME
6346 messages and settings can be overridden by use of the smime menu instead of the
6347 pgp menu. (Crypto only)
6349 3.39. crypt_autosmime
6354 This variable controls whether or not mutt may automatically enable S/MIME
6355 encryption/signing for messages. See also $crypt_autoencrypt,
6356 $crypt_replyencrypt, $crypt_autosign, $crypt_replysign and $smime_is_default.
6358 3.40. crypt_replyencrypt
6363 If set, automatically PGP or OpenSSL encrypt replies to messages which are
6364 encrypted. (Crypto only)
6366 3.41. crypt_replysign
6371 If set, automatically PGP or OpenSSL sign replies to messages which are signed.
6373 Note: this does not work on messages that are encrypted and signed! (Crypto
6376 3.42. crypt_replysignencrypted
6381 If set, automatically PGP or OpenSSL sign replies to messages which are
6382 encrypted. This makes sense in combination with $crypt_replyencrypt, because it
6383 allows you to sign all messages which are automatically encrypted. This works
6384 around the problem noted in $crypt_replysign, that mutt is not able to find out
6385 whether an encrypted message is also signed. (Crypto only)
6387 3.43. crypt_timestamp
6392 If set, mutt will include a time stamp in the lines surrounding PGP or S/MIME
6393 output, so spoofing such lines is more difficult. If you are using colors to
6394 mark these lines, and rely on these, you may unset this setting. (Crypto only)
6396 3.44. crypt_use_gpgme
6401 This variable controls the use of the GPGME-enabled crypto backends. If it is
6402 set and Mutt was built with gpgme support, the gpgme code for S/MIME and PGP
6403 will be used instead of the classic code. Note that you need to set this option
6404 in .muttrc; it won't have any effect when used interactively.
6411 Controls whether mutt uses PKA (see http://www.g10code.de/docs/
6412 pka-intro.de.pdf) during signature verification (only supported by the GPGME
6415 3.46. crypt_verify_sig
6420 If ?yes?, always attempt to verify PGP or S/MIME signatures. If ?ask-*?, ask
6421 whether or not to verify the signature. If \Fi?no?, never attempt to verify
6422 cryptographic signatures. (Crypto only)
6427 Default: ?!%a, %b %d, %Y at %I:%M:%S%p %Z?
6429 This variable controls the format of the date printed by the ?%d? sequence in
6430 $index_format. This is passed to the strftime(3) function to process the date,
6431 see the man page for the proper syntax.
6433 Unless the first character in the string is a bang (?!?), the month and week
6434 day names are expanded according to the locale specified in the variable
6435 $locale. If the first character in the string is a bang, the bang is discarded,
6436 and the month and week day names in the rest of the string are expanded in the
6437 C locale (that is in US English).
6442 Default: ??f %s !?P | (?P ?C %s)?
6444 This variable controls how ?message-hook?, ?reply-hook?, ?send-hook?, ?
6445 send2-hook?, ?save-hook?, and ?fcc-hook? will be interpreted if they are
6446 specified with only a simple regexp, instead of a matching pattern. The hooks
6447 are expanded when they are declared, so a hook will be interpreted according to
6448 the value of this variable at the time the hook is declared.
6450 The default value matches if the message is either from a user matching the
6451 regular expression given, or if it is from you (if the from address matches ?
6452 alternates?) and is to or cc'ed to a user matching the given regular
6460 Controls whether or not messages are really deleted when closing or
6461 synchronizing a mailbox. If set to yes, messages marked for deleting will
6462 automatically be purged without prompting. If set to no, messages marked for
6463 deletion will be kept in the mailbox.
6470 If this option is set, mutt will untag messages when marking them for deletion.
6471 This applies when you either explicitly delete a message, or when you save it
6474 3.51. digest_collapse
6479 If this option is set, mutt's received-attachments menu will not show the
6480 subparts of individual messages in a multipart/digest. To see these subparts,
6481 press ?v? on that menu.
6483 3.52. display_filter
6488 When set, specifies a command used to filter messages. When a message is viewed
6489 it is passed as standard input to $display_filter, and the filtered message is
6490 read from the standard output.
6492 3.53. dotlock_program
6495 Default: ?/usr/local/bin/mutt_dotlock?
6497 Contains the path of the mutt_dotlock(8) binary to be used by mutt.
6504 This variable sets the request for when notification is returned. The string
6505 consists of a comma separated list (no spaces!) of one or more of the
6506 following: never, to never request notification, failure, to request
6507 notification on transmission failure, delay, to be notified of message delays,
6508 success, to be notified of successful transmission.
6512 set dsn_notify="failure,delay"
6514 Note: when using $sendmail for delivery, you should not enable this unless you
6515 are either using Sendmail 8.8.x or greater or a MTA providing a sendmail(1)
6516 -compatible interface supporting the -N option for DSN. For SMTP delivery, DSN
6517 support is autodetected so that it depends on the server whether DSN will be
6525 This variable controls how much of your message is returned in DSN messages. It
6526 may be set to either hdrs to return just the message header, or full to return
6533 Note: when using $sendmail for delivery, you should not enable this unless you
6534 are either using Sendmail 8.8.x or greater or a MTA providing a sendmail(1)
6535 -compatible interface supporting the -R option for DSN. For SMTP delivery, DSN
6536 support is autodetected so that it depends on the server whether DSN will be
6539 3.56. duplicate_threads
6544 This variable controls whether mutt, when $sort is set to threads, threads
6545 messages with the same Message-Id together. If it is set, it will indicate that
6546 it thinks they are duplicates of each other with an equals sign in the thread
6554 This option allows you to edit the header of your outgoing messages along with
6555 the body of your message.
6557 Note that changes made to the References: and Date: headers are ignored for
6558 interoperability reasons.
6565 This variable specifies which editor is used by mutt. It defaults to the value
6566 of the $VISUAL, or $EDITOR, environment variable, or to the string ?vi? if
6567 neither of those are set.
6574 When set, mutt will quoted-printable encode messages when they contain the
6575 string ?From ? (note the trailing space) in the beginning of a line. This is
6576 useful to avoid the tampering certain mail delivery and transport agents tend
6577 to do with messages (in order to prevent tools from misinterpreting the line as
6578 a mbox message separator).
6585 The file which includes random data that is used to initialize SSL library
6588 3.61. envelope_from_address
6590 Type: e-mail address
6593 Manually sets the envelope sender for outgoing messages. This value is ignored
6594 if $use_envelope_from is unset.
6601 Escape character to use for functions in the builtin editor.
6608 When set, the initial prompt for recipients and subject are skipped when
6609 replying to messages, and the initial prompt for subject is skipped when
6610 forwarding messages.
6612 Note: this variable has no effect when the $autoedit variable is set.
6619 This variable controls whether or not attachments on outgoing messages are
6620 saved along with the main body of your message.
6627 When this variable is set, FCCs will be stored unencrypted and unsigned, even
6628 when the actual message is encrypted and/or signed. (PGP only)
6635 Specifies the default location of your mailboxes. A ?+? or ?=? at the beginning
6636 of a pathname will be expanded to the value of this variable. Note that if you
6637 change this variable (from the default) value you need to make sure that the
6638 assignment occurs before you use ?+? or ?=? for any other variables since
6639 expansion takes place when handling the ?mailboxes? command.
6644 Default: ?%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f?
6646 This variable allows you to customize the file browser display to your personal
6647 taste. This string is similar to $index_format, but has its own set of printf
6650 +-----------------------------------------------------------------------------+
6651 |%C |current file number |
6652 |---+-------------------------------------------------------------------------|
6653 |%d |date/time folder was last modified |
6654 |---+-------------------------------------------------------------------------|
6655 |%f |filename (?/? is appended to directory names, ?@? to symbolic links and |
6656 | |?*? to executable files) |
6657 |---+-------------------------------------------------------------------------|
6658 |%F |file permissions |
6659 |---+-------------------------------------------------------------------------|
6660 |%g |group name (or numeric gid, if missing) |
6661 |---+-------------------------------------------------------------------------|
6662 |%l |number of hard links |
6663 |---+-------------------------------------------------------------------------|
6664 |%N |N if folder has new mail, blank otherwise |
6665 |---+-------------------------------------------------------------------------|
6666 |%s |size in bytes |
6667 |---+-------------------------------------------------------------------------|
6668 |%t |?*? if the file is tagged, blank otherwise |
6669 |---+-------------------------------------------------------------------------|
6670 |%u |owner name (or numeric uid, if missing) |
6671 |---+-------------------------------------------------------------------------|
6672 |%>X|right justify the rest of the string and pad with character ?X? |
6673 |---+-------------------------------------------------------------------------|
6674 |%|X|pad to the end of the line with character ?X? |
6675 |---+-------------------------------------------------------------------------|
6676 |%*X|soft-fill with character ?X? as pad |
6677 +-----------------------------------------------------------------------------+
6679 For an explanation of ?soft-fill?, see the $index_format documentation.
6686 Controls whether or not the ?Mail-Followup-To:? header field is generated when
6687 sending mail. When set, Mutt will generate this field when you are replying to
6688 a known mailing list, specified with the ?subscribe? or ?lists? commands.
6690 This field has two purposes. First, preventing you from receiving duplicate
6691 copies of replies to messages which you send to mailing lists, and second,
6692 ensuring that you do get a reply separately for any messages sent to known
6693 lists to which you are not subscribed.
6695 The header will contain only the list's address for subscribed lists, and both
6696 the list address and your own email address for unsubscribed lists. Without
6697 this header, a group reply to your message sent to a subscribed list will be
6698 sent to both the list and your address, resulting in two copies of the same
6706 This variable is similar to $save_name, except that Mutt will store a copy of
6707 your outgoing message by the username of the address you are sending to even if
6708 that mailbox does not exist.
6710 Also see the $record variable.
6712 3.70. forward_decode
6717 Controls the decoding of complex MIME messages into text/plain when forwarding
6718 a message. The message header is also RFC2047 decoded. This variable is only
6719 used, if $mime_forward is unset, otherwise $mime_forward_decode is used
6722 3.71. forward_decrypt
6727 Controls the handling of encrypted messages when forwarding a message. When set
6728 , the outer layer of encryption is stripped off. This variable is only used if
6729 $mime_forward is set and $mime_forward_decode is unset. (PGP only)
6736 This quadoption controls whether or not the user is automatically placed in the
6737 editor when forwarding messages. For those who always want to forward with no
6738 modification, use a setting of ?no?.
6740 3.73. forward_format
6745 This variable controls the default subject when forwarding a message. It uses
6746 the same format sequences as the $index_format variable.
6753 When set, forwarded messages included in the main body of the message (when
6754 $mime_forward is unset) will be quoted using $indent_string.
6758 Type: e-mail address
6761 When set, this variable contains a default from address. It can be overridden
6762 using ?my_hdr? (including from a ?send-hook?) and $reverse_name. This variable
6763 is ignored if $use_from is unset.
6765 This setting defaults to the contents of the environment variable $EMAIL.
6769 Type: regular expression
6772 A regular expression used by mutt to parse the GECOS field of a password entry
6773 when expanding the alias. The default value will return the string up to the
6774 first ?,? encountered. If the GECOS field contains a string like ?lastname,
6775 firstname? then you should set it to ?.*?.
6777 This can be useful if you see the following behavior: you address an e-mail to
6778 user ID ?stevef? whose full name is ?Steve Franklin?. If mutt expands ?stevef?
6779 to ?"Franklin" stevef@foo.bar? then you should set the $gecos_mask to a regular
6780 expression that will match the whole name so mutt will expand ?Franklin? to
6788 When unset, the header fields normally added by the ?my_hdr? command are not
6789 created. This variable must be unset before composing a new message or replying
6790 in order to take effect. If set, the user defined header fields are added to
6798 When set, this variable causes Mutt to include the header of the message you
6799 are replying to into the edit buffer. The $weed setting applies.
6806 This variable points to the header cache database. If pointing to a directory
6807 Mutt will contain a header cache database file per folder, if pointing to a
6808 file that file will be a single global header cache. By default it is unset so
6809 no header caching will be used.
6811 Header caching can greatly improve speed when opening POP, IMAP MH or Maildir
6812 folders, see ?caching? for details.
6814 3.80. header_cache_compress
6819 When mutt is compiled with qdbm or tokyocabinet as header cache backend, this
6820 option determines whether the database will be compressed. Compression results
6821 in database files roughly being one fifth of the usual diskspace, but the
6822 uncompression can result in a slower opening of cached folder(s) which in
6823 general is still much faster than opening non header cached folders.
6825 3.81. header_cache_pagesize
6830 When mutt is compiled with either gdbm or bdb4 as the header cache backend,
6831 this option changes the database page size. Too large or too small values can
6832 waste space, memory, or CPU time. The default should be more or less optimal
6840 When set, help lines describing the bindings for the major functions provided
6841 by each menu are displayed on the first line of the screen.
6843 Note: The binding will not be displayed correctly if the function is bound to a
6844 sequence rather than a single keystroke. Also, the help line may not be updated
6845 if a binding is changed while Mutt is running. Since this variable is primarily
6846 aimed at new users, neither of these should present a major problem.
6853 When set, mutt will skip the host name part of $hostname variable when adding
6854 the domain part to addresses. This variable does not affect the generation of
6855 Message-IDs, and it will not lead to the cut-off of first-level domains.
6862 When set, mutt will not show the presence of messages that are hidden by
6863 limiting, in the thread tree.
6870 When set, mutt will not show the presence of missing messages in the thread
6873 3.86. hide_thread_subject
6878 When set, mutt will not show the subject of messages in the thread tree that
6879 have the same subject as their parent or closest previously displayed sibling.
6881 3.87. hide_top_limited
6886 When set, mutt will not show the presence of messages that are hidden by
6887 limiting, at the top of threads in the thread tree. Note that when
6888 $hide_limited is set, this option will have no effect.
6890 3.88. hide_top_missing
6895 When set, mutt will not show the presence of missing messages at the top of
6896 threads in the thread tree. Note that when $hide_missing is set, this option
6897 will have no effect.
6904 This variable controls the size (in number of strings remembered) of the string
6905 history buffer per category. The buffer is cleared each time the variable is
6911 Default: ??/.mutthistory?
6913 The file in which Mutt will save its history.
6915 3.91. honor_disposition
6920 When set, Mutt will not display attachments with a disposition of ?attachment?
6921 inline even if it could render the part to plain text. These MIME parts can
6922 only be viewed from the attachment menu.
6924 If unset, Mutt will render all MIME parts it can properly transform to plain
6927 3.92. honor_followup_to
6932 This variable controls whether or not a Mail-Followup-To header is honored when
6933 group-replying to a message.
6940 Specifies the fully-qualified hostname of the system mutt is running on
6941 containing the host's name and the DNS domain it belongs to. It is used as the
6942 domain part (after ?@?) for local email addresses as well as Message-Id
6945 Its value is determined at startup as follows: If the node's name as returned
6946 by the uname(3) function contains the hostname and the domain, these are used
6947 to construct $hostname. If there is no domain part returned, Mutt will look for
6948 a ?domain? or ?search? line in /etc/resolv.conf to determine the domain.
6949 Optionally, Mutt can be compiled with a fixed domain name in which case a
6950 detected one is not used.
6952 Also see $use_domain and $hidden_host.
6954 3.94. ignore_linear_white_space
6959 This option replaces linear-white-space between encoded-word and text to a
6960 single space to prevent the display of MIME-encoded ?Subject:? field from being
6961 divided into multiple lines.
6963 3.95. ignore_list_reply_to
6968 Affects the behaviour of the <reply> function when replying to messages from
6969 mailing lists (as defined by the ?subscribe? or ?lists? commands). When set, if
6970 the ?Reply-To:? field is set to the same value as the ?To:? field, Mutt assumes
6971 that the ?Reply-To:? field was set by the mailing list to automate responses to
6972 the list, and will ignore this field. To direct a response to the mailing list
6973 when this option is set, use the <list-reply> function; <group-reply> will
6974 reply to both the sender and the list.
6976 3.96. imap_authenticators
6981 This is a colon-delimited list of authentication methods mutt may attempt to
6982 use to log in to an IMAP server, in the order mutt should try them.
6983 Authentication methods are either ?login? or the right side of an IMAP ?AUTH=
6984 xxx? capability string, eg ?digest-md5?, ?gssapi? or ?cram-md5?. This option is
6985 case-insensitive. If it's unset (the default) mutt will try all available
6986 methods, in order from most-secure to least-secure.
6990 set imap_authenticators="gssapi:cram-md5:login"
6992 Note: Mutt will only fall back to other authentication methods if the previous
6993 methods are unavailable. If a method is available but authentication fails,
6994 mutt will not connect to the IMAP server.
6996 3.97. imap_check_subscribed
7001 When set, mutt will fetch the set of subscribed folders from your server on
7002 connection, and add them to the set of mailboxes it polls for new mail just as
7003 if you had issued individual ?mailboxes? commands.
7005 3.98. imap_delim_chars
7010 This contains the list of characters which you would like to treat as folder
7011 separators for displaying IMAP paths. In particular it helps in using the ?=?
7012 shortcut for your folder variable.
7019 Mutt requests these header fields in addition to the default headers (?Date:?,
7020 ?From:?, ?Subject:?, ?To:?, ?Cc:?, ?Message-Id:?, ?References:?,
7021 ?Content-Type:?, ?Content-Description:?, ?In-Reply-To:?, ?Reply-To:?, ?Lines:?,
7022 ?List-Post:?, ?X-Label:?) from IMAP servers before displaying the index menu.
7023 You may want to add more headers for spam detection.
7025 Note: This is a space separated list, items should be uppercase and not contain
7026 the colon, e.g. ?X-BOGOSITY X-SPAM-STATUS? for the ?X-Bogosity:? and
7027 ?X-Spam-Status:? header fields.
7034 When set, mutt will attempt to use the IMAP IDLE extension to check for new
7035 mail in the current mailbox. Some servers (dovecot was the inspiration for this
7036 option) react badly to mutt's implementation. If your connection seems to
7037 freeze up periodically, try unsetting this.
7039 3.101. imap_keepalive
7044 This variable specifies the maximum amount of time in seconds that mutt will
7045 wait before polling open IMAP connections, to prevent the server from closing
7046 them before mutt has finished with them. The default is well within the
7047 RFC-specified minimum amount of time (30 minutes) before a server is allowed to
7048 do this, but in practice the RFC does get violated every now and then. Reduce
7049 this number if you find yourself getting disconnected from your IMAP server due
7052 3.102. imap_list_subscribed
7057 This variable configures whether IMAP folder browsing will look for only
7058 subscribed folders or all folders. This can be toggled in the IMAP browser with
7059 the <toggle-subscribed> function.
7066 Your login name on the IMAP server.
7068 This variable defaults to the value of $imap_user.
7075 Specifies the password for your IMAP account. If unset, Mutt will prompt you
7076 for your password when you invoke the <imap-fetch-mail> function or try to open
7079 Warning: you should only use this option when you are on a fairly secure
7080 machine, because the superuser can read your muttrc even if you are the only
7081 one who can read the file.
7088 When set, mutt will not open new IMAP connections to check for new mail. Mutt
7089 will only check for new mail over existing IMAP connections. This is useful if
7090 you don't want to be prompted to user/password pairs on mutt invocation, or if
7091 opening the connection is slow.
7098 When set, mutt will avoid implicitly marking your mail as read whenever you
7099 fetch a message from the server. This is generally a good thing, but can make
7100 closing an IMAP folder somewhat slower. This option exists to appease speed
7103 3.107. imap_pipeline_depth
7108 Controls the number of IMAP commands that may be queued up before they are sent
7109 to the server. A deeper pipeline reduces the amount of time mutt must wait for
7110 the server, and can make IMAP servers feel much more responsive. But not all
7111 servers correctly handle pipelined commands, so if you have problems you might
7112 want to try setting this variable to 0.
7114 Note: Changes to this variable have no effect on open connections.
7116 3.108. imap_servernoise
7121 When set, mutt will display warning messages from the IMAP server as error
7122 messages. Since these messages are often harmless, or generated due to
7123 configuration problems on the server which are out of the users' hands, you may
7124 wish to suppress them at some point.
7131 The name of the user whose mail you intend to access on the IMAP server.
7133 This variable defaults to your user name on the local machine.
7135 3.110. implicit_autoview
7140 If set to ?yes?, mutt will look for a mailcap entry with the ?copiousoutput?
7141 flag set for every MIME attachment it doesn't have an internal viewer defined
7142 for. If such an entry is found, mutt will use the viewer defined in that entry
7143 to convert the body part to text form.
7150 Controls whether or not a copy of the message(s) you are replying to is
7151 included in your reply.
7153 3.112. include_onlyfirst
7158 Controls whether or not Mutt includes only the first attachment of the message
7161 3.113. indent_string
7166 Specifies the string to prepend to each line of text quoted in a message to
7167 which you are replying. You are strongly encouraged not to change this value,
7168 as it tends to agitate the more fanatical netizens.
7170 The value of this option is ignored if $text_flowed is set, too because the
7171 quoting mechanism is strictly defined for format=flowed.
7173 This option is a format string, please see the description of $index_format for
7174 supported printf(3)-style sequences.
7179 Default: ?%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s?
7181 This variable allows you to customize the message index display to your
7184 ?Format strings? are similar to the strings used in the C function printf(3) to
7185 format output (see the man page for more details). The following sequences are
7188 +-----------------------------------------------------------------------------+
7189 |%a |address of the author |
7190 |-----+-----------------------------------------------------------------------|
7191 |%A |reply-to address (if present; otherwise: address of author) |
7192 |-----+-----------------------------------------------------------------------|
7193 |%b |filename of the original message folder (think mailbox) |
7194 |-----+-----------------------------------------------------------------------|
7195 |%B |the list to which the letter was sent, or else the folder name (%b). |
7196 |-----+-----------------------------------------------------------------------|
7197 |%c |number of characters (bytes) in the message |
7198 |-----+-----------------------------------------------------------------------|
7199 |%C |current message number |
7200 |-----+-----------------------------------------------------------------------|
7201 |%d |date and time of the message in the format specified by $date_format |
7202 | |converted to sender's time zone |
7203 |-----+-----------------------------------------------------------------------|
7204 |%D |date and time of the message in the format specified by $date_format |
7205 | |converted to the local time zone |
7206 |-----+-----------------------------------------------------------------------|
7207 |%e |current message number in thread |
7208 |-----+-----------------------------------------------------------------------|
7209 |%E |number of messages in current thread |
7210 |-----+-----------------------------------------------------------------------|
7211 |%f |sender (address + real name), either From: or Return-Path: |
7212 |-----+-----------------------------------------------------------------------|
7213 |%F |author name, or recipient name if the message is from you |
7214 |-----+-----------------------------------------------------------------------|
7215 |%H |spam attribute(s) of this message |
7216 |-----+-----------------------------------------------------------------------|
7217 |%i |message-id of the current message |
7218 |-----+-----------------------------------------------------------------------|
7219 |%l |number of lines in the message (does not work with maildir, mh, and |
7220 | |possibly IMAP folders) |
7221 |-----+-----------------------------------------------------------------------|
7222 | |If an address in the ?To:? or ?Cc:? header field matches an address |
7223 |%L |defined by the users ?subscribe? command, this displays "To <list-name>|
7224 | |", otherwise the same as %F. |
7225 |-----+-----------------------------------------------------------------------|
7226 |%m |total number of message in the mailbox |
7227 |-----+-----------------------------------------------------------------------|
7228 |%M |number of hidden messages if the thread is collapsed. |
7229 |-----+-----------------------------------------------------------------------|
7230 |%N |message score |
7231 |-----+-----------------------------------------------------------------------|
7232 |%n |author's real name (or address if missing) |
7233 |-----+-----------------------------------------------------------------------|
7234 |%O |original save folder where mutt would formerly have stashed the |
7235 | |message: list name or recipient name if not sent to a list |
7236 |-----+-----------------------------------------------------------------------|
7237 |%P |progress indicator for the builtin pager (how much of the file has been|
7239 |-----+-----------------------------------------------------------------------|
7240 |%s |subject of the message |
7241 |-----+-----------------------------------------------------------------------|
7242 |%S |status of the message (?N?/?D?/?d?/?!?/?r?/*) |
7243 |-----+-----------------------------------------------------------------------|
7244 |%t |?To:? field (recipients) |
7245 |-----+-----------------------------------------------------------------------|
7246 |%T |the appropriate character from the $to_chars string |
7247 |-----+-----------------------------------------------------------------------|
7248 |%u |user (login) name of the author |
7249 |-----+-----------------------------------------------------------------------|
7250 |%v |first name of the author, or the recipient if the message is from you |
7251 |-----+-----------------------------------------------------------------------|
7252 |%X |number of attachments (please see the ?attachments? section for |
7253 | |possible speed effects) |
7254 |-----+-----------------------------------------------------------------------|
7255 |%y |?X-Label:? field, if present |
7256 |-----+-----------------------------------------------------------------------|
7257 | |?X-Label:? field, if present, and (1) not at part of a thread tree, (2)|
7258 |%Y |at the top of a thread, or (3) ?X-Label:? is different from preceding |
7259 | |message's ?X-Label:?. |
7260 |-----+-----------------------------------------------------------------------|
7261 |%Z |message status flags |
7262 |-----+-----------------------------------------------------------------------|
7263 |% |the date and time of the message is converted to sender's time zone, |
7264 |{fmt}|and ?fmt? is expanded by the library function strftime(3); a leading |
7265 | |bang disables locales |
7266 |-----+-----------------------------------------------------------------------|
7267 |% |the date and time of the message is converted to the local time zone, |
7268 |[fmt]|and ?fmt? is expanded by the library function strftime(3); a leading |
7269 | |bang disables locales |
7270 |-----+-----------------------------------------------------------------------|
7271 |% |the local date and time when the message was received. ?fmt? is |
7272 |(fmt)|expanded by the library function strftime(3); a leading bang disables |
7274 |-----+-----------------------------------------------------------------------|
7275 |% |the current local time. ?fmt? is expanded by the library function |
7276 |<fmt>|strftime(3); a leading bang disables locales. |
7277 |-----+-----------------------------------------------------------------------|
7278 |%>X |right justify the rest of the string and pad with character ?X? |
7279 |-----+-----------------------------------------------------------------------|
7280 |%|X |pad to the end of the line with character ?X? |
7281 |-----+-----------------------------------------------------------------------|
7282 |%*X |soft-fill with character ?X? as pad |
7283 +-----------------------------------------------------------------------------+
7285 ?Soft-fill? deserves some explanation: Normal right-justification will print
7286 everything to the left of the ?%>?, displaying padding and whatever lies to the
7287 right only if there's room. By contrast, soft-fill gives priority to the
7288 right-hand side, guaranteeing space to display it and showing padding only if
7289 there's still room. If necessary, soft-fill will eat text leftwards to make
7290 room for rightward text.
7292 Note that these expandos are supported in ?save-hook?, ?fcc-hook? and ?
7293 fcc-save-hook?, too.
7300 How to invoke ispell (GNU's spell-checking software).
7307 If set, read messages marked as flagged will not be moved from your spool
7308 mailbox to your $mbox mailbox, or as a result of a ?mbox-hook? command.
7315 The locale used by strftime(3) to format dates. Legal values are the strings
7316 your system accepts for the locale environment variable $LC_TIME.
7323 This variable configures how often (in seconds) mutt should look for new mail.
7324 Also see the $timeout variable.
7331 This variable specifies which files to consult when attempting to display MIME
7332 bodies not directly supported by Mutt.
7334 3.120. mailcap_sanitize
7339 If set, mutt will restrict possible characters in mailcap % expandos to a
7340 well-defined set of safe characters. This is the safe setting, but we are not
7341 sure it doesn't break some more advanced MIME stuff.
7343 DON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE DOING!
7345 3.121. maildir_header_cache_verify
7350 Check for Maildir unaware programs other than mutt having modified maildir
7351 files when the header cache is in use. This incurs one stat(2) per message
7352 every time the folder is opened (which can be very slow for NFS folders).
7354 3.122. maildir_trash
7359 If set, messages marked as deleted will be saved with the maildir trashed flag
7360 instead of unlinked. Note: this only applies to maildir-style mailboxes.
7361 Setting it will have no effect on other mailbox types.
7368 Controls whether or not mutt marks new unread messages as old if you exit a
7369 mailbox without reading them. With this option set, the next time you start
7370 mutt, the messages will show up with an ?O? next to them in the index menu,
7371 indicating that they are old.
7378 Controls the display of wrapped lines in the internal pager. If set, a ?+?
7379 marker is displayed at the beginning of wrapped lines.
7381 Also see the $smart_wrap variable.
7385 Type: regular expression
7388 A regular expression used in the file browser, optionally preceded by the not
7389 operator ?!?. Only files whose names match this mask will be shown. The match
7390 is always case-sensitive.
7397 This specifies the folder into which read mail in your $spoolfile folder will
7400 Also see the $move variable.
7407 The default mailbox type used when creating new folders. May be any of ?mbox?,
7408 ?MMDF?, ?MH? and ?Maildir?. This is overriden by the -m command-line option.
7415 This variable controls the number of lines of context that are given when
7416 scrolling through menus. (Similar to $pager_context.)
7418 3.129. menu_move_off
7423 When unset, the bottom entry of menus will never scroll up past the bottom of
7424 the screen, unless there are less entries than lines. When set, the bottom
7425 entry may move off the bottom.
7432 When set, menus will be scrolled up or down one line when you attempt to move
7433 across a screen boundary. If unset, the screen is cleared and the next or
7434 previous page of the menu is displayed (useful for slow links to avoid many
7437 3.131. message_cache_clean
7442 If set, mutt will clean out obsolete entries from the message cache when the
7443 mailbox is synchronized. You probably only want to set it every once in a
7444 while, since it can be a little slow (especially for large folders).
7446 3.132. message_cachedir
7451 Set this to a directory and mutt will cache copies of messages from your IMAP
7452 and POP servers here. You are free to remove entries at any time.
7454 When setting this variable to a directory, mutt needs to fetch every remote
7455 message only once and can perform regular expression searches as fast as for
7458 Also see the $message_cache_clean variable.
7460 3.133. message_format
7465 This is the string displayed in the ?attachment? menu for attachments of type
7466 message/rfc822. For a full listing of defined printf(3)-like sequences see the
7467 section on $index_format.
7474 If set, forces Mutt to interpret keystrokes with the high bit (bit 8) set as if
7475 the user had pressed the Esc key and whatever key remains after having the high
7476 bit removed. For example, if the key pressed has an ASCII value of 0xf8, then
7477 this is treated as if the user had pressed Esc then ?x?. This is because the
7478 result of removing the high bit from 0xf8 is 0x78, which is the ASCII character
7486 If unset, Mutt will remove your address (see the ?alternates? command) from the
7487 list of recipients when replying to a message.
7494 When unset, mutt will mimic mh's behaviour and rename deleted messages to ,<old
7495 file name> in mh folders instead of really deleting them. This leaves the
7496 message on disk but makes programs reading the folder ignore it. If the
7497 variable is set, the message files will simply be deleted.
7499 This option is similar to $maildir_trash for Maildir folders.
7501 3.137. mh_seq_flagged
7506 The name of the MH sequence used for flagged messages.
7508 3.138. mh_seq_replied
7513 The name of the MH sequence used to tag replied messages.
7515 3.139. mh_seq_unseen
7520 The name of the MH sequence used for unseen messages.
7527 When set, the message you are forwarding will be attached as a separate message
7528 /rfc822 MIME part instead of included in the main body of the message. This is
7529 useful for forwarding MIME messages so the receiver can properly view the
7530 message as it was delivered to you. If you like to switch between MIME and not
7531 MIME from mail to mail, set this variable to ?ask-no? or ?ask-yes?.
7533 Also see $forward_decode and $mime_forward_decode.
7535 3.141. mime_forward_decode
7540 Controls the decoding of complex MIME messages into text/plain when forwarding
7541 a message while $mime_forward is set. Otherwise $forward_decode is used
7544 3.142. mime_forward_rest
7549 When forwarding multiple attachments of a MIME message from the attachment
7550 menu, attachments which cannot be decoded in a reasonable manner will be
7551 attached to the newly composed message if this option is set.
7553 3.143. mix_entry_format
7556 Default: ?%4n %c %-16s %a?
7558 This variable describes the format of a remailer line on the mixmaster chain
7559 selection screen. The following printf(3)-like sequences are supported:
7561 +----------------------------------+
7562 |%n|The running number on the menu.|
7563 |--+-------------------------------|
7564 |%c|Remailer capabilities. |
7565 |--+-------------------------------|
7566 |%s|The remailer's short name. |
7567 |--+-------------------------------|
7568 |%a|The remailer's e-mail address. |
7569 +----------------------------------+
7574 Default: ?mixmaster?
7576 This variable contains the path to the Mixmaster binary on your system. It is
7577 used with various sets of parameters to gather the list of known remailers, and
7578 to finally send a message through the mixmaster chain.
7585 Controls whether or not Mutt will move read messages from your spool mailbox to
7586 your $mbox mailbox, or as a result of a ?mbox-hook? command.
7593 This variable, when set, makes the thread tree narrower, allowing deeper
7594 threads to fit on the screen.
7601 Operations that expect to transfer a large amount of data over the network will
7602 update their progress every $net_inc kilobytes. If set to 0, no progress
7603 messages will be displayed.
7605 See also $read_inc, $write_inc and $net_inc.
7612 This variable specifies which pager you would like to use to view messages. The
7613 value ?builtin? means to use the builtin pager, otherwise this variable should
7614 specify the pathname of the external pager you would like to use.
7616 Using an external pager may have some disadvantages: Additional keystrokes are
7617 necessary because you can't call mutt functions directly from the pager, and
7618 screen resizes cause lines longer than the screen width to be badly formatted
7621 3.149. pager_context
7626 This variable controls the number of lines of context that are given when
7627 displaying the next or previous page in the internal pager. By default, Mutt
7628 will display the line after the last one on the screen at the top of the next
7629 page (0 lines of context).
7631 This variable also specifies the amount of context given for search results. If
7632 positive, this many lines will be given before a match, if 0, the match will be
7638 Default: ?-%Z- %C/%m: %-20.20n %s%* -- (%P)?
7640 This variable controls the format of the one-line message ?status? displayed
7641 before each message in either the internal or an external pager. The valid
7642 sequences are listed in the $index_format section.
7644 3.151. pager_index_lines
7649 Determines the number of lines of a mini-index which is shown when in the
7650 pager. The current message, unless near the top or bottom of the folder, will
7651 be roughly one third of the way down this mini-index, giving the reader the
7652 context of a few messages before and after the message. This is useful, for
7653 example, to determine how many messages remain to be read in the current
7654 thread. One of the lines is reserved for the status bar from the index, so a
7655 setting of 6 will only show 5 lines of the actual index. A value of 0 results
7656 in no index being shown. If the number of messages in the current folder is
7657 less than $pager_index_lines, then the index will only use as many lines as it
7665 When set, the internal-pager will not move to the next message when you are at
7666 the end of a message and invoke the <next-page> function.
7668 3.153. pgp_auto_decode
7673 If set, mutt will automatically attempt to decrypt traditional PGP messages
7674 whenever the user performs an operation which ordinarily would result in the
7675 contents of the message being operated on. For example, if the user displays a
7676 pgp-traditional message which has not been manually checked with the
7677 <check-traditional-pgp> function, mutt will automatically check the message for
7680 3.154. pgp_autoinline
7685 This option controls whether Mutt generates old-style inline (traditional) PGP
7686 encrypted or signed messages under certain circumstances. This can be
7687 overridden by use of the pgp menu, when inline is not required.
7689 Note that Mutt might automatically use PGP/MIME for messages which consist of
7690 more than a single MIME part. Mutt can be configured to ask before sending PGP/
7691 MIME messages when inline (traditional) would not work.
7693 Also see the $pgp_mime_auto variable.
7695 Also note that using the old-style PGP message format is strongly deprecated.
7698 3.155. pgp_check_exit
7703 If set, mutt will check the exit code of the PGP subprocess when signing or
7704 encrypting. A non-zero exit code means that the subprocess failed. (PGP only)
7706 3.156. pgp_clearsign_command
7711 This format is used to create an old-style ?clearsigned? PGP message. Note that
7712 the use of this format is strongly deprecated.
7714 This is a format string, see the $pgp_decode_command command for possible
7715 printf(3)-like sequences. (PGP only)
7717 3.157. pgp_decode_command
7722 This format strings specifies a command which is used to decode application/pgp
7725 The PGP command formats have their own set of printf(3)-like sequences:
7727 +-----------------------------------------------------------------------------+
7728 |%p|Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty string |
7729 | |otherwise. Note: This may be used with a %? construct. |
7730 |--+--------------------------------------------------------------------------|
7731 |%f|Expands to the name of a file containing a message. |
7732 |--+--------------------------------------------------------------------------|
7733 |%s|Expands to the name of a file containing the signature part of a multipart|
7734 | |/signed attachment when verifying it. |
7735 |--+--------------------------------------------------------------------------|
7736 |%a|The value of $pgp_sign_as. |
7737 |--+--------------------------------------------------------------------------|
7738 |%r|One or more key IDs. |
7739 +-----------------------------------------------------------------------------+
7741 For examples on how to configure these formats for the various versions of PGP
7742 which are floating around, see the pgp and gpg sample configuration files in
7743 the samples/ subdirectory which has been installed on your system alongside the
7744 documentation. (PGP only)
7746 3.158. pgp_decrypt_command
7751 This command is used to decrypt a PGP encrypted message.
7753 This is a format string, see the $pgp_decode_command command for possible
7754 printf(3)-like sequences. (PGP only)
7756 3.159. pgp_encrypt_only_command
7761 This command is used to encrypt a body part without signing it.
7763 This is a format string, see the $pgp_decode_command command for possible
7764 printf(3)-like sequences. (PGP only)
7766 3.160. pgp_encrypt_sign_command
7771 This command is used to both sign and encrypt a body part.
7773 This is a format string, see the $pgp_decode_command command for possible
7774 printf(3)-like sequences. (PGP only)
7776 3.161. pgp_entry_format
7779 Default: ?%4n %t%f %4l/0x%k %-4a %2c %u?
7781 This variable allows you to customize the PGP key selection menu to your
7782 personal taste. This string is similar to $index_format, but has its own set of
7783 printf(3)-like sequences:
7785 +-------------------------------------------------------------+
7787 |------+------------------------------------------------------|
7789 |------+------------------------------------------------------|
7791 |------+------------------------------------------------------|
7793 |------+------------------------------------------------------|
7795 |------+------------------------------------------------------|
7797 |------+------------------------------------------------------|
7799 |------+------------------------------------------------------|
7800 |%t |trust/validity of the key-uid association |
7801 |------+------------------------------------------------------|
7802 |%[<s>]|date of the key where <s> is an strftime(3) expression|
7803 +-------------------------------------------------------------+
7807 3.162. pgp_export_command
7812 This command is used to export a public key from the user's key ring.
7814 This is a format string, see the $pgp_decode_command command for possible
7815 printf(3)-like sequences. (PGP only)
7817 3.163. pgp_getkeys_command
7822 This command is invoked whenever mutt will need public key information. Of the
7823 sequences supported by $pgp_decode_command, %r is the only printf(3)-like
7824 sequence used with this format. (PGP only)
7826 3.164. pgp_good_sign
7828 Type: regular expression
7831 If you assign a text to this variable, then a PGP signature is only considered
7832 verified if the output from $pgp_verify_command contains the text. Use this
7833 variable if the exit code from the command is 0 even for bad signatures. (PGP
7836 3.165. pgp_ignore_subkeys
7841 Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead, the
7842 principal key will inherit the subkeys' capabilities. Unset this if you want to
7843 play interesting key selection games. (PGP only)
7845 3.166. pgp_import_command
7850 This command is used to import a key from a message into the user's public key
7853 This is a format string, see the $pgp_decode_command command for possible
7854 printf(3)-like sequences. (PGP only)
7856 3.167. pgp_list_pubring_command
7861 This command is used to list the public key ring's contents. The output format
7862 must be analogous to the one used by
7864 gpg --list-keys --with-colons.
7866 This format is also generated by the pgpring utility which comes with mutt.
7868 This is a format string, see the $pgp_decode_command command for possible
7869 printf(3)-like sequences. (PGP only)
7871 3.168. pgp_list_secring_command
7876 This command is used to list the secret key ring's contents. The output format
7877 must be analogous to the one used by:
7879 gpg --list-keys --with-colons.
7881 This format is also generated by the pgpring utility which comes with mutt.
7883 This is a format string, see the $pgp_decode_command command for possible
7884 printf(3)-like sequences. (PGP only)
7891 If set, use 64 bit PGP key IDs, if unset use the normal 32 bit key IDs. (PGP
7894 3.170. pgp_mime_auto
7899 This option controls whether Mutt will prompt you for automatically sending a
7900 (signed/encrypted) message using PGP/MIME when inline (traditional) fails (for
7903 Also note that using the old-style PGP message format is strongly deprecated.
7906 3.171. pgp_replyinline
7911 Setting this variable will cause Mutt to always attempt to create an inline
7912 (traditional) message when replying to a message which is PGP encrypted/signed
7913 inline. This can be overridden by use of the pgp menu, when inline is not
7914 required. This option does not automatically detect if the (replied-to) message
7915 is inline; instead it relies on Mutt internals for previously checked/flagged
7918 Note that Mutt might automatically use PGP/MIME for messages which consist of
7919 more than a single MIME part. Mutt can be configured to ask before sending PGP/
7920 MIME messages when inline (traditional) would not work.
7922 Also see the $pgp_mime_auto variable.
7924 Also note that using the old-style PGP message format is strongly deprecated.
7927 3.172. pgp_retainable_sigs
7932 If set, signed and encrypted messages will consist of nested multipart/signed
7933 and multipart/encrypted body parts.
7935 This is useful for applications like encrypted and signed mailing lists, where
7936 the outer layer (multipart/encrypted) can be easily removed, while the inner
7937 multipart/signed part is retained. (PGP only)
7939 3.173. pgp_show_unusable
7944 If set, mutt will display non-usable keys on the PGP key selection menu. This
7945 includes keys which have been revoked, have expired, or have been marked as
7946 ?disabled? by the user. (PGP only)
7953 If you have more than one key pair, this option allows you to specify which of
7954 your private keys to use. It is recommended that you use the keyid form to
7955 specify your key (e.g. 0x00112233). (PGP only)
7957 3.175. pgp_sign_command
7962 This command is used to create the detached PGP signature for a multipart/
7963 signed PGP/MIME body part.
7965 This is a format string, see the $pgp_decode_command command for possible
7966 printf(3)-like sequences. (PGP only)
7968 3.176. pgp_sort_keys
7973 Specifies how the entries in the pgp menu are sorted. The following are legal
7976 +--------------------------------------+
7977 |address|sort alphabetically by user id|
7978 |-------+------------------------------|
7979 |keyid |sort alphabetically by key id |
7980 |-------+------------------------------|
7981 |date |sort by key creation date |
7982 |-------+------------------------------|
7983 |trust |sort by the trust of the key |
7984 +--------------------------------------+
7986 If you prefer reverse order of the above values, prefix it with ?reverse-?.
7989 3.177. pgp_strict_enc
7994 If set, Mutt will automatically encode PGP/MIME signed messages as
7995 quoted-printable. Please note that unsetting this variable may lead to problems
7996 with non-verifyable PGP signatures, so only change this if you know what you
7997 are doing. (PGP only)
8004 The number of seconds after which a cached passphrase will expire if not used.
8007 3.179. pgp_use_gpg_agent
8012 If set, mutt will use a possibly-running gpg-agent(1) process. (PGP only)
8014 3.180. pgp_verify_command
8019 This command is used to verify PGP signatures.
8021 This is a format string, see the $pgp_decode_command command for possible
8022 printf(3)-like sequences. (PGP only)
8024 3.181. pgp_verify_key_command
8029 This command is used to verify key information from the key selection menu.
8031 This is a format string, see the $pgp_decode_command command for possible
8032 printf(3)-like sequences. (PGP only)
8039 Used in connection with the <pipe-message> command. When unset, Mutt will pipe
8040 the messages without any preprocessing. When set, Mutt will weed headers and
8041 will attempt to decode the messages first.
8048 The separator to add between messages when piping a list of tagged messages to
8049 an external Unix command.
8056 Used in connection with the <pipe-message> function following <tag-prefix>. If
8057 this variable is unset, when piping a list of tagged messages Mutt will
8058 concatenate the messages and will pipe them all concatenated. When set, Mutt
8059 will pipe the messages one by one. In both cases the messages are piped in the
8060 current sorted order, and the $pipe_sep separator is added after each message.
8062 3.185. pop_auth_try_all
8067 If set, Mutt will try all available authentication methods. When unset, Mutt
8068 will only fall back to other authentication methods if the previous methods are
8069 unavailable. If a method is available but authentication fails, Mutt will not
8070 connect to the POP server.
8072 3.186. pop_authenticators
8077 This is a colon-delimited list of authentication methods mutt may attempt to
8078 use to log in to an POP server, in the order mutt should try them.
8079 Authentication methods are either ?user?, ?apop? or any SASL mechanism, eg
8080 ?digest-md5?, ?gssapi? or ?cram-md5?. This option is case-insensitive. If this
8081 option is unset (the default) mutt will try all available methods, in order
8082 from most-secure to least-secure.
8086 set pop_authenticators="digest-md5:apop:user"
8088 3.187. pop_checkinterval
8093 This variable configures how often (in seconds) mutt should look for new mail
8094 in the currently selected mailbox if it is a POP mailbox.
8101 If set, Mutt will delete successfully downloaded messages from the POP server
8102 when using the <fetch-mail> function. When unset, Mutt will download messages
8103 but also leave them on the POP server.
8110 The name of your POP server for the <fetch-mail> function. You can also specify
8111 an alternative port, username and password, ie:
8113 [pop[s]://][username[:password]@]popserver[:port]
8115 where ?[...]? denotes an optional part.
8122 If this variable is set, mutt will try to use the ?LAST? POP command for
8123 retrieving only unread messages from the POP server when using the <fetch-mail>
8131 Specifies the password for your POP account. If unset, Mutt will prompt you for
8132 your password when you open a POP mailbox.
8134 Warning: you should only use this option when you are on a fairly secure
8135 machine, because the superuser can read your muttrc even if you are the only
8136 one who can read the file.
8138 3.192. pop_reconnect
8143 Controls whether or not Mutt will try to reconnect to the POP server if the
8151 Your login name on the POP server.
8153 This variable defaults to your user name on the local machine.
8155 3.194. post_indent_string
8160 Similar to the $attribution variable, Mutt will append this string after the
8161 inclusion of a message which is being replied to.
8168 Controls whether or not messages are saved in the $postponed mailbox when you
8169 elect not to send immediately.
8171 Also see the $recall variable.
8176 Default: ??/postponed?
8178 Mutt allows you to indefinitely ?postpone sending a message? which you are
8179 editing. When you choose to postpone a message, Mutt saves it in the mailbox
8180 specified by this variable.
8182 Also see the $postpone variable.
8189 If set, a shell command to be executed if mutt fails to establish a connection
8190 to the server. This is useful for setting up secure connections, e.g. with ssh
8191 (1). If the command returns a nonzero status, mutt gives up opening the server.
8194 set preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net \
8195 sleep 20 < /dev/null > /dev/null"
8197 Mailbox ?foo? on ?mailhost.net? can now be reached as ?{localhost:1234}foo?.
8199 Note: For this example to work, you must be able to log in to the remote
8200 machine without having to enter a password.
8207 Controls whether or not Mutt really prints messages. This is set to ?ask-no? by
8208 default, because some people accidentally hit ?p? often.
8210 3.199. print_command
8215 This specifies the command pipe that should be used to print messages.
8222 Used in connection with the <print-message> command. If this option is set, the
8223 message is decoded before it is passed to the external command specified by
8224 $print_command. If this option is unset, no processing will be applied to the
8225 message when printing it. The latter setting may be useful if you are using
8226 some advanced printer filter which is able to properly format e-mail messages
8234 Used in connection with the <print-message> command. If this option is set, the
8235 command specified by $print_command is executed once for each message which is
8236 to be printed. If this option is unset, the command specified by $print_command
8237 is executed only once, and all the messages are concatenated, with a form feed
8238 as the message separator.
8240 Those who use the enscript(1) program's mail-printing mode will most likely
8241 want to set this option.
8248 If you use an external $pager, setting this variable will cause Mutt to prompt
8249 you for a command when the pager exits rather than returning to the index menu.
8250 If unset, Mutt will return to the index menu when the external pager exits.
8252 3.203. query_command
8257 This specifies the command that mutt will use to make external address queries.
8258 The string should contain a ?%s?, which will be substituted with the query
8259 string the user types. See ?query? for more information.
8264 Default: ?%4c %t %-25.25a %-25.25n %?e?(%e)??
8266 This variable describes the format of the ?query? menu. The following printf(3)
8267 -style sequences are understood:
8269 +---------------------------------------------------------+
8270 |%a |destination address |
8271 |---+-----------------------------------------------------|
8272 |%c |current entry number |
8273 |---+-----------------------------------------------------|
8274 |%e |extra information * |
8275 |---+-----------------------------------------------------|
8276 |%n |destination name |
8277 |---+-----------------------------------------------------|
8278 |%t |?*? if current entry is tagged, a space otherwise |
8279 |---+-----------------------------------------------------|
8280 |%>X|right justify the rest of the string and pad with ?X?|
8281 |---+-----------------------------------------------------|
8282 |%|X|pad to the end of the line with ?X? |
8283 |---+-----------------------------------------------------|
8284 |%*X|soft-fill with character ?X? as pad |
8285 +---------------------------------------------------------+
8287 For an explanation of ?soft-fill?, see the $index_format documentation.
8289 * = can be optionally printed if nonzero, see the $status_format documentation.
8296 This variable controls whether ?quit? and ?exit? actually quit from mutt. If
8297 this option is set, they do quit, if it is unset, they have no effect, and if
8298 it is set to ask-yes or ask-no, you are prompted for confirmation when you try
8303 Type: regular expression
8304 Default: ?^([ \t]*[|>:}#])+?
8306 A regular expression used in the internal pager to determine quoted sections of
8307 text in the body of a message. Quoted text may be filtered out using the
8308 <toggle-quoted> command, or colored according to the ?color quoted? family of
8311 Higher levels of quoting may be colored differently (?color quoted1?, ?color
8312 quoted2?, etc.). The quoting level is determined by removing the last character
8313 from the matched text and recursively reapplying the regular expression until
8314 it fails to produce a match.
8316 Match detection may be overridden by the $smileys regular expression.
8323 If set to a value greater than 0, Mutt will display which message it is
8324 currently on when reading a mailbox or when performing search actions such as
8325 search and limit. The message is printed after this many messages have been
8326 read or searched (e.g., if set to 25, Mutt will print a message when it is at
8327 message 25, and then again when it gets to message 50). This variable is meant
8328 to indicate progress when reading or searching large mailboxes which may take
8329 some time. When set to 0, only a single message will appear before the reading
8332 Also see the $write_inc, $net_inc and $time_inc variables and the ?tuning?
8333 section of the manual for performance considerations.
8340 If set, all folders are opened in read-only mode.
8347 This variable specifies what ?real? or ?personal? name should be used when
8350 By default, this is the GECOS field from /etc/passwd. Note that this variable
8351 will not be used when the user has set a real name in the $from variable.
8358 Controls whether or not Mutt recalls postponed messages when composing a new
8361 Setting this variable to is not generally useful, and thus not recommended.
8363 Also see $postponed variable.
8370 This specifies the file into which your outgoing messages should be appended.
8371 (This is meant as the primary method for saving a copy of your messages, but
8372 another way to do this is using the ?my_hdr? command to create a ?Bcc:? field
8373 with your email address in it.)
8375 The value of $record is overridden by the $force_name and $save_name variables,
8376 and the ?fcc-hook? command.
8380 Type: regular expression
8381 Default: ?^(re([\[0-9\]+])*|aw):[ \t]*?
8383 A regular expression used to recognize reply messages when threading and
8384 replying. The default value corresponds to the English "Re:" and the German
8392 If unset and you are replying to a message sent by you, Mutt will assume that
8393 you want to reply to the recipients of that message rather than to yourself.
8395 Also see the ?alternates? command.
8402 If set, when replying to a message, Mutt will use the address listed in the
8403 Reply-to: header as the recipient of the reply. If unset, it will use the
8404 address in the From: header field instead. This option is useful for reading a
8405 mailing list that sets the Reply-To: header field to the list address and you
8406 want to send a private message to the author of a message.
8413 When set, the cursor will be automatically advanced to the next (possibly
8414 undeleted) message whenever a command that modifies the current message is
8417 3.216. reverse_alias
8422 This variable controls whether or not Mutt will display the ?personal? name
8423 from your aliases in the index menu if it finds an alias that matches the
8424 message's sender. For example, if you have the following alias:
8426 alias juser abd30425@somewhere.net (Joe User)
8428 and then you receive mail which contains the following header:
8430 From: abd30425@somewhere.net
8432 It would be displayed in the index menu as ?Joe User? instead of
8433 ?abd30425@somewhere.net.? This is useful when the person's e-mail address is
8441 It may sometimes arrive that you receive mail to a certain machine, move the
8442 messages to another machine, and reply to some the messages from there. If this
8443 variable is set, the default From: line of the reply messages is built using
8444 the address where you received the messages you are replying to if that address
8445 matches your ?alternates?. If the variable is unset, or the address that would
8446 be used doesn't match your ?alternates?, the From: line will use your address
8447 on the current machine.
8449 Also see the ?alternates? command.
8451 3.218. reverse_realname
8456 This variable fine-tunes the behaviour of the $reverse_name feature. When it is
8457 set, mutt will use the address from incoming messages as-is, possibly including
8458 eventual real names. When it is unset, mutt will override any such real names
8459 with the setting of the $realname variable.
8461 3.219. rfc2047_parameters
8466 When this variable is set, Mutt will decode RFC2047-encoded MIME parameters.
8467 You want to set this variable when mutt suggests you to save attachments to
8470 =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
8472 When this variable is set interactively, the change won't be active until you
8475 Note that this use of RFC2047's encoding is explicitly prohibited by the
8476 standard, but nevertheless encountered in the wild.
8478 Also note that setting this parameter will not have the effect that mutt
8479 generates this kind of encoding. Instead, mutt will unconditionally use the
8480 encoding specified in RFC2231.
8487 If set, mutt will take the sender's full address when choosing a default folder
8488 for saving a mail. If $save_name or $force_name is set too, the selection of
8489 the Fcc folder will be changed as well.
8496 When unset, mailboxes which contain no saved messages will be removed when
8497 closed (the exception is $spoolfile which is never removed). If set, mailboxes
8500 Note: This only applies to mbox and MMDF folders, Mutt does not delete MH and
8501 Maildir directories.
8508 This variable controls the size of the history (per category) saved in the
8516 This variable controls how copies of outgoing messages are saved. When set, a
8517 check is made to see if a mailbox specified by the recipient address exists
8518 (this is done by searching for a mailbox in the $folder directory with the
8519 username part of the recipient address). If the mailbox exists, the outgoing
8520 message will be saved to that mailbox, otherwise the message is saved to the
8523 Also see the $force_name variable.
8530 When this variable is unset, scoring is turned off. This can be useful to
8531 selectively disable scoring for certain folders when the
8532 $score_threshold_delete variable and related are used.
8534 3.225. score_threshold_delete
8539 Messages which have been assigned a score equal to or lower than the value of
8540 this variable are automatically marked for deletion by mutt. Since mutt scores
8541 are always greater than or equal to zero, the default setting of this variable
8542 will never mark a message for deletion.
8544 3.226. score_threshold_flag
8549 Messages which have been assigned a score greater than or equal to this
8550 variable's value are automatically marked "flagged".
8552 3.227. score_threshold_read
8557 Messages which have been assigned a score equal to or lower than the value of
8558 this variable are automatically marked as read by mutt. Since mutt scores are
8559 always greater than or equal to zero, the default setting of this variable will
8560 never mark a message read.
8562 3.228. search_context
8567 For the pager, this variable specifies the number of lines shown before search
8568 results. By default, search results will be top-aligned.
8573 Default: ?us-ascii:iso-8859-1:utf-8?
8575 A colon-delimited list of character sets for outgoing messages. Mutt will use
8576 the first character set into which the text can be converted exactly. If your
8577 $charset is not ?iso-8859-1? and recipients may not understand ?UTF-8?, it is
8578 advisable to include in the list an appropriate widely used standard character
8579 set (such as ?iso-8859-2?, ?koi8-r? or ?iso-2022-jp?) either instead of or
8582 In case the text cannot be converted into one of these exactly, mutt uses
8583 $charset as a fallback.
8588 Default: ?/usr/sbin/sendmail -oem -oi?
8590 Specifies the program and arguments used to deliver mail sent by Mutt. Mutt
8591 expects that the specified program interprets additional arguments as recipient
8594 3.231. sendmail_wait
8599 Specifies the number of seconds to wait for the $sendmail process to finish
8600 before giving up and putting delivery in the background.
8602 Mutt interprets the value of this variable as follows:
8604 +---------------------------------------------------------------------+
8605 |>0|number of seconds to wait for sendmail to finish before continuing|
8606 |--+------------------------------------------------------------------|
8607 |0 |wait forever for sendmail to finish |
8608 |--+------------------------------------------------------------------|
8609 |<0|always put sendmail in the background without waiting |
8610 +---------------------------------------------------------------------+
8612 Note that if you specify a value other than 0, the output of the child process
8613 will be put in a temporary file. If there is some error, you will be informed
8614 as to where to find the output.
8621 Command to use when spawning a subshell. By default, the user's login shell
8622 from /etc/passwd is used.
8629 If set, a line containing ?-- ? (note the trailing space) will be inserted
8630 before your $signature. It is strongly recommended that you not unset this
8631 variable unless your signature contains just your name. The reason for this is
8632 because many software packages use ?-- \n? to detect your signature. For
8633 example, Mutt has the ability to highlight the signature in a different color
8634 in the builtin pager.
8641 If set, the signature will be included before any quoted or forwarded text. It
8642 is strongly recommended that you do not set this variable unless you really
8643 know what you are doing, and are prepared to take some heat from netiquette
8649 Default: ??/.signature?
8651 Specifies the filename of your signature, which is appended to all outgoing
8652 messages. If the filename ends with a pipe (?|?), it is assumed that filename
8653 is a shell command and input should be read from its standard output.
8655 3.236. simple_search
8658 Default: ??f %s | ?s %s?
8660 Specifies how Mutt should expand a simple search into a real search pattern. A
8661 simple search is one that does not contain any of the ??? pattern operators.
8662 See ?patterns? for more information on search patterns.
8664 For example, if you simply type ?joe? at a search or limit prompt, Mutt will
8665 automatically expand it to the value specified by this variable by replacing
8666 ?%s? with the supplied string. For the default value, ?joe? would be expanded
8667 to: ??f joe | ?s joe?.
8674 Specifies time, in seconds, to pause while displaying certain informational
8675 messages, while moving from folder to folder and after expunging messages from
8676 the current folder. The default is to pause one second, so a value of zero for
8677 this option suppresses the pause.
8684 Controls the display of lines longer than the screen width in the internal
8685 pager. If set, long lines are wrapped at a word boundary. If unset, lines are
8686 simply wrapped at the screen edge. Also see the $markers variable.
8690 Type: regular expression
8691 Default: ?(>From )|(:[-^]?[][)(><}{|/DP])?
8693 The pager uses this variable to catch some common false positives of
8694 $quote_regexp, most notably smileys and not consider a line quoted text if it
8695 also matches $smileys. This mostly happens at the beginning of a line.
8697 3.240. smime_ask_cert_label
8702 This flag controls whether you want to be asked to enter a label for a
8703 certificate about to be added to the database or not. It is set by default. (S/
8706 3.241. smime_ca_location
8711 This variable contains the name of either a directory, or a file which contains
8712 trusted certificates for use with OpenSSL. (S/MIME only)
8714 3.242. smime_certificates
8719 Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
8720 storage and retrieval of keys by itself. This is very basic right now, and keys
8721 and certificates are stored in two different directories, both named as the
8722 hash-value retrieved from OpenSSL. There is an index file which contains
8723 mailbox-address keyid pairs, and which can be manually edited. This option
8724 points to the location of the certificates. (S/MIME only)
8726 3.243. smime_decrypt_command
8731 This format string specifies a command which is used to decrypt application/
8732 x-pkcs7-mime attachments.
8734 The OpenSSL command formats have their own set of printf(3)-like sequences
8737 +-----------------------------------------------------------------------------+
8738 |%f|Expands to the name of a file containing a message. |
8739 |--+--------------------------------------------------------------------------|
8740 |%s|Expands to the name of a file containing the signature part of a multipart|
8741 | |/signed attachment when verifying it. |
8742 |--+--------------------------------------------------------------------------|
8743 |%k|The key-pair specified with $smime_default_key |
8744 |--+--------------------------------------------------------------------------|
8745 |%c|One or more certificate IDs. |
8746 |--+--------------------------------------------------------------------------|
8747 |%a|The algorithm used for encryption. |
8748 |--+--------------------------------------------------------------------------|
8749 | |CA location: Depending on whether $smime_ca_location points to a directory|
8750 |%C|or file, this expands to ?-CApath $smime_ca_location? or ?-CAfile |
8751 | |$smime_ca_location?. |
8752 +-----------------------------------------------------------------------------+
8754 For examples on how to configure these formats, see the smime.rc in the samples
8755 / subdirectory which has been installed on your system alongside the
8756 documentation. (S/MIME only)
8758 3.244. smime_decrypt_use_default_key
8763 If set (default) this tells mutt to use the default key for decryption.
8764 Otherwise, if managing multiple certificate-key-pairs, mutt will try to use the
8765 mailbox-address to determine the key to use. It will ask you to supply a key,
8766 if it can't find one. (S/MIME only)
8768 3.245. smime_default_key
8773 This is the default key-pair to use for signing. This must be set to the keyid
8774 (the hash-value that OpenSSL generates) to work properly (S/MIME only)
8776 3.246. smime_encrypt_command
8781 This command is used to create encrypted S/MIME messages.
8783 This is a format string, see the $smime_decrypt_command command for possible
8784 printf(3)-like sequences. (S/MIME only)
8786 3.247. smime_encrypt_with
8791 This sets the algorithm that should be used for encryption. Valid choices are
8792 ?des?, ?des3?, ?rc2-40?, ?rc2-64?, ?rc2-128?. If unset, ?3des? (TripleDES) is
8795 3.248. smime_get_cert_command
8800 This command is used to extract X509 certificates from a PKCS7 structure.
8802 This is a format string, see the $smime_decrypt_command command for possible
8803 printf(3)-like sequences. (S/MIME only)
8805 3.249. smime_get_cert_email_command
8810 This command is used to extract the mail address(es) used for storing X509
8811 certificates, and for verification purposes (to check whether the certificate
8812 was issued for the sender's mailbox).
8814 This is a format string, see the $smime_decrypt_command command for possible
8815 printf(3)-like sequences. (S/MIME only)
8817 3.250. smime_get_signer_cert_command
8822 This command is used to extract only the signers X509 certificate from a S/MIME
8823 signature, so that the certificate's owner may get compared to the email's
8826 This is a format string, see the $smime_decrypt_command command for possible
8827 printf(3)-like sequences. (S/MIME only)
8829 3.251. smime_import_cert_command
8834 This command is used to import a certificate via smime_keys.
8836 This is a format string, see the $smime_decrypt_command command for possible
8837 printf(3)-like sequences. (S/MIME only)
8839 3.252. smime_is_default
8844 The default behaviour of mutt is to use PGP on all auto-sign/encryption
8845 operations. To override and to use OpenSSL instead this must be set. However,
8846 this has no effect while replying, since mutt will automatically select the
8847 same application that was used to sign/encrypt the original message. (Note that
8848 this variable can be overridden by unsetting $crypt_autosmime.) (S/MIME only)
8855 Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
8856 storage and retrieval of keys/certs by itself. This is very basic right now,
8857 and stores keys and certificates in two different directories, both named as
8858 the hash-value retrieved from OpenSSL. There is an index file which contains
8859 mailbox-address keyid pair, and which can be manually edited. This option
8860 points to the location of the private keys. (S/MIME only)
8862 3.254. smime_pk7out_command
8867 This command is used to extract PKCS7 structures of S/MIME signatures, in order
8868 to extract the public X509 certificate(s).
8870 This is a format string, see the $smime_decrypt_command command for possible
8871 printf(3)-like sequences. (S/MIME only)
8873 3.255. smime_sign_command
8878 This command is used to created S/MIME signatures of type multipart/signed,
8879 which can be read by all mail clients.
8881 This is a format string, see the $smime_decrypt_command command for possible
8882 printf(3)-like sequences. (S/MIME only)
8884 3.256. smime_sign_opaque_command
8889 This command is used to created S/MIME signatures of type application/
8890 x-pkcs7-signature, which can only be handled by mail clients supporting the S/
8893 This is a format string, see the $smime_decrypt_command command for possible
8894 printf(3)-like sequences. (S/MIME only)
8896 3.257. smime_timeout
8901 The number of seconds after which a cached passphrase will expire if not used.
8904 3.258. smime_verify_command
8909 This command is used to verify S/MIME signatures of type multipart/signed.
8911 This is a format string, see the $smime_decrypt_command command for possible
8912 printf(3)-like sequences. (S/MIME only)
8914 3.259. smime_verify_opaque_command
8919 This command is used to verify S/MIME signatures of type application/
8922 This is a format string, see the $smime_decrypt_command command for possible
8923 printf(3)-like sequences. (S/MIME only)
8925 3.260. smtp_authenticators
8930 This is a colon-delimited list of authentication methods mutt may attempt to
8931 use to log in to an SMTP server, in the order mutt should try them.
8932 Authentication methods are any SASL mechanism, eg ?digest-md5?, ?gssapi? or
8933 ?cram-md5?. This option is case-insensitive. If it is ?unset? (the default)
8934 mutt will try all available methods, in order from most-secure to least-secure.
8938 set smtp_authenticators="digest-md5:cram-md5"
8945 Specifies the password for your SMTP account. If unset, Mutt will prompt you
8946 for your password when you first send mail via SMTP. See $smtp_url to configure
8947 mutt to send mail via SMTP.
8949 Warning: you should only use this option when you are on a fairly secure
8950 machine, because the superuser can read your muttrc even if you are the only
8951 one who can read the file.
8958 Defines the SMTP smarthost where sent messages should relayed for delivery.
8959 This should take the form of an SMTP URL, eg:
8961 smtp[s]://[user[:pass]@]host[:port]/
8963 where ?[...]? denotes an optional part. Setting this variable overrides the
8964 value of the $sendmail variable.
8971 Specifies how to sort messages in the ?index? menu. Valid values are:
8979 * mailbox-order (unsorted)
8993 You may optionally use the ?reverse-? prefix to specify reverse sorting order
8994 (example: ?set sort=reverse-date-sent?).
9001 Specifies how the entries in the ?alias? menu are sorted. The following are
9004 * address (sort alphabetically by email address)
9006 * alias (sort alphabetically by alias name)
9008 * unsorted (leave in order specified in .muttrc)
9015 When sorting by threads, this variable controls how threads are sorted in
9016 relation to other threads, and how the branches of the thread trees are sorted.
9017 This can be set to any value that $sort can, except ?threads? (in that case,
9018 mutt will just use ?date-sent?). You can also specify the ?last-? prefix in
9019 addition to the ?reverse-? prefix, but ?last-? must come after ?reverse-?. The
9020 ?last-? prefix causes messages to be sorted against its siblings by which has
9021 the last descendant, using the rest of $sort_aux as an ordering. For instance,
9023 set sort_aux=last-date-received
9025 would mean that if a new message is received in a thread, that thread becomes
9026 the last one displayed (or the first, if you have ?set sort=reverse-threads?.)
9028 Note: For reversed $sort order $sort_aux is reversed again (which is not the
9029 right thing to do, but kept to not break any existing configuration setting).
9036 Specifies how to sort entries in the file browser. By default, the entries are
9037 sorted alphabetically. Valid values:
9039 * alpha (alphabetically)
9047 You may optionally use the ?reverse-? prefix to specify reverse sorting order
9048 (example: ?set sort_browser=reverse-date?).
9055 This variable is only useful when sorting by threads with $strict_threads unset
9056 . In that case, it changes the heuristic mutt uses to thread messages by
9057 subject. With $sort_re set, mutt will only attach a message as the child of
9058 another message by subject if the subject of the child message starts with a
9059 substring matching the setting of $reply_regexp. With $sort_re unset, mutt will
9060 attach the message whether or not this is the case, as long as the non-
9061 $reply_regexp parts of both messages are identical.
9063 3.268. spam_separator
9068 This variable controls what happens when multiple spam headers are matched: if
9069 unset, each successive header will overwrite any previous matches value for the
9070 spam label. If set, each successive match will append to the previous, using
9071 this variable's value as a separator.
9078 If your spool mailbox is in a non-default place where Mutt cannot find it, you
9079 can specify its location with this variable. Mutt will initially set this
9080 variable to the value of the environment variable $MAIL or $MAILDIR if either
9083 3.270. ssl_ca_certificates_file
9088 This variable specifies a file containing trusted CA certificates. Any server
9089 certificate that is signed with one of these CA certificates is also
9090 automatically accepted.
9094 set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
9096 3.271. ssl_client_cert
9101 The file containing a client certificate and its associated private key.
9103 3.272. ssl_force_tls
9108 If this variable is set, Mutt will require that all connections to remote
9109 servers be encrypted. Furthermore it will attempt to negotiate TLS even if the
9110 server does not advertise the capability, since it would otherwise have to
9111 abort the connection anyway. This option supersedes $ssl_starttls.
9113 3.273. ssl_min_dh_prime_bits
9118 This variable specifies the minimum acceptable prime size (in bits) for use in
9119 any Diffie-Hellman key exchange. A value of 0 will use the default from the
9127 If set (the default), mutt will attempt to use STARTTLS on servers advertising
9128 the capability. When unset, mutt will not attempt to use STARTTLS regardless of
9129 the server's capabilities.
9131 3.275. ssl_use_sslv2
9136 This variable specifies whether to attempt to use SSLv2 in the SSL
9137 authentication process.
9139 3.276. ssl_use_sslv3
9144 This variable specifies whether to attempt to use SSLv3 in the SSL
9145 authentication process.
9147 3.277. ssl_use_tlsv1
9152 This variable specifies whether to attempt to use TLSv1 in the SSL
9153 authentication process.
9155 3.278. ssl_usesystemcerts
9160 If set to yes, mutt will use CA certificates in the system-wide certificate
9161 store when checking if a server certificate is signed by a trusted CA.
9163 3.279. ssl_verify_dates
9168 If set (the default), mutt will not automatically accept a server certificate
9169 that is either not yet valid or already expired. You should only unset this for
9170 particular known hosts, using the <account-hook> function.
9172 3.280. ssl_verify_host
9177 If set (the default), mutt will not automatically accept a server certificate
9178 whose host name does not match the host used in your folder URL. You should
9179 only unset this for particular known hosts, using the <account-hook> function.
9186 Controls the characters used by the ?%r? indicator in $status_format. The first
9187 character is used when the mailbox is unchanged. The second is used when the
9188 mailbox has been changed, and it needs to be resynchronized. The third is used
9189 if the mailbox is in read-only mode, or if the mailbox will not be written when
9190 exiting that mailbox (You can toggle whether to write changes to a mailbox with
9191 the <toggle-write> operation, bound by default to ?%?). The fourth is used to
9192 indicate that the current folder has been opened in attach- message mode
9193 (Certain operations like composing a new mail, replying, forwarding, etc. are
9194 not permitted in this mode).
9196 3.282. status_format
9199 Default: ?-%r-Mutt: %f [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d? Del:%d?%?F?
9200 Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l? %l?]---(%s/%S)-%>-(%P)---?
9202 Controls the format of the status line displayed in the ?index? menu. This
9203 string is similar to $index_format, but has its own set of printf(3)-like
9206 +-----------------------------------------------------------------------------+
9207 |%b |number of mailboxes with new mail * |
9208 |---+-------------------------------------------------------------------------|
9209 |%d |number of deleted messages * |
9210 |---+-------------------------------------------------------------------------|
9211 |%f |the full pathname of the current mailbox |
9212 |---+-------------------------------------------------------------------------|
9213 |%F |number of flagged messages * |
9214 |---+-------------------------------------------------------------------------|
9215 |%h |local hostname |
9216 |---+-------------------------------------------------------------------------|
9217 |%l |size (in bytes) of the current mailbox * |
9218 |---+-------------------------------------------------------------------------|
9219 |%L |size (in bytes) of the messages shown (i.e., which match the current |
9221 |---+-------------------------------------------------------------------------|
9222 |%m |the number of messages in the mailbox * |
9223 |---+-------------------------------------------------------------------------|
9224 |%M |the number of messages shown (i.e., which match the current limit) * |
9225 |---+-------------------------------------------------------------------------|
9226 |%n |number of new messages in the mailbox * |
9227 |---+-------------------------------------------------------------------------|
9228 |%o |number of old unread messages * |
9229 |---+-------------------------------------------------------------------------|
9230 |%p |number of postponed messages * |
9231 |---+-------------------------------------------------------------------------|
9232 |%P |percentage of the way through the index |
9233 |---+-------------------------------------------------------------------------|
9234 |%r |modified/read-only/won't-write/attach-message indicator, according to |
9236 |---+-------------------------------------------------------------------------|
9237 |%s |current sorting mode ($sort) |
9238 |---+-------------------------------------------------------------------------|
9239 |%S |current aux sorting method ($sort_aux) |
9240 |---+-------------------------------------------------------------------------|
9241 |%t |number of tagged messages * |
9242 |---+-------------------------------------------------------------------------|
9243 |%u |number of unread messages * |
9244 |---+-------------------------------------------------------------------------|
9245 |%v |Mutt version string |
9246 |---+-------------------------------------------------------------------------|
9247 |%V |currently active limit pattern, if any * |
9248 |---+-------------------------------------------------------------------------|
9249 |%>X|right justify the rest of the string and pad with ?X? |
9250 |---+-------------------------------------------------------------------------|
9251 |%|X|pad to the end of the line with ?X? |
9252 |---+-------------------------------------------------------------------------|
9253 |%*X|soft-fill with character ?X? as pad |
9254 +-----------------------------------------------------------------------------+
9256 For an explanation of ?soft-fill?, see the $index_format documentation.
9258 * = can be optionally printed if nonzero
9260 Some of the above sequences can be used to optionally print a string if their
9261 value is nonzero. For example, you may only want to see the number of flagged
9262 messages if such messages exist, since zero is not particularly meaningful. To
9263 optionally print a string based upon one of the above sequences, the following
9266 %?<sequence_char>?<optional_string>?
9268 where sequence_char is a character from the table above, and optional_string is
9269 the string you would like printed if sequence_char is nonzero. optional_string
9270 may contain other sequences as well as normal text, but you may not nest
9273 Here is an example illustrating how to optionally print the number of new
9274 messages in a mailbox:
9276 %?n?%n new messages.?
9278 You can also switch between two strings using the following construct:
9280 %?<sequence_char>?<if_string>&<else_string>?
9282 If the value of sequence_char is non-zero, if_string will be expanded,
9283 otherwise else_string will be expanded.
9285 You can force the result of any printf(3)-like sequence to be lowercase by
9286 prefixing the sequence character with an underscore (?_?) sign. For example, if
9287 you want to display the local hostname in lowercase, you would use: ?%_h?.
9289 If you prefix the sequence character with a colon (?:?) character, mutt will
9290 replace any dots in the expansion by underscores. This might be helpful with
9291 IMAP folders that don't like dots in folder names.
9293 3.283. status_on_top
9298 Setting this variable causes the ?status bar? to be displayed on the first line
9299 of the screen rather than near the bottom. If $help is set, too it'll be placed
9302 3.284. strict_threads
9307 If set, threading will only make use of the ?In-Reply-To? and ?References:?
9308 fields when you $sort by message threads. By default, messages with the same
9309 subject are grouped together in ?pseudo threads.?. This may not always be
9310 desirable, such as in a personal mailbox where you might have several unrelated
9311 messages with the subjects like ?hi? which will get grouped together. See also
9312 $sort_re for a less drastic way of controlling this behaviour.
9319 When unset, mutt won't stop when the user presses the terminal's susp key,
9320 usually ?^Z?. This is useful if you run mutt inside an xterm using a command
9321 like ?xterm -e mutt?.
9328 When set, mutt will generate ?format=flowed? bodies with a content type of
9329 ?text/plain; format=flowed?. This format is easier to handle for some mailing
9330 software, and generally just looks like ordinary text. To actually make use of
9331 this format's features, you'll need support in your editor.
9333 Note that $indent_string is ignored when this option is set.
9335 3.287. thorough_search
9340 Affects the ?b and ?h search operations described in section ?patterns?. If set
9341 , the headers and body/attachments of messages to be searched are decoded
9342 before searching. If unset, messages are searched as they appear in the folder.
9344 Users searching attachments or for non-ASCII characters should set this value
9345 because decoding also includes MIME parsing/decoding and possible character set
9346 conversions. Otherwise mutt will attempt to match against the raw message
9347 received (for example quoted-printable encoded or with encoded headers) which
9348 may lead to incorrect search results.
9350 3.288. thread_received
9355 When set, mutt uses the date received rather than the date sent to thread
9356 messages by subject.
9363 When set, the internal-pager will pad blank lines to the bottom of the screen
9371 Along with $read_inc, $write_inc, and $net_inc, this variable controls the
9372 frequency with which progress updates are displayed. It suppresses updates less
9373 than $time_inc milliseconds apart. This can improve throughput on systems with
9374 slow terminals, or when running mutt on a remote system.
9376 Also see the ?tuning? section of the manual for performance considerations.
9383 When Mutt is waiting for user input either idleing in menus or in an
9384 interactive prompt, Mutt would block until input is present. Depending on the
9385 context, this would prevent certain operations from working, like checking for
9386 new mail or keeping an IMAP connection alive.
9388 This variable controls how many seconds Mutt will at most wait until it aborts
9389 waiting for input, performs these operations and continues to wait for input.
9391 A value of zero or less will cause Mutt to never time out.
9398 This variable allows you to specify where Mutt will place its temporary files
9399 needed for displaying and composing messages. If this variable is not set, the
9400 environment variable $TMPDIR is used. If $TMPDIR is not set then ?/tmp? is
9408 Controls the character used to indicate mail addressed to you. The first
9409 character is the one used when the mail is not addressed to your address. The
9410 second is used when you are the only recipient of the message. The third is
9411 when your address appears in the ?To:? header field, but you are not the only
9412 recipient of the message. The fourth character is used when your address is
9413 specified in the ?Cc:? header field, but you are not the only recipient. The
9414 fifth character is used to indicate mail that was sent by you. The sixth
9415 character is used to indicate when a mail was sent to a mailing-list you
9423 Setting this variable will cause mutt to open a pipe to a command instead of a
9424 raw socket. You may be able to use this to set up preauthenticated connections
9425 to your IMAP/POP3/SMTP server. Example:
9427 set tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
9429 Note: For this example to work you must be able to log in to the remote machine
9430 without having to enter a password.
9432 When set, Mutt uses the tunnel for all remote connections. Please see ?
9433 account-hook? in the manual for how to use different tunnel commands per
9436 3.295. uncollapse_jump
9441 When set, Mutt will jump to the next unread message, if any, when the current
9442 thread is uncollapsed.
9449 Warning: do not set this variable unless you are using a version of sendmail
9450 which supports the -B8BITMIME flag (such as sendmail 8.8.x) or you may not be
9453 When set, Mutt will invoke $sendmail with the -B8BITMIME flag when sending
9454 8-bit messages to enable ESMTP negotiation.
9461 When set, Mutt will qualify all local addresses (ones without the ?@host?
9462 portion) with the value of $hostname. If unset, no addresses will be qualified.
9464 3.298. use_envelope_from
9469 When set, mutt will set the envelope sender of the message. If
9470 $envelope_from_address is set, it will be used as the sender address. If unset,
9471 mutt will attempt to derive the sender from the ?From:? header.
9473 Note that this information is passed to sendmail command using the -f command
9474 line switch. Therefore setting this option is not useful if the $sendmail
9475 variable already contains -f or if the executable pointed to by $sendmail
9476 doesn't support the -f switch.
9483 When set, Mutt will generate the ?From:? header field when sending messages. If
9484 unset, no ?From:? header field will be generated unless the user explicitly
9485 sets one using the ?my_hdr? command.
9492 When set, Mutt will show you international domain names decoded. Note: You can
9493 use IDNs for addresses even if this is unset. This variable only affects
9501 When set, Mutt will look for IPv6 addresses of hosts it tries to contact. If
9502 this option is unset, Mutt will restrict itself to IPv4 addresses. Normally,
9503 the default should work.
9510 When set, mutt will add a ?User-Agent:? header to outgoing messages, indicating
9511 which version of mutt was used for composing them.
9518 Specifies the visual editor to invoke when the ??v? command is given in the
9526 Controls whether Mutt will ask you to press a key after an external command has
9527 been invoked by these functions: <shell-escape>, <pipe-message>, <pipe-entry>,
9528 <print-message>, and <print-entry> commands.
9530 It is also used when viewing attachments with ?auto_view?, provided that the
9531 corresponding mailcap entry has a needsterminal flag, and the external program
9534 When set, Mutt will always ask for a key. When unset, Mutt will wait for a key
9535 only if the external command returned a non-zero status.
9542 When set, mutt will weed headers when displaying, forwarding, printing, or
9543 replying to messages.
9550 When set to a positive value, mutt will wrap text at $wrap characters. When set
9551 to a negative value, mutt will wrap text so that there are $wrap characters of
9552 empty space on the right side of the terminal.
9559 Controls whether searches wrap around the end.
9561 When set, searches will wrap around the first (or last) item. When unset,
9562 incremental searches will not wrap.
9569 (DEPRECATED) Equivalent to setting $wrap with a negative value.
9576 Controls whether mutt writes out the ?Bcc:? header when preparing messages to
9577 be sent. Exim users may wish to unset this. If mutt is set to deliver directly
9578 via SMTP (see $smtp_url), this option does nothing: mutt will never write out
9579 the ?Bcc:? header in this case.
9586 When writing a mailbox, a message will be printed every $write_inc messages to
9587 indicate progress. If set to 0, only a single message will be displayed before
9590 Also see the $read_inc, $net_inc and $time_inc variables and the ?tuning?
9591 section of the manual for performance considerations.
9595 The following is the list of available functions listed by the mapping in which
9596 they are available. The default key setting is given, and an explanation of
9597 what the function does. The key bindings of these functions can be changed with
9602 The generic menu is not a real menu, but specifies common functions (such as
9603 movement) available in all menus except for pager and editor. Changing settings
9604 for this menu will affect the default bindings for all menus (except as noted).
9606 Table 9.2. Default generic Function Bindings
9608 +-------------------------------------------------------------------------+
9609 | Function |Default key| Description |
9610 |-----------------+-----------+-------------------------------------------|
9611 |<top-page> |H |move to the top of the page |
9612 |-----------------+-----------+-------------------------------------------|
9613 |<next-entry> |j |move to the next entry |
9614 |-----------------+-----------+-------------------------------------------|
9615 |<previous-entry> |k |move to the previous entry |
9616 |-----------------+-----------+-------------------------------------------|
9617 |<bottom-page> |L |move to the bottom of the page |
9618 |-----------------+-----------+-------------------------------------------|
9619 |<refresh> |^L |clear and redraw the screen |
9620 |-----------------+-----------+-------------------------------------------|
9621 |<middle-page> |M |move to the middle of the page |
9622 |-----------------+-----------+-------------------------------------------|
9623 |<search-next> |n |search for next match |
9624 |-----------------+-----------+-------------------------------------------|
9625 |<exit> |q |exit this menu |
9626 |-----------------+-----------+-------------------------------------------|
9627 |<tag-entry> |t |tag the current entry |
9628 |-----------------+-----------+-------------------------------------------|
9629 |<next-page> |z |move to the next page |
9630 |-----------------+-----------+-------------------------------------------|
9631 |<previous-page> |Z |move to the previous page |
9632 |-----------------+-----------+-------------------------------------------|
9633 |<last-entry> |* |move to the last entry |
9634 |-----------------+-----------+-------------------------------------------|
9635 |<first-entry> |= |move to the first entry |
9636 |-----------------+-----------+-------------------------------------------|
9637 |<enter-command> |: |enter a muttrc command |
9638 |-----------------+-----------+-------------------------------------------|
9639 |<next-line> |> |scroll down one line |
9640 |-----------------+-----------+-------------------------------------------|
9641 |<previous-line> |< |scroll up one line |
9642 |-----------------+-----------+-------------------------------------------|
9643 |<half-up> |[ |scroll up 1/2 page |
9644 |-----------------+-----------+-------------------------------------------|
9645 |<half-down> |] |scroll down 1/2 page |
9646 |-----------------+-----------+-------------------------------------------|
9647 |<help> |? |this screen |
9648 |-----------------+-----------+-------------------------------------------|
9649 |<tag-prefix> |; |apply next function to tagged messages |
9650 |-----------------+-----------+-------------------------------------------|
9651 |<tag-prefix-cond>| |apply next function ONLY to tagged messages|
9652 |-----------------+-----------+-------------------------------------------|
9653 |<end-cond> | |end of conditional execution (noop) |
9654 |-----------------+-----------+-------------------------------------------|
9655 |<shell-escape> |! |invoke a command in a subshell |
9656 |-----------------+-----------+-------------------------------------------|
9657 |<select-entry> |<Return> |select the current entry |
9658 |-----------------+-----------+-------------------------------------------|
9659 |<search> |/ |search for a regular expression |
9660 |-----------------+-----------+-------------------------------------------|
9661 |<search-reverse> |Esc / |search backwards for a regular expression |
9662 |-----------------+-----------+-------------------------------------------|
9663 |<search-opposite>| |search for next match in opposite direction|
9664 |-----------------+-----------+-------------------------------------------|
9665 |<jump> | |jump to an index number |
9666 |-----------------+-----------+-------------------------------------------|
9667 |<current-top> | |move entry to top of screen |
9668 |-----------------+-----------+-------------------------------------------|
9669 |<current-middle> | |move entry to middle of screen |
9670 |-----------------+-----------+-------------------------------------------|
9671 |<current-bottom> | |move entry to bottom of screen |
9672 |-----------------+-----------+-------------------------------------------|
9673 |<what-key> | |display the keycode for a key press |
9674 +-------------------------------------------------------------------------+
9679 Table 9.3. Default index Function Bindings
9681 +-----------------------------------------------------------------------------+
9682 | Function | Default | Description |
9684 |--------------------------+---------+----------------------------------------|
9685 |<create-alias> |a |create an alias from a message sender |
9686 |--------------------------+---------+----------------------------------------|
9687 |<bounce-message> |b |remail a message to another user |
9688 |--------------------------+---------+----------------------------------------|
9689 |<break-thread> |# |break the thread in two |
9690 |--------------------------+---------+----------------------------------------|
9691 |<change-folder> |c |open a different folder |
9692 |--------------------------+---------+----------------------------------------|
9693 |<change-folder-readonly> |Esc c |open a different folder in read only |
9695 |--------------------------+---------+----------------------------------------|
9696 |<next-unread-mailbox> | |open next mailbox with new mail |
9697 |--------------------------+---------+----------------------------------------|
9698 |<collapse-thread> |Esc v |collapse/uncollapse current thread |
9699 |--------------------------+---------+----------------------------------------|
9700 |<collapse-all> |Esc V |collapse/uncollapse all threads |
9701 |--------------------------+---------+----------------------------------------|
9702 |<copy-message> |C |copy a message to a file/mailbox |
9703 |--------------------------+---------+----------------------------------------|
9704 |<decode-copy> |Esc C |make decoded (text/plain) copy |
9705 |--------------------------+---------+----------------------------------------|
9706 |<decode-save> |Esc s |make decoded copy (text/plain) and |
9708 |--------------------------+---------+----------------------------------------|
9709 |<delete-message> |d |delete the current entry |
9710 |--------------------------+---------+----------------------------------------|
9711 |<delete-pattern> |D |delete messages matching a pattern |
9712 |--------------------------+---------+----------------------------------------|
9713 |<delete-thread> |^D |delete all messages in thread |
9714 |--------------------------+---------+----------------------------------------|
9715 |<delete-subthread> |Esc d |delete all messages in subthread |
9716 |--------------------------+---------+----------------------------------------|
9717 |<edit> |e |edit the raw message |
9718 |--------------------------+---------+----------------------------------------|
9719 |<edit-type> |^E |edit attachment content type |
9720 |--------------------------+---------+----------------------------------------|
9721 |<forward-message> |f |forward a message with comments |
9722 |--------------------------+---------+----------------------------------------|
9723 |<flag-message> |F |toggle a message's 'important' flag |
9724 |--------------------------+---------+----------------------------------------|
9725 |<group-reply> |g |reply to all recipients |
9726 |--------------------------+---------+----------------------------------------|
9727 |<fetch-mail> |G |retrieve mail from POP server |
9728 |--------------------------+---------+----------------------------------------|
9729 |<imap-fetch-mail> | |force retrieval of mail from IMAP server|
9730 |--------------------------+---------+----------------------------------------|
9731 |<display-toggle-weed> |h |display message and toggle header |
9733 |--------------------------+---------+----------------------------------------|
9734 |<next-undeleted> |j |move to the next undeleted message |
9735 |--------------------------+---------+----------------------------------------|
9736 |<previous-undeleted> |k |move to the previous undeleted message |
9737 |--------------------------+---------+----------------------------------------|
9738 |<limit> |l |show only messages matching a pattern |
9739 |--------------------------+---------+----------------------------------------|
9740 |<link-threads> |& |link tagged message to the current one |
9741 |--------------------------+---------+----------------------------------------|
9742 |<list-reply> |L |reply to specified mailing list |
9743 |--------------------------+---------+----------------------------------------|
9744 |<mail> |m |compose a new mail message |
9745 |--------------------------+---------+----------------------------------------|
9746 |<toggle-new> |N |toggle a message's 'new' flag |
9747 |--------------------------+---------+----------------------------------------|
9748 |<toggle-write> |% |toggle whether the mailbox will be |
9750 |--------------------------+---------+----------------------------------------|
9751 |<next-thread> |^N |jump to the next thread |
9752 |--------------------------+---------+----------------------------------------|
9753 |<next-subthread> |Esc n |jump to the next subthread |
9754 |--------------------------+---------+----------------------------------------|
9755 |<query> |Q |query external program for addresses |
9756 |--------------------------+---------+----------------------------------------|
9757 |<quit> |q |save changes to mailbox and quit |
9758 |--------------------------+---------+----------------------------------------|
9759 |<reply> |r |reply to a message |
9760 |--------------------------+---------+----------------------------------------|
9761 |<show-limit> |Esc l |show currently active limit pattern |
9762 |--------------------------+---------+----------------------------------------|
9763 |<sort-mailbox> |o |sort messages |
9764 |--------------------------+---------+----------------------------------------|
9765 |<sort-reverse> |O |sort messages in reverse order |
9766 |--------------------------+---------+----------------------------------------|
9767 |<print-message> |p |print the current entry |
9768 |--------------------------+---------+----------------------------------------|
9769 |<previous-thread> |^P |jump to previous thread |
9770 |--------------------------+---------+----------------------------------------|
9771 |<previous-subthread> |Esc p |jump to previous subthread |
9772 |--------------------------+---------+----------------------------------------|
9773 |<recall-message> |R |recall a postponed message |
9774 |--------------------------+---------+----------------------------------------|
9775 |<read-thread> |^R |mark the current thread as read |
9776 |--------------------------+---------+----------------------------------------|
9777 |<read-subthread> |Esc r |mark the current subthread as read |
9778 |--------------------------+---------+----------------------------------------|
9779 |<resend-message> |Esc e |use the current message as a template |
9780 | | |for a new one |
9781 |--------------------------+---------+----------------------------------------|
9782 |<save-message> |s |save message/attachment to a mailbox/ |
9784 |--------------------------+---------+----------------------------------------|
9785 |<tag-pattern> |T |tag messages matching a pattern |
9786 |--------------------------+---------+----------------------------------------|
9787 |<tag-subthread> | |tag the current subthread |
9788 |--------------------------+---------+----------------------------------------|
9789 |<tag-thread> |Esc t |tag the current thread |
9790 |--------------------------+---------+----------------------------------------|
9791 |<untag-pattern> |^T |untag messages matching a pattern |
9792 |--------------------------+---------+----------------------------------------|
9793 |<undelete-message> |u |undelete the current entry |
9794 |--------------------------+---------+----------------------------------------|
9795 |<undelete-pattern> |U |undelete messages matching a pattern |
9796 |--------------------------+---------+----------------------------------------|
9797 |<undelete-subthread> |Esc u |undelete all messages in subthread |
9798 |--------------------------+---------+----------------------------------------|
9799 |<undelete-thread> |^U |undelete all messages in thread |
9800 |--------------------------+---------+----------------------------------------|
9801 |<view-attachments> |v |show MIME attachments |
9802 |--------------------------+---------+----------------------------------------|
9803 |<show-version> |V |show the Mutt version number and date |
9804 |--------------------------+---------+----------------------------------------|
9805 |<set-flag> |w |set a status flag on a message |
9806 |--------------------------+---------+----------------------------------------|
9807 |<clear-flag> |W |clear a status flag from a message |
9808 |--------------------------+---------+----------------------------------------|
9809 |<display-message> |<Return> |display a message |
9810 |--------------------------+---------+----------------------------------------|
9811 |<buffy-list> |. |list mailboxes with new mail |
9812 |--------------------------+---------+----------------------------------------|
9813 |<sync-mailbox> |$ |save changes to mailbox |
9814 |--------------------------+---------+----------------------------------------|
9815 |<display-address> |@ |display full address of sender |
9816 |--------------------------+---------+----------------------------------------|
9817 |<pipe-message> || |pipe message/attachment to a shell |
9819 |--------------------------+---------+----------------------------------------|
9820 |<next-new> | |jump to the next new message |
9821 |--------------------------+---------+----------------------------------------|
9822 |<next-new-then-unread> |<Tab> |jump to the next new or unread message |
9823 |--------------------------+---------+----------------------------------------|
9824 |<previous-new> | |jump to the previous new message |
9825 |--------------------------+---------+----------------------------------------|
9826 |<previous-new-then-unread>|Esc <Tab>|jump to the previous new or unread |
9828 |--------------------------+---------+----------------------------------------|
9829 |<next-unread> | |jump to the next unread message |
9830 |--------------------------+---------+----------------------------------------|
9831 |<previous-unread> | |jump to the previous unread message |
9832 |--------------------------+---------+----------------------------------------|
9833 |<parent-message> |P |jump to parent message in thread |
9834 |--------------------------+---------+----------------------------------------|
9835 |<extract-keys> |^K |extract supported public keys |
9836 |--------------------------+---------+----------------------------------------|
9837 |<forget-passphrase> |^F |wipe passphrase(s) from memory |
9838 |--------------------------+---------+----------------------------------------|
9839 |<check-traditional-pgp> |Esc P |check for classic PGP |
9840 |--------------------------+---------+----------------------------------------|
9841 |<mail-key> |Esc k |mail a PGP public key |
9842 |--------------------------+---------+----------------------------------------|
9843 |<decrypt-copy> | |make decrypted copy |
9844 |--------------------------+---------+----------------------------------------|
9845 |<decrypt-save> | |make decrypted copy and delete |
9846 +-----------------------------------------------------------------------------+
9851 Table 9.4. Default pager Function Bindings
9853 +-----------------------------------------------------------------------------+
9854 | Function | Default | Description |
9856 |------------------------+---------+------------------------------------------|
9857 |<break-thread> |# |break the thread in two |
9858 |------------------------+---------+------------------------------------------|
9859 |<create-alias> |a |create an alias from a message sender |
9860 |------------------------+---------+------------------------------------------|
9861 |<bounce-message> |b |remail a message to another user |
9862 |------------------------+---------+------------------------------------------|
9863 |<change-folder> |c |open a different folder |
9864 |------------------------+---------+------------------------------------------|
9865 |<change-folder-readonly>|Esc c |open a different folder in read only mode |
9866 |------------------------+---------+------------------------------------------|
9867 |<next-unread-mailbox> | |open next mailbox with new mail |
9868 |------------------------+---------+------------------------------------------|
9869 |<copy-message> |C |copy a message to a file/mailbox |
9870 |------------------------+---------+------------------------------------------|
9871 |<decode-copy> |Esc C |make decoded (text/plain) copy |
9872 |------------------------+---------+------------------------------------------|
9873 |<delete-message> |d |delete the current entry |
9874 |------------------------+---------+------------------------------------------|
9875 |<delete-thread> |^D |delete all messages in thread |
9876 |------------------------+---------+------------------------------------------|
9877 |<delete-subthread> |Esc d |delete all messages in subthread |
9878 |------------------------+---------+------------------------------------------|
9879 |<set-flag> |w |set a status flag on a message |
9880 |------------------------+---------+------------------------------------------|
9881 |<clear-flag> |W |clear a status flag from a message |
9882 |------------------------+---------+------------------------------------------|
9883 |<edit> |e |edit the raw message |
9884 |------------------------+---------+------------------------------------------|
9885 |<edit-type> |^E |edit attachment content type |
9886 |------------------------+---------+------------------------------------------|
9887 |<forward-message> |f |forward a message with comments |
9888 |------------------------+---------+------------------------------------------|
9889 |<flag-message> |F |toggle a message's 'important' flag |
9890 |------------------------+---------+------------------------------------------|
9891 |<group-reply> |g |reply to all recipients |
9892 |------------------------+---------+------------------------------------------|
9893 |<imap-fetch-mail> | |force retrieval of mail from IMAP server |
9894 |------------------------+---------+------------------------------------------|
9895 |<display-toggle-weed> |h |display message and toggle header weeding |
9896 |------------------------+---------+------------------------------------------|
9897 |<next-undeleted> |j |move to the next undeleted message |
9898 |------------------------+---------+------------------------------------------|
9899 |<next-entry> |J |move to the next entry |
9900 |------------------------+---------+------------------------------------------|
9901 |<previous-undeleted> |k |move to the previous undeleted message |
9902 |------------------------+---------+------------------------------------------|
9903 |<previous-entry> |K |move to the previous entry |
9904 |------------------------+---------+------------------------------------------|
9905 |<link-threads> |& |link tagged message to the current one |
9906 |------------------------+---------+------------------------------------------|
9907 |<list-reply> |L |reply to specified mailing list |
9908 |------------------------+---------+------------------------------------------|
9909 |<redraw-screen> |^L |clear and redraw the screen |
9910 |------------------------+---------+------------------------------------------|
9911 |<mail> |m |compose a new mail message |
9912 |------------------------+---------+------------------------------------------|
9913 |<mark-as-new> |N |toggle a message's 'new' flag |
9914 |------------------------+---------+------------------------------------------|
9915 |<search-next> |n |search for next match |
9916 |------------------------+---------+------------------------------------------|
9917 |<next-thread> |^N |jump to the next thread |
9918 |------------------------+---------+------------------------------------------|
9919 |<next-subthread> |Esc n |jump to the next subthread |
9920 |------------------------+---------+------------------------------------------|
9921 |<print-message> |p |print the current entry |
9922 |------------------------+---------+------------------------------------------|
9923 |<previous-thread> |^P |jump to previous thread |
9924 |------------------------+---------+------------------------------------------|
9925 |<previous-subthread> |Esc p |jump to previous subthread |
9926 |------------------------+---------+------------------------------------------|
9927 |<quit> |Q |save changes to mailbox and quit |
9928 |------------------------+---------+------------------------------------------|
9929 |<exit> |q |exit this menu |
9930 |------------------------+---------+------------------------------------------|
9931 |<reply> |r |reply to a message |
9932 |------------------------+---------+------------------------------------------|
9933 |<recall-message> |R |recall a postponed message |
9934 |------------------------+---------+------------------------------------------|
9935 |<read-thread> |^R |mark the current thread as read |
9936 |------------------------+---------+------------------------------------------|
9937 |<read-subthread> |Esc r |mark the current subthread as read |
9938 |------------------------+---------+------------------------------------------|
9939 |<resend-message> |Esc e |use the current message as a template for |
9941 |------------------------+---------+------------------------------------------|
9942 |<save-message> |s |save message/attachment to a mailbox/file |
9943 |------------------------+---------+------------------------------------------|
9944 |<skip-quoted> |S |skip beyond quoted text |
9945 |------------------------+---------+------------------------------------------|
9946 |<decode-save> |Esc s |make decoded copy (text/plain) and delete |
9947 |------------------------+---------+------------------------------------------|
9948 |<tag-message> |t |tag the current entry |
9949 |------------------------+---------+------------------------------------------|
9950 |<toggle-quoted> |T |toggle display of quoted text |
9951 |------------------------+---------+------------------------------------------|
9952 |<undelete-message> |u |undelete the current entry |
9953 |------------------------+---------+------------------------------------------|
9954 |<undelete-subthread> |Esc u |undelete all messages in subthread |
9955 |------------------------+---------+------------------------------------------|
9956 |<undelete-thread> |^U |undelete all messages in thread |
9957 |------------------------+---------+------------------------------------------|
9958 |<view-attachments> |v |show MIME attachments |
9959 |------------------------+---------+------------------------------------------|
9960 |<show-version> |V |show the Mutt version number and date |
9961 |------------------------+---------+------------------------------------------|
9962 |<search-toggle> |\\ |toggle search pattern coloring |
9963 |------------------------+---------+------------------------------------------|
9964 |<display-address> |@ |display full address of sender |
9965 |------------------------+---------+------------------------------------------|
9966 |<next-new> | |jump to the next new message |
9967 |------------------------+---------+------------------------------------------|
9968 |<pipe-message> || |pipe message/attachment to a shell command|
9969 |------------------------+---------+------------------------------------------|
9970 |<help> |? |this screen |
9971 |------------------------+---------+------------------------------------------|
9972 |<next-page> |<Space> |move to the next page |
9973 |------------------------+---------+------------------------------------------|
9974 |<previous-page> |- |move to the previous page |
9975 |------------------------+---------+------------------------------------------|
9976 |<top> |^ |jump to the top of the message |
9977 |------------------------+---------+------------------------------------------|
9978 |<sync-mailbox> |$ |save changes to mailbox |
9979 |------------------------+---------+------------------------------------------|
9980 |<shell-escape> |! |invoke a command in a subshell |
9981 |------------------------+---------+------------------------------------------|
9982 |<enter-command> |: |enter a muttrc command |
9983 |------------------------+---------+------------------------------------------|
9984 |<buffy-list> |. |list mailboxes with new mail |
9985 |------------------------+---------+------------------------------------------|
9986 |<search> |/ |search for a regular expression |
9987 |------------------------+---------+------------------------------------------|
9988 |<search-reverse> |Esc / |search backwards for a regular expression |
9989 |------------------------+---------+------------------------------------------|
9990 |<search-opposite> | |search for next match in opposite |
9992 |------------------------+---------+------------------------------------------|
9993 |<next-line> |<Return> |scroll down one line |
9994 |------------------------+---------+------------------------------------------|
9995 |<jump> | |jump to an index number |
9996 |------------------------+---------+------------------------------------------|
9997 |<next-unread> | |jump to the next unread message |
9998 |------------------------+---------+------------------------------------------|
9999 |<previous-new> | |jump to the previous new message |
10000 |------------------------+---------+------------------------------------------|
10001 |<previous-unread> | |jump to the previous unread message |
10002 |------------------------+---------+------------------------------------------|
10003 |<half-up> | |scroll up 1/2 page |
10004 |------------------------+---------+------------------------------------------|
10005 |<half-down> | |scroll down 1/2 page |
10006 |------------------------+---------+------------------------------------------|
10007 |<previous-line> | |scroll up one line |
10008 |------------------------+---------+------------------------------------------|
10009 |<bottom> | |jump to the bottom of the message |
10010 |------------------------+---------+------------------------------------------|
10011 |<parent-message> |P |jump to parent message in thread |
10012 |------------------------+---------+------------------------------------------|
10013 |<check-traditional-pgp> |Esc P |check for classic PGP |
10014 |------------------------+---------+------------------------------------------|
10015 |<mail-key> |Esc k |mail a PGP public key |
10016 |------------------------+---------+------------------------------------------|
10017 |<extract-keys> |^K |extract supported public keys |
10018 |------------------------+---------+------------------------------------------|
10019 |<forget-passphrase> |^F |wipe passphrase(s) from memory |
10020 |------------------------+---------+------------------------------------------|
10021 |<decrypt-copy> | |make decrypted copy |
10022 |------------------------+---------+------------------------------------------|
10023 |<decrypt-save> | |make decrypted copy and delete |
10024 |------------------------+---------+------------------------------------------|
10025 |<what-key> | |display the keycode for a key press |
10026 +-----------------------------------------------------------------------------+
10031 Table 9.5. Default alias Function Bindings
10033 +-------------------------------------------------------+
10034 | Function |Default key| Description |
10035 |----------------+-----------+--------------------------|
10036 |<delete-entry> |d |delete the current entry |
10037 |----------------+-----------+--------------------------|
10038 |<undelete-entry>|u |undelete the current entry|
10039 +-------------------------------------------------------+
10044 Table 9.6. Default query Function Bindings
10046 +----------------------------------------------------------------------+
10047 | Function |Default key| Description |
10048 |--------------+-----------+-------------------------------------------|
10049 |<create-alias>|a |create an alias from a message sender |
10050 |--------------+-----------+-------------------------------------------|
10051 |<mail> |m |compose a new mail message |
10052 |--------------+-----------+-------------------------------------------|
10053 |<query> |Q |query external program for addresses |
10054 |--------------+-----------+-------------------------------------------|
10055 |<query-append>|A |append new query results to current results|
10056 +----------------------------------------------------------------------+
10061 Table 9.7. Default attach Function Bindings
10063 +-----------------------------------------------------------------------------+
10064 | Function | Default | Description |
10066 |-----------------------+---------+-------------------------------------------|
10067 |<bounce-message> |b |remail a message to another user |
10068 |-----------------------+---------+-------------------------------------------|
10069 |<display-toggle-weed> |h |display message and toggle header weeding |
10070 |-----------------------+---------+-------------------------------------------|
10071 |<edit-type> |^E |edit attachment content type |
10072 |-----------------------+---------+-------------------------------------------|
10073 |<print-entry> |p |print the current entry |
10074 |-----------------------+---------+-------------------------------------------|
10075 |<save-entry> |s |save message/attachment to a mailbox/file |
10076 |-----------------------+---------+-------------------------------------------|
10077 |<pipe-entry> || |pipe message/attachment to a shell command |
10078 |-----------------------+---------+-------------------------------------------|
10079 |<view-mailcap> |m |force viewing of attachment using mailcap |
10080 |-----------------------+---------+-------------------------------------------|
10081 |<reply> |r |reply to a message |
10082 |-----------------------+---------+-------------------------------------------|
10083 |<resend-message> |Esc e |use the current message as a template for a|
10085 |-----------------------+---------+-------------------------------------------|
10086 |<group-reply> |g |reply to all recipients |
10087 |-----------------------+---------+-------------------------------------------|
10088 |<list-reply> |L |reply to specified mailing list |
10089 |-----------------------+---------+-------------------------------------------|
10090 |<forward-message> |f |forward a message with comments |
10091 |-----------------------+---------+-------------------------------------------|
10092 |<view-text> |T |view attachment as text |
10093 |-----------------------+---------+-------------------------------------------|
10094 |<view-attach> |<Return> |view attachment using mailcap entry if |
10096 |-----------------------+---------+-------------------------------------------|
10097 |<delete-entry> |d |delete the current entry |
10098 |-----------------------+---------+-------------------------------------------|
10099 |<undelete-entry> |u |undelete the current entry |
10100 |-----------------------+---------+-------------------------------------------|
10101 |<collapse-parts> |v |Toggle display of subparts |
10102 |-----------------------+---------+-------------------------------------------|
10103 |<check-traditional-pgp>|Esc P |check for classic PGP |
10104 |-----------------------+---------+-------------------------------------------|
10105 |<extract-keys> |^K |extract supported public keys |
10106 |-----------------------+---------+-------------------------------------------|
10107 |<forget-passphrase> |^F |wipe passphrase(s) from memory |
10108 +-----------------------------------------------------------------------------+
10113 Table 9.8. Default compose Function Bindings
10115 +-----------------------------------------------------------------------------+
10116 | Function | Default | Description |
10118 |---------------------+----------+--------------------------------------------|
10119 |<attach-file> |a |attach file(s) to this message |
10120 |---------------------+----------+--------------------------------------------|
10121 |<attach-message> |A |attach message(s) to this message |
10122 |---------------------+----------+--------------------------------------------|
10123 |<edit-bcc> |b |edit the BCC list |
10124 |---------------------+----------+--------------------------------------------|
10125 |<edit-cc> |c |edit the CC list |
10126 |---------------------+----------+--------------------------------------------|
10127 |<copy-file> |C |save message/attachment to a mailbox/file |
10128 |---------------------+----------+--------------------------------------------|
10129 |<detach-file> |D |delete the current entry |
10130 |---------------------+----------+--------------------------------------------|
10131 |<toggle-disposition> |^D |toggle disposition between inline/attachment|
10132 |---------------------+----------+--------------------------------------------|
10133 |<edit-description> |d |edit attachment description |
10134 |---------------------+----------+--------------------------------------------|
10135 |<edit-message> |e |edit the message |
10136 |---------------------+----------+--------------------------------------------|
10137 |<edit-headers> |E |edit the message with headers |
10138 |---------------------+----------+--------------------------------------------|
10139 |<edit-file> |^X e |edit the file to be attached |
10140 |---------------------+----------+--------------------------------------------|
10141 |<edit-encoding> |^E |edit attachment transfer-encoding |
10142 |---------------------+----------+--------------------------------------------|
10143 |<edit-from> |Esc f |edit the from field |
10144 |---------------------+----------+--------------------------------------------|
10145 |<edit-fcc> |f |enter a file to save a copy of this message |
10147 |---------------------+----------+--------------------------------------------|
10148 |<filter-entry> |F |filter attachment through a shell command |
10149 |---------------------+----------+--------------------------------------------|
10150 |<get-attachment> |G |get a temporary copy of an attachment |
10151 |---------------------+----------+--------------------------------------------|
10152 |<display-toggle-weed>|h |display message and toggle header weeding |
10153 |---------------------+----------+--------------------------------------------|
10154 |<ispell> |i |run ispell on the message |
10155 |---------------------+----------+--------------------------------------------|
10156 |<print-entry> |l |print the current entry |
10157 |---------------------+----------+--------------------------------------------|
10158 |<edit-mime> |m |edit attachment using mailcap entry |
10159 |---------------------+----------+--------------------------------------------|
10160 |<new-mime> |n |compose new attachment using mailcap entry |
10161 |---------------------+----------+--------------------------------------------|
10162 |<postpone-message> |P |save this message to send later |
10163 |---------------------+----------+--------------------------------------------|
10164 |<edit-reply-to> |r |edit the Reply-To field |
10165 |---------------------+----------+--------------------------------------------|
10166 |<rename-file> |R |rename/move an attached file |
10167 |---------------------+----------+--------------------------------------------|
10168 |<edit-subject> |s |edit the subject of this message |
10169 |---------------------+----------+--------------------------------------------|
10170 |<edit-to> |t |edit the TO list |
10171 |---------------------+----------+--------------------------------------------|
10172 |<edit-type> |^T |edit attachment content type |
10173 |---------------------+----------+--------------------------------------------|
10174 |<write-fcc> |w |write the message to a folder |
10175 |---------------------+----------+--------------------------------------------|
10176 |<toggle-unlink> |u |toggle whether to delete file after sending |
10178 |---------------------+----------+--------------------------------------------|
10179 |<toggle-recode> | |toggle recoding of this attachment |
10180 |---------------------+----------+--------------------------------------------|
10181 |<update-encoding> |U |update an attachment's encoding info |
10182 |---------------------+----------+--------------------------------------------|
10183 |<view-attach> |<Return> |view attachment using mailcap entry if |
10185 |---------------------+----------+--------------------------------------------|
10186 |<send-message> |y |send the message |
10187 |---------------------+----------+--------------------------------------------|
10188 |<pipe-entry> || |pipe message/attachment to a shell command |
10189 |---------------------+----------+--------------------------------------------|
10190 |<attach-key> |Esc k |attach a PGP public key |
10191 |---------------------+----------+--------------------------------------------|
10192 |<pgp-menu> |p |show PGP options |
10193 |---------------------+----------+--------------------------------------------|
10194 |<forget-passphrase> |^F |wipe passphrase(s) from memory |
10195 |---------------------+----------+--------------------------------------------|
10196 |<smime-menu> |S |show S/MIME options |
10197 |---------------------+----------+--------------------------------------------|
10198 |<mix> |M |send the message through a mixmaster |
10199 | | |remailer chain |
10200 +-----------------------------------------------------------------------------+
10205 Table 9.9. Default postpone Function Bindings
10207 +-------------------------------------------------------+
10208 | Function |Default key| Description |
10209 |----------------+-----------+--------------------------|
10210 |<delete-entry> |d |delete the current entry |
10211 |----------------+-----------+--------------------------|
10212 |<undelete-entry>|u |undelete the current entry|
10213 +-------------------------------------------------------+
10218 Table 9.10. Default browser Function Bindings
10220 +-----------------------------------------------------------------------------+
10221 | Function | Default | Description |
10223 |-------------------+----------+----------------------------------------------|
10224 |<change-dir> |c |change directories |
10225 |-------------------+----------+----------------------------------------------|
10226 |<display-filename> |@ |display the currently selected file's name |
10227 |-------------------+----------+----------------------------------------------|
10228 |<enter-mask> |m |enter a file mask |
10229 |-------------------+----------+----------------------------------------------|
10230 |<sort> |o |sort messages |
10231 |-------------------+----------+----------------------------------------------|
10232 |<sort-reverse> |O |sort messages in reverse order |
10233 |-------------------+----------+----------------------------------------------|
10234 |<select-new> |N |select a new file in this directory |
10235 |-------------------+----------+----------------------------------------------|
10236 |<check-new> | |check mailboxes for new mail |
10237 |-------------------+----------+----------------------------------------------|
10238 |<toggle-mailboxes> |<Tab> |toggle whether to browse mailboxes or all |
10240 |-------------------+----------+----------------------------------------------|
10241 |<view-file> |<Space> |view file |
10242 |-------------------+----------+----------------------------------------------|
10243 |<buffy-list> |. |list mailboxes with new mail |
10244 |-------------------+----------+----------------------------------------------|
10245 |<create-mailbox> |C |create a new mailbox (IMAP only) |
10246 |-------------------+----------+----------------------------------------------|
10247 |<delete-mailbox> |d |delete the current mailbox (IMAP only) |
10248 |-------------------+----------+----------------------------------------------|
10249 |<rename-mailbox> |r |rename the current mailbox (IMAP only) |
10250 |-------------------+----------+----------------------------------------------|
10251 |<subscribe> |s |subscribe to current mailbox (IMAP only) |
10252 |-------------------+----------+----------------------------------------------|
10253 |<unsubscribe> |u |unsubscribe from current mailbox (IMAP only) |
10254 |-------------------+----------+----------------------------------------------|
10255 |<toggle-subscribed>|T |toggle view all/subscribed mailboxes (IMAP |
10257 +-----------------------------------------------------------------------------+
10262 Table 9.11. Default pgp Function Bindings
10264 +------------------------------------------------+
10265 | Function |Default key| Description |
10266 |------------+-----------+-----------------------|
10267 |<verify-key>|c |verify a PGP public key|
10268 |------------+-----------+-----------------------|
10269 |<view-name> |% |view the key's user id |
10270 +------------------------------------------------+
10275 Table 9.12. Default smime Function Bindings
10277 +------------------------------------------------+
10278 | Function |Default key| Description |
10279 |------------+-----------+-----------------------|
10280 |<verify-key>|c |verify a PGP public key|
10281 |------------+-----------+-----------------------|
10282 |<view-name> |% |view the key's user id |
10283 +------------------------------------------------+
10288 Table 9.13. Default mix Function Bindings
10290 +-----------------------------------------------------------------+
10291 | Function |Default key| Description |
10292 |------------+-----------+----------------------------------------|
10293 |<accept> |<Return> |Accept the chain constructed |
10294 |------------+-----------+----------------------------------------|
10295 |<append> |a |Append a remailer to the chain |
10296 |------------+-----------+----------------------------------------|
10297 |<insert> |i |Insert a remailer into the chain |
10298 |------------+-----------+----------------------------------------|
10299 |<delete> |d |Delete a remailer from the chain |
10300 |------------+-----------+----------------------------------------|
10301 |<chain-prev>|<Left> |Select the previous element of the chain|
10302 |------------+-----------+----------------------------------------|
10303 |<chain-next>|<Right> |Select the next element of the chain |
10304 +-----------------------------------------------------------------+
10309 Table 9.14. Default editor Function Bindings
10311 +-----------------------------------------------------------------------------+
10312 | Function |Default key| Description |
10313 |-----------------+-----------+-----------------------------------------------|
10314 |<bol> |^A |jump to the beginning of the line |
10315 |-----------------+-----------+-----------------------------------------------|
10316 |<backward-char> |^B |move the cursor one character to the left |
10317 |-----------------+-----------+-----------------------------------------------|
10318 |<backward-word> |Esc b |move the cursor to the beginning of the word |
10319 |-----------------+-----------+-----------------------------------------------|
10320 |<capitalize-word>|Esc c |capitalize the word |
10321 |-----------------+-----------+-----------------------------------------------|
10322 |<downcase-word> |Esc l |convert the word to lower case |
10323 |-----------------+-----------+-----------------------------------------------|
10324 |<upcase-word> |Esc u |convert the word to upper case |
10325 |-----------------+-----------+-----------------------------------------------|
10326 |<delete-char> |^D |delete the char under the cursor |
10327 |-----------------+-----------+-----------------------------------------------|
10328 |<eol> |^E |jump to the end of the line |
10329 |-----------------+-----------+-----------------------------------------------|
10330 |<forward-char> |^F |move the cursor one character to the right |
10331 |-----------------+-----------+-----------------------------------------------|
10332 |<forward-word> |Esc f |move the cursor to the end of the word |
10333 |-----------------+-----------+-----------------------------------------------|
10334 |<backspace> |<Backspace>|delete the char in front of the cursor |
10335 |-----------------+-----------+-----------------------------------------------|
10336 |<kill-eol> |^K |delete chars from cursor to end of line |
10337 |-----------------+-----------+-----------------------------------------------|
10338 |<kill-eow> |Esc d |delete chars from the cursor to the end of the |
10340 |-----------------+-----------+-----------------------------------------------|
10341 |<kill-line> |^U |delete all chars on the line |
10342 |-----------------+-----------+-----------------------------------------------|
10343 |<quote-char> |^V |quote the next typed key |
10344 |-----------------+-----------+-----------------------------------------------|
10345 |<kill-word> |^W |delete the word in front of the cursor |
10346 |-----------------+-----------+-----------------------------------------------|
10347 |<complete> |<Tab> |complete filename or alias |
10348 |-----------------+-----------+-----------------------------------------------|
10349 |<complete-query> |^T |complete address with query |
10350 |-----------------+-----------+-----------------------------------------------|
10351 |<buffy-cycle> |<Space> |cycle among incoming mailboxes |
10352 |-----------------+-----------+-----------------------------------------------|
10353 |<history-up> | |scroll up through the history list |
10354 |-----------------+-----------+-----------------------------------------------|
10355 |<history-down> | |scroll down through the history list |
10356 |-----------------+-----------+-----------------------------------------------|
10357 |<transpose-chars>| |transpose character under cursor with previous |
10358 +-----------------------------------------------------------------------------+
10361 Chapter 10. Miscellany
10365 1. Acknowledgements
10366 2. About This Document
10368 1. Acknowledgements
10370 Kari Hurtta <kari.hurtta@fmi.fi> co-developed the original MIME parsing code
10371 back in the ELM-ME days.
10373 The following people have been very helpful to the development of Mutt:
10375 * Vikas Agnihotri <vikasa@writeme.com>
10377 * Francois Berjon <Francois.Berjon@aar.alcatel-alsthom.fr>
10379 * Aric Blumer <aric@fore.com>
10381 * John Capo <jc@irbs.com>
10383 * David Champion <dgc@uchicago.edu>
10385 * Brendan Cully <brendan@kublai.com>
10387 * Liviu Daia <daia@stoilow.imar.ro>
10389 * Thomas E. Dickey <dickey@herndon4.his.com>
10391 * David DeSimone <fox@convex.hp.com>
10393 * Nickolay N. Dudorov <nnd@wint.itfs.nsk.su>
10395 * Ruslan Ermilov <ru@freebsd.org>
10397 * Edmund Grimley Evans <edmundo@rano.org>
10399 * Michael Finken <finken@conware.de>
10401 * Sven Guckes <guckes@math.fu-berlin.de>
10403 * Lars Hecking <lhecking@nmrc.ie>
10405 * Mark Holloman <holloman@nando.net>
10407 * Andreas Holzmann <holzmann@fmi.uni-passau.de>
10409 * Marco d'Itri <md@linux.it>
10411 * Bj?rn Jacke <bjacke@suse.com>
10413 * Byrial Jensen <byrial@image.dk>
10415 * David Jeske <jeske@igcom.net>
10417 * Christophe Kalt <kalt@hugo.int-evry.fr>
10419 * Tommi Komulainen <Tommi.Komulainen@iki.fi>
10421 * Felix von Leitner (a.k.a ?Fefe?) <leitner@math.fu-berlin.de>
10423 * Brandon Long <blong@fiction.net>
10425 * Jimmy M?kel? <jmy@flashback.net>
10427 * Lars Marowsky-Bree <lmb@pointer.in-minden.de>
10429 * Thomas ?Mike? Michlmayr <mike@cosy.sbg.ac.at>
10431 * Andrew W. Nosenko <awn@bcs.zp.ua>
10433 * David O'Brien <obrien@Nuxi.cs.ucdavis.edu>
10435 * Clint Olsen <olsenc@ichips.intel.com>
10437 * Park Myeong Seok <pms@romance.kaist.ac.kr>
10439 * Thomas Parmelan <tom@ankh.fr.eu.org>
10441 * Ollivier Robert <roberto@keltia.freenix.fr>
10443 * Thomas Roessler <roessler@does-not-exist.org>
10445 * Roland Rosenfeld <roland@spinnaker.de>
10447 * Rocco Rutte <pdmef@gmx.net>
10449 * TAKIZAWA Takashi <taki@luna.email.ne.jp>
10451 * Allain Thivillon <Allain.Thivillon@alma.fr>
10453 * Gero Treuner <gero@70t.de>
10455 * Vsevolod Volkov <vvv@lucky.net>
10457 * Ken Weinert <kenw@ihs.com>
10459 2. About This Document
10461 This document was written in DocBook, and then rendered using the Gnome XSLT
projects / software / mutt-debian.git / blob