Manpage of muttrc

muttrc

Section: User Manuals (5)
Updated: September 2002
Index Return to Main Contents

NAME

muttrc - Configuration file for the Mutt Mail User Agent

DESCRIPTION

A mutt configuration file consists of a series of lqcommandsrq. Each line of the file may contain one or more commands. When multiple commands are used, they must be separated by a semicolon (lq;rq).

The hash mark, or pound sign (lq#rq), is used as a lqcommentrq character. You can use it to annotate your initialization file. All text after the comment character to the end of the line is ignored.

Single quotes (lq'rq) and double quotes (lq"rq) can be used to quote strings which contain spaces or other special characters. The difference between the two types of quotes is similar to that of many popular shell programs, namely that a single quote is used to specify a literal string (one that is not interpreted for shell variables or quoting with a backslash [see next paragraph]), while double quotes indicate a string which should be evaluated. For example, backquotes are evaluated inside of double quotes, but not single quotes.

rs quotes the next character, just as in shells such as bash and zsh. For example, if want to put quotes (lq"rq) inside of a string, you can use lqrsrq to force the next character to be a literal instead of interpreted character.

lqrsrsrq means to insert a literal lqrsrq into the line. lqrsnrq and lqrsrrq have their usual C meanings of linefeed and carriage-return, respectively.

A lqrsrq at the end of a line can be used to split commands over multiple lines, provided that the split points don't appear in the middle of command names.

It is also possible to substitute the output of a Unix command in an initialization file. This is accomplished by enclosing the command in backquotes (`command`).

UNIX environment variables can be accessed like the way it is done in shells like sh and bash: Prepend the name of the variable by a dollar (lqDorq) sign.

COMMANDS

alias [-group name [...]] key address [, address [ ... ]]
unalias [ *  | key ]

: alias defines an alias key for the given addresses. Each address will be resolved into either an email address (user@example.com) or a named email address (User Name <user@example.com>). The address may be specified in either format, or in the format lquser@example.com (User Name)rq. unalias removes the alias corresponding to the given key or all aliases when lq*rq is used as an argument. The optional -group argument to alias causes the aliased address(es) to be added to the named group.

group [-group name] [-rx EXPR [ ... ]] [-addr address [ ... ]]
ungroup [-group name ] [ * | [[-rx EXPR [ ... ]] [-addr address [ ... ]]]

: group is used to directly add either addresses or regular expressions to the specified group or groups. The different categories of arguments to the group command can be in any order. The flags -rx and -addr specify what the following strings (that cannot begin with a hyphen) should be interpreted as: either a regular expression or an email address, respectively. ungroup is used to remove addresses or regular expressions from the specified group or groups. The syntax is similar to the group command, however the special character * can be used to empty a group of all of its contents.
: These address groups can also be created implicitely by the alias, lists, subscribe and alternates commands by specifying the optional -group option.
: Once defined, these address groups can be used in patterns to search for and limit the display to messages matching a group.

alternates [-group name] regexp [ , regexp [ ... ]]
unalternates [ *  | regexp [ , regexp [ ... ]] ]

: alternates is used to inform mutt about alternate addresses where you receive mail; you can use regular expressions to specify alternate addresses. This affects mutt's idea about messages from you, and messages addressed to you. unalternates removes a regular expression from the list of known alternates. The -group flag causes all of the subsequent regular expressions to be added to the named group.

alternative_order type[/subtype] [ ... ]
unalternative_order [ *  | type/subtype] [...]

: alternative_order command permits you to define an order of preference which is used by mutt to determine which part of a multipart/alternative body to display. A subtype of lq*rq matches any subtype, as does an empty subtype. unalternative_order removes entries from the ordered list or deletes the entire list when lq*rq is used as an argument.

auto_view type[/subtype] [ ... ]
unauto_view type[/subtype] [ ... ]

: This commands permits you to specify that mutt should automatically convert the given MIME types to text/plain when displaying messages. For this to work, there must be a mailcap(5) entry for the given MIME type with the copiousoutput flag set. A subtype of lq*rq matches any subtype, as does an empty subtype.

mime_lookup type[/subtype] [ ... ]
unmime_lookup type[/subtype] [ ... ]

: This command permits you to define a list of "data" MIME content types for which mutt will try to determine the actual file type from the file name, and not use a mailcap(5) entry given for the original MIME type. For instance, you may add the application/octet-stream MIME type to this list.
bind map1,map2,... key function: This command binds the given key for the given map or maps to the given function. Multiple maps may be specified by separating them with commas (no whitespace is allowed).
: Valid maps are: generic, alias, attach, browser, editor, index, compose, pager, pgp, postpone, mix.
: For more information on keys and functions, please consult the Mutt Manual.
account-hook [!]regexp command: This hook is executed whenever you access a remote mailbox. Useful to adjust configuration settings to different IMAP or POP servers.
charset-hook alias charset: This command defines an alias for a character set. This is useful to properly display messages which are tagged with a character set name not known to mutt.
iconv-hook charset local-charset: This command defines a system-specific name for a character set. This is useful when your system's iconv(3) implementation does not understand MIME character set names (such as iso-8859-1), but instead insists on being fed with implementation-specific character set names (such as 8859-1). In this specific case, you'd put this into your configuration file:
: iconv-hook iso-8859-1 8859-1
message-hook [!]pattern command: Before mutt displays (or formats for replying or forwarding) a message which matches the given pattern (or, when it is preceded by an exclamation mark, does not match the pattern), the given command is executed. When multiple message-hooks match, they are executed in the order in which they occur in the configuration file.
folder-hook [!]regexp command: When mutt enters a folder which matches regexp (or, when regexp is preceded by an exclamation mark, does not match regexp), the given command is executed.
: When several folder-hooks match a given mail folder, they are executed in the order given in the configuration file.
macro map key sequence [ description ]: This command binds the given sequence of keys to the given key in the given map or maps. For valid maps, see bind. To specify multiple maps, put only a comma between the maps.

color object foreground background [  regexp ]
color index foreground background [  pattern ]
uncolor index pattern [ pattern ... ]

: If your terminal supports color, these commands can be used to assign foreground/backgound combinations to certain objects. Valid objects are: attachment, body, bold, header, hdrdefault, index, indicator, markers, message, normal, quoted, quotedN, search, signature, status, tilde, tree, underline. The body and header objects allow you to restrict the colorization to a regular expression. The index object permits you to select colored messages by pattern.
: Valid colors include: white, black, green, magenta, blue, cyan, yellow, red, default, colorN.

mono object attribute [ regexp ]
mono index attribute [ pattern ]

: For terminals which don't support color, you can still assign attributes to objects. Valid attributes include: none, bold, underline, reverse, and standout.
[un]ignore pattern [ pattern ... ]: The ignore command permits you to specify header fields which you usually don't wish to see. Any header field whose tag begins with an lqignoredrq pattern will be ignored.
: The unignore command permits you to define exceptions from the above mentioned list of ignored headers.

lists [-group name] regexp [ regexp ... ]
unlists regexp [ regexp ... ]
subscribe [-group name] regexp [ regexp ... ]
unsubscribe regexp [ regexp ... ]

: Mutt maintains two lists of mailing list address patterns, a list of subscribed mailing lists, and a list of known mailing lists. All subscribed mailing lists are known. Patterns use regular expressions.
: The lists command adds a mailing list address to the list of known mailing lists. The unlists command removes a mailing list from the lists of known and subscribed mailing lists. The subscribe command adds a mailing list to the lists of known and subscribed mailing lists. The unsubscribe command removes it from the list of subscribed mailing lists. The -group flag adds all of the subsequent regular expressions to the named group.
mbox-hook [!]pattern mailbox: When mutt changes to a mail folder which matches pattern, mailbox will be used as the lqmboxrq folder, i.e., read messages will be moved to that folder when the mail folder is left.
: The first matching mbox-hook applies.

mailboxes filename [ filename ... ]
unmailboxes [ * | filename ... ]

: The mailboxes specifies folders which can receive mail and which will be checked for new messages. When changing folders, pressing space will cycle through folders with new mail. The unmailboxes command is used to remove a file name from the list of folders which can receive mail. If "*" is specified as the file name, the list is emptied.

my_hdr string
unmy_hdr field

: Using my_hdr, you can define headers which will be added to the messages you compose. unmy_hdr will remove the given user-defined headers.
hdr_order header1 header2 [ ... ]: With this command, you can specify an order in which mutt will attempt to present headers to you when viewing messages.
save-hook [!]pattern filename: When a message matches pattern, the default file name when saving it will be the given filename.
fcc-hook [!]pattern filename: When an outgoing message matches pattern, the default file name for storing a copy (fcc) will be the given filename.
fcc-save-hook [!]pattern filename: This command is an abbreviation for identical fcc-hook and save-hook commands.
send-hook [!]pattern command: When composing a message matching pattern, command is executed. When multiple send-hooks match, they are executed in the order in which they occur in the configuration file.
send2-hook [!]pattern command: Whenever a message matching pattern is changed (either by editing it or by using the compose menu), command is executed. When multiple send2-hooks match, they are executed in the order in which they occur in the configuration file. Possible applications include setting the $sendmail variable when a message's from header is changed.
: send2-hook execution is not triggered by use of enter-command from the compose menu.
reply-hook [!]pattern command: When replying to a message matching pattern, command is executed. When multiple reply-hooks match, they are executed in the order in which they occur in the configuration file, but all reply-hooks are matched and executed before send-hooks, regardless of their order in the configuration file.
crypt-hook pattern key-id: The crypt-hook command provides a method by which you can specify the ID of the public key to be used when encrypting messages to a certain recipient. The meaning of "key ID" is to be taken broadly: This can be a different e-mail address, a numerical key ID, or even just an arbitrary search string.
push string: This command adds the named string to the keyboard buffer.

set [no|inv|&|?]variable[=value] [ ... ]
toggle variable [ ... ]
unset variable [ ... ]
reset variable [ ... ]

: These commands are used to set and manipulate configuration varibles.
: Mutt knows four basic types of variables: boolean, number, string and quadoption. Boolean variables can be set (true), unset (false), or toggled. Number variables can be assigned a positive integer value.
: String variables consist of any number of printable characters. Strings must be enclosed in quotes if they contain spaces or tabs. You may also use the lqCrq escape sequences \n and \t for newline and tab, respectively.
: Quadoption variables are used to control whether or not to be prompted for certain actions, or to specify a default action. A value of yes will cause the action to be carried out automatically as if you had answered yes to the question. Similarly, a value of no will cause the the action to be carried out as if you had answered lqno.rq A value of ask-yes will cause a prompt with a default answer of lqyesrq and ask-no will provide a default answer of lqno.rq
: The reset command resets all given variables to the compile time defaults. If you reset the special variable all, all variables will reset to their compile time defaults.
source filename: The given file will be evaluated as a configuration file.
spam pattern format nospam pattern
These commands define spam-detection patterns from external spam filters, so that mutt can sort, limit, and search on ``spam tags'' or ``spam attributes'', or display them in the index. See the Mutt manual for details.: spam pattern format nospam pattern
unhook [ * | hook-type ]: This command will remove all hooks of a given type, or all hooks when lq*rq is used as an argument. hook-type can be any of the -hook commands documented above.

PATTERNS

In various places with mutt, including some of the abovementioned hook commands, you can specify patterns to match messages.

Constructing Patterns

A simple pattern consists of an operator of the form lq~characterrq, possibly followed by a parameter against which mutt is supposed to match the object specified by this operator. For some characters, the ~ may be replaced by another character to alter the behavior of the match. These are described in the list of operators, below.

With some of these operators, the object to be matched consists of several e-mail addresses. In these cases, the object is matched if at least one of these e-mail addresses matches. You can prepend a hat (lq^rq) character to such a pattern to indicate that all addresses must match in order to match the object.

You can construct complex patterns by combining simple patterns with logical operators. Logical AND is specified by simply concatenating two simple patterns, for instance lq~C mutt-dev ~s bugrq. Logical OR is specified by inserting a vertical bar (lq|rq) between two patterns, for instance lq~C mutt-dev | ~s bugrq. Additionally, you can negate a pattern by prepending a bang (lq!rq) character. For logical grouping, use braces (lq()rq). Example: lq!(~t mutt|~c mutt) ~f elkinsrq.

Simple Patterns

Mutt understands the following simple patterns:

~A: all messages
~b EXPR: messages which contain EXPR in the message body.
=b STRING: messages which contain STRING in the message body. If IMAP is enabled, searches for STRING on the server, rather than downloading each message and searching it locally.
~B EXPR: messages which contain EXPR in the whole message.
~c EXPR: messages carbon-copied to EXPR
%c GROUP: messages carbon-copied to any member of GROUP
~C EXPR: messages either to: or cc: EXPR
%C GROUP: messages either to: or cc: to any member of GROUP
~d MIN-MAX: messages with lqdate-sentrq in a Date range
~D: deleted messages
~e EXPR: messages which contain EXPR in the lqSenderrq field
%e GROUP: messages which contain a member of GROUP in the lqSenderrq field
~E: expired messages
~f EXPR: messages originating from EXPR
%f GROUP: messages originating form any member of GROUP
~F: flagged messages
~g: PGP signed messages
~G: PGP encrypted messages
~h EXPR: messages which contain EXPR in the message header
~H EXPR: messages with spam tags matching EXPR
~i EXPR: messages which match EXPR in the lqMessage-IDrq field
~k: messages containing PGP key material
~l: messages addressed to a known mailing list (defined by either subscribe or list)
~L EXPR: messages either originated or received by EXPR
%L GROUP: messages either originated or received by any member of GROUP
~m MIN-MAX: message in the range MIN to MAX
~n MIN-MAX: messages with a score in the range MIN to MAX
~N: new messages
~O: old messages
~p: messages addressed to you (as defined by alternates)
~P: messages from you (as defined by alternates)
~Q: messages which have been replied to
~r MIN-MAX: messages with lqdate-receivedrq in a Date range
~R: read messages
~s EXPR: messages having EXPR in the lqSubjectrq field.
~S: superseded messages
~t EXPR: messages addressed to EXPR
~T: tagged messages
~u: messages addressed to a subscribed mailing list (defined by subscribe commands)
~U: unread messages
~v: message is part of a collapsed thread.
~V: cryptographically verified messages
~x EXPR: messages which contain EXPR in the lqReferencesrq field
~X MIN-MAX: messages with MIN - MAX attachments
~y EXPR: messages which contain EXPR in the lqX-Labelrq field
~z MIN-MAX: messages with a size in the range MIN to MAX
~=: duplicated messages (see $duplicate_threads)
~$: unreferenced message (requries threaded view)
~(PATTERN): messages in threads containing messages matching a certain pattern, e.g. all threads containing messages from you: ~(~P)

In the above, EXPR is a regular expression.

With the ~m, ~n, ~X, and ~z operators, you can also specify ranges in the forms <MAX, >MIN, MIN-, and -MAX.

Matching dates

The ~d and ~r operators are used to match date ranges, which are interpreted to be given in your local time zone.

A date is of the form DD[/MM[/[cc]YY]], that is, a two-digit date, optionally followed by a two-digit month, optionally followed by a year specifications. Omitted fields default to the current month and year.

Mutt understands either two or four digit year specifications. When given a two-digit year, mutt will interpret values less than 70 as lying in the 21st century (i.e., lq38rq means 2038 and not 1938, and lq00rq is interpreted as 2000), and values greater than or equal to 70 as lying in the 20th century.

Note that this behaviour is Y2K compliant, but that mutt does have a Y2.07K problem.

If a date range consists of a single date, the operator in question will match that precise date. If the date range consists of a dash (lq-rq), followed by a date, this range will match any date before and up to the date given. Similarly, a date followed by a dash matches the date given and any later point of time. Two dates, separated by a dash, match any date which lies in the given range of time.

You can also modify any absolute date by giving an error range. An error range consists of one of the characters +, -, *, followed by a positive number, followed by one of the unit characters y, m, w, or d, specifying a unit of years, months, weeks, or days. + increases the maximum date matched by the given interval of time, - decreases the minimum date matched by the given interval of time, and * increases the maximum date and decreases the minimum date matched by the given interval of time. It is possible to give multiple error margins, which cumulate. Example: 1/1/2001-1w+2w*3d

You can also specify offsets relative to the current date. An offset is specified as one of the characters <, >, =, followed by a positive number, followed by one of the unit characters y, m, w, or d. > matches dates which are older than the specified amount of time, an offset which begins with the character < matches dates which are more recent than the specified amount of time, and an offset which begins with the character = matches points of time which are precisely the given amount of time ago.

CONFIGURATION VARIABLES

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.

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.

alias_file

Type: path
Default: lq~/.muttrcrq

The default file in which to save aliases created by the lqcreate-aliasrq function.

Note: Mutt will not automatically source this file; you must explicitly use the lqsourcerq command for it to be executed.

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

alias_format

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

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 rqdrq for 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

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.

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 rq[-- PGP output follows ...rq and give it the same color as your attachment color.

arrow_cursor

Type: boolean
Default: no

When set, an arrow (lq->rq) 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.

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.

askbcc

Type: boolean
Default: no

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

askcc

Type: boolean
Default: no

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

assumed_charset

Type: string
Default: lqrq

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 rqus-asciirq.

For example, Japanese users might prefer this:

set assumed_charset=rqiso-2022-jp:euc-jp:shift_jis:utf-8rq

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

attach_charset

Type: string
Default: lqrq

This variable is a colon-separated list of character encoding schemes for text file attachments. If unset, $charset value will be used instead. For example, the following configuration would work for Japanese text handling:

set attach_charset=rqiso-2022-jp:euc-jp:shift_jis:utf-8rq

Note: rqiso-2022-*rq must be put at the head of the value as shown above if included.

attach_format

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

This variable describes the format of the `attachment' menu. The following printf-style sequences are understood:

%C: charset
%c: requires charset conversion (n or c)
%D: deleted flag
%d: description
%e: MIME content-transfer-encoding
%f: filename
%I: disposition (I=inline, A=attachment)
%m: major MIME type
%M: MIME subtype
%n: attachment number
%Q: rqQrq, 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 lqattachmentsrq section for possible speed effects)
%>X: right justify the rest of the string and pad with character rqXrq
%|X: pad to the end of the line with character rqXrq
%*X: soft-fill with character rqXrq as pad

For an explanation of `soft-fill', see the lq$index_formatrq documentation.

attach_sep

Type: string
Default: lq\nrq

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

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 lq$attach_seprq separator is added after each attachment. When set, Mutt will operate on the attachments one by one.

attribution

Type: string
Default: lqOn %d, %n wrote:rq

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

autoedit

Type: boolean
Default: no

When set along with lq$edit_headersrq, Mutt will skip the initial send-menu 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.

Also see lq$fast_replyrq.

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 (default: rq;rq) to make the next function apply to all tagged messages.

beep

Type: boolean
Default: yes

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

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 lq$beeprq variable.

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.

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.

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_cursor variable is unset, making it easier for blind persons using Braille displays to follow these menus. The option is disabled by default because many visual terminals don't permit making the cursor invisible.

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.

charset

Type: string
Default: lqrq

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

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 check_new is unset, no check for new mail is performed while the mailbox is open.

collapse_unread

Type: boolean
Default: yes

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

uncollapse_jump

Type: boolean
Default: no

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

compose_format

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

Controls the format of the status line displayed in the Compose menu. This string is similar to lq$status_formatrq, but has its own set of printf()-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 lq$status_formatrq option for more information on how to set lq$compose_formatrq.

config_charset

Type: string
Default: lqrq

When defined, Mutt will recode commands in rc files from this encoding.

confirmappend

Type: boolean
Default: yes

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

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.

connect_timeout

Type: number
Default: 30

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

content_type

Type: string
Default: lqtext/plainrq

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

copy

Type: quadoption
Default: yes

This variable controls whether or not copies of your outgoing messages will be saved for later references. Also see lq$recordrq, lq$save_namerq, lq$force_namerq and lqfcc-hookrq.

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.

crypt_use_pka

Type: boolean
Default: no

(http://www.g10code.de/docs/pka-intro.de.pdf) during signature verification (only supported by the GPGME backend).

crypt_autopgp

Type: boolean
Default: yes

This variable controls whether or not mutt may automatically enable PGP encryption/signing for messages. See also lq$crypt_autoencryptrq, lq$crypt_replyencryptrq, lq$crypt_autosignrq, lq$crypt_replysignrq and lq$smime_is_defaultrq.

crypt_autosmime

Type: boolean
Default: yes

This variable controls whether or not mutt may automatically enable S/MIME encryption/signing for messages. See also lq$crypt_autoencryptrq, lq$crypt_replyencryptrq, lq$crypt_autosignrq, lq$crypt_replysignrq and lq$smime_is_defaultrq.

date_format

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

This variable controls the format of the date printed by the lq%drq sequence in lq$index_formatrq. This is passed to the strftime call to process the date. See the man page for strftime(3) for the proper syntax.

Unless the first character in the string is a bang (lq!rq), the month and week day names are expanded according to the locale specified in the variable lq$localerq. 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).

default_hook

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

This variable controls how message-hooks, reply-hooks, send-hooks, send2-hooks, save-hooks, and fcc-hooks 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 lqalternatesrq) and is to or cc'ed to a user matching the given regular expression.

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.

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.

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 'v' on that menu.

display_filter

Type: path
Default: lqrq

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.

dotlock_program

Type: path
Default: lq/opt/mutt/bin/mutt_dotlockrq

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

dsn_notify

Type: string
Default: lqrq

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=rqfailure,delayrq

Note: when using $sendmail for 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 -N option for DSN. For SMTP delivery, it depends on the server whether DSN is supported or not.

dsn_return

Type: string
Default: lqrq

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 $sendmail for 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 -R option for DSN. For SMTP delivery, it depends on the server whether DSN is supported or not.

duplicate_threads

Type: boolean
Default: yes

This variable controls whether mutt, when sorting by 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 diagram.

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.

editor

Type: path
Default: lqrq

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 rqvirq if neither of those are set.

encode_from

Type: boolean
Default: no

When set, mutt will quoted-printable encode messages when they contain the string rqFrom rq in the beginning of a line. Useful to avoid the tampering certain mail delivery and transport agents tend to do with messages.

envelope_from_address

Type: e-mail address
Default: lqrq

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

escape

Type: string
Default: lq~rq

Escape character to use for functions in the builtin editor.

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 lq$autoeditrq variable is set.

fcc_attach

Type: boolean
Default: yes

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

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)

folder

Type: path
Default: lq~/Mailrq

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 during the `set' command.

folder_format

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

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

%C: current file number
%d: date/time folder was last modified
%f: filename
%F: file permissions
%g: group name (or numeric gid, if missing)
%l: number of hard links
%N: N if folder 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 rqXrq
%|X: pad to the end of the line with character rqXrq
%*X: soft-fill with character rqXrq as pad

For an explanation of `soft-fill', see the lq$index_formatrq documentation.

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 lqsubscriberq or lqlistsrq 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.

force_name

Type: boolean
Default: no

This variable is similar to lq$save_namerq, 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 lq$recordrq variable.

forward_decode

Type: boolean
Default: yes

Controls the decoding of complex MIME messages into text/plain when forwarding a message. The message header is also RFC2047 decoded. This variable is only used, if lq$mime_forwardrq is unset, otherwise lq$mime_forward_decoderq is used instead.

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 lqnorq.

forward_format

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

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

forward_quote

Type: boolean
Default: no

When set forwarded messages included in the main body of the message (when lq$mime_forwardrq is unset) will be quoted using lq$indent_stringrq.

from

Type: e-mail address
Default: lqrq

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

Defaults to the contents of the environment variable EMAIL.

gecos_mask

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

A regular expression used by mutt to parse the GECOS field of a password entry when expanding the alias. By default the regular expression is set to rq^[^,]*rq which will return the string up to the first rq,rq encountered. If the GECOS field contains a string like rqlastname, firstnamerq then you should set the gecos_mask=rq.*rq.

This can be useful if you see the following behavior: you address a e-mail to user ID stevef whose full name is Steve Franklin. If mutt expands stevef to rqFranklinrq stevef@foo.bar then you should set the gecos_mask to a regular expression that will match the whole name so mutt will expand rqFranklinrq to rqFranklin, Steverq.

hdrs

Type: boolean
Default: yes

When unset, the header fields normally added by the lqmy_hdrrq 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.

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 lq$weedrq setting applies.

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.

hidden_host

Type: boolean
Default: no

When set, mutt will skip the host name part of lq$hostnamerq variable 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.

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.

hide_missing

Type: boolean
Default: yes

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

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.

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_limited is set, this option will have no effect.

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_missing is set, this option will have no effect.

history

Type: number
Default: 10

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

history_file

Type: path
Default: lq~/.mutthistoryrq

The file in which Mutt will save its history.

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.

hostname

Type: string
Default: lqrq

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 lq@rq) for local email addresses as well as Message-Id headers.

Its value is determined at startup as follows: If the node's name as returned by the uname(3) function contains the hostname and the domain, these are used to construct $hostname. If there is no domain part returned, Mutt will look for a lqdomainrq or lqsearchrq line in /etc/resolv.conf to determine the domain. Optionally, Mutt can be compiled with a fixed domain name in which case a detected one is not used.

Also see lq$use_domainrq and lq$hidden_hostrq.

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 lqSubjectrq field from being divided into multiple lines.

ignore_list_reply_to

Type: boolean
Default: no

Affects the behaviour of the reply function when replying to messages from mailing lists (as defined by the lqsubscriberq or lqlistsrq commands). When set, if the lqReply-To:rq field is set to the same value as the lqTo:rq field, Mutt assumes that the lqReply-To:rq 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.

imap_authenticators

Type: string
Default: lqrq

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 'login' or the right side of an IMAP 'AUTH=xxx' capability string, eg 'digest-md5', 'gssapi' or 'cram-md5'. This parameter is case-insensitive. If this parameter is unset (the default) mutt will try all available methods, in order from most-secure to least-secure.

Example: set imap_authenticators=rqgssapi:cram-md5:loginrq

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.

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. See also the lqmailboxesrq command.

imap_delim_chars

Type: string
Default: lq/.rq

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.

imap_headers

Type: string
Default: lqrq

Mutt requests these header fields in addition to the default headers (rqDATE FROM SUBJECT TO CC MESSAGE-ID REFERENCES CONTENT-TYPE CONTENT-DESCRIPTION IN-REPLY-TO REPLY-TO LINES X-LABELrq) 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.

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.

imap_keepalive

Type: number
Default: 900

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.

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.

imap_login

Type: string
Default: lqrq

Your login name on the IMAP server.

This variable defaults to the value of imap_user.

imap_pass

Type: string
Default: lqrq

Specifies the password for your IMAP account. If unset, Mutt will prompt you for your password when you invoke the fetch-mail function. 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.

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.

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.

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.

imap_user

Type: string
Default: lqrq

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.

implicit_autoview

Type: boolean
Default: no

If set to lqyesrq, 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.

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.

include_onlyfirst

Type: boolean
Default: no

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

indent_string

Type: string
Default: lq> rq

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.

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

index_format

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

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

lqFormat stringsrq are similar to the strings used in the lqCrq function printf to format output (see the man page for more detail). 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 lqdate_formatrq converted to sender's time zone
%D: date and time of the message in the format specified by lqdate_formatrq converted 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
%H: spam attribute(s) of this message
%i: message-id of the current message
%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 lqsubscriberq command, this displays rqTo <list-name>rq, 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: (_O_riginal save folder) Where mutt would formerly have stashed the message: list name or recipient name if no list
%P: progress indicator for the builtin pager (how much of the file has been displayed)
%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_chars string
%u: user (login) name of the author
%v: first name of the author, or the recipient if the message is from you
%X: number of attachments (please see the lqattachmentsrq 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 lqfmtrq is expanded by the library function lqstrftimerq; a leading bang disables locales
%[fmt]: the date and time of the message is converted to the local time zone, and lqfmtrq is expanded by the library function lqstrftimerq; a leading bang disables locales
%(fmt): the local date and time when the message was received. lqfmtrq is expanded by the library function lqstrftimerq; a leading bang disables locales
%<fmt>: the current local time. lqfmtrq is expanded by the library function lqstrftimerq; a leading bang disables locales.
%>X: right justify the rest of the string and pad with character rqXrq
%|X: pad to the end of the line with character rqXrq
%*X: soft-fill with character rqXrq as pad

`Soft-fill' deserves some explanation. Normal right-justification will print everything to the left of the %>, displaying padding and the 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 lqsave-hookrq, lqfcc-hookrq and lqfcc-save-hookrq, too.

See also: lq$to_charsrq.

ispell

Type: path
Default: lq/usr/bin/ispellrq

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

keep_flagged

Type: boolean
Default: no

If set, read messages marked as flagged will not be moved from your spool mailbox to your lq$mboxrq mailbox, or as a result of a lqmbox-hookrq command.

locale

Type: string
Default: lqCrq

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

mail_check

Type: number
Default: 5

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

mailcap_path

Type: string
Default: lqrq

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

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!

header_cache

Type: path
Default: lqrq

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

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.

header_cache_pagesize

Type: string
Default: lq16384rq

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.

header_cache_compress

Type: boolean
Default: yes

When mutt is compiled with qdbm 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 uncompression can result in a slower opening of cached folder(s).

maildir_trash

Type: boolean
Default: no

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

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 rqOrq next to them in the index menu, indicating that they are old.

markers

Type: boolean
Default: yes

Controls the display of wrapped lines in the internal pager. If set, a lq+rq marker is displayed at the beginning of wrapped lines. Also see the lq$smart_wraprq variable.

mask

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

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

mbox

Type: path
Default: lq~/mboxrq

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

mbox_type

Type: folder magic
Default: mbox

The default mailbox type used when creating new folders. May be any of mbox, MMDF, MH and Maildir.

metoo

Type: boolean
Default: no

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

menu_context

Type: number
Default: 0

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

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.

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).

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 lqxrq. This is because the result of removing the high bit from lq0xf8rq is lq0x78rq, which is the ASCII character lqxrq.

mh_purge

Type: boolean
Default: no

When unset, mutt will mimic mh's behaviour and rename deleted messages to ,<old file name> in mh folders instead of really deleting them. If the variable is set, the message files will simply be deleted.

mh_seq_flagged

Type: string
Default: lqflaggedrq

The name of the MH sequence used for flagged messages.

mh_seq_replied

Type: string
Default: lqrepliedrq

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

mh_seq_unseen

Type: string
Default: lqunseenrq

The name of the MH sequence used for unseen messages.

mime_forward

Type: quadoption
Default: no

When set, the message you are forwarding will be attached as a separate MIME 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-no or ask-yes.

Also see lq$forward_decoderq and lq$mime_forward_decoderq.

mime_forward_decode

Type: boolean
Default: no

Controls the decoding of complex MIME messages into text/plain when forwarding a message while lq$mime_forwardrq is set. Otherwise lq$forward_decoderq is used instead.

mime_forward_rest

Type: quadoption
Default: yes

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

mix_entry_format

Type: string
Default: lq%4n %c %-16s %arq

This variable describes the format of a remailer line on the mixmaster chain selection screen. The following printf-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.

mixmaster

Type: path
Default: lqmixmasterrq

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.

move

Type: quadoption
Default: ask-no

Controls whether or not Mutt will move read messages from your spool mailbox to your lq$mboxrq mailbox, or as a result of a lqmbox-hookrq command.

message_cachedir

Type: path
Default: lqrq

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, for instance if stale entries accumulate because you have deleted messages with another mail client.

message_cache_clean

Type: boolean
Default: no

If set, mutt will clean out obsolete entries from the 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.

message_format

Type: string
Default: lq%srq

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

narrow_tree

Type: boolean
Default: no

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

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_inc kilobytes. If set to 0, no progress messages will be displayed.

See also lq$read_incrq and lq$write_incrq.

pager

Type: path
Default: lqbuiltinrq

This variable specifies which pager you would like to use to view messages. builtin means to use the builtin 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.

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).

pager_format

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

This variable controls the format of the one-line message lqstatusrq displayed before each message in either the internal or an external pager. The valid sequences are listed in the lq$index_formatrq section.

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 pager_index_lines 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.

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.

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 lq$smime_is_defaultrq is set, then OpenSSL is used instead to create S/MIME messages and settings can be overridden by use of the smime-menu. (Crypto only)

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 lq$smime_is_defaultrq is set, then OpenSSL is used instead to create S/MIME messages and settings can be overridden by use of the smime-menu. (Crypto only)

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)

crypt_replyencrypt

Type: boolean
Default: yes

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

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)

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 lq$crypt_replyencryptrq, because it allows you to sign all messages which are automatically encrypted. This works around the problem noted in lq$crypt_replysignrq, that mutt is not able to find out whether an encrypted message is also signed. (Crypto only)

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)

pgp_use_gpg_agent

Type: boolean
Default: no

If set, mutt will use a possibly-running gpg-agent process. (PGP only)

crypt_verify_sig

Type: quadoption
Default: yes

If lqyesrq, always attempt to verify PGP or S/MIME signatures. If lqaskrq, ask whether or not to verify the signature. If lqnorq, never attempt to verify cryptographic signatures. (Crypto only)

smime_is_default

Type: boolean
Default: no

The default behaviour 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)

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)

smime_decrypt_use_default_key

Type: boolean
Default: yes

If set (default) this tells mutt to use the default key for decryption. Otherwise, if manage 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)

pgp_entry_format

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

This variable allows you to customize the PGP key selection menu to your personal taste. This string is similar to lq$index_formatrq, but has its own set of printf()-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)

pgp_good_sign

Type: regular expression
Default: lqrq

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

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)

pgp_long_ids

Type: boolean
Default: no

If set, use 64 bit PGP key IDs. Unset uses the normal 32 bit Key IDs. (PGP only)

pgp_retainable_sigs

Type: boolean
Default: no

If set, signed and encrypted messages will consist of nested multipart/signed and multipart/encrypted body 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/signed part is retained. (PGP only)

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.

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. See also: lq$pgp_mime_autorq.

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

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.

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

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 lqdisabledrq by the user. (PGP only)

pgp_sign_as

Type: string
Default: lqrq

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., lq0x00112233rq). (PGP only)

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)

pgp_timeout

Type: number
Default: 300

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

pgp_sort_keys

Type: sort order
Default: address

Specifies how the entries in the `pgp keys' 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)

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)

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.

pgp_decode_command

Type: string
Default: lqrq

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

The PGP command formats have their own set of printf-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/signed attachment when verifying it.
%a: The value of $pgp_sign_as.
%r: One or more key IDs.

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

pgp_getkeys_command

Type: string
Default: lqrq

This command is invoked whenever mutt will need public key information. %r is the only printf-like sequence used with this format. (PGP only)

pgp_verify_command

Type: string
Default: lqrq

This command is used to verify PGP signatures. (PGP only)

pgp_decrypt_command

Type: string
Default: lqrq

This command is used to decrypt a PGP encrypted message. (PGP only)

pgp_clearsign_command

Type: string
Default: lqrq

This format is used to create a old-style rqclearsignedrq PGP message. Note that the use of this format is strongly deprecated. (PGP only)

pgp_sign_command

Type: string
Default: lqrq

This command is used to create the detached PGP signature for a multipart/signed PGP/MIME body part. (PGP only)

pgp_encrypt_sign_command

Type: string
Default: lqrq

This command is used to both sign and encrypt a body part. (PGP only)

pgp_encrypt_only_command

Type: string
Default: lqrq

This command is used to encrypt a body part without signing it. (PGP only)

pgp_import_command

Type: string
Default: lqrq

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

pgp_export_command

Type: string
Default: lqrq

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

pgp_verify_key_command

Type: string
Default: lqrq

This command is used to verify key information from the key selection menu. (PGP only)

pgp_list_secring_command

Type: string
Default: lqrq

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.

This format is also generated by the pgpring utility which comes with mutt. (PGP only)

pgp_list_pubring_command

Type: string
Default: lqrq

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.

This format is also generated by the pgpring utility which comes with mutt. (PGP only)

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 lq$mime_forwardrq is set and lq$mime_forward_decoderq is unset. (PGP only)

smime_timeout

Type: number
Default: 300

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

smime_encrypt_with

Type: string
Default: lqrq

This sets the algorithm that should be used for encryption. Valid choices are rqdesrq, rqdes3rq, rqrc2-40rq, rqrc2-64rq, rqrc2-128rq. If unset rq3desrq (TripleDES) is used. (S/MIME only)

smime_keys

Type: path
Default: lqrq

Since there is no pubring/secring as with PGP, mutt has to handle storage ad 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 one points to the location of the private keys. (S/MIME only)

smime_ca_location

Type: path
Default: lqrq

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

smime_certificates

Type: path
Default: lqrq

Since 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 one points to the location of the certificates. (S/MIME only)

smime_decrypt_command

Type: string
Default: lqrq

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

The OpenSSL command formats have their own set of printf-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/signed attachment when verifying it.
%k: The key-pair specified with $smime_default_key
%c: One or more certificate IDs.
%a: The algorithm used for encryption.
%C: CA location: Depending on whether $smime_ca_location
points to a directory or file, this expands to
rq-CApath $smime_ca_locationrq or rq-CAfile $smime_ca_locationrq.

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

smime_verify_command

Type: string
Default: lqrq

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

smime_verify_opaque_command

Type: string
Default: lqrq

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

smime_sign_command

Type: string
Default: lqrq

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

smime_sign_opaque_command

Type: string
Default: lqrq

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. (S/MIME only)

smime_encrypt_command

Type: string
Default: lqrq

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

smime_pk7out_command

Type: string
Default: lqrq

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

smime_get_cert_command

Type: string
Default: lqrq

This command is used to extract X509 certificates from a PKCS7 structure. (S/MIME only)

smime_get_signer_cert_command

Type: string
Default: lqrq

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. (S/MIME only)

smime_import_cert_command

Type: string
Default: lqrq

This command is used to import a certificate via smime_keys. (S/MIME only)

smime_get_cert_email_command

Type: string
Default: lqrq

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). (S/MIME only)

smime_default_key

Type: string
Default: lqrq

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)

