Reference

1. Command-Line Options

Running muttwith no arguments will make Mutt attempt to read your spool mailbox. However, it is possible to read other mailboxes and to send messages from the command line as well.

Table 38.1. Command line options

Option Description
-A expand an alias
-a attach a file to a message
-b specify a blind carbon-copy (BCC) address
-c specify a carbon-copy (Cc) address
-d log debugging output to ~/.muttdebug0 if mutt was compiled with +DEBUG; it can range from 1-5 and affects verbosity (a value of 2 is recommended)
-D print the value of all Mutt variables to stdout
-D -S like -D but hide the value of sensitive variables
-E edit the draft (-H) or include (-i) file
-e specify a config command to be run after initialization files are read
-f specify a mailbox to load
-F specify an alternate file to read initialization commands
-h print help on command line options
-H specify a draft file from which to read a header and body
-i specify a file to include in a message composition
-m specify a default mailbox type
-n do not read the system Muttrc
-p recall a postponed message
-Q query a configuration variable
-R open mailbox in read-only mode
-s specify a subject (enclose in quotes if it contains spaces)
-v show version number and compile-time definitions
-x simulate the mailx(1) compose mode
-y show a menu containing the files specified by the mailboxes command
-z exit immediately if there are no messages in the mailbox
-Z open the first folder with new message, exit immediately if none

To read messages in a mailbox

mutt[ -nz] [ -F muttrc ] [ -m type ] [ -f mailbox ]

To compose a new message

mutt[ -En] [ -F muttrc ] [ -c address ] [ -Hi filename ] [ -s subject ] [ -a file [...]--] address | mailto_url ...

Mutt also supports a batchmode to send prepared messages. Simply redirect input from the file you wish to send. For example,

mutt -s "data set for run #2" professor@bigschool.edu < ~/run2.dat

will send a message to <professor@bigschool.edu>with a subject of data set for run #2. In the body of the message will be the contents of the file ~/run2.dat.

An include file passed with -iwill be used as the body of the message. When combined with -E, the include file will be directly edited during message composition. The file will be modified regardless of whether the message is sent or aborted.

A draft file passed with -Hwill be used as the initial header and body for the message. Multipart messages can be used as a draft file. When combined with -E, the draft file will be updated to the final state of the message after composition, regardless of whether the message is sent, aborted, or even postponed. Note that if the message is sent encrypted or signed, the draft file will be saved that way too.

All files passed with -a file will be attached as a MIME part to the message. To attach a single or several files, use --to separate files and recipient addresses:

mutt -a image.png -- some@one.org

or

mutt -a *.png -- some@one.org

Note

The -aoption must be last in the option list.

In addition to accepting a list of email addresses, Mutt also accepts a URL with the mailto:schema as specified in RFC2368. This is useful when configuring a web browser to launch Mutt when clicking on mailto links.

mutt mailto:some@one.org?subject=test&cc=other@one.org

2. Configuration Commands

The following are the commands understood by Mutt:

3. Configuration Variables

3.1. abort_noattach

Type: quadoption
Default: no

If set to yes , when composing messages containing the regular expression specified by attach_keywordand no attachments ** are given, composition will be aborted. If set to no , composing ** messages as such will never be aborted.

Example:

set attach_keyword = "\\<attach(|ed|ments?)\\>"

3.2. abort_nosubject

Type: quadoption
Default: ask-yes

If set to yes , when composing messages and no subject is given at the subject prompt, composition will be aborted. If set to no , composing messages with no subject given at the subject prompt will never be aborted.

3.3. abort_unmodified

Type: quadoption
Default: yes

If set to yes , composition will automatically abort after editing the message body if no changes are made to the file (this check only happens after the first edit of the file). When set to no , composition will never be aborted.

3.4. alias_file

Type: path
Default:  ~/.muttrc

The default file in which to save aliases created by the <create-alias> function. Entries added to this file are encoded in the character set specified by $config_charsetif it is set or the current character set otherwise.

Note: Mutt will not automatically source this file; you must explicitly use the source command for it to be executed in case this option points to a dedicated alias file.

The default for this option is the currently used muttrc file, or ~/.muttrcif no user muttrc was found.

3.5. alias_format

Type: string
Default:  %4n %2f %t %-10a   %r

Specifies the format of the data displayed for the alias menu. The following printf(3)-style sequences are available:

%a alias name
%f flags - currently, a dfor an alias marked for deletion
%n index number
%r address which alias expands to
%t character which indicates if the alias is tagged for inclusion

3.6. allow_8bit

Type: boolean
Default: yes

Controls whether 8-bit data is converted to 7-bit using either Quoted- Printable or Base64 encoding when sending mail.

3.7. allow_ansi

Type: boolean
Default: no

Controls whether ANSI color codes in messages (and color tags in rich text messages) are to be interpreted. Messages containing these codes are rare, but if this option is set , their text will be colored accordingly. Note that this may override your color choices, and even present a security problem, since a message could include a line like

[-- PGP output follows ...

and give it the same color as your attachment color (see also $crypt_timestamp).

3.8. arrow_cursor

Type: boolean
Default: no

When set , an arrow ( ->) will be used to indicate the current entry in menus instead of highlighting the whole line. On slow network or modem links this will make response faster because there is less that has to be redrawn on the screen when moving to the next or previous entries in the menu.

3.9. ascii_chars

Type: boolean
Default: no

If set , Mutt will use plain ASCII characters when displaying thread and attachment trees, instead of the default ACS characters.

3.10. askbcc

Type: boolean
Default: no

If set , Mutt will prompt you for blind-carbon-copy (Bcc) recipients before editing an outgoing message.

3.11. askcc

Type: boolean
Default: no

If set , Mutt will prompt you for carbon-copy (Cc) recipients before editing the body of an outgoing message.

3.12. ask_follow_up

Type: boolean
Default: no

If set, Mutt will prompt you for follow-up groups before editing the body of an outgoing message.

3.13. ask_x_comment_to

Type: boolean
Default: no

If set, Mutt will prompt you for x-comment-to field before editing the body of an outgoing message.

3.14. assumed_charset

Type: string
Default: (empty)

This variable is a colon-separated list of character encoding schemes for messages without character encoding indication. Header field values and message body content without character encoding indication would be assumed that they are written in one of this list. By default, all the header fields and message body without any charset indication are assumed to be in us-ascii.

For example, Japanese users might prefer this:

set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"

However, only the first content is valid for the message body.

3.15. attach_charset

Type: string
Default: (empty)

This variable is a colon-separated list of character encoding schemes for text file attachments. Mutt uses this setting to guess which encoding files being attached are encoded in to convert them to a proper character set given in $send_charset.

If unset , the value of $charsetwill be used instead. For example, the following configuration would work for Japanese text handling:

set attach_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"

Note: for Japanese users, iso-2022-*must be put at the head of the value as shown above if included.

3.16. attach_format

Type: string
Default:  %u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] 

This variable describes the format of the attachmentmenu. The following printf(3)-style sequences are understood:

%C charset
%c requires charset conversion ( nor c)
%D deleted flag
%d description (if none, falls back to %F)
%e MIME content-transfer-encoding
%F filename in content-disposition header (if none, falls back to %f)
%f filename
%I disposition ( Ifor inline, Afor attachment)
%m major MIME type
%M MIME subtype
%n attachment number
%Q Q, if MIME part qualifies for attachment counting
%s size
%t tagged flag
%T graphic tree characters
%u unlink (=to delete) flag
%X number of qualifying MIME parts in this part and its children (please see the attachments section for possible speed effects)
%>X right justify the rest of the string and pad with character X
%|X pad to the end of the line with character X
%*X soft-fill with character Xas pad

For an explanation of soft-fill, see the $index_formatdocumentation.

3.17. attach_keyword

Type: regular expression
Default:  \<(attach|attached|attachments?)\>

If abort_noattachis not set to no, then the body of the message will be scanned for this regular expression, and if found, you will be prompted if there are no attachments.

3.18. attach_sep

Type: string
Default:  \n

The separator to add between attachments when operating (saving, printing, piping, etc) on a list of tagged attachments.

3.19. attach_split

Type: boolean
Default: yes

If this variable is unset , when operating (saving, printing, piping, etc) on a list of tagged attachments, Mutt will concatenate the attachments and will operate on them as a single attachment. The $attach_sepseparator is added after each attachment. When set , Mutt will operate on the attachments one by one.

3.20. attribution

Type: string
Default:  On %d, %n wrote:

This is the string that will precede a message which has been included in a reply. For a full listing of defined printf(3)-like sequences see the section on $index_format.

3.21. attribution_locale

Type: string
Default: (empty)

The locale used by strftime(3)to format dates in the attributionstring. Legal values are the strings your system accepts for the locale environment variable $LC_TIME.

This variable is to allow the attribution date format to be customized by recipient or folder using hooks. By default, Mutt will use your locale environment, so there is no need to set this except to override that default.

3.22. auto_tag

Type: boolean
Default: no

When set , functions in the index menu which affect a message will be applied to all tagged messages (if there are any). When unset, you must first use the <tag-prefix>function (bound to ;by default) to make the next function apply to all tagged messages.

3.23. autoedit

Type: boolean
Default: no

When set along with $edit_headers, Mutt will skip the initial send-menu (prompting for subject and recipients) and allow you to immediately begin editing the body of your message. The send-menu may still be accessed once you have finished editing the body of your message.

Note: when this option is set , you cannot use send-hooks that depend on the recipients when composing a new (non-reply) message, as the initial list of recipients is empty.

Also see $fast_reply.

3.24. beep

Type: boolean
Default: yes

When this variable is set , mutt will beep when an error occurs.

3.25. beep_new

Type: boolean
Default: no

When this variable is set , mutt will beep whenever it prints a message notifying you of new mail. This is independent of the setting of the $beepvariable.

3.26. bounce

Type: quadoption
Default: ask-yes

Controls whether you will be asked to confirm bouncing messages. If set to yes you don't get asked if you want to bounce a message. Setting this variable to no is not generally useful, and thus not recommended, because you are unable to bounce messages.

3.27. bounce_delivered

Type: boolean
Default: yes

When this variable is set , mutt will include Delivered-To headers when bouncing messages. Postfix users may wish to unset this variable.

3.28. braille_friendly

Type: boolean
Default: no

When this variable is set , mutt will place the cursor at the beginning of the current line in menus, even when the $arrow_cursorvariable is unset , making it easier for blind persons using Braille displays to follow these menus. The option is unset by default because many visual terminals don't permit making the cursor invisible.

3.29. catchup_newsgroup

Type: quadoption
Default: ask-yes

If this variable is set , Mutt will mark all articles in newsgroup as read when you quit the newsgroup (catchup newsgroup).

3.30. certificate_file

Type: path
Default:  ~/.mutt_certificates

This variable specifies the file where the certificates you trust are saved. When an unknown certificate is encountered, you are asked if you accept it or not. If you accept it, the certificate can also be saved in this file and further connections are automatically accepted.

You can also manually add CA certificates in this file. Any server certificate that is signed with one of these CA certificates is also automatically accepted.

Example:

set certificate_file=~/.mutt/certificates

3.31. charset

Type: string
Default: (empty)

Character set your terminal uses to display and enter textual data. It is also the fallback for $send_charset.

Upon startup Mutt tries to derive this value from environment variables such as $LC_CTYPEor $LANG.

Note: It should only be set in case Mutt isn't able to determine the character set used correctly.

3.32. check_mbox_size

Type: boolean
Default: no

When this variable is set , mutt will use file size attribute instead of access time when checking for new mail in mbox and mmdf folders.

This variable is unset by default and should only be enabled when new mail detection for these folder types is unreliable or doesn't work.

Note that enabling this variable should happen before any mailboxes directives occur in configuration files regarding mbox or mmdf folders because mutt needs to determine the initial new mail status of such a mailbox by performing a fast mailbox scan when it is defined. Afterwards the new mail status is tracked by file size changes.

3.33. check_new

Type: boolean
Default: yes

Note: this option only affects maildir and MH style mailboxes.

When set , Mutt will check for new mail delivered while the mailbox is open. Especially with MH mailboxes, this operation can take quite some time since it involves scanning the directory and checking each file to see if it has already been looked at. If this variable is unset , no check for new mail is performed while the mailbox is open.

3.34. collapse_unread

Type: boolean
Default: yes

When unset , Mutt will not collapse a thread if it contains any unread messages.

3.35. compose_format

Type: string
Default:  -- NeoMutt: Compose  [Approx. msg size: %l   Atts: %a]%>-

Controls the format of the status line displayed in the composemenu. This string is similar to $status_format, but has its own set of printf(3)-like sequences:

%a total number of attachments
%h local hostname
%l approximate size (in bytes) of the current message
%v Mutt version string

See the text describing the $status_formatoption for more information on how to set $compose_format.

3.36. config_charset

Type: string
Default: (empty)

When defined, Mutt will recode commands in rc files from this encoding to the current character set as specified by $charsetand aliases written to $alias_filefrom the current character set.

Please note that if setting $charsetit must be done before setting $config_charset.

Recoding should be avoided as it may render unconvertable characters as question marks which can lead to undesired side effects (for example in regular expressions).

3.37. confirmappend

Type: boolean
Default: yes

When set , Mutt will prompt for confirmation when appending messages to an existing mailbox.

3.38. confirmcreate

Type: boolean
Default: yes

When set , Mutt will prompt for confirmation when saving messages to a mailbox which does not yet exist before creating it.

3.39. connect_timeout

Type: number
Default: 30

Causes Mutt to timeout a network connection (for IMAP, POP or SMTP) after this many seconds if the connection is not able to be established. A negative value causes Mutt to wait indefinitely for the connection attempt to succeed.

3.40. content_type

Type: string
Default:  text/plain

Sets the default Content-Type for the body of newly composed messages.

3.41. copy

Type: quadoption
Default: yes

This variable controls whether or not copies of your outgoing messages will be saved for later references. Also see $record, $save_name, $force_nameand fcc-hook .

3.42. crypt_autoencrypt

Type: boolean
Default: no

Setting this variable will cause Mutt to always attempt to PGP encrypt outgoing messages. This is probably only useful in connection to the send-hook command. It can be overridden by use of the pgp menu, when encryption is not required or signing is requested as well. If $smime_is_defaultis set , then OpenSSL is used instead to create S/MIME messages and settings can be overridden by use of the smime menu instead. (Crypto only)

3.43. crypt_autopgp

Type: boolean
Default: yes

This variable controls whether or not mutt may automatically enable PGP encryption/signing for messages. See also $crypt_autoencrypt, $crypt_replyencrypt, $crypt_autosign, $crypt_replysignand $smime_is_default.

3.44. crypt_autosign

Type: boolean
Default: no

Setting this variable will cause Mutt to always attempt to cryptographically sign outgoing messages. This can be overridden by use of the pgp menu, when signing is not required or encryption is requested as well. If $smime_is_defaultis set , then OpenSSL is used instead to create S/MIME messages and settings can be overridden by use of the smime menu instead of the pgp menu. (Crypto only)

3.45. crypt_autosmime

Type: boolean
Default: yes

This variable controls whether or not mutt may automatically enable S/MIME encryption/signing for messages. See also $crypt_autoencrypt, $crypt_replyencrypt, $crypt_autosign, $crypt_replysignand $smime_is_default.

3.46. crypt_confirmhook

Type: boolean
Default: yes

If set, then you will be prompted for confirmation of keys when using the crypt-hook command. If unset, no such confirmation prompt will be presented. This is generally considered unsafe, especially where typos are concerned.

3.47. crypt_opportunistic_encrypt

Type: boolean
Default: no

Setting this variable will cause Mutt to automatically enable and disable encryption, based on whether all message recipient keys can be located by Mutt.

When this option is enabled, Mutt will enable/disable encryption each time the TO, CC, and BCC lists are edited. If $edit_headersis set, Mutt will also do so each time the message is edited.

While this is set, encryption can't be manually enabled/disabled. The pgp or smime menus provide a selection to temporarily disable this option for the current message.

If $crypt_autoencryptor $crypt_replyencryptenable encryption for a message, this option will be disabled for that message. It can be manually re-enabled in the pgp or smime menus. (Crypto only)

3.48. crypt_replyencrypt

Type: boolean
Default: yes

If set , automatically PGP or OpenSSL encrypt replies to messages which are encrypted. (Crypto only)

3.49. crypt_replysign

Type: boolean
Default: no

If set , automatically PGP or OpenSSL sign replies to messages which are signed.

Note: this does not work on messages that are encrypted and signed! (Crypto only)

3.50. crypt_replysignencrypted

Type: boolean
Default: no

If set , automatically PGP or OpenSSL sign replies to messages which are encrypted. This makes sense in combination with $crypt_replyencrypt, because it allows you to sign all messages which are automatically encrypted. This works around the problem noted in $crypt_replysign, that mutt is not able to find out whether an encrypted message is also signed. (Crypto only)

3.51. pgp_encrypt_self

Type: quadoption
Default: no

Encrypt the message to $pgp_sign_astoo. (PGP only)

3.52. crypt_timestamp

Type: boolean
Default: yes