ssl_client_cert

Type: path
Default: lqrq

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

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 lq$ssl_starttlsrq.

ssl_starttls

Type: quadoption
Default: yes

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

certificate_file

Type: path
Default: lq~/.mutt_certificatesrq

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 are also automatically accepted.

Example: set certificate_file=~/.mutt/certificates

ssl_usesystemcerts

Type: boolean
Default: yes

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

entropy_file

Type: path
Default: lqrq

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

ssl_use_sslv2

Type: boolean
Default: yes

This variables specifies whether to attempt to use SSLv2 in the SSL authentication process.

ssl_use_sslv3

Type: boolean
Default: yes

This variables specifies whether to attempt to use SSLv3 in the SSL authentication process.

ssl_use_tlsv1

Type: boolean
Default: yes

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

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.

ssl_ca_certificates_file

Type: path
Default: lqrq

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

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

pipe_split

Type: boolean
Default: no

Used in connection with the pipe-message command and the lqtag- prefixrq operator. If this variable is unset, when piping a list of tagged messages Mutt will concatenate the messages and will pipe them as a single folder. When set, Mutt will pipe the messages one by one. In both cases the messages are piped in the current sorted order, and the lq$pipe_seprq separator is added after each message.

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 PGP/MIME decode the messages first.

pipe_sep

Type: string
Default: lq\nrq

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

pop_authenticators

Type: string
Default: lqrq

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', 'apop' or any SASL mechanism, eg 'digest-md5', 'gssapi' or 'cram-md5'. This parameter is case-insensitive. If this parameter is unset (the default) mutt will try all available methods, in order from most-secure to least-secure.

Example: set pop_authenticators=rqdigest-md5:apop:userrq

pop_auth_try_all

Type: boolean
Default: yes

If set, Mutt will try all available methods. When unset, Mutt will only fall back to other authentication metho

HACKTUX notes from the trenches

Latest Links

Man Page

Man Perl

PERL

NAME

SYNOPSIS

Overview

Tutorials

Reference Manual

Internals and C Language Interface

Miscellaneous

Language-Specific

Platform-Specific

DESCRIPTION

AVAILABILITY

ENVIRONMENT

AUTHOR

FILES

SEE ALSO

DIAGNOSTICS

BUGS

NOTES

Index

Man Muttrc

muttrc

NAME

DESCRIPTION

COMMANDS

PATTERNS

Constructing Patterns

Simple Patterns

Matching dates

CONFIGURATION VARIABLES