If set , mutt will include a time stamp in the lines surrounding PGP or S/MIME output, so spoofing such lines is more difficult. If you are using colors to mark these lines, and rely on these, you may unset this setting. (Crypto only)

3.53. crypt_use_gpgme

Type: boolean
Default: no

This variable controls the use of the GPGME-enabled crypto backends. If it is set and Mutt was built with gpgme support, the gpgme code for S/MIME and PGP will be used instead of the classic code. Note that you need to set this option in .muttrc; it won't have any effect when used interactively.

Note that the GPGME backend does not support creating old-style inline (traditional) PGP encrypted or signed messages (see $pgp_autoinline).

3.54. crypt_use_pka

Type: boolean
Default: no

Controls whether mutt uses PKA (see http://www.g10code.de/docs/pka-intro.de.pdf) during signature verification (only supported by the GPGME backend).

3.55. crypt_verify_sig

Type: quadoption
Default: yes

If yes , always attempt to verify PGP or S/MIME signatures. If ask-* , ask whether or not to verify the signature. If no , never attempt to verify cryptographic signatures. (Crypto only)

3.56. date_format

Type: string
Default:  !%a, %b %d, %Y at %I:%M:%S%p %Z

This variable controls the format of the date printed by the %dsequence in $index_format. This is passed to the strftime(3)function to process the date, see the man page for the proper syntax.

Unless the first character in the string is a bang ( !), the month and week day names are expanded according to the locale. If the first character in the string is a bang, the bang is discarded, and the month and week day names in the rest of the string are expanded in the C locale (that is in US English).

3.57. default_hook

Type: string
Default:  ~f %s !~P | (~P ~C %s)

This variable controls how message-hook , reply-hook , send-hook , send2-hook , save-hook , and fcc-hook will be interpreted if they are specified with only a simple regexp, instead of a matching pattern. The hooks are expanded when they are declared, so a hook will be interpreted according to the value of this variable at the time the hook is declared.

The default value matches if the message is either from a user matching the regular expression given, or if it is from you (if the from address matches alternates ) and is to or cc'ed to a user matching the given regular expression.

3.58. delete

Type: quadoption
Default: ask-yes

Controls whether or not messages are really deleted when closing or synchronizing a mailbox. If set to yes , messages marked for deleting will automatically be purged without prompting. If set to no , messages marked for deletion will be kept in the mailbox.

3.59. delete_untag

Type: boolean
Default: yes

If this option is set , mutt will untag messages when marking them for deletion. This applies when you either explicitly delete a message, or when you save it to another folder.

3.60. digest_collapse

Type: boolean
Default: yes

If this option is set , mutt's received-attachments menu will not show the subparts of individual messages in a multipart/digest. To see these subparts, press von that menu.

3.61. display_filter

Type: path
Default: (empty)

When set, specifies a command used to filter messages. When a message is viewed it is passed as standard input to $display_filter, and the filtered message is read from the standard output.

3.62. dotlock_program

Type: path
Default:  /home/mutt/install/bin/mutt_dotlock

Contains the path of the mutt_dotlock(8)binary to be used by mutt.

3.63. dsn_notify

Type: string
Default: (empty)

This variable sets the request for when notification is returned. The string consists of a comma separated list (no spaces!) of one or more of the following: never , to never request notification, failure , to request notification on transmission failure, delay , to be notified of message delays, success , to be notified of successful transmission.

Example:

set dsn_notify="failure,delay"

Note: when using $sendmailfor delivery, you should not enable this unless you are either using Sendmail 8.8.x or greater or a MTA providing a sendmail(1)-compatible interface supporting the -Noption for DSN. For SMTP delivery, DSN support is auto-detected so that it depends on the server whether DSN will be used or not.

3.64. dsn_return

Type: string
Default: (empty)

This variable controls how much of your message is returned in DSN messages. It may be set to either hdrs to return just the message header, or full to return the full message.

Example:

set dsn_return=hdrs

Note: when using $sendmailfor delivery, you should not enable this unless you are either using Sendmail 8.8.x or greater or a MTA providing a sendmail(1)-compatible interface supporting the -Roption for DSN. For SMTP delivery, DSN support is auto-detected so that it depends on the server whether DSN will be used or not.

3.65. duplicate_threads

Type: boolean
Default: yes

This variable controls whether mutt, when $sortis set to threads , threads messages with the same Message-Id together. If it is set , it will indicate that it thinks they are duplicates of each other with an equals sign in the thread tree.

3.66. edit_headers

Type: boolean
Default: no

This option allows you to edit the header of your outgoing messages along with the body of your message.

Note that changes made to the References: and Date: headers are ignored for interoperability reasons.

3.67. editor

Type: path
Default: (empty)

This variable specifies which editor is used by mutt. It defaults to the value of the $VISUAL, or $EDITOR, environment variable, or to the string viif neither of those are set.

The $editor string may contain a %s escape, which will be replaced by the name of the file to be edited. If the %s escape does not appear in $editor , a space and the name to be edited are appended.

The resulting string is then executed by running

sh -c 'string'

where string is the expansion of $editor described above.

3.68. empty_subject

Type: string
Default:  Re: your mail

This variable specifies the subject to be used when replying to an email with an empty subject. It defaults to "Re: your mail".

3.69. encode_from

Type: boolean
Default: no

When set , mutt will quoted-printable encode messages when they contain the string From(note the trailing space) in the beginning of a line. This is useful to avoid the tampering certain mail delivery and transport agents tend to do with messages (in order to prevent tools from misinterpreting the line as a mbox message separator).

3.70. entropy_file

Type: path
Default: (empty)

The file which includes random data that is used to initialize SSL library functions.

3.71. envelope_from_address

Type: e-mail address
Default: (empty)

Manually sets the envelope sender for outgoing messages. This value is ignored if $use_envelope_fromis unset .

3.72. escape

Type: string
Default:  ~

Escape character to use for functions in the built-in editor.

3.73. fast_reply

Type: boolean
Default: no

When set , the initial prompt for recipients and subject are skipped when replying to messages, and the initial prompt for subject is skipped when forwarding messages.

Note: this variable has no effect when the $autoeditvariable is set .

3.74. fcc_attach

Type: quadoption
Default: yes

This variable controls whether or not attachments on outgoing messages are saved along with the main body of your message.

3.75. fcc_clear

Type: boolean
Default: no

When this variable is set , FCCs will be stored unencrypted and unsigned, even when the actual message is encrypted and/or signed. (PGP only)

3.76. flag_safe

Type: boolean
Default: no

If set, flagged messages cannot be deleted.

3.77. folder

Type: path
Default:  ~/Mail

Specifies the default location of your mailboxes. A +or =at the beginning of a pathname will be expanded to the value of this variable. Note that if you change this variable (from the default) value you need to make sure that the assignment occurs before you use +or =for any other variables since expansion takes place when handling the mailboxes command.

3.78. folder_format

Type: string
Default:  %2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f

This variable allows you to customize the file browser display to your personal taste. This string is similar to $index_format, but has its own set of printf(3)-like sequences:

%C current file number
%d date/time folder was last modified
%D date/time folder was last modified using $date_format.
%f filename ( /is appended to directory names, @to symbolic links and *to executable files)
%F file permissions
%g group name (or numeric gid, if missing)
%l number of hard links
%m number of messages in the mailbox *
%n number of unread messages in the mailbox *
%N N if mailbox has new mail, blank otherwise
%s size in bytes
%t *if the file is tagged, blank otherwise
%u owner name (or numeric uid, if missing)
%>X right justify the rest of the string and pad with character X
%|X pad to the end of the line with character X
%*X soft-fill with character Xas pad

For an explanation of soft-fill, see the $index_formatdocumentation.

* = can be optionally printed if nonzero

%m, %n, and %N only work for monitored mailboxes. %m requires $mail_check_statsto be set. %n requires $mail_check_statsto be set (except for IMAP mailboxes).

3.79. followup_to

Type: boolean
Default: yes

Controls whether or not the Mail-Followup-To:header field is generated when sending mail. When set , Mutt will generate this field when you are replying to a known mailing list, specified with the subscribe or lists commands.

This field has two purposes. First, preventing you from receiving duplicate copies of replies to messages which you send to mailing lists, and second, ensuring that you do get a reply separately for any messages sent to known lists to which you are not subscribed.

The header will contain only the list's address for subscribed lists, and both the list address and your own email address for unsubscribed lists. Without this header, a group reply to your message sent to a subscribed list will be sent to both the list and your address, resulting in two copies of the same email for you.

3.80. followup_to_poster

Type: quadoption
Default: ask-yes

If this variable is set and the keyword "poster" is present in Followup-To header, follow-up to newsgroup function is not permitted. The message will be mailed to the submitter of the message via mail.

3.81. force_name

Type: boolean
Default: no

This variable is similar to $save_name, except that Mutt will store a copy of your outgoing message by the username of the address you are sending to even if that mailbox does not exist.

Also see the $recordvariable.

3.82. forward_decode

Type: boolean
Default: yes

Controls the decoding of complex MIME messages into text/plainwhen forwarding a message. The message header is also RFC2047 decoded. This variable is only used, if $mime_forwardis unset , otherwise $mime_forward_decodeis used instead.

3.83. forward_decrypt

Type: boolean
Default: yes

Controls the handling of encrypted messages when forwarding a message. When set , the outer layer of encryption is stripped off. This variable is only used if $mime_forwardis set and $mime_forward_decodeis unset . (PGP only)

3.84. forward_edit

Type: quadoption
Default: yes

This quadoption controls whether or not the user is automatically placed in the editor when forwarding messages. For those who always want to forward with no modification, use a setting of no.

3.85. forward_format

Type: string
Default:  [%a: %s]

This variable controls the default subject when forwarding a message. It uses the same format sequences as the $index_formatvariable.

3.86. forward_quote

Type: boolean
Default: no

When set , forwarded messages included in the main body of the message (when $mime_forwardis unset ) will be quoted using $indent_string.

3.87. forward_references

Type: boolean
Default: no

When set , forwarded messages set the In-Reply-To:and References:headers in the same way as normal replies would. Hence the forwarded message becomes part of the original thread instead of starting a new one.

3.88. from

Type: e-mail address
Default: (empty)

When set , this variable contains a default from address. It can be overridden using my_hdr (including from a send-hook ) and $reverse_name. This variable is ignored if $use_fromis unset .

This setting defaults to the contents of the environment variable $EMAIL.

3.89. from_chars

Type: string
Default: (empty)

Controls the character used to prefix the %F and %L fields in the index.

Character Description
1 Mail is written by you and has a To address, or has a known mailing list in the To address.
2 Mail is written by you and has a Cc address, or has a known mailing list in the Cc address.
3 Mail is written by you and has a Bcc address.
4 All remaining cases.

If this is empty or unset (default), the traditional long "To ", "Cc " and "Bcc " prefixes are used. If set but too short to include a character for a particular case, a single space will be prepended to the field. To prevent any prefix at all from being added in a particular case, use the special value CR (aka ^M) for the corresponding character.

This slightly odd interface is necessitated by mutt's handling of string variables; one cannot tell a variable that is unset from one that is set to the empty string.

3.90. gecos_mask

Type: regular expression
Default:  ^[^,]*

A regular expression used by mutt to parse the GECOS field of a password entry when expanding the alias. The default value will return the string up to the first ,encountered. If the GECOS field contains a string like lastname, firstnamethen you should set it to .* .

This can be useful if you see the following behavior: you address an e-mail to user ID stevefwhose full name is Steve Franklin. If mutt expands stevefto "Franklin" stevef@foo.barthen you should set the $gecos_maskto a regular expression that will match the whole name so mutt will expand Franklinto Franklin, Steve.

3.91. group_index_format

Type: string
Default:  %4C %M%N %5s  %-45.45f %d

This variable allows you to customize the newsgroup browser display to your personal taste. This string is similar to index_format , but has its own set of printf()-like sequences:

%C current newsgroup number
%d description of newsgroup (becomes from server)
%f newsgroup name
%M - if newsgroup not allowed for direct post (moderated for example)
%N N if newsgroup is new, u if unsubscribed, blank otherwise
%n number of new articles in newsgroup
%s number of unread articles in newsgroup
%>X right justify the rest of the string and pad with character "X"
%|X pad to the end of the line with character "X"

3.92. hdrs

Type: boolean
Default: yes

When unset , the header fields normally added by the my_hdr command are not created. This variable must be unset before composing a new message or replying in order to take effect. If set , the user defined header fields are added to every new message.

3.93. header

Type: boolean
Default: no

When set , this variable causes Mutt to include the header of the message you are replying to into the edit buffer. The $weedsetting applies.

3.94. header_cache

Type: path
Default: (empty)

This variable points to the header cache database. If pointing to a directory Mutt will contain a header cache database file per folder, if pointing to a file that file will be a single global header cache. By default it is unset so no header caching will be used.

Header caching can greatly improve speed when opening POP, IMAP MH or Maildir folders, see caching for details.

3.95. header_cache_backend

Type: -none-
Default: 0

This variable specifies the header cache backend.

3.96. header_cache_compress

Type: boolean
Default: yes

When mutt is compiled with qdbm, tokyocabinet or kyotocabinet as header cache backend, this option determines whether the database will be compressed. Compression results in database files roughly being one fifth of the usual diskspace, but the decompression can result in a slower opening of cached folder(s) which in general is still much faster than opening non header cached folders.

3.97. header_cache_pagesize

Type: string
Default:  16384

When mutt is compiled with either gdbm or bdb4 as the header cache backend, this option changes the database page size. Too large or too small values can waste space, memory, or CPU time. The default should be more or less optimal for most use cases.

3.98. help

Type: boolean
Default: yes

When set , help lines describing the bindings for the major functions provided by each menu are displayed on the first line of the screen.

Note: The binding will not be displayed correctly if the function is bound to a sequence rather than a single keystroke. Also, the help line may not be updated if a binding is changed while Mutt is running. Since this variable is primarily aimed at new users, neither of these should present a major problem.

3.99. hidden_host

Type: boolean
Default: no

When set , mutt will skip the host name part of $hostnamevariable when adding the domain part to addresses. This variable does not affect the generation of Message-IDs, and it will not lead to the cut-off of first-level domains.

3.100. hide_limited

Type: boolean
Default: no

When set , mutt will not show the presence of messages that are hidden by limiting, in the thread tree.

3.101. hide_missing

Type: boolean
Default: yes

When set , mutt will not show the presence of missing messages in the thread tree.

3.102. hide_thread_subject

Type: boolean
Default: yes

When set , mutt will not show the subject of messages in the thread tree that have the same subject as their parent or closest previously displayed sibling.

3.103. hide_top_limited

Type: boolean
Default: no

When set , mutt will not show the presence of messages that are hidden by limiting, at the top of threads in the thread tree. Note that when $hide_limitedis set , this option will have no effect.

3.104. hide_top_missing

Type: boolean
Default: yes

When set , mutt will not show the presence of missing messages at the top of threads in the thread tree. Note that when $hide_missingis set , this option will have no effect.

3.105. history

Type: number
Default: 10

This variable controls the size (in number of strings remembered) of the string history buffer per category. The buffer is cleared each time the variable is set.

3.106. history_file

Type: path
Default:  ~/.mutthistory

The file in which Mutt will save its history.

3.107. honor_disposition

Type: boolean
Default: no

When set , Mutt will not display attachments with a disposition of attachmentinline even if it could render the part to plain text. These MIME parts can only be viewed from the attachment menu.

If unset , Mutt will render all MIME parts it can properly transform to plain text.

3.108. honor_followup_to

Type: quadoption
Default: yes

This variable controls whether or not a Mail-Followup-To header is honored when group-replying to a message.

3.109. hostname

Type: string
Default: (empty)

Specifies the fully-qualified hostname of the system mutt is running on containing the host's name and the DNS domain it belongs to. It is used as the domain part (after @) for local email addresses as well as Message-Id headers.

Its value is determined at startup as follows: the node's hostname is first determined by the uname(3)function. The domain is then looked up using the gethostname(2)and getaddrinfo(3)functions. If those calls are unable to determine the domain, the full value returned by uname is used. Optionally, Mutt can be compiled with a fixed domain name in which case a detected one is not used.

Also see $use_domainand $hidden_host.

3.110. idn_decode

Type: boolean
Default: yes

When set , Mutt will show you international domain names decoded. Note: You can use IDNs for addresses even if this is unset . This variable only affects decoding. (IDN only)

3.111. idn_encode

Type: boolean
Default: yes

When set , Mutt will encode international domain names using IDN. Unset this if your SMTP server can handle newer (RFC 6531) UTF-8 encoded domains. (IDN only)

3.112. ignore_linear_white_space

Type: boolean
Default: no

This option replaces linear-white-space between encoded-word and text to a single space to prevent the display of MIME-encoded Subject:field from being divided into multiple lines.

3.113. ignore_list_reply_to

Type: boolean
Default: no

Affects the behavior of the <reply>function when replying to messages from mailing lists (as defined by the subscribe or lists commands). When set , if the Reply-To:field is set to the same value as the To:field, Mutt assumes that the Reply-To:field was set by the mailing list to automate responses to the list, and will ignore this field. To direct a response to the mailing list when this option is set , use the <list-reply> function; <group-reply>will reply to both the sender and the list.

3.114. show_multipart_alternative

Type: string
Default: (empty)

When set to info, the multipart/alternative information is shown. When set to inline, all of the alternatives are displayed. When not set, the default behavior is to show only the chosen alternative.

3.115. imap_authenticators

Type: string
Default: (empty)

This is a colon-delimited list of authentication methods mutt may attempt to use to log in to an IMAP server, in the order mutt should try them. Authentication methods are either loginor the right side of an IMAP AUTH=xxxcapability string, e.g. digest-md5, gssapior cram-md5. This option is case-insensitive. If it's unset (the default) mutt will try all available methods, in order from most-secure to least-secure.

Example:

set imap_authenticators="gssapi:cram-md5:login"

Note: Mutt will only fall back to other authentication methods if the previous methods are unavailable. If a method is available but authentication fails, mutt will not connect to the IMAP server.

3.116. imap_check_subscribed

Type: boolean
Default: no

When set , mutt will fetch the set of subscribed folders from your server on connection, and add them to the set of mailboxes it polls for new mail just as if you had issued individual mailboxes commands.

3.117. imap_delim_chars

Type: string
Default:  /.

This contains the list of characters which you would like to treat as folder separators for displaying IMAP paths. In particular it helps in using the =shortcut for your folder variable.

3.118. imap_headers

Type: string
Default: (empty)

Mutt requests these header fields in addition to the default headers ( Date:, From:, Subject:, To:, Cc:, Message-Id:, References:, Content-Type:, Content-Description:, In-Reply-To:, Reply-To:, Lines:, List-Post:, X-Label:) from IMAP servers before displaying the index menu. You may want to add more headers for spam detection.

Note: This is a space separated list, items should be uppercase and not contain the colon, e.g. X-BOGOSITY X-SPAM-STATUSfor the X-Bogosity:and X-Spam-Status:header fields.

3.119. imap_idle

Type: boolean
Default: no

When set , mutt will attempt to use the IMAP IDLE extension to check for new mail in the current mailbox. Some servers (dovecot was the inspiration for this option) react badly to mutt's implementation. If your connection seems to freeze up periodically, try unsetting this.

3.120. imap_keepalive

Type: number
Default: 300

This variable specifies the maximum amount of time in seconds that mutt will wait before polling open IMAP connections, to prevent the server from closing them before mutt has finished with them. The default is well within the RFC-specified minimum amount of time (30 minutes) before a server is allowed to do this, but in practice the RFC does get violated every now and then. Reduce this number if you find yourself getting disconnected from your IMAP server due to inactivity.

3.121. imap_list_subscribed

Type: boolean
Default: no

This variable configures whether IMAP folder browsing will look for only subscribed folders or all folders. This can be toggled in the IMAP browser with the <toggle-subscribed>function.

3.122. imap_login

Type: string
Default: (empty)

Your login name on the IMAP server.

This variable defaults to the value of $imap_user.

3.123. imap_pass

Type: string
Default: (empty)

Specifies the password for your IMAP account. If unset , Mutt will prompt you for your password when you invoke the <imap-fetch-mail>function or try to open an IMAP folder.

Warning : you should only use this option when you are on a fairly secure machine, because the superuser can read your muttrc even if you are the only one who can read the file.

3.124. imap_passive

Type: boolean
Default: yes

When set , mutt will not open new IMAP connections to check for new mail. Mutt will only check for new mail over existing IMAP connections. This is useful if you don't want to be prompted to user/password pairs on mutt invocation, or if opening the connection is slow.

3.125. imap_peek

Type: boolean
Default: yes

When set , mutt will avoid implicitly marking your mail as read whenever you fetch a message from the server. This is generally a good thing, but can make closing an IMAP folder somewhat slower. This option exists to appease speed freaks.

3.126. imap_pipeline_depth

Type: number
Default: 15

Controls the number of IMAP commands that may be queued up before they are sent to the server. A deeper pipeline reduces the amount of time mutt must wait for the server, and can make IMAP servers feel much more responsive. But not all servers correctly handle pipelined commands, so if you have problems you might want to try setting this variable to 0.

Note: Changes to this variable have no effect on open connections.

3.127. imap_servernoise

Type: boolean
Default: yes

When set , mutt will display warning messages from the IMAP server as error messages. Since these messages are often harmless, or generated due to configuration problems on the server which are out of the users' hands, you may wish to suppress them at some point.

3.128. imap_user

Type: string
Default: (empty)

The name of the user whose mail you intend to access on the IMAP server.

This variable defaults to your user name on the local machine.

3.129. implicit_autoview

Type: boolean
Default: no

If set to yes, mutt will look for a mailcap entry with the copiousoutput flag set for every MIME attachment it doesn't have an internal viewer defined for. If such an entry is found, mutt will use the viewer defined in that entry to convert the body part to text form.

3.130. include

Type: quadoption
Default: ask-yes

Controls whether or not a copy of the message(s) you are replying to is included in your reply.

3.131. include_onlyfirst

Type: boolean
Default: no

Controls whether or not Mutt includes only the first attachment of the message you are replying.

3.132. indent_string

Type: string
Default: 

Specifies the string to prepend to each line of text quoted in a message to which you are replying. You are strongly encouraged not to change this value, as it tends to agitate the more fanatical netizens.

The value of this option is ignored if $text_flowedis set, too because the quoting mechanism is strictly defined for format=flowed.

This option is a format string, please see the description of $index_formatfor supported printf(3)-style sequences.

3.133. index_format

Type: string
Default:  %4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s

This variable allows you to customize the message index display to your personal taste.

Format stringsare similar to the strings used in the C function printf(3)to format output (see the man page for more details). The following sequences are defined in Mutt:

%a address of the author
%A reply-to address (if present; otherwise: address of author)
%b filename of the original message folder (think mailbox)
%B the list to which the letter was sent, or else the folder name (%b).
%c number of characters (bytes) in the message
%C current message number
%d date and time of the message in the format specified by $date_formatconverted to sender's time zone
%D date and time of the message in the format specified by $date_formatconverted to the local time zone
%e current message number in thread
%E number of messages in current thread
%f sender (address + real name), either From: or Return-Path:
%F author name, or recipient name if the message is from you
%g newsgroup name (if compiled with NNTP support)
%g message labels (e.g. notmuch tags)
%H spam attribute(s) of this message
%i message-id of the current message
%K the list to which the letter was sent (if any; otherwise: empty).
%l number of lines in the message (does not work with maildir, mh, and possibly IMAP folders)
%L If an address in the To:or Cc:header field matches an address defined by the users subscribe command, this displays "To <list-name>", otherwise the same as %F.
%m total number of message in the mailbox
%M number of hidden messages if the thread is collapsed.
%N message score
%n author's real name (or address if missing)
%O original save folder where mutt would formerly have stashed the message: list name or recipient name if not sent to a list
%P progress indicator for the built-in pager (how much of the file has been displayed)
%r comma separated list of To:recipients
%R comma separated list of Cc:recipients
%s subject of the message
%S status of the message ( N/ D/ d/ !/ r/*)
%t To:field (recipients)
%T the appropriate character from the $to_charsstring
%u user (login) name of the author
%v first name of the author, or the recipient if the message is from you
%W name of organization of author ( Organization:field)
%x X-Comment-To:field (if present and compiled with NNTP support)
%X number of attachments (please see the attachments section for possible speed effects)
%y X-Label:field, if present
%Y X-Label:field, if present, and (1) not at part of a thread tree, (2) at the top of a thread, or (3) X-Label:is different from preceding message's X-Label:.
%Z message status flags
%{fmt} the date and time of the message is converted to sender's time zone, and fmtis expanded by the library function strftime(3); a leading bang disables locales
%[fmt] the date and time of the message is converted to the local time zone, and fmtis expanded by the library function strftime(3); a leading bang disables locales
%(fmt) the local date and time when the message was received. fmtis expanded by the library function strftime(3); a leading bang disables locales
%<fmt> the current local time. fmtis expanded by the library function strftime(3); a leading bang disables locales.
%>X right justify the rest of the string and pad with character X
%|X pad to the end of the line with character X
%*X soft-fill with character Xas pad

Date format expressions can be constructed based on relative dates. Using the date formatting operators along with nested conditionals, the date format can be modified based on how old a message is. See the section on Conditional Datesfor an explanation and examples Soft-filldeserves some explanation: Normal right-justification will print everything to the left of the %>, displaying padding and whatever lies to the right only if there's room. By contrast, soft-fill gives priority to the right-hand side, guaranteeing space to display it and showing padding only if there's still room. If necessary, soft-fill will eat text leftwards to make room for rightward text.

Note that these expandos are supported in save-hook , fcc-hook and fcc-save-hook , too.

3.134. inews

Type: path
Default: (empty)

If set, specifies the program and arguments used to deliver news posted by Mutt. Otherwise, mutt posts article using current connection to news server. The following printf-style sequence is understood:

%a account url
%p port
%P port if specified
%s news server name
%S url schema
%u username

Example:

set inews="/usr/local/bin/inews -hS"

3.135. ispell

Type: path
Default:  /usr/bin/hunspell

How to invoke ispell (GNU's spell-checking software).

3.136. keep_flagged

Type: boolean
Default: no

If set , read messages marked as flagged will not be moved from your spool mailbox to your $mboxmailbox, or as a result of a mbox-hook command.

3.137. keywords_legacy

Type: boolean
Default: yes

If set , keywords/labels/tags will be written to whatever legacy, nonstandard headers (X-Label, X-Keywords, X-Mozilla-Keys) they were sourced from.

If both $keywords_legacy and $keywords_standard are false, mutt will save keywords to legacy headers to ensure that it does not lose your labels.

3.138. keywords_standard

Type: boolean
Default: no

If set , keywords/labels/tags will be written to the RFC2822-standard Keywords: header; this may imply a conversion from legacy headers.

If both $keywords_legacy and $keywords_standard are false, mutt will save keywords to legacy headers to ensure that it does not lose your labels.

3.139. mail_check

Type: number
Default: 5

This variable configures how often (in seconds) mutt should look for new mail. Also see the $timeoutvariable.

3.140. mail_check_recent

Type: boolean
Default: yes

When set , Mutt will only notify you about new mail that has been received since the last time you opened the mailbox. When unset , Mutt will notify you if any new mail exists in the mailbox, regardless of whether you have visited it recently.

When $mark_old is set, Mutt does not consider the mailbox to contain new mail if only old messages exist.

3.141. mail_check_stats

Type: boolean
Default: no

When set , mutt will periodically calculate message statistics of a mailbox while polling for new mail. It will check for unread, flagged, and total message counts. Because this operation is more performance intensive, it defaults to unset , and has a separate option, $mail_check_stats_interval, to control how often to update these counts.

3.142. mail_check_stats_interval

Type: number
Default: 60

When $mail_check_statsis set , this variable configures how often (in seconds) mutt will update message counts.

3.143. mailcap_path

Type: string
Default: (empty)

This variable specifies which files to consult when attempting to display MIME bodies not directly supported by Mutt.

3.144. mailcap_sanitize

Type: boolean
Default: yes

If set , mutt will restrict possible characters in mailcap % expandos to a well-defined set of safe characters. This is the safe setting, but we are not sure it doesn't break some more advanced MIME stuff.

DON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE DOING!

3.145. maildir_header_cache_verify

Type: boolean
Default: yes

Check for Maildir unaware programs other than mutt having modified maildir files when the header cache is in use. This incurs one stat(2)per message every time the folder is opened (which can be very slow for NFS folders).

3.146. maildir_trash

Type: boolean
Default: no

If set , messages marked as deleted will be saved with the maildir trashed flag instead of unlinked. Note: this only applies to maildir-style mailboxes. Setting it will have no effect on other mailbox types.

3.147. maildir_check_cur

Type: boolean
Default: no

If set , mutt will poll both the new and cur directories of a maildir folder for new messages. This might be useful if other programs interacting with the folder (e.g. dovecot) are moving new messages to the cur directory. Note that setting this option may slow down polling for new messages in large folders, since mutt has to scan all cur messages.

3.148. mark_macro_prefix

Type: string
Default:  '

Prefix for macros created using mark-message. A new macro automatically generated with <mark-message>a will be composed from this prefix and the letter a .

3.149. mark_old

Type: boolean
Default: yes

Controls whether or not mutt marks new unread messages as old if you exit a mailbox without reading them. With this option set , the next time you start mutt, the messages will show up with an Onext to them in the index menu, indicating that they are old.

3.150. markers

Type: boolean
Default: yes

Controls the display of wrapped lines in the internal pager. If set, a +marker is displayed at the beginning of wrapped lines.

Also see the $smart_wrapvariable.

3.151. mask

Type: regular expression
Default:  !^\.[^.]

A regular expression used in the file browser, optionally preceded by the not operator !. Only files whose names match this mask will be shown. The match is always case-sensitive.

3.152. mbox

Type: path
Default:  ~/mbox

This specifies the folder into which read mail in your $spoolfilefolder will be appended.

Also see the $movevariable.

3.153. mbox_type

Type: folder magic
Default: mbox

The default mailbox type used when creating new folders. May be any of mbox, MMDF, MHand Maildir. This is overridden by the -mcommand-line option.

3.154. menu_context

Type: number
Default: 0

This variable controls the number of lines of context that are given when scrolling through menus. (Similar to $pager_context.)

3.155. menu_move_off

Type: boolean
Default: yes

When unset , the bottom entry of menus will never scroll up past the bottom of the screen, unless there are less entries than lines. When set , the bottom entry may move off the bottom.

3.156. menu_scroll

Type: boolean
Default: no

When set , menus will be scrolled up or down one line when you attempt to move across a screen boundary. If unset , the screen is cleared and the next or previous page of the menu is displayed (useful for slow links to avoid many redraws).

3.157. message_cache_clean

Type: boolean
Default: no

If set , mutt will clean out obsolete entries from the message cache when the mailbox is synchronized. You probably only want to set it every once in a while, since it can be a little slow (especially for large folders).

3.158. message_cachedir

Type: path
Default: (empty)

Set this to a directory and mutt will cache copies of messages from your IMAP and POP servers here. You are free to remove entries at any time.

When setting this variable to a directory, mutt needs to fetch every remote message only once and can perform regular expression searches as fast as for local folders.

Also see the $message_cache_cleanvariable.

3.159. message_format

Type: string
Default:  %s

This is the string displayed in the attachmentmenu for attachments of type message/rfc822. For a full listing of defined printf(3)-like sequences see the section on $index_format.

3.160. meta_key

Type: boolean
Default: no

If set , forces Mutt to interpret keystrokes with the high bit (bit 8) set as if the user had pressed the Esc key and whatever key remains after having the high bit removed. For example, if the key pressed has an ASCII value of 0xf8, then this is treated as if the user had pressed Esc then x. This is because the result of removing the high bit from 0xf8is 0x78, which is the ASCII character x.

3.161. metoo

Type: boolean
Default: no

If unset , Mutt will remove your address (see the alternates command) from the list of recipients when replying to a message.

3.162. mh_purge

Type: boolean
Default: no

When unset , mutt will mimic mh's behavior and rename deleted messages to ,<old file name> in mh folders instead of really deleting them. This leaves the message on disk but makes programs reading the folder ignore it. If the variable is set , the message files will simply be deleted.

This option is similar to $maildir_trashfor Maildir folders.

3.163. mh_seq_flagged

Type: string
Default:  flagged

The name of the MH sequence used for flagged messages.

3.164. mh_seq_replied

Type: string
Default:  replied

The name of the MH sequence used to tag replied messages.

3.165. mh_seq_unseen

Type: string
Default:  unseen

The name of the MH sequence used for unseen messages.

3.166. mime_forward

Type: quadoption
Default: no

When set , the message you are forwarding will be attached as a separate message/rfc822MIME part instead of included in the main body of the message. This is useful for forwarding MIME messages so the receiver can properly view the message as it was delivered to you. If you like to switch between MIME and not MIME from mail to mail, set this variable to ask-noor ask-yes.

Also see $forward_decodeand $mime_forward_decode.

3.167. mime_forward_decode

Type: boolean
Default: no

Controls the decoding of complex MIME messages into text/plainwhen forwarding a message while $mime_forwardis set . Otherwise $forward_decodeis used instead.

3.168. mime_forward_rest

Type: quadoption
Default: yes

When forwarding multiple attachments of a MIME message from the attachment menu, attachments which cannot be decoded in a reasonable manner will be attached to the newly composed message if this option is set .

3.169. mime_subject

Type: boolean
Default: yes

If unset , 8-bit subject:line in article header will not be encoded according to RFC2047 to base64. This is useful when message is Usenet article, because MIME for news is nonstandard feature.

3.170. mix_entry_format

Type: string
Default:  %4n %c %-16s %a

This variable describes the format of a remailer line on the mixmaster chain selection screen. The following printf(3)-like sequences are supported:

%n The running number on the menu.
%c Remailer capabilities.
%s The remailer's short name.
%a The remailer's e-mail address.

3.171. mixmaster

Type: path
Default:  mixmaster

This variable contains the path to the Mixmaster binary on your system. It is used with various sets of parameters to gather the list of known remailers, and to finally send a message through the mixmaster chain.

3.172. move

Type: quadoption
Default: no

Controls whether or not Mutt will move read messages from your spool mailbox to your $mboxmailbox, or as a result of a mbox-hook command.

3.173. narrow_tree

Type: boolean
Default: no

This variable, when set , makes the thread tree narrower, allowing deeper threads to fit on the screen.

3.174. net_inc

Type: number
Default: 10

Operations that expect to transfer a large amount of data over the network will update their progress every $net_inckilobytes. If set to 0, no progress messages will be displayed.

See also $read_inc, $write_incand $net_inc.

3.175. new_mail_command

Type: path
Default:  NULL

If set , Mutt will call this command after a new message is received. See the $status_formatdocumentation for the values that can be formatted into this command.

3.176. news_cache_dir

Type: path
Default:  ~/.mutt

This variable pointing to directory where Mutt will save cached news articles and headers in. If unset , articles and headers will not be saved at all and will be reloaded from the server each time.

3.177. news_server

Type: string
Default: (empty)

This variable specifies domain name or address of NNTP server. It defaults to the news server specified in the environment variable $NNTPSERVER or contained in the file /etc/nntpserver. You can also specify username and an alternative port for each news server, ie:

[[s]news://][username[:password]@]server[:port]

3.178. newsgroups_charset

Type: string
Default:  utf-8

Character set of newsgroups descriptions.

3.179. newsrc

Type: path
Default:  ~/.newsrc

The file, containing info about subscribed newsgroups - names and indexes of read articles. The following printf-style sequence is understood:

%a account url
%p port
%P port if specified
%s news server name
%S url schema
%u username

3.180. nntp_authenticators

Type: string
Default: (empty)

This is a colon-delimited list of authentication methods mutt may attempt to use to log in to a news server, in the order mutt should try them. Authentication methods are either useror any SASL mechanism, e.g. digest-md5, gssapior cram-md5. This option is case-insensitive. If it's unset (the default) mutt will try all available methods, in order from most-secure to least-secure.

Example:

set nntp_authenticators="digest-md5:user"

Note: Mutt will only fall back to other authentication methods if the previous methods are unavailable. If a method is available but authentication fails, mutt will not connect to the IMAP server.

3.181. nntp_context

Type: number
Default: 1000

This variable defines number of articles which will be in index when newsgroup entered. If active newsgroup have more articles than this number, oldest articles will be ignored. Also controls how many articles headers will be saved in cache when you quit newsgroup.

3.182. nntp_listgroup

Type: boolean
Default: yes

This variable controls whether or not existence of each article is checked when newsgroup is entered.

3.183. nntp_load_description

Type: boolean
Default: yes

This variable controls whether or not descriptions for each newsgroup must be loaded when newsgroup is added to list (first time list loading or new newsgroup adding).

3.184. nntp_user

Type: string
Default: (empty)

Your login name on the NNTP server. If unset and NNTP server requires authentication, Mutt will prompt you for your account name when you connect to news server.

3.185. nntp_pass

Type: string
Default: (empty)

Your password for NNTP account.

3.186. nntp_poll

Type: number
Default: 60

The time in seconds until any operations on newsgroup except post new article will cause recheck for new news. If set to 0, Mutt will recheck newsgroup on each operation in index (stepping, read article, etc.).

3.187. nm_open_timeout

Type: number
Default: 5

This variable specifies the timeout for database open in seconds.

3.188. nm_default_uri

Type: string
Default: (empty)

This variable specifies the default Notmuch database in format notmuch://<absolute path>.

3.189. nm_hidden_tags

Type: string
Default:  unread,draft,flagged,passed,replied,attachment,signed,encrypted

This variable specifies private notmuch tags which should not be printed on screen.

3.190. nm_exclude_tags

Type: string
Default: (empty)

The messages tagged with these tags are excluded and not loaded from notmuch DB to mutt unless specified explicitly.

3.191. nm_unread_tag

Type: string
Default:  unread

This variable specifies notmuch tag which is used for unread messages. The variable is used to count unread messages in DB only. All other mutt commands use standard (e.g. maildir) flags.

3.192. nm_db_limit

Type: number
Default: 0

This variable specifies the default limit used in notmuch queries.

3.193. nm_query_type

Type: string
Default:  messages

This variable specifies the default query type (threads or messages) used in notmuch queries.

3.194. nm_record

Type: boolean
Default: no

This variable specifies if the mutt record should indexed by notmuch.

3.195. nm_record_tags

Type: string
Default: (empty)

This variable specifies the default tags applied to messages stored to the mutt record. When set to 0 this variable disable the window feature.

3.196. nm_query_window_duration

Type: number
Default: 0

This variable sets the time base of a windowed notmuch query. Accepted values are 'minute', 'hour', 'day', 'week', 'month', 'year'

3.197. nm_query_window_timebase

Type: string
Default:  week

This variable sets the time duration of a windowed notmuch query. Accepted values all non negative integers. A value of 0 disables the feature.

3.198. nm_query_window_current_search

Type: string
Default: (empty)

This variable sets the time duration of a windowed notmuch query. Accepted values all non negative integers. A value of 0 disables the feature.

3.199. nm_query_window_current_position

Type: number
Default: 0

This variable contains the currently setup notmuch search for window based vfolder.

3.200. pager

Type: path
Default:  builtin

This variable specifies which pager you would like to use to view messages. The value builtinmeans to use the built-in pager, otherwise this variable should specify the pathname of the external pager you would like to use.

Using an external pager may have some disadvantages: Additional keystrokes are necessary because you can't call mutt functions directly from the pager, and screen resizes cause lines longer than the screen width to be badly formatted in the help menu.

3.201. pager_context

Type: number
Default: 0

This variable controls the number of lines of context that are given when displaying the next or previous page in the internal pager. By default, Mutt will display the line after the last one on the screen at the top of the next page (0 lines of context).

This variable also specifies the amount of context given for search results. If positive, this many lines will be given before a match, if 0, the match will be top-aligned.

3.202. pager_format

Type: string
Default:  -%Z- %C/%m: %-20.20n   %s%*  -- (%P)

This variable controls the format of the one-line message statusdisplayed before each message in either the internal or an external pager. The valid sequences are listed in the $index_formatsection.

3.203. pager_index_lines

Type: number
Default: 0

Determines the number of lines of a mini-index which is shown when in the pager. The current message, unless near the top or bottom of the folder, will be roughly one third of the way down this mini-index, giving the reader the context of a few messages before and after the message. This is useful, for example, to determine how many messages remain to be read in the current thread. One of the lines is reserved for the status bar from the index, so a setting of 6 will only show 5 lines of the actual index. A value of 0 results in no index being shown. If the number of messages in the current folder is less than $pager_index_lines, then the index will only use as many lines as it needs.

3.204. pager_stop

Type: boolean
Default: no

When set , the internal-pager will not move to the next message when you are at the end of a message and invoke the <next-page>function.

3.205. pgp_auto_decode

Type: boolean
Default: no

If set , mutt will automatically attempt to decrypt traditional PGP messages whenever the user performs an operation which ordinarily would result in the contents of the message being operated on. For example, if the user displays a pgp-traditional message which has not been manually checked with the <check-traditional-pgp> function, mutt will automatically check the message for traditional pgp.

3.206. pgp_autoinline

Type: boolean
Default: no

This option controls whether Mutt generates old-style inline (traditional) PGP encrypted or signed messages under certain circumstances. This can be overridden by use of the pgp menu, when inline is not required. The GPGME backend does not support this option.

Note that Mutt might automatically use PGP/MIME for messages which consist of more than a single MIME part. Mutt can be configured to ask before sending PGP/MIME messages when inline (traditional) would not work.

Also see the $pgp_mime_autovariable.

Also note that using the old-style PGP message format is strongly deprecated . (PGP only)

3.207. pgp_check_exit

Type: boolean
Default: yes

If set , mutt will check the exit code of the PGP subprocess when signing or encrypting. A non-zero exit code means that the subprocess failed. (PGP only)

3.208. pgp_clearsign_command

Type: string
Default: (empty)

This format is used to create an old-style clearsignedPGP message. Note that the use of this format is strongly deprecated .

This is a format string, see the $pgp_decode_commandcommand for possible printf(3)-like sequences. (PGP only)

3.209. pgp_decode_command

Type: string
Default: (empty)

This format strings specifies a command which is used to decode application/pgp attachments.

The PGP command formats have their own set of printf(3)-like sequences:

%p Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty string otherwise. Note: This may be used with a %? construct.
%f Expands to the name of a file containing a message.
%s Expands to the name of a file containing the signature part of a multipart/signedattachment when verifying it.
%a The value of $pgp_sign_as.
%r One or more key IDs (or fingerprints if available).

For examples on how to configure these formats for the various versions of PGP which are floating around, see the pgp and gpg sample configuration files in the samples/subdirectory which has been installed on your system alongside the documentation. (PGP only)

3.210. pgp_decrypt_command

Type: string
Default: (empty)

This command is used to decrypt a PGP encrypted message.

This is a format string, see the $pgp_decode_commandcommand for possible printf(3)-like sequences. (PGP only)

3.211. pgp_decryption_okay

Type: regular expression
Default: (empty)

If you assign text to this variable, then an encrypted PGP message is only considered successfully decrypted if the output from $pgp_decrypt_commandcontains the text. This is used to protect against a spoofed encrypted message, with multipart/encrypted headers but containing a block that is not actually encrypted. (e.g. simply signed and ascii armored text). (PGP only)

3.212. pgp_encrypt_only_command

Type: string
Default: (empty)

This command is used to encrypt a body part without signing it.

This is a format string, see the $pgp_decode_commandcommand for possible printf(3)-like sequences. (PGP only)

3.213. pgp_encrypt_sign_command

Type: string
Default: (empty)

This command is used to both sign and encrypt a body part.

This is a format string, see the $pgp_decode_commandcommand for possible printf(3)-like sequences. (PGP only)

3.214. pgp_entry_format

Type: string
Default:  %4n %t%f %4l/0x%k %-4a %2c %u

This variable allows you to customize the PGP key selection menu to your personal taste. This string is similar to $index_format, but has its own set of printf(3)-like sequences:

%n number
%k key id
%u user id
%a algorithm
%l key length
%f flags
%c capabilities
%t trust/validity of the key-uid association
%[<s>] date of the key where <s> is an strftime(3)expression

(PGP only)

3.215. pgp_export_command

Type: string
Default: (empty)

This command is used to export a public key from the user's key ring.

This is a format string, see the $pgp_decode_commandcommand for possible printf(3)-like sequences. (PGP only)

3.216. pgp_getkeys_command

Type: string
Default: (empty)

This command is invoked whenever Mutt needs to fetch the public key associated with an email address. Of the sequences supported by $pgp_decode_command, %r is the only printf(3)-like sequence used with this format. Note that in this case, %r expands to the email address, not the public key ID (the key ID is unknown, which is why Mutt is invoking this command). (PGP only)

3.217. pgp_good_sign

Type: regular expression
Default: (empty)

If you assign a text to this variable, then a PGP signature is only considered verified if the output from $pgp_verify_commandcontains the text. Use this variable if the exit code from the command is 0 even for bad signatures. (PGP only)

3.218. pgp_ignore_subkeys

Type: boolean
Default: yes

Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead, the principal key will inherit the subkeys' capabilities. Unset this if you want to play interesting key selection games. (PGP only)

3.219. pgp_import_command

Type: string
Default: (empty)

This command is used to import a key from a message into the user's public key ring.

This is a format string, see the $pgp_decode_commandcommand for possible printf(3)-like sequences. (PGP only)

3.220. pgp_list_pubring_command

Type: string
Default: (empty)

This command is used to list the public key ring's contents. The output format must be analogous to the one used by

gpg --list-keys --with-colons --with-fingerprint

This format is also generated by the pgpringutility which comes with mutt.

Note: gpg's fixed-list-modeoption should not be used. It produces a different date format which may result in mutt showing incorrect key generation dates.

This is a format string, see the $pgp_decode_commandcommand for possible printf(3)-like sequences. (PGP only)

3.221. pgp_list_secring_command

Type: string
Default: (empty)

This command is used to list the secret key ring's contents. The output format must be analogous to the one used by:

gpg --list-keys --with-colons --with-fingerprint

This format is also generated by the pgpringutility which comes with mutt.

Note: gpg's fixed-list-modeoption should not be used. It produces a different date format which may result in mutt showing incorrect key generation dates.

This is a format string, see the $pgp_decode_commandcommand for possible printf(3)-like sequences. (PGP only)

3.222. pgp_long_ids

Type: boolean
Default: yes

If set , use 64 bit PGP key IDs, if unset use the normal 32 bit key IDs. NOTE: Internally, Mutt has transitioned to using fingerprints (or long key IDs as a fallback). This option now only controls the display of key IDs in the key selection menu and a few other places. (PGP only)

3.223. pgp_mime_auto

Type: quadoption
Default: ask-yes

This option controls whether Mutt will prompt you for automatically sending a (signed/encrypted) message using PGP/MIME when inline (traditional) fails (for any reason).

Also note that using the old-style PGP message format is strongly deprecated . (PGP only)

3.224. pgp_replyinline

Type: boolean
Default: no

Setting this variable will cause Mutt to always attempt to create an inline (traditional) message when replying to a message which is PGP encrypted/signed inline. This can be overridden by use of the pgp menu, when inline is not required. This option does not automatically detect if the (replied-to) message is inline; instead it relies on Mutt internals for previously checked/flagged messages.

Note that Mutt might automatically use PGP/MIME for messages which consist of more than a single MIME part. Mutt can be configured to ask before sending PGP/MIME messages when inline (traditional) would not work.

Also see the $pgp_mime_autovariable.

Also note that using the old-style PGP message format is strongly deprecated . (PGP only)

3.225. pgp_retainable_sigs

Type: boolean
Default: no

If set , signed and encrypted messages will consist of nested multipart/signedand multipart/encryptedbody parts.

This is useful for applications like encrypted and signed mailing lists, where the outer layer ( multipart/encrypted) can be easily removed, while the inner multipart/signedpart is retained. (PGP only)

3.226. pgp_show_unusable

Type: boolean
Default: yes

If set , mutt will display non-usable keys on the PGP key selection menu. This includes keys which have been revoked, have expired, or have been marked as disabledby the user. (PGP only)

3.227. pgp_sign_as

Type: string
Default: (empty)

If you have more than one key pair, this option allows you to specify which of your private keys to use. It is recommended that you use the keyid form to specify your key (e.g. 0x00112233). (PGP only)

3.228. pgp_sign_command

Type: string
Default: (empty)

This command is used to create the detached PGP signature for a multipart/signedPGP/MIME body part.

This is a format string, see the $pgp_decode_commandcommand for possible printf(3)-like sequences. (PGP only)

3.229. pgp_sort_keys

Type: sort order
Default: address

Specifies how the entries in the pgp menu are sorted. The following are legal values:

address sort alphabetically by user id
keyid sort alphabetically by key id
date sort by key creation date
trust sort by the trust of the key

If you prefer reverse order of the above values, prefix it with reverse-. (PGP only)

3.230. pgp_strict_enc

Type: boolean
Default: yes

If set , Mutt will automatically encode PGP/MIME signed messages as quoted-printable. Please note that unsetting this variable may lead to problems with non-verifyable PGP signatures, so only change this if you know what you are doing. (PGP only)

3.231. pgp_timeout

Type: number
Default: 300

The number of seconds after which a cached passphrase will expire if not used. (PGP only)

3.232. pgp_use_gpg_agent

Type: boolean
Default: no

If set , mutt will use a possibly-running gpg-agent(1)process. Note that as of version 2.1, GnuPG no longer exports GPG_AGENT_INFO, so mutt no longer verifies if the agent is running. (PGP only)

3.233. pgp_verify_command

Type: string
Default: (empty)

This command is used to verify PGP signatures.

This is a format string, see the $pgp_decode_commandcommand for possible printf(3)-like sequences. (PGP only)

3.234. pgp_verify_key_command

Type: string
Default: (empty)

This command is used to verify key information from the key selection menu.

This is a format string, see the $pgp_decode_commandcommand for possible printf(3)-like sequences. (PGP only)

3.235. pipe_decode

Type: boolean
Default: no

Used in connection with the <pipe-message>command. When unset , Mutt will pipe the messages without any preprocessing. When set , Mutt will weed headers and will attempt to decode the messages first.

3.236. pipe_sep

Type: string
Default:  \n

The separator to add between messages when piping a list of tagged messages to an external Unix command.

3.237. pipe_split

Type: boolean
Default: no

Used in connection with the <pipe-message>function following <tag-prefix>. If this variable is unset , when piping a list of tagged messages Mutt will concatenate the messages and will pipe them all concatenated. When set , Mutt will pipe the messages one by one. In both cases the messages are piped in the current sorted order, and the $pipe_sepseparator is added after each message.

3.238. pop_auth_try_all

Type: boolean
Default: yes

If set , Mutt will try all available authentication methods. When unset , Mutt will only fall back to other authentication methods if the previous methods are unavailable. If a method is available but authentication fails, Mutt will not connect to the POP server.

3.239. pop_authenticators

Type: string
Default: (empty)

This is a colon-delimited list of authentication methods mutt may attempt to use to log in to an POP server, in the order mutt should try them. Authentication methods are either user, apopor any SASL mechanism, e.g. digest-md5, gssapior cram-md5. This option is case-insensitive. If this option is unset (the default) mutt will try all available methods, in order from most-secure to least-secure.

Example:

set pop_authenticators="digest-md5:apop:user"

3.240. pop_checkinterval

Type: number
Default: 60

This variable configures how often (in seconds) mutt should look for new mail in the currently selected mailbox if it is a POP mailbox.

3.241. pop_delete

Type: quadoption
Default: ask-no

If set , Mutt will delete successfully downloaded messages from the POP server when using the <fetch-mail> function. When unset , Mutt will download messages but also leave them on the POP server.

3.242. pop_host

Type: string
Default: (empty)

The name of your POP server for the <fetch-mail> function. You can also specify an alternative port, username and password, i.e.:

[pop[s]://][username[:password]@]popserver[:port]

where [...]denotes an optional part.

3.243. pop_last

Type: boolean
Default: no

If this variable is set , mutt will try to use the LAST POP command for retrieving only unread messages from the POP server when using the <fetch-mail> function.

3.244. pop_pass

Type: string
Default: (empty)

Specifies the password for your POP account. If unset , Mutt will prompt you for your password when you open a POP mailbox.

Warning : you should only use this option when you are on a fairly secure machine, because the superuser can read your muttrc even if you are the only one who can read the file.

3.245. pop_reconnect

Type: quadoption
Default: ask-yes

Controls whether or not Mutt will try to reconnect to the POP server if the connection is lost.

3.246. pop_user

Type: string
Default: (empty)

Your login name on the POP server.

This variable defaults to your user name on the local machine.

3.247. post_indent_string

Type: string
Default: (empty)

Similar to the $attributionvariable, Mutt will append this string after the inclusion of a message which is being replied to.

3.248. post_moderated

Type: quadoption
Default: ask-yes

If set to yes , Mutt will post article to newsgroup that have not permissions to posting (e.g. moderated). Note: if news server does not support posting to that newsgroup or totally read-only, that posting will not have an effect.

3.249. postpone

Type: quadoption
Default: ask-yes

Controls whether or not messages are saved in the $postponedmailbox when you elect not to send immediately.

Also see the $recallvariable.

3.250. postponed

Type: path
Default:  ~/postponed

Mutt allows you to indefinitely postponesending a messagewhich you are editing. When you choose to postpone a message, Mutt saves it in the mailbox specified by this variable.

Also see the $postponevariable.

3.251. postpone_encrypt

Type: boolean
Default: no

When set , postponed messages that are marked for encryption will be encrypted using the key in $postpone_encrypt_asbefore saving. (Crypto only)

3.252. postpone_encrypt_as

Type: string
Default: (empty)

This is the key used to encrypt postponed messages. It should be in keyid or fingerprint form (e.g. 0x00112233 for PGP or the hash-value that OpenSSL generates for S/MIME). (Crypto only)

3.253. preconnect

Type: string
Default: (empty)

If set , a shell command to be executed if mutt fails to establish a connection to the server. This is useful for setting up secure connections, e.g. with ssh(1). If the command returns a nonzero status, mutt gives up opening the server. Example:

set preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net \
sleep 20 < /dev/null > /dev/null"

Mailbox fooon mailhost.netcan now be reached as {localhost:1234}foo.

Note: For this example to work, you must be able to log in to the remote machine without having to enter a password.

3.254. print

Type: quadoption
Default: ask-no

Controls whether or not Mutt really prints messages. This is set to ask-noby default, because some people accidentally hit poften.

3.255. print_command

Type: path
Default:  lpr

This specifies the command pipe that should be used to print messages.

3.256. print_decode

Type: boolean
Default: yes

Used in connection with the <print-message>command. If this option is set , the message is decoded before it is passed to the external command specified by $print_command. If this option is unset , no processing will be applied to the message when printing it. The latter setting may be useful if you are using some advanced printer filter which is able to properly format e-mail messages for printing.

3.257. print_split

Type: boolean
Default: no

Used in connection with the <print-message>command. If this option is set , the command specified by $print_commandis executed once for each message which is to be printed. If this option is unset , the command specified by $print_commandis executed only once, and all the messages are concatenated, with a form feed as the message separator.

Those who use the enscript(1) program's mail-printing mode will most likely want to set this option.

3.258. prompt_after

Type: boolean
Default: yes

If you use an external $pager, setting this variable will cause Mutt to prompt you for a command when the pager exits rather than returning to the index menu. If unset , Mutt will return to the index menu when the external pager exits.

3.259. query_command

Type: path
Default: (empty)

This specifies the command Mutt will use to make external address queries. The string may contain a %s, which will be substituted with the query string the user types. Mutt will add quotes around the string substituted for %sautomatically according to shell quoting rules, so you should avoid adding your own. If no %sis found in the string, Mutt will append the user's query to the end of the string. See query for more information.

3.260. query_format

Type: string
Default:  %4c %t %-25.25a %-25.25n %?e?(%e)?

This variable describes the format of the querymenu. The following printf(3)-style sequences are understood:

%a destination address
%c current entry number
%e extra information *
%n destination name
%t *if current entry is tagged, a space otherwise
%>X right justify the rest of the string and pad with X
%|X pad to the end of the line with X
%*X soft-fill with character Xas pad

For an explanation of soft-fill, see the $index_formatdocumentation.

* = can be optionally printed if nonzero, see the $status_formatdocumentation.

3.261. quit

Type: quadoption
Default: yes

This variable controls whether quitand exitactually quit from mutt. If this option is set , they do quit, if it is unset , they have no effect, and if it is set to ask-yes or ask-no , you are prompted for confirmation when you try to quit.

3.262. quote_regexp

Type: regular expression
Default:  ^([ \t]*[|>:}#])+

A regular expression used in the internal pager to determine quoted sections of text in the body of a message. Quoted text may be filtered out using the <toggle-quoted>command, or colored according to the color quotedfamily of directives.

Higher levels of quoting may be colored differently ( color quoted1, color quoted2, etc.). The quoting level is determined by removing the last character from the matched text and recursively reapplying the regular expression until it fails to produce a match.

Match detection may be overridden by the $smileysregular expression.

3.263. read_inc

Type: number
Default: 10

If set to a value greater than 0, Mutt will display which message it is currently on when reading a mailbox or when performing search actions such as search and limit. The message is printed after this many messages have been read or searched (e.g., if set to 25, Mutt will print a message when it is at message 25, and then again when it gets to message 50). This variable is meant to indicate progress when reading or searching large mailboxes which may take some time. When set to 0, only a single message will appear before the reading the mailbox.

Also see the $write_inc, $net_incand $time_incvariables and the tuning section of the manual for performance considerations.

3.264. read_only

Type: boolean
Default: no

If set , all folders are opened in read-only mode.

3.265. realname

Type: string
Default: (empty)

This variable specifies what realor personalname should be used when sending messages.

By default, this is the GECOS field from /etc/passwd. Note that this variable will not be used when the user has set a real name in the $fromvariable.

3.266. recall

Type: quadoption
Default: ask-yes

Controls whether or not Mutt recalls postponed messages when composing a new message.

Setting this variable to yes is not generally useful, and thus not recommended. Note that the <recall-message>function can be used to manually recall postponed messages.

Also see $postponedvariable.

3.267. record

Type: path
Default:  ~/sent

This specifies the file into which your outgoing messages should be appended. (This is meant as the primary method for saving a copy of your messages, but another way to do this is using the my_hdr command to create a Bcc:field with your email address in it.)

The value of $record is overridden by the $force_nameand $save_namevariables, and the fcc-hook command.

3.268. reflow_space_quotes

Type: boolean
Default: yes

This option controls how quotes from format=flowed messages are displayed in the pager and when replying (with $text_flowed unset ). When set, this option adds spaces after each level of quote marks, turning ">>>foo" into "> > > foo".

Note: If $reflow_textis unset , this option has no effect. Also, this option does not affect replies when $text_flowedis set .

3.269. reflow_text

Type: boolean
Default: yes

When set , Mutt will reformat paragraphs in text/plain parts marked format=flowed. If unset , Mutt will display paragraphs unaltered from how they appear in the message body. See RFC3676 for details on the format=flowed format.

Also see $reflow_wrap, and $wrap.

3.270. reflow_wrap

Type: number
Default: 78

This variable controls the maximum paragraph width when reformatting text/plain parts when $reflow_textis set . When the value is 0, paragraphs will be wrapped at the terminal's right margin. A positive value sets the paragraph width relative to the left margin. A negative value set the paragraph width relative to the right margin.

Also see $wrap.

3.271. reply_regexp

Type: regular expression
Default:  ^(re([\[0-9\]+])*|aw):[ \t]*

A regular expression used to recognize reply messages when threading and replying. The default value corresponds to the English "Re:" and the German "Aw:".

3.272. reply_self

Type: boolean
Default: no

If unset and you are replying to a message sent by you, Mutt will assume that you want to reply to the recipients of that message rather than to yourself.

Also see the alternates command.

3.273. reply_to

Type: quadoption
Default: ask-yes

If set , when replying to a message, Mutt will use the address listed in the Reply-to: header as the recipient of the reply. If unset , it will use the address in the From: header field instead. This option is useful for reading a mailing list that sets the Reply-To: header field to the list address and you want to send a private message to the author of a message.

3.274. reply_with_xorig

Type: boolean
Default: no

This variable provides a toggle. When active, the From: header will be extracted from the current mail's `X-Original-To:' header. This setting does not have precedence over reverse_realname .

Assuming `fast_reply' is disabled, this option will prompt the user with a prefilled From: header.

3.275. resolve

Type: boolean
Default: yes

When set , the cursor will be automatically advanced to the next (possibly undeleted) message whenever a command that modifies the current message is executed.

3.276. resume_draft_files

Type: boolean
Default: no

If set , draft files (specified by -Hon the command line) are processed similarly to when resuming a postponed message. Recipients are not prompted for; send-hooks are not evaluated; no alias expansion takes place; user-defined headers and signatures are not added to the message.

3.277. resume_edited_draft_files

Type: boolean
Default: yes

If set , draft files previously edited (via -E -Hon the command line) will have $resume_draft_filesautomatically set when they are used as a draft file again.

The first time a draft file is saved, mutt will add a header, X-Mutt-Resume-Draft to the saved file. The next time the draft file is read in, if mutt sees the header, it will set $resume_draft_files.

This option is designed to prevent multiple signatures, user-defined headers, and other processing effects from being made multiple times to the draft file.

3.278. reverse_alias

Type: boolean
Default: no

This variable controls whether or not Mutt will display the personalname from your aliases in the index menu if it finds an alias that matches the message's sender. For example, if you have the following alias:

alias juser abd30425@somewhere.net (Joe User)

and then you receive mail which contains the following header:

From: abd30425@somewhere.net

It would be displayed in the index menu as Joe Userinstead of abd30425@somewhere.net.This is useful when the person's e-mail address is not human friendly.

3.279. reverse_name

Type: boolean
Default: no

It may sometimes arrive that you receive mail to a certain machine, move the messages to another machine, and reply to some the messages from there. If this variable is set , the default From: line of the reply messages is built using the address where you received the messages you are replying to if that address matches your alternates . If the variable is unset , or the address that would be used doesn't match your alternates , the From: line will use your address on the current machine.

Also see the alternates command.

3.280. reverse_realname

Type: boolean
Default: yes

This variable fine-tunes the behavior of the $reverse_namefeature. When it is set , mutt will use the address from incoming messages as-is, possibly including eventual real names. When it is unset , mutt will override any such real names with the setting of the $realnamevariable.

3.281. rfc2047_parameters

Type: boolean
Default: no

When this variable is set , Mutt will decode RFC2047-encoded MIME parameters. You want to set this variable when mutt suggests you to save attachments to files named like:

=?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=

When this variable is set interactively, the change won't be active until you change folders.

Note that this use of RFC2047's encoding is explicitly prohibited by the standard, but nevertheless encountered in the wild.

Also note that setting this parameter will not have the effect that mutt generates this kind of encoding. Instead, mutt will unconditionally use the encoding specified in RFC2231.

3.282. save_address

Type: boolean
Default: no

If set , mutt will take the sender's full address when choosing a default folder for saving a mail. If $save_nameor $force_nameis set too, the selection of the Fcc folder will be changed as well.

3.283. save_empty

Type: boolean
Default: yes

When unset , mailboxes which contain no saved messages will be removed when closed (the exception is $spoolfilewhich is never removed). If set , mailboxes are never removed.

Note: This only applies to mbox and MMDF folders, Mutt does not delete MH and Maildir directories.

3.284. save_history

Type: number
Default: 0

This variable controls the size of the history (per category) saved in the $history_filefile.

3.285. save_name

Type: boolean
Default: no

This variable controls how copies of outgoing messages are saved. When set , a check is made to see if a mailbox specified by the recipient address exists (this is done by searching for a mailbox in the $folderdirectory with the username part of the recipient address). If the mailbox exists, the outgoing message will be saved to that mailbox, otherwise the message is saved to the $recordmailbox.

Also see the $force_namevariable.

3.286. score

Type: boolean
Default: yes

When this variable is unset , scoring is turned off. This can be useful to selectively disable scoring for certain folders when the $score_threshold_deletevariable and related are used.

3.287. score_threshold_delete

Type: number
Default: -1

Messages which have been assigned a score equal to or lower than the value of this variable are automatically marked for deletion by mutt. Since mutt scores are always greater than or equal to zero, the default setting of this variable will never mark a message for deletion.

3.288. score_threshold_flag

Type: number
Default: 9999

Messages which have been assigned a score greater than or equal to this variable's value are automatically marked "flagged".

3.289. score_threshold_read

Type: number
Default: -1

Messages which have been assigned a score equal to or lower than the value of this variable are automatically marked as read by mutt. Since mutt scores are always greater than or equal to zero, the default setting of this variable will never mark a message read.

3.290. search_context

Type: number
Default: 0

For the pager, this variable specifies the number of lines shown before search results. By default, search results will be top-aligned.

3.291. send_charset

Type: string
Default:  us-ascii:iso-8859-1:utf-8

A colon-delimited list of character sets for outgoing messages. Mutt will use the first character set into which the text can be converted exactly. If your $charsetis not iso-8859-1and recipients may not understand UTF-8, it is advisable to include in the list an appropriate widely used standard character set (such as iso-8859-2, koi8-ror iso-2022-jp) either instead of or after iso-8859-1.

In case the text cannot be converted into one of these exactly, mutt uses $charsetas a fallback.

3.292. sendmail

Type: path
Default:  /usr/sbin/sendmail -oem -oi

Specifies the program and arguments used to deliver mail sent by Mutt. Mutt expects that the specified program interprets additional arguments as recipient addresses. Mutt appends all recipients after adding a --delimiter (if not already present). Additional flags, such as for $use_8bitmime, $use_envelope_from, $dsn_notify, or $dsn_returnwill be added before the delimiter.

3.293. sendmail_wait

Type: number
Default: 0

Specifies the number of seconds to wait for the $sendmailprocess to finish before giving up and putting delivery in the background.

Mutt interprets the value of this variable as follows:

>0 number of seconds to wait for sendmail to finish before continuing
0 wait forever for sendmail to finish
<0 always put sendmail in the background without waiting

Note that if you specify a value other than 0, the output of the child process will be put in a temporary file. If there is some error, you will be informed as to where to find the output.

3.294. shell

Type: path
Default: (empty)

Command to use when spawning a subshell. By default, the user's login shell from /etc/passwdis used.

3.295. save_unsubscribed

Type: boolean
Default: no

When set , info about unsubscribed newsgroups will be saved into newsrcfile and into cache.

3.296. show_new_news

Type: boolean
Default: yes

If set , news server will be asked for new newsgroups on entering the browser. Otherwise, it will be done only once for a news server. Also controls whether or not number of new articles of subscribed newsgroups will be then checked.

3.297. show_only_unread

Type: boolean
Default: no

If set , only subscribed newsgroups that contain unread articles will be displayed in browser.

3.298. sidebar_delim_chars

Type: string
Default:  /.

This contains the list of characters which you would like to treat as folder separators for displaying paths in the sidebar.

Local mail is often arranged in directories: `dir1/dir2/mailbox'.

set sidebar_delim_chars='/'

IMAP mailboxes are often named: `folder1.folder2.mailbox'.

set sidebar_delim_chars='.'

See also: $sidebar_short_path, $sidebar_folder_indent, $sidebar_indent_string.

3.299. sidebar_divider_char

Type: string
Default: (empty)

This specifies the characters to be drawn between the sidebar (when visible) and the other Mutt panels. ASCII and Unicode line-drawing characters are supported.

3.300. sidebar_folder_indent

Type: boolean
Default: no

Set this to indent mailboxes in the sidebar.

See also: $sidebar_short_path, $sidebar_indent_string, $sidebar_delim_chars.

3.301. sidebar_format

Type: string
Default:  %B%*  %n

This variable allows you to customize the sidebar display. This string is similar to $index_format, but has its own set of printf(3)-like sequences:

%B Name of the mailbox
%S * Size of mailbox (total number of messages)
%N * Number of unread messages in the mailbox
%n N if mailbox has new mail, blank otherwise
%F * Number of Flagged messages in the mailbox
%! !: one flagged message; !!: two flagged messages; n!: n flagged messages (for n > 2). Otherwise prints nothing.
%d * @ Number of deleted messages
%L * @ Number of messages after limiting
%t * @ Number of tagged messages
%>X right justify the rest of the string and pad with X
%|X pad to the end of the line with X
%*X soft-fill with character Xas pad

* = Can be optionally printed if nonzero @ = Only applicable to the current folder

In order to use %S, %N, %F, and %!, $mail_check_statsmust be set . When thus set, a suggested value for this option is "%B%?F? [%F]?%* %?N?%N/?%S".

3.302. sidebar_indent_string

Type: string
Default:    

This specifies the string that is used to indent mailboxes in the sidebar. It defaults to two spaces.

See also: $sidebar_short_path, $sidebar_folder_indent, $sidebar_delim_chars.

3.303. sidebar_new_mail_only

Type: boolean
Default: no

When set, the sidebar will only display mailboxes containing new, or flagged, mail.

See also: sidebar_whitelist.

3.304. sidebar_next_new_wrap

Type: boolean
Default: no

When set, the <sidebar-next-new>command will not stop and the end of the list of mailboxes, but wrap around to the beginning. The <sidebar-prev-new>command is similarly affected, wrapping around to the end of the list.

3.305. sidebar_on_right

Type: boolean
Default: no

When set, the sidebar will appear on the right-hand side of the screen.

3.306. sidebar_short_path

Type: boolean
Default: no

By default the sidebar will show the mailbox's path, relative to the $foldervariable. Setting sidebar_shortpath=yeswill shorten the names relative to the previous name. Here's an example:

shortpath=no shortpath=yes shortpath=yes, folderindent=yes, indentstr=".."
fruit fruit fruit
fruit.apple apple ..apple
fruit.banana banana ..banana
fruit.cherry cherry ..cherry

See also: $sidebar_delim_chars, $sidebar_folder_indent, $sidebar_indent_string.

3.307. sidebar_sort_method

Type: sort order
Default: order

Specifies how to sort entries in the file browser. By default, the entries are sorted alphabetically. Valid values:

  • alpha (alphabetically)

  • count (all message count)

  • flagged (flagged message count)

  • name (alphabetically)

  • new (unread message count)

  • path (alphabetically)

  • unread (unread message count)

  • unsorted

You may optionally use the reverse-prefix to specify reverse sorting order (example: set sort_browser=reverse-date ).

3.308. sidebar_visible

Type: boolean
Default: no

This specifies whether or not to show sidebar. The sidebar shows a list of all your mailboxes.

See also: $sidebar_format, $sidebar_width

3.309. sidebar_width

Type: number
Default: 30

This controls the width of the sidebar. It is measured in screen columns. For example: sidebar_width=20 could display 20 ASCII characters, or 10 Chinese characters.

3.310. sig_dashes

Type: boolean
Default: yes

If set , a line containing --(note the trailing space) will be inserted before your $signature. It is strongly recommended that you not unset this variable unless your signature contains just your name. The reason for this is because many software packages use -- \nto detect your signature. For example, Mutt has the ability to highlight the signature in a different color in the built-in pager.

3.311. sig_on_top

Type: boolean
Default: no

If set , the signature will be included before any quoted or forwarded text. It is strongly recommended that you do not set this variable unless you really know what you are doing, and are prepared to take some heat from netiquette guardians.

3.312. signature

Type: path
Default:  ~/.signature

Specifies the filename of your signature, which is appended to all outgoing messages. If the filename ends with a pipe ( |), it is assumed that filename is a shell command and input should be read from its standard output.

3.313. simple_search

Type: string
Default:  ~f %s | ~s %s

Specifies how Mutt should expand a simple search into a real search pattern. A simple search is one that does not contain any of the ~pattern operators. See patterns for more information on search patterns.

For example, if you simply type joeat a search or limit prompt, Mutt will automatically expand it to the value specified by this variable by replacing %swith the supplied string. For the default value, joewould be expanded to: ~f joe | ~s joe.

3.314. skip_quoted_offset

Type: number
Default: 0

Lines of quoted text that are displayed before the unquoted text after skip to quotedcommand (S)

3.315. sleep_time

Type: number
Default: 1

Specifies time, in seconds, to pause while displaying certain informational messages, while moving from folder to folder and after expunging messages from the current folder. The default is to pause one second, so a value of zero for this option suppresses the pause.

3.316. smart_wrap

Type: boolean
Default: yes

Controls the display of lines longer than the screen width in the internal pager. If set , long lines are wrapped at a word boundary. If unset , lines are simply wrapped at the screen edge. Also see the $markersvariable.

3.317. smileys

Type: regular expression
Default:  (>From )|(:[-^]?[][)(><}{|/DP])

The pager uses this variable to catch some common false positives of $quote_regexp, most notably smileys and not consider a line quoted text if it also matches $smileys. This mostly happens at the beginning of a line.

3.318. smime_ask_cert_label

Type: boolean
Default: yes

This flag controls whether you want to be asked to enter a label for a certificate about to be added to the database or not. It is set by default. (S/MIME only)

3.319. smime_ca_location

Type: path
Default: (empty)

This variable contains the name of either a directory, or a file which contains trusted certificates for use with OpenSSL. (S/MIME only)

3.320. smime_certificates

Type: path
Default: (empty)

Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle storage and retrieval of keys by itself. This is very basic right now, and keys and certificates are stored in two different directories, both named as the hash-value retrieved from OpenSSL. There is an index file which contains mailbox-address keyid pairs, and which can be manually edited. This option points to the location of the certificates. (S/MIME only)

3.321. smime_decrypt_command

Type: string
Default: (empty)

This format string specifies a command which is used to decrypt application/x-pkcs7-mimeattachments.

The OpenSSL command formats have their own set of printf(3)-like sequences similar to PGP's:

%f Expands to the name of a file containing a message.
%s Expands to the name of a file containing the signature part of a multipart/signedattachment when verifying it.
%k The key-pair specified with $smime_default_key
%c One or more certificate IDs.
%a The algorithm used for encryption.
%d The message digest algorithm specified with $smime_sign_digest_alg.
%C CA location: Depending on whether $smime_ca_locationpoints to a directory or file, this expands to -CApath $smime_ca_locationor -CAfile $smime_ca_location.

For examples on how to configure these formats, see the smime.rcin the samples/subdirectory which has been installed on your system alongside the documentation. (S/MIME only)

3.322. smime_decrypt_use_default_key

Type: boolean
Default: yes

If set (default) this tells mutt to use the default key for decryption. Otherwise, if managing multiple certificate-key-pairs, mutt will try to use the mailbox-address to determine the key to use. It will ask you to supply a key, if it can't find one. (S/MIME only)

3.323. smime_default_key

Type: string
Default: (empty)

This is the default key-pair to use for signing. This must be set to the keyid (the hash-value that OpenSSL generates) to work properly (S/MIME only)

3.324. smime_encrypt_command

Type: string
Default: (empty)

This command is used to create encrypted S/MIME messages.

This is a format string, see the $smime_decrypt_commandcommand for possible printf(3)-like sequences. (S/MIME only)

3.325. smime_encrypt_self

Type: quadoption
Default: no

Encrypt the message to $smime_default_keytoo. (S/MIME only)

3.326. smime_encrypt_with

Type: string
Default:  aes256

This sets the algorithm that should be used for encryption. Valid choices are aes128, aes192, aes256, des, des3, rc2-40, rc2-64, rc2-128. (S/MIME only)

3.327. smime_get_cert_command

Type: string
Default: (empty)

This command is used to extract X509 certificates from a PKCS7 structure.

This is a format string, see the $smime_decrypt_commandcommand for possible printf(3)-like sequences. (S/MIME only)

3.328. smime_get_cert_email_command

Type: string
Default: (empty)

This command is used to extract the mail address(es) used for storing X509 certificates, and for verification purposes (to check whether the certificate was issued for the sender's mailbox).

This is a format string, see the $smime_decrypt_commandcommand for possible printf(3)-like sequences. (S/MIME only)

3.329. smime_get_signer_cert_command

Type: string
Default: (empty)

This command is used to extract only the signers X509 certificate from a S/MIME signature, so that the certificate's owner may get compared to the email's From:field.

This is a format string, see the $smime_decrypt_commandcommand for possible printf(3)-like sequences. (S/MIME only)

3.330. smime_import_cert_command

Type: string
Default: (empty)

This command is used to import a certificate via smime_keys.

This is a format string, see the $smime_decrypt_commandcommand for possible printf(3)-like sequences. (S/MIME only)

3.331. smime_is_default

Type: boolean
Default: no

The default behavior of mutt is to use PGP on all auto-sign/encryption operations. To override and to use OpenSSL instead this must be set . However, this has no effect while replying, since mutt will automatically select the same application that was used to sign/encrypt the original message. (Note that this variable can be overridden by unsetting $crypt_autosmime.) (S/MIME only)

3.332. smime_keys

Type: path
Default: (empty)

Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle storage and retrieval of keys/certs by itself. This is very basic right now, and stores keys and certificates in two different directories, both named as the hash-value retrieved from OpenSSL. There is an index file which contains mailbox-address keyid pair, and which can be manually edited. This option points to the location of the private keys. (S/MIME only)

3.333. smime_pk7out_command

Type: string
Default: (empty)

This command is used to extract PKCS7 structures of S/MIME signatures, in order to extract the public X509 certificate(s).

This is a format string, see the $smime_decrypt_commandcommand for possible printf(3)-like sequences. (S/MIME only)

3.334. smime_sign_command

Type: string
Default: (empty)

This command is used to created S/MIME signatures of type multipart/signed, which can be read by all mail clients.

This is a format string, see the $smime_decrypt_commandcommand for possible printf(3)-like sequences. (S/MIME only)

3.335. smime_sign_digest_alg

Type: string
Default:  sha256

This sets the algorithm that should be used for the signature message digest. Valid choices are md5, sha1, sha224, sha256, sha384, sha512. (S/MIME only)

3.336. smime_sign_opaque_command

Type: string
Default: (empty)

This command is used to created S/MIME signatures of type application/x-pkcs7-signature, which can only be handled by mail clients supporting the S/MIME extension.

This is a format string, see the $smime_decrypt_commandcommand for possible printf(3)-like sequences. (S/MIME only)

3.337. smime_timeout

Type: number
Default: 300

The number of seconds after which a cached passphrase will expire if not used. (S/MIME only)

3.338. smime_verify_command

Type: string
Default: (empty)

This command is used to verify S/MIME signatures of type multipart/signed.

This is a format string, see the $smime_decrypt_commandcommand for possible printf(3)-like sequences. (S/MIME only)

3.339. smime_verify_opaque_command

Type: string
Default: (empty)

This command is used to verify S/MIME signatures of type application/x-pkcs7-mime.

This is a format string, see the $smime_decrypt_commandcommand for possible printf(3)-like sequences. (S/MIME only)

3.340. smtp_authenticators

Type: string
Default: (empty)

This is a colon-delimited list of authentication methods mutt may attempt to use to log in to an SMTP server, in the order mutt should try them. Authentication methods are any SASL mechanism, e.g. plain, digest-md5, gssapior cram-md5. This option is case-insensitive. If it is unset(the default) mutt will try all available methods, in order from most-secure to least-secure. Support for the plainmechanism is bundled; other mechanisms are provided by an external SASL library (look for +USE_SASL in the output of mutt -v).

Example:

set smtp_authenticators="digest-md5:cram-md5"

3.341. smtp_pass

Type: string
Default: (empty)

Specifies the password for your SMTP account. If unset , Mutt will prompt you for your password when you first send mail via SMTP. See $smtp_urlto configure mutt to send mail via SMTP.

Warning : you should only use this option when you are on a fairly secure machine, because the superuser can read your muttrc even if you are the only one who can read the file.

3.342. smtp_url

Type: string
Default: (empty)

Defines the SMTP smarthost where sent messages should relayed for delivery. This should take the form of an SMTP URL, e.g.:

smtp[s]://[user[:pass]@]host[:port]

where [...]denotes an optional part. Setting this variable overrides the value of the $sendmailvariable.

3.343. sort

Type: sort order
Default: date

Specifies how to sort messages in the indexmenu. Valid values are:

  • date or date-sent

  • date-received

  • from

  • mailbox-order (unsorted)

  • score

  • size

  • spam

  • subject

  • threads

  • to

You may optionally use the reverse-prefix to specify reverse sorting order.

Example:

set sort=reverse-date-sent

3.344. sort_alias

Type: sort order
Default: alias

Specifies how the entries in the aliasmenu are sorted. The following are legal values:

  • address (sort alphabetically by email address)

  • alias (sort alphabetically by alias name)

  • unsorted (leave in order specified in .muttrc)

3.345. sort_aux

Type: sort order
Default: date

When sorting by threads, this variable controls how threads are sorted in relation to other threads, and how the branches of the thread trees are sorted. This can be set to any value that $sortcan, except threads(in that case, mutt will just use date-sent). You can also specify the last-prefix in addition to the reverse-prefix, but last-must come after reverse-. The last-prefix causes messages to be sorted against its siblings by which has the last descendant, using the rest of $sort_auxas an ordering. For instance,

set sort_aux=last-date-received

would mean that if a new message is received in a thread, that thread becomes the last one displayed (or the first, if you have set sort=reverse-threads .)

Note: For reversed $sortorder $sort_auxis reversed again (which is not the right thing to do, but kept to not break any existing configuration setting).

3.346. sort_browser

Type: sort order
Default: alpha

Specifies how to sort entries in the file browser. By default, the entries are sorted alphabetically. Valid values:

  • alpha (alphabetically)

  • count (all message count)

  • date

  • desc (description)

  • new (new message count)

  • size

  • unsorted

You may optionally use the reverse-prefix to specify reverse sorting order (example: set sort_browser=reverse-date ).

3.347. sort_re

Type: boolean
Default: yes

This variable is only useful when sorting by mailboxes in sidebar. By default, entries are unsorted. Valid values:

  • count (all message count)

  • desc (virtual mailbox description)

  • new (new message count)

  • path

  • unsorted

3.348. spam_separator

Type: string
Default:  ,

This variable controls what happens when multiple spam headers are matched: if unset , each successive header will overwrite any previous matches value for the spam label. If set , each successive match will append to the previous, using this variable's value as a separator.

3.349. spoolfile

Type: path
Default: (empty)

If your spool mailbox is in a non-default place where Mutt cannot find it, you can specify its location with this variable. Mutt will initially set this variable to the value of the environment variable $MAILor $MAILDIRif either is defined.

3.350. ssl_ca_certificates_file

Type: path
Default: (empty)

This variable specifies a file containing trusted CA certificates. Any server certificate that is signed with one of these CA certificates is also automatically accepted.

Example:

set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt

3.351. ssl_client_cert

Type: path
Default: (empty)

The file containing a client certificate and its associated private key.

3.352. ssl_force_tls

Type: boolean
Default: no

If this variable is set , Mutt will require that all connections to remote servers be encrypted. Furthermore it will attempt to negotiate TLS even if the server does not advertise the capability, since it would otherwise have to abort the connection anyway. This option supersedes $ssl_starttls.

3.353. ssl_min_dh_prime_bits

Type: number
Default: 0

This variable specifies the minimum acceptable prime size (in bits) for use in any Diffie-Hellman key exchange. A value of 0 will use the default from the GNUTLS library.

3.354. ssl_starttls

Type: quadoption
Default: yes

If set (the default), mutt will attempt to use STARTTLSon servers advertising the capability. When unset , mutt will not attempt to use STARTTLSregardless of the server's capabilities.

3.355. ssl_use_sslv2

Type: boolean
Default: no

This variable specifies whether to attempt to use SSLv2 in the SSL authentication process. Note that SSLv2 and SSLv3 are now considered fundamentally insecure and are no longer recommended.

3.356. ssl_use_sslv3

Type: boolean
Default: no

This variable specifies whether to attempt to use SSLv3 in the SSL authentication process. Note that SSLv2 and SSLv3 are now considered fundamentally insecure and are no longer recommended.

3.357. ssl_use_tlsv1

Type: boolean
Default: yes

This variable specifies whether to attempt to use TLSv1.0 in the SSL authentication process.

3.358. ssl_use_tlsv1_1

Type: boolean
Default: yes

This variable specifies whether to attempt to use TLSv1.1 in the SSL authentication process.

3.359. ssl_use_tlsv1_2

Type: boolean
Default: yes

This variable specifies whether to attempt to use TLSv1.2 in the SSL authentication process.

3.360. ssl_usesystemcerts

Type: boolean
Default: yes

If set to yes , mutt will use CA certificates in the system-wide certificate store when checking if a server certificate is signed by a trusted CA.

3.361. ssl_verify_dates

Type: boolean
Default: yes

If set (the default), mutt will not automatically accept a server certificate that is either not yet valid or already expired. You should only unset this for particular known hosts, using the <account-hook> function.

3.362. ssl_verify_host

Type: boolean
Default: yes

If set (the default), mutt will not automatically accept a server certificate whose host name does not match the host used in your folder URL. You should only unset this for particular known hosts, using the <account-hook> function.

3.363. ssl_verify_partial_chains

Type: boolean
Default: no

This option should not be changed from the default unless you understand what you are doing.

Setting this variable to yes will permit verifying partial certification chains, i. e. a certificate chain where not the root, but an intermediate certificate CA, or the host certificate, are marked trusted (in $certificate_file), without marking the root signing CA as trusted.

(OpenSSL 1.0.2b and newer only).

3.364. ssl_ciphers

Type: string
Default: (empty)

Contains a colon-seperated list of ciphers to use when using SSL. For OpenSSL, see ciphers(1) for the syntax of the string.

For GnuTLS, this option will be used in place of "NORMAL" at the start of the priority string. See gnutls_priority_init(3) for the syntax and more details. (Note: GnuTLS version 2.1.7 or higher is required.)

3.365. status_chars

Type: string
Default:  -*%A

Controls the characters used by the %rindicator in $status_format.

Character Default Description
1 - Mailbox is unchanged
2 * Mailbox has been changed and needs to be resynchronized
3 % Mailbox is read-only, or will not be written when exiting. (You can toggle whether to write changes to a mailbox with the <toggle-write>operation, bound by default to %)
4 A Folder opened in attach-message mode. (Certain operations like composing a new mail, replying, forwarding, etc. are not permitted in this mode)

3.366. status_format

Type: string
Default:  -%r-NeoMutt: %f [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d? Del:%d?%?F? Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l? %l?]---(%s/%S)-%>-(%P)---

Controls the format of the status line displayed in the indexmenu. This string is similar to $index_format, but has its own set of printf(3)-like sequences:

%b number of mailboxes with new mail *
%d number of deleted messages *
%f the full pathname of the current mailbox
%F number of flagged messages *
%h local hostname
%l size (in bytes) of the current mailbox *
%L size (in bytes) of the messages shown (i.e., which match the current limit) *
%m the number of messages in the mailbox *
%M the number of messages shown (i.e., which match the current limit) *
%n number of new messages in the mailbox *
%o number of old unread messages *
%p number of postponed messages *
%P percentage of the way through the index
%r modified/read-only/won't-write/attach-message indicator, according to $status_chars
%s current sorting mode ( $sort)
%S current aux sorting method ( $sort_aux)
%t number of tagged messages *
%u number of unread messages *
%v Mutt version string
%V currently active limit pattern, if any *
%>X right justify the rest of the string and pad with X
%|X pad to the end of the line with X
%*X soft-fill with character Xas pad

For an explanation of soft-fill, see the $index_formatdocumentation.

* = can be optionally printed if nonzero

Some of the above sequences can be used to optionally print a string if their value is nonzero. For example, you may only want to see the number of flagged messages if such messages exist, since zero is not particularly meaningful. To optionally print a string based upon one of the above sequences, the following construct is used:

%?<sequence_char>?<optional_string>?

where sequence_char is a character from the table above, and optional_string is the string you would like printed if sequence_char is nonzero. optional_string may contain other sequences as well as normal text, but you may not nest optional strings.

Here is an example illustrating how to optionally print the number of new messages in a mailbox:

%?n?%n new messages.?

You can also switch between two strings using the following construct:

%?<sequence_char>?<if_string>&<else_string>?

If the value of sequence_char is non-zero, if_string will be expanded, otherwise else_string will be expanded.

You can force the result of any printf(3)-like sequence to be lowercase by prefixing the sequence character with an underscore ( _) sign. For example, if you want to display the local hostname in lowercase, you would use: %_h .

If you prefix the sequence character with a colon ( :) character, mutt will replace any dots in the expansion by underscores. This might be helpful with IMAP folders that don't like dots in folder names.

3.367. status_on_top

Type: boolean
Default: no

Setting this variable causes the status barto be displayed on the first line of the screen rather than near the bottom. If $helpis set , too it'll be placed at the bottom.

3.368. strict_threads

Type: boolean
Default: no

If set , threading will only make use of the In-Reply-Toand References:fields when you $sortby message threads. By default, messages with the same subject are grouped together in pseudo threads.. This may not always be desirable, such as in a personal mailbox where you might have several unrelated messages with the subjects like hiwhich will get grouped together. See also $sort_refor a less drastic way of controlling this behavior.

3.369. suspend

Type: boolean
Default: yes

When unset , mutt won't stop when the user presses the terminal's susp key, usually ^Z. This is useful if you run mutt inside an xterm using a command like xterm -e mutt .

3.370. text_flowed

Type: boolean
Default: no

When set , mutt will generate format=flowedbodies with a content type of text/plain; format=flowed . This format is easier to handle for some mailing software, and generally just looks like ordinary text. To actually make use of this format's features, you'll need support in your editor.

Note that $indent_stringis ignored when this option is set .

3.371. thorough_search

Type: boolean
Default: yes

Affects the ~band ~hsearch operations described in section patterns . If set , the headers and body/attachments of messages to be searched are decoded before searching. If unset , messages are searched as they appear in the folder.

Users searching attachments or for non-ASCII characters should set this value because decoding also includes MIME parsing/decoding and possible character set conversions. Otherwise mutt will attempt to match against the raw message received (for example quoted-printable encoded or with encoded headers) which may lead to incorrect search results.

3.372. thread_received

Type: boolean
Default: no

When set , mutt uses the date received rather than the date sent to thread messages by subject.

3.373. tilde

Type: boolean
Default: no

When set , the internal-pager will pad blank lines to the bottom of the screen with a tilde ( ~).

3.374. time_inc

Type: number
Default: 0

Along with $read_inc, $write_inc, and $net_inc, this variable controls the frequency with which progress updates are displayed. It suppresses updates less than $time_incmilliseconds apart. This can improve throughput on systems with slow terminals, or when running mutt on a remote system.

Also see the tuning section of the manual for performance considerations.

3.375. timeout

Type: number
Default: 600

When Mutt is waiting for user input either idling in menus or in an interactive prompt, Mutt would block until input is present. Depending on the context, this would prevent certain operations from working, like checking for new mail or keeping an IMAP connection alive.

This variable controls how many seconds Mutt will at most wait until it aborts waiting for input, performs these operations and continues to wait for input.

A value of zero or less will cause Mutt to never time out.

3.376. tmpdir

Type: path
Default: (empty)

This variable allows you to specify where Mutt will place its temporary files needed for displaying and composing messages. If this variable is not set, the environment variable $TMPDIRis used. If $TMPDIRis not set then /tmp is used.

3.377. to_chars

Type: string
Default:   +TCFL

Controls the character used to indicate mail addressed to you.

Character Default Description
1 <space> The mail is not addressed to your address.
2 + You are the only recipient of the message.
3 T Your address appears in the To:header field, but you are not the only recipient of the message.
4 C Your address is specified in the Cc:header field, but you are not the only recipient.
5 F Indicates the mail that was sent by you .
6 L Indicates the mail was sent to a mailing-list you subscribe to.

3.378. flag_chars

Type: string
Default:  *!DdrONon- 

Controls the characters used in several flags.

Character Default Description
1 * The mail is tagged.
2 ! The mail is flagged as important.
3 D The mail is marked for deletion.
4 d The mail has attachments marked for deletion.
5 r The mail has been replied to.
6 O The mail is Old (Unread but seen).
7 N The mail is New (Unread but not seen).
8 o The mail thread is Old (Unread but seen).
9 n The mail thread is New (Unread but not seen).
10 - The mail is read - %S expando.
11 <space> The mail is read - %Z expando.

3.379. trash

Type: path
Default: (empty)

If set, this variable specifies the path of the trash folder where the mails marked for deletion will be moved, instead of being irremediably purged.

NOTE: When you delete a message in the trash folder, it is really deleted, so that you have a way to clean the trash.

3.380. ts_icon_format

Type: string
Default:  M%?n?AIL&ail?

Controls the format of the icon title, as long as $ts_enabled is set. This string is identical in formatting to the one used by $status_format .

3.381. ts_enabled

Type: boolean
Default: no

Controls whether mutt tries to set the terminal status line and icon name. Most terminal emulators emulate the status line in the window title.

3.382. ts_status_format

Type: string
Default:  NeoMutt with %?m?%m messages&no messages?%?n? [%n NEW]?

Controls the format of the terminal status line (or window title), provided that $ts_enabled has been set. This string is identical in formatting to the one used by $status_format .

3.383. tunnel

Type: string
Default: (empty)

Setting this variable will cause mutt to open a pipe to a command instead of a raw socket. You may be able to use this to set up preauthenticated connections to your IMAP/POP3/SMTP server. Example:

set tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"

Note: For this example to work you must be able to log in to the remote machine without having to enter a password.

When set, Mutt uses the tunnel for all remote connections. Please see account-hook in the manual for how to use different tunnel commands per connection.

3.384. uncollapse_jump

Type: boolean
Default: no

When set , Mutt will jump to the next unread message, if any, when the current thread is un collapsed.

3.385. uncollapse_new

Type: boolean
Default: yes

When set , Mutt will automatically uncollapse any collapsed thread that receives a new message. When unset , collapsed threads will remain collapsed. the presence of the new message will still affect index sorting, though.

3.386. use_8bitmime

Type: boolean
Default: no

Warning: do not set this variable unless you are using a version of sendmail which supports the -B8BITMIMEflag (such as sendmail 8.8.x) or you may not be able to send mail.

When set , Mutt will invoke $sendmailwith the -B8BITMIMEflag when sending 8-bit messages to enable ESMTP negotiation.

3.387. use_domain

Type: boolean
Default: yes

When set , Mutt will qualify all local addresses (ones without the @hostportion) with the value of $hostname. If unset , no addresses will be qualified.

3.388. use_envelope_from

Type: boolean
Default: no

When set , mutt will set the envelope sender of the message. If $envelope_from_addressis set , it will be used as the sender address. If unset , mutt will attempt to derive the sender from the From:header.

Note that this information is passed to sendmail command using the -fcommand line switch. Therefore setting this option is not useful if the $sendmailvariable already contains -for if the executable pointed to by $sendmaildoesn't support the -fswitch.

3.389. use_from

Type: boolean
Default: yes

When set , Mutt will generate the From:header field when sending messages. If unset , no From:header field will be generated unless the user explicitly sets one using the my_hdr command.

3.390. use_ipv6

Type: boolean
Default: yes

When set , Mutt will look for IPv6 addresses of hosts it tries to contact. If this option is unset , Mutt will restrict itself to IPv4 addresses. Normally, the default should work.

3.391. user_agent

Type: boolean
Default: yes

When set , mutt will add a User-Agent:header to outgoing messages, indicating which version of mutt was used for composing them.

3.392. visual

Type: path
Default: (empty)

Specifies the visual editor to invoke when the ~v command is given in the built-in editor.

3.393. vfolder_format

Type: string
Default:  %2C %?n?%4n/&     ?%4m %f

This variable allows you to customize the file browser display for virtual folders to your personal taste. This string uses many of the same expandos as $folder_format.

3.394. virtual_spoolfile

Type: boolean
Default: no

When set , mutt will use the first defined virtual mailbox (see virtual-mailboxes) as a spool file.

3.395. wait_key

Type: boolean
Default: yes

Controls whether Mutt will ask you to press a key after an external command has been invoked by these functions: <shell-escape>, <pipe-message>, <pipe-entry>, <print-message>, and <print-entry>commands.

It is also used when viewing attachments with auto_view , provided that the corresponding mailcap entry has a needsterminal flag, and the external program is interactive.

When set , Mutt will always ask for a key. When unset , Mutt will wait for a key only if the external command returned a non-zero status.

3.396. weed

Type: boolean
Default: yes

When set , mutt will weed headers when displaying, forwarding, printing, or replying to messages.

3.397. wrap

Type: number
Default: 0

When set to a positive value, mutt will wrap text at $wrapcharacters. When set to a negative value, mutt will wrap text so that there are $wrapcharacters of empty space on the right side of the terminal. Setting it to zero makes mutt wrap at the terminal width.

Also see $reflow_wrap.

3.398. wrap_headers

Type: number
Default: 78

This option specifies the number of characters to use for wrapping an outgoing message's headers. Allowed values are between 78 and 998 inclusive.

Note: This option usually shouldn't be changed. RFC5233 recommends a line length of 78 (the default), so please only change this setting when you know what you're doing .

3.399. wrap_search

Type: boolean
Default: yes

Controls whether searches wrap around the end.

When set , searches will wrap around the first (or last) item. When unset , incremental searches will not wrap.

3.400. wrapmargin

Type: number
Default: 0

(DEPRECATED) Equivalent to setting $wrapwith a negative value.

3.401. write_bcc

Type: boolean
Default: yes

Controls whether mutt writes out the Bcc:header when preparing messages to be sent. Exim users may wish to unset this. If mutt is set to deliver directly via SMTP (see $smtp_url), this option does nothing: mutt will never write out the Bcc:header in this case.

3.402. write_inc

Type: number
Default: 10

When writing a mailbox, a message will be printed every $write_incmessages to indicate progress. If set to 0, only a single message will be displayed before writing a mailbox.

Also see the $read_inc, $net_incand $time_incvariables and the tuning section of the manual for performance considerations.

3.403. xlabel_delimiter

Type: string
Default: (empty)

The character used to delimit distinct keywords in X-Label headers. X-Label is primarily a Mutt artifact, and the semantics of the field were never defined: it is free-form text. However interaction with X-Keywords:, X-Mozilla-Keys:, and Keywords: requires that we adopt some means of identifying separate keywords within the field. Set this to your personal convention.

This affect both parsing existing X-Label headers and writing new X-Label headers. You can modify this variable in runtime to accomplish various kinds of conversion.

3.404. x_comment_to

Type: boolean
Default: no

If set , Mutt will add X-Comment-To:field (that contains full name of original article author) to article that followuped to newsgroup.

3.405. collapse_all

Type: boolean
Default: no

When set , Mutt will collapse all threads when entering a folder.

4. Functions

The following is the list of available functions listed by the mapping in which they are available. The default key setting is given, and an explanation of what the function does. The key bindings of these functions can be changed with the bindcommand.

4.1. Generic Menu

The generic menu is not a real menu, but specifies common functions (such as movement) available in all menus except for pager and editor . Changing settings for this menu will affect the default bindings for all menus (except as noted).

Table 38.2. Default Generic Menu Bindings

Function Default key Description
<top-page> H move to the top of the page
<next-entry> j move to the next entry
<previous-entry> k move to the previous entry
<bottom-page> L move to the bottom of the page
<refresh> ^L clear and redraw the screen
<middle-page> M move to the middle of the page
<search-next> n search for next match
<exit> q exit this menu
<tag-entry> t tag the current entry
<next-page> z move to the next page
<previous-page> Z move to the previous page
<last-entry> * move to the last entry
<first-entry> = move to the first entry
<enter-command> : enter a muttrc command
<next-line> > scroll down one line
<previous-line> < scroll up one line
<half-up> [ scroll up 1/2 page
<half-down> ] scroll down 1/2 page
<help> ? this screen
<tag-prefix> ; apply next function to tagged messages
<tag-prefix-cond>   apply next function ONLY to tagged messages
<end-cond>   end of conditional execution (noop)
<shell-escape> ! invoke a command in a subshell
<select-entry> <Enter> select the current entry
<select-entry> <Return> select the current entry
<search> / search for a regular expression
<search-reverse> Esc / search backwards for a regular expression
<search-opposite>   search for next match in opposite direction
<jump>   jump to an index number
<current-top>   move entry to top of screen
<current-middle>   move entry to middle of screen
<current-bottom>   move entry to bottom of screen
<what-key>   display the keycode for a key press

4.2. Index Menu

Table 38.3. Default Index Menu Bindings

Function Default key Description
<create-alias> a create an alias from a message sender
<bounce-message> b remail a message to another user
<break-thread> # break the thread in two
<change-folder> c open a different folder
<change-folder-readonly> Esc c open a different folder in read only mode
<change-newsgroup>   open a different newsgroup
<change-newsgroup-readonly>   open a different newsgroup in read only mode
<next-unread-mailbox>   open next mailbox with new mail
<collapse-thread> Esc v collapse/uncollapse current thread
<collapse-all> Esc V collapse/uncollapse all threads
<copy-message> C copy a message to a file/mailbox
<decode-copy> Esc C make decoded (text/plain) copy
<decode-save> Esc s make decoded copy (text/plain) and delete
<delete-message> d delete the current entry
<delete-pattern> D delete messages matching a pattern
<delete-thread> ^D delete all messages in thread
<delete-subthread> Esc d delete all messages in subthread
<edit> e edit the raw message
<edit-label> Y add, change, or delete a message's label
<edit-type> ^E edit attachment content type
<forward-message> f forward a message with comments
<forward-to-group>   forward to newsgroup
<followup-message>   followup to newsgroup
<get-children>   get all children of the current message
<get-message>   get message with Message-Id
<get-parent>   get parent of the current message
<reconstruct-thread>   reconstruct thread containing current message
<flag-message> F toggle a message's 'important' flag
<group-reply> g reply to all recipients
<fetch-mail> G retrieve mail from POP server
<imap-fetch-mail>   force retrieval of mail from IMAP server
<imap-logout-all>   logout from all IMAP servers
<display-toggle-weed> h display message and toggle header weeding
<next-undeleted> j move to the next undeleted message
<previous-undeleted> k move to the previous undeleted message
<limit> l show only messages matching a pattern
<limit-current-thread>   limit view to current thread
<link-threads> & link tagged message to the current one
<list-reply> L reply to specified mailing list
<mail> m compose a new mail message
<toggle-new> N toggle a message's 'new' flag
<toggle-write> % toggle whether the mailbox will be rewritten
<next-thread> ^N jump to the next thread
<next-subthread> Esc n jump to the next subthread
<purge-message>   really delete the current entry, bypassing the trash folder
<purge-thread>   really delete the current thread, bypassing the trash folder
<query> Q query external program for addresses
<quit> q save changes to mailbox and quit
<reply> r reply to a message
<show-limit> Esc l show currently active limit pattern
<sort-mailbox> o sort messages
<sort-reverse> O sort messages in reverse order
<print-message> p print the current entry
<post-message>   post message to newsgroup
<previous-thread> ^P jump to previous thread
<previous-subthread> Esc p jump to previous subthread
<recall-message> R recall a postponed message
<read-thread> ^R mark the current thread as read
<read-subthread> Esc r mark the current subthread as read
<resend-message> Esc e use the current message as a template for a new one
<compose-to-sender>   compose a new message to the sender
<save-message> s save message/attachment to a mailbox/file
<tag-pattern> T tag messages matching a pattern
<tag-subthread>   tag the current subthread
<tag-thread> Esc t tag the current thread
<untag-pattern> ^T untag messages matching a pattern
<undelete-message> u undelete the current entry
<undelete-pattern> U undelete messages matching a pattern
<undelete-subthread> Esc u undelete all messages in subthread
<undelete-thread> ^U undelete all messages in thread
<view-attachments> v show MIME attachments
<show-version> V show the Mutt version number and date
<set-flag> w set a status flag on a message
<clear-flag> W clear a status flag from a message
<toggle-read>   toggle view of read messages
<catchup>   mark all articles in newsgroup as read
<display-message> <Enter> display a message
<display-message> <Return> display a message
<mark-message> ~ create a hotkey macro for the current message
<buffy-list> . list mailboxes with new mail
<sync-mailbox> $ save changes to mailbox
<display-address> @ display full address of sender
<pipe-message> | pipe message/attachment to a shell command
<next-new>   jump to the next new message
<next-new-then-unread> <Tab> jump to the next new or unread message
<previous-new>   jump to the previous new message
<previous-new-then-unread> Esc <Tab> jump to the previous new or unread message
<next-unread>   jump to the next unread message
<previous-unread>   jump to the previous unread message
<parent-message> P jump to parent message in thread
<root-message>   jump to root message in thread
<extract-keys> ^K extract supported public keys
<forget-passphrase> ^F wipe passphrase(s) from memory
<check-traditional-pgp> Esc P check for classic PGP
<mail-key> Esc k mail a PGP public key
<decrypt-copy>   make decrypted copy
<decrypt-save>   make decrypted copy and delete
<quasi-delete>   delete from mutt, don't touch on disk
<sidebar-next>   move the highlight to next mailbox
<sidebar-next-new>   move the highlight to next mailbox with new mail
<sidebar-open>   open highlighted mailbox
<sidebar-page-down>   scroll the sidebar down 1 page
<sidebar-page-up>   scroll the sidebar up 1 page
<sidebar-prev>   move the highlight to previous mailbox
<sidebar-prev-new>   move the highlight to previous mailbox with new mail
<sidebar-toggle-virtual>   toggle between mailboxes and virtual mailboxes
<sidebar-toggle-visible>   make the sidebar (in)visible
<change-vfolder>   open a different virtual folder
<vfolder-from-query>   generate virtual folder from query
<vfolder-window-backward>   shifts virtual folder time window backwards
<vfolder-window-forward>   shifts virtual folder time window forwards
<modify-labels>   modify (notmuch) tags
<modify-labels-then-hide>   modify labels and then hide message
<entire-thread>   read entire thread of the current message

4.3. Pager Menu

Table 38.4. Default Pager Menu Bindings

Function Default key Description
<break-thread> # break the thread in two
<create-alias> a create an alias from a message sender
<bounce-message> b remail a message to another user
<change-folder> c open a different folder
<change-folder-readonly> Esc c open a different folder in read only mode
<change-newsgroup>   open a different newsgroup
<change-newsgroup-readonly>   open a different newsgroup in read only mode
<next-unread-mailbox>   open next mailbox with new mail
<copy-message> C copy a message to a file/mailbox
<decode-copy> Esc C make decoded (text/plain) copy
<delete-message> d delete the current entry
<delete-thread> ^D delete all messages in thread
<delete-subthread> Esc d delete all messages in subthread
<set-flag> w set a status flag on a message
<clear-flag> W clear a status flag from a message
<edit> e edit the raw message
<edit-label> Y add, change, or delete a message's label
<edit-type> ^E edit attachment content type
<followup-message>   followup to newsgroup
<forward-to-group>   forward to newsgroup
<forward-message> f forward a message with comments
<flag-message> F toggle a message's 'important' flag
<group-reply> g reply to all recipients
<imap-fetch-mail>   force retrieval of mail from IMAP server
<imap-logout-all>   logout from all IMAP servers
<display-toggle-weed> h display message and toggle header weeding
<next-undeleted> j move to the next undeleted message
<next-entry> J move to the next entry
<previous-undeleted> k move to the previous undeleted message
<previous-entry> K move to the previous entry
<link-threads> & link tagged message to the current one
<list-reply> L reply to specified mailing list
<redraw-screen> ^L clear and redraw the screen
<mail> m compose a new mail message
<mark-as-new> N toggle a message's 'new' flag
<search-next> n search for next match
<next-thread> ^N jump to the next thread
<next-subthread> Esc n jump to the next subthread
<sort-mailbox> o sort messages
<sort-reverse> O sort messages in reverse order
<print-message> p print the current entry
<post-message>   post message to newsgroup
<previous-thread> ^P jump to previous thread
<previous-subthread> Esc p jump to previous subthread
<purge-message>   really delete the current entry, bypassing the trash folder
<purge-thread>   really delete the current thread, bypassing the trash folder
<quit> Q save changes to mailbox and quit
<exit> q exit this menu
<reply> r reply to a message
<recall-message> R recall a postponed message
<reconstruct-thread>   reconstruct thread containing current message
<read-thread> ^R mark the current thread as read
<read-subthread> Esc r mark the current subthread as read
<resend-message> Esc e use the current message as a template for a new one
<compose-to-sender>   compose a new message to the sender
<save-message> s save message/attachment to a mailbox/file
<skip-quoted> S skip beyond quoted text
<decode-save> Esc s make decoded copy (text/plain) and delete
<tag-message> t tag the current entry
<toggle-quoted> T toggle display of quoted text
<undelete-message> u undelete the current entry
<undelete-subthread> Esc u undelete all messages in subthread
<undelete-thread> ^U undelete all messages in thread
<view-attachments> v show MIME attachments
<show-version> V show the Mutt version number and date
<search-toggle> \\ toggle search pattern coloring
<display-address> @ display full address of sender
<next-new>   jump to the next new message
<next-new-then-unread> <Tab> jump to the next new or unread message
<pipe-message> | pipe message/attachment to a shell command
<help> ? this screen
<next-page> <Space> move to the next page
<previous-page> - move to the previous page
<top> ^ jump to the top of the message
<sync-mailbox> $ save changes to mailbox
<shell-escape> ! invoke a command in a subshell
<enter-command> : enter a muttrc command
<buffy-list> . list mailboxes with new mail
<search> / search for a regular expression
<search-reverse> Esc / search backwards for a regular expression
<search-opposite>   search for next match in opposite direction
<next-line> <Enter> scroll down one line
<next-line> <Return> scroll down one line
<jump>   jump to an index number
<next-unread>   jump to the next unread message
<previous-new>   jump to the previous new message
<previous-new-then-unread>   jump to the previous new or unread message
<previous-unread>   jump to the previous unread message
<half-up>   scroll up 1/2 page
<half-down>   scroll down 1/2 page
<previous-line>   scroll up one line
<bottom>   jump to the bottom of the message
<parent-message> P jump to parent message in thread
<root-message>   jump to root message in thread
<check-traditional-pgp> Esc P check for classic PGP
<mail-key> Esc k mail a PGP public key
<extract-keys> ^K extract supported public keys
<forget-passphrase> ^F wipe passphrase(s) from memory
<decrypt-copy>   make decrypted copy
<decrypt-save>   make decrypted copy and delete
<what-key>   display the keycode for a key press
<quasi-delete>   delete from mutt, don't touch on disk
<sidebar-next>   move the highlight to next mailbox
<sidebar-next-new>   move the highlight to next mailbox with new mail
<sidebar-open>   open highlighted mailbox
<sidebar-page-down>   scroll the sidebar down 1 page
<sidebar-page-up>   scroll the sidebar up 1 page
<sidebar-prev>   move the highlight to previous mailbox
<sidebar-prev-new>   move the highlight to previous mailbox with new mail
<sidebar-toggle-virtual>   toggle between mailboxes and virtual mailboxes
<sidebar-toggle-visible>   make the sidebar (in)visible
<change-vfolder>   open a different virtual folder
<vfolder-from-query>   generate virtual folder from query
<modify-labels>   modify (notmuch) tags
<modify-labels-then-hide>   modify labels and then hide message
<entire-thread>   read entire thread of the current message

4.4. Alias Menu

Table 38.5. Default Alias Menu Bindings

Function Default key Description
<delete-entry> d delete the current entry
<undelete-entry> u undelete the current entry

4.5. Query Menu

Table 38.6. Default Query Menu Bindings

Function Default key Description
<create-alias> a create an alias from a message sender
<mail> m compose a new mail message
<query> Q query external program for addresses
<query-append> A append new query results to current results

4.6. Attachment Menu

Table 38.7. Default Attachment Menu Bindings

Function Default key Description
<bounce-message> b remail a message to another user
<display-toggle-weed> h display message and toggle header weeding
<edit-type> ^E edit attachment content type
<followup-message>   followup to newsgroup
<forward-to-group>   forward to newsgroup
<print-entry> p print the current entry
<save-entry> s save message/attachment to a mailbox/file
<pipe-entry> | pipe message/attachment to a shell command
<view-mailcap> m force viewing of attachment using mailcap
<reply> r reply to a message
<resend-message> Esc e use the current message as a template for a new one
<group-reply> g reply to all recipients
<list-reply> L reply to specified mailing list
<forward-message> f forward a message with comments
<view-text> T view attachment as text
<view-attach> <Enter> view attachment using mailcap entry if necessary
<view-attach> <Return> view attachment using mailcap entry if necessary
<delete-entry> d delete the current entry
<undelete-entry> u undelete the current entry
<collapse-parts> v Toggle display of subparts
<check-traditional-pgp> Esc P check for classic PGP
<extract-keys> ^K extract supported public keys
<forget-passphrase> ^F wipe passphrase(s) from memory

4.7. Compose Menu

Table 38.8. Default Compose Menu Bindings

Function Default key Description
<attach-file> a attach file(s) to this message
<attach-message> A attach message(s) to this message
<attach-news-message>   attach news article(s) to this message
<edit-bcc> b edit the BCC list
<edit-cc> c edit the CC list
<copy-file> C save message/attachment to a mailbox/file
<detach-file> D delete the current entry
<toggle-disposition> ^D toggle disposition between inline/attachment
<edit-description> d edit attachment description
<edit-message> e edit the message
<edit-headers> E edit the message with headers
<edit-file> ^X e edit the file to be attached
<edit-encoding> ^E edit attachment transfer-encoding
<edit-from> Esc f edit the from field
<edit-fcc> f enter a file to save a copy of this message in
<filter-entry> F filter attachment through a shell command
<get-attachment> G get a temporary copy of an attachment
<display-toggle-weed> h display message and toggle header weeding
<ispell> i run ispell on the message
<print-entry> l print the current entry
<edit-mime> m edit attachment using mailcap entry
<new-mime> n compose new attachment using mailcap entry
<edit-newsgroups>   edit the newsgroups list
<edit-followup-to>   edit the Followup-To field
<edit-x-comment-to>   edit the X-Comment-To field
<postpone-message> P save this message to send later
<edit-reply-to> r edit the Reply-To field
<rename-attachment> ^O send attachment with a different name
<rename-file> R rename/move an attached file
<edit-subject> s edit the subject of this message
<edit-to> t edit the TO list
<edit-type> ^T edit attachment content type
<write-fcc> w write the message to a folder
<toggle-unlink> u toggle whether to delete file after sending it
<toggle-recode>   toggle recoding of this attachment
<update-encoding> U update an attachment's encoding info
<view-attach> <Enter> view attachment using mailcap entry if necessary
<view-attach> <Return> view attachment using mailcap entry if necessary
<send-message> y send the message
<pipe-entry> | pipe message/attachment to a shell command
<attach-key> Esc k attach a PGP public key
<pgp-menu> p show PGP options
<forget-passphrase> ^F wipe passphrase(s) from memory
<smime-menu> S show S/MIME options
<mix> M send the message through a mixmaster remailer chain

4.8. Postpone Menu

Table 38.9. Default Postpone Menu Bindings

Function Default key Description
<delete-entry> d delete the current entry
<undelete-entry> u undelete the current entry

4.9. Browser Menu

Table 38.10. Default Browser Menu Bindings

Function Default key Description
<change-dir> c change directories
<display-filename> @ display the currently selected file's name
<enter-mask> m enter a file mask
<sort> o sort messages
<sort-reverse> O sort messages in reverse order
<select-new> N select a new file in this directory
<check-new>   check mailboxes for new mail
<toggle-mailboxes> <Tab> toggle whether to browse mailboxes or all files
<reload-active>   load list of all newsgroups from NNTP server
<subscribe-pattern>   subscribe to newsgroups matching a pattern
<unsubscribe-pattern>   unsubscribe from newsgroups matching a pattern
<catchup>   mark all articles in newsgroup as read
<uncatchup>   mark all articles in newsgroup as unread
<view-file> <Space> view file
<buffy-list> . list mailboxes with new mail
<create-mailbox> C create a new mailbox (IMAP only)
<delete-mailbox> d delete the current mailbox (IMAP only)
<rename-mailbox> r rename the current mailbox (IMAP only)
<subscribe> s subscribe to current mbox (IMAP/NNTP only)
<unsubscribe> u unsubscribe from current mbox (IMAP/NNTP only)
<toggle-subscribed> T toggle view all/subscribed mailboxes (IMAP only)
<goto-folder> = swap the current folder position with $folder if it exists

4.10. Pgp Menu

Table 38.11. Default Pgp Menu Bindings

Function Default key Description
<verify-key> c verify a PGP public key
<view-name> % view the key's user id

4.11. Smime Menu

Table 38.12. Default Smime Menu Bindings

Function Default key Description
<verify-key> c verify a PGP public key
<view-name> % view the key's user id

4.12. Mixmaster Menu

Table 38.13. Default Mixmaster Menu Bindings

Function Default key Description
<accept> <Enter> accept the chain constructed
<accept> <Return> accept the chain constructed
<append> a append a remailer to the chain
<insert> i insert a remailer into the chain
<delete> d delete a remailer from the chain
<chain-prev> <Left> select the previous element of the chain
<chain-next> <Right> select the next element of the chain

4.13. Editor Menu

Table 38.14. Default Editor Menu Bindings

Function Default key Description
<bol> ^A jump to the beginning of the line
<backward-char> ^B move the cursor one character to the left
<backward-word> Esc b move the cursor to the beginning of the word
<capitalize-word> Esc c capitalize the word
<downcase-word> Esc l convert the word to lower case
<upcase-word> Esc u convert the word to upper case
<delete-char> ^D delete the char under the cursor
<eol> ^E jump to the end of the line
<forward-char> ^F move the cursor one character to the right
<forward-word> Esc f move the cursor to the end of the word
<backspace> <Backspace> delete the char in front of the cursor
<kill-eol> ^K delete chars from cursor to end of line
<kill-eow> Esc d delete chars from the cursor to the end of the word
<kill-line> ^U delete all chars on the line
<quote-char> ^V quote the next typed key
<kill-word> ^W delete the word in front of the cursor
<complete> <Tab> complete filename or alias
<complete-query> ^T complete address with query
<buffy-cycle> <Space> cycle among incoming mailboxes
<history-up>   scroll up through the history list
<history-down>   scroll down through the history list
<transpose-chars>   transpose character under cursor with previous