9 If set to \fIyes\fP, when composing messages and no subject is given
10 at the subject prompt, composition will be aborted. If set to
11 \fIno\fP, composing messages with no subject given at the subject
12 prompt will never be aborted.
22 If set to \fIyes\fP, composition will automatically abort after
23 editing the message body if no changes are made to the file (this
24 check only happens after the \fIfirst\fP edit of the file). When set
25 to \fIno\fP, composition will never be aborted.
32 Default: \(lq~/.muttrc\(rq
35 The default file in which to save aliases created by the
36 \fC<create-alias>\fP function. Entries added to this file are
37 encoded in the character set specified by $config_charset if it
38 is \fIset\fP or the current character set otherwise.
40 \fBNote:\fP Mutt will not automatically source this file; you must
41 explicitly use the \(lqsource\(rq command for it to be executed in case
42 this option points to a dedicated alias file.
44 The default for this option is the currently used muttrc file, or
45 \(lq~/.muttrc\(rq if no user muttrc was found.
52 Default: \(lq%4n %2f %t %\-10a %r\(rq
55 Specifies the format of the data displayed for the \(lqalias\(rq menu. The
56 following \fCprintf(3)\fP\-style sequences are available:
64 flags \- currently, a \(lqd\(rq for an alias marked for deletion
70 address which alias expands to
73 character which indicates if the alias is tagged for inclusion
84 Controls whether 8\-bit data is converted to 7\-bit using either Quoted\-
85 Printable or Base64 encoding when sending mail.
95 Controls whether ANSI color codes in messages (and color tags in
96 rich text messages) are to be interpreted.
97 Messages containing these codes are rare, but if this option is \fIset\fP,
98 their text will be colored accordingly. Note that this may override
99 your color choices, and even present a security problem, since a
100 message could include a line like
107 [\-\- PGP output follows ...
114 and give it the same color as your attachment color (see also
125 When \fIset\fP, an arrow (\(lq\->\(rq) will be used to indicate the current entry
126 in menus instead of highlighting the whole line. On slow network or modem
127 links this will make response faster because there is less that has to
128 be redrawn on the screen when moving to the next or previous entries
139 If \fIset\fP, Mutt will use plain ASCII characters when displaying thread
140 and attachment trees, instead of the default \fIACS\fP characters.
150 If \fIset\fP, Mutt will prompt you for blind\-carbon\-copy (Bcc) recipients
151 before editing an outgoing message.
161 If \fIset\fP, Mutt will prompt you for carbon\-copy (Cc) recipients before
162 editing the body of an outgoing message.
172 This variable is a colon\-separated list of character encoding
173 schemes for messages without character encoding indication.
174 Header field values and message body content without character encoding
175 indication would be assumed that they are written in one of this list.
176 By default, all the header fields and message body without any charset
177 indication are assumed to be in \(lqus\-ascii\(rq.
179 For example, Japanese users might prefer this:
186 set assumed_charset=\(rqiso\-2022\-jp:euc\-jp:shift_jis:utf\-8\(rq
193 However, only the first content is valid for the message body.
203 This variable is a colon\-separated list of character encoding
204 schemes for text file attachments. Mutt uses this setting to guess
205 which encoding files being attached are encoded in to convert them to
206 a proper character set given in $send_charset.
208 If \fIunset\fP, the value of $charset will be used instead.
209 For example, the following configuration would work for Japanese
217 set attach_charset=\(rqiso\-2022\-jp:euc\-jp:shift_jis:utf\-8\(rq
224 Note: for Japanese users, \(lqiso\-2022\-*\(rq must be put at the head
225 of the value as shown above if included.
232 Default: \(lq%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] \(rq
235 This variable describes the format of the \(lqattachment\(rq menu. The
236 following \fCprintf(3)\fP\-style sequences are understood:
244 requires charset conversion (\(lqn\(rq or \(lqc\(rq)
253 MIME content\-transfer\-encoding
259 disposition (\(lqI\(rq for inline, \(lqA\(rq for attachment)
271 \(lqQ\(rq, if MIME part qualifies for attachment counting
280 graphic tree characters
283 unlink (=to delete) flag
286 number of qualifying MIME parts in this part and its children
287 (please see the \(lqattachments\(rq section for possible speed effects)
290 right justify the rest of the string and pad with character \(lqX\(rq
293 pad to the end of the line with character \(lqX\(rq
296 soft\-fill with character \(lqX\(rq as pad
300 For an explanation of \(lqsoft\-fill\(rq, see the $index_format documentation.
310 The separator to add between attachments when operating (saving,
311 printing, piping, etc) on a list of tagged attachments.
321 If this variable is \fIunset\fP, when operating (saving, printing, piping,
322 etc) on a list of tagged attachments, Mutt will concatenate the
323 attachments and will operate on them as a single attachment. The
324 $attach_sep separator is added after each attachment. When \fIset\fP,
325 Mutt will operate on the attachments one by one.
332 Default: \(lqOn %d, %n wrote:\(rq
335 This is the string that will precede a message which has been included
336 in a reply. For a full listing of defined \fCprintf(3)\fP\-like sequences see
337 the section on $index_format.
347 When \fIset\fP, functions in the \fIindex\fP menu which affect a message
348 will be applied to all tagged messages (if there are any). When
349 unset, you must first use the \fC<tag\-prefix>\fP function (bound to \(lq;\(rq
350 by default) to make the next function apply to all tagged messages.
360 When \fIset\fP along with $edit_headers, Mutt will skip the initial
361 send\-menu (prompting for subject and recipients) and allow you to
362 immediately begin editing the body of your
363 message. The send\-menu may still be accessed once you have finished
364 editing the body of your message.
366 \fBNote:\fP when this option is \fIset\fP, you cannot use send\-hooks that depend
367 on the recipients when composing a new (non\-reply) message, as the initial
368 list of recipients is empty.
370 Also see $fast_reply.
380 When this variable is \fIset\fP, mutt will beep when an error occurs.
390 When this variable is \fIset\fP, mutt will beep whenever it prints a message
391 notifying you of new mail. This is independent of the setting of the
402 Controls whether you will be asked to confirm bouncing messages.
403 If set to \fIyes\fP you don't get asked if you want to bounce a
404 message. Setting this variable to \fIno\fP is not generally useful,
405 and thus not recommended, because you are unable to bounce messages.
415 When this variable is \fIset\fP, mutt will include Delivered\-To headers when
416 bouncing messages. Postfix users may wish to \fIunset\fP this variable.
426 When this variable is \fIset\fP, mutt will place the cursor at the beginning
427 of the current line in menus, even when the $arrow_cursor variable
428 is \fIunset\fP, making it easier for blind persons using Braille displays to
429 follow these menus. The option is \fIunset\fP by default because many
430 visual terminals don't permit making the cursor invisible.
437 Default: \(lq~/.mutt_certificates\(rq
440 This variable specifies the file where the certificates you trust
441 are saved. When an unknown certificate is encountered, you are asked
442 if you accept it or not. If you accept it, the certificate can also
443 be saved in this file and further connections are automatically
446 You can also manually add CA certificates in this file. Any server
447 certificate that is signed with one of these CA certificates is
448 also automatically accepted.
457 set certificate_file=~/.mutt/certificates
472 Character set your terminal uses to display and enter textual data.
473 It is also the fallback for $send_charset.
475 Upon startup Mutt tries to derive this value from environment variables
476 such as \fC$LC_CTYPE\fP or \fC$LANG\fP.
478 \fBNote:\fP It should only be set in case Mutt isn't abled to determine the
479 character set used correctly.
489 When this variable is \fIset\fP, mutt will use file size attribute instead of
490 access time when checking for new mail in mbox and mmdf folders.
492 This variable is \fIunset\fP by default and should only be enabled when
493 new mail detection for these folder types is unreliable or doesn't work.
495 Note that enabling this variable should happen before any \(lqmailboxes\(rq
496 directives occur in configuration files regarding mbox or mmdf folders
497 because mutt needs to determine the initial new mail status of such a
498 mailbox by performing a fast mailbox scan when it is defined.
499 Afterwards the new mail status is tracked by file size changes.
509 \fBNote:\fP this option only affects \fImaildir\fP and \fIMH\fP style
512 When \fIset\fP, Mutt will check for new mail delivered while the
513 mailbox is open. Especially with MH mailboxes, this operation can
514 take quite some time since it involves scanning the directory and
515 checking each file to see if it has already been looked at. If
516 this variable is \fIunset\fP, no check for new mail is performed
517 while the mailbox is open.
527 When \fIunset\fP, Mutt will not collapse a thread if it contains any
535 Default: \(lq\-\- Mutt: Compose [Approx. msg size: %l Atts: %a]%>\-\(rq
538 Controls the format of the status line displayed in the \(lqcompose\(rq
539 menu. This string is similar to $status_format, but has its own
540 set of \fCprintf(3)\fP\-like sequences:
545 total number of attachments
551 approximate size (in bytes) of the current message
558 See the text describing the $status_format option for more
559 information on how to set $compose_format.
569 When defined, Mutt will recode commands in rc files from this
570 encoding to the current character set as specified by $charset
571 and aliases written to $alias_file from the current character set.
573 Please note that if setting $charset it must be done before
574 setting $config_charset.
576 Recoding should be avoided as it may render unconvertable
577 characters as question marks which can lead to undesired
578 side effects (for example in regular expressions).
588 When \fIset\fP, Mutt will prompt for confirmation when appending messages to
599 When \fIset\fP, Mutt will prompt for confirmation when saving messages to a
600 mailbox which does not yet exist before creating it.
610 Causes Mutt to timeout a network connection (for IMAP, POP or SMTP) after this
611 many seconds if the connection is not able to be established. A negative
612 value causes Mutt to wait indefinitely for the connection attempt to succeed.
619 Default: \(lqtext/plain\(rq
622 Sets the default Content\-Type for the body of newly composed messages.
632 This variable controls whether or not copies of your outgoing messages
633 will be saved for later references. Also see $record,
634 $save_name, $force_name and \(lqfcc-hook\(rq.
644 Setting this variable will cause Mutt to always attempt to PGP
645 encrypt outgoing messages. This is probably only useful in
646 connection to the \(lqsend-hook\(rq command. It can be overridden
647 by use of the pgp menu, when encryption is not required or
648 signing is requested as well. If $smime_is_default is \fIset\fP,
649 then OpenSSL is used instead to create S/MIME messages and
650 settings can be overridden by use of the smime menu instead.
661 This variable controls whether or not mutt may automatically enable
662 PGP encryption/signing for messages. See also $crypt_autoencrypt,
664 $crypt_autosign, $crypt_replysign and $smime_is_default.
674 Setting this variable will cause Mutt to always attempt to
675 cryptographically sign outgoing messages. This can be overridden
676 by use of the pgp menu, when signing is not required or
677 encryption is requested as well. If $smime_is_default is \fIset\fP,
678 then OpenSSL is used instead to create S/MIME messages and settings can
679 be overridden by use of the smime menu instead of the pgp menu.
690 This variable controls whether or not mutt may automatically enable
691 S/MIME encryption/signing for messages. See also $crypt_autoencrypt,
693 $crypt_autosign, $crypt_replysign and $smime_is_default.
697 .B crypt_replyencrypt
703 If \fIset\fP, automatically PGP or OpenSSL encrypt replies to messages which are
715 If \fIset\fP, automatically PGP or OpenSSL sign replies to messages which are
718 \fBNote:\fP this does not work on messages that are encrypted
724 .B crypt_replysignencrypted
730 If \fIset\fP, automatically PGP or OpenSSL sign replies to messages
731 which are encrypted. This makes sense in combination with
732 $crypt_replyencrypt, because it allows you to sign all
733 messages which are automatically encrypted. This works around
734 the problem noted in $crypt_replysign, that mutt is not able
735 to find out whether an encrypted message is also signed.
746 If \fIset\fP, mutt will include a time stamp in the lines surrounding
747 PGP or S/MIME output, so spoofing such lines is more difficult.
748 If you are using colors to mark these lines, and rely on these,
749 you may \fIunset\fP this setting.
760 This variable controls the use of the GPGME\-enabled crypto backends.
761 If it is \fIset\fP and Mutt was built with gpgme support, the gpgme code for
762 S/MIME and PGP will be used instead of the classic code. Note that
763 you need to set this option in .muttrc; it won't have any effect when
774 Controls whether mutt uses PKA
775 (see http://www.g10code.de/docs/pka\-intro.de.pdf) during signature
776 verification (only supported by the GPGME backend).
786 If \fI\(lqyes\(rq\fP, always attempt to verify PGP or S/MIME signatures.
787 If \fI\(lqask\-*\(rq\fP, ask whether or not to verify the signature.
788 If \\Fi\(lqno\(rq\fP, never attempt to verify cryptographic signatures.
796 Default: \(lq!%a, %b %d, %Y at %I:%M:%S%p %Z\(rq
799 This variable controls the format of the date printed by the \(lq%d\(rq
800 sequence in $index_format. This is passed to the \fCstrftime(3)\fP
801 function to process the date, see the man page for the proper syntax.
803 Unless the first character in the string is a bang (\(lq!\(rq), the month
804 and week day names are expanded according to the locale specified in
805 the variable $locale. If the first character in the string is a
806 bang, the bang is discarded, and the month and week day names in the
807 rest of the string are expanded in the \fIC\fP locale (that is in US
815 Default: \(lq~f %s !~P | (~P ~C %s)\(rq
818 This variable controls how \(lqmessage-hook\(rq, \(lqreply-hook\(rq, \(lqsend-hook\(rq,
819 \(lqsend2-hook\(rq, \(lqsave-hook\(rq, and \(lqfcc-hook\(rq will
820 be interpreted if they are specified with only a simple regexp,
821 instead of a matching pattern. The hooks are expanded when they are
822 declared, so a hook will be interpreted according to the value of this
823 variable at the time the hook is declared.
825 The default value matches
826 if the message is either from a user matching the regular expression
827 given, or if it is from you (if the from address matches
828 \(lqalternates\(rq) and is to or cc'ed to a user matching the given
839 Controls whether or not messages are really deleted when closing or
840 synchronizing a mailbox. If set to \fIyes\fP, messages marked for
841 deleting will automatically be purged without prompting. If set to
842 \fIno\fP, messages marked for deletion will be kept in the mailbox.
852 If this option is \fIset\fP, mutt will untag messages when marking them
853 for deletion. This applies when you either explicitly delete a message,
854 or when you save it to another folder.
864 If this option is \fIset\fP, mutt's received\-attachments menu will not show the subparts of
865 individual messages in a multipart/digest. To see these subparts, press \(lqv\(rq on that menu.
875 When set, specifies a command used to filter messages. When a message
876 is viewed it is passed as standard input to $display_filter, and the
877 filtered message is read from the standard output.
884 Default: \(lq/usr/bin/mutt_dotlock\(rq
887 Contains the path of the \fCmutt_dotlock(8)\fP binary to be used by
898 This variable sets the request for when notification is returned. The
899 string consists of a comma separated list (no spaces!) of one or more
900 of the following: \fInever\fP, to never request notification,
901 \fIfailure\fP, to request notification on transmission failure,
902 \fIdelay\fP, to be notified of message delays, \fIsuccess\fP, to be
903 notified of successful transmission.
912 set dsn_notify=\(rqfailure,delay\(rq
919 \fBNote:\fP when using $sendmail for delivery, you should not enable
920 this unless you are either using Sendmail 8.8.x or greater or a MTA
921 providing a \fCsendmail(1)\fP\-compatible interface supporting the \fC\-N\fP option
922 for DSN. For SMTP delivery, DSN support is autodetected so that it
923 depends on the server whether DSN will be used or not.
933 This variable controls how much of your message is returned in DSN
934 messages. It may be set to either \fIhdrs\fP to return just the
935 message header, or \fIfull\fP to return the full message.
951 \fBNote:\fP when using $sendmail for delivery, you should not enable
952 this unless you are either using Sendmail 8.8.x or greater or a MTA
953 providing a \fCsendmail(1)\fP\-compatible interface supporting the \fC\-R\fP option
954 for DSN. For SMTP delivery, DSN support is autodetected so that it
955 depends on the server whether DSN will be used or not.
965 This variable controls whether mutt, when $sort is set to \fIthreads\fP, threads
966 messages with the same Message\-Id together. If it is \fIset\fP, it will indicate
967 that it thinks they are duplicates of each other with an equals sign
978 This option allows you to edit the header of your outgoing messages
979 along with the body of your message.
981 \fBNote\fP that changes made to the References: and Date: headers are
982 ignored for interoperability reasons.
992 This variable specifies which editor is used by mutt.
993 It defaults to the value of the \fC$VISUAL\fP, or \fC$EDITOR\fP, environment
994 variable, or to the string \(lqvi\(rq if neither of those are set.
1004 When \fIset\fP, mutt will quoted\-printable encode messages when
1005 they contain the string \(lqFrom \(rq (note the trailing space) in the beginning of a line.
1006 This is useful to avoid the tampering certain mail delivery and transport
1007 agents tend to do with messages (in order to prevent tools from
1008 misinterpreting the line as a mbox message separator).
1018 The file which includes random data that is used to initialize SSL
1023 .B envelope_from_address
1025 Type: e-mail address
1029 Manually sets the \fIenvelope\fP sender for outgoing messages.
1030 This value is ignored if $use_envelope_from is \fIunset\fP.
1040 Escape character to use for functions in the builtin editor.
1050 When \fIset\fP, the initial prompt for recipients and subject are skipped
1051 when replying to messages, and the initial prompt for subject is
1052 skipped when forwarding messages.
1054 \fBNote:\fP this variable has no effect when the $autoedit
1055 variable is \fIset\fP.
1065 This variable controls whether or not attachments on outgoing messages
1066 are saved along with the main body of your message.
1076 When this variable is \fIset\fP, FCCs will be stored unencrypted and
1077 unsigned, even when the actual message is encrypted and/or
1086 Default: \(lq~/Mail\(rq
1089 Specifies the default location of your mailboxes. A \(lq+\(rq or \(lq=\(rq at the
1090 beginning of a pathname will be expanded to the value of this
1091 variable. Note that if you change this variable (from the default)
1092 value you need to make sure that the assignment occurs \fIbefore\fP
1093 you use \(lq+\(rq or \(lq=\(rq for any other variables since expansion takes place
1094 when handling the \(lqmailboxes\(rq command.
1101 Default: \(lq%2C %t %N %F %2l %\-8.8u %\-8.8g %8s %d %f\(rq
1104 This variable allows you to customize the file browser display to your
1105 personal taste. This string is similar to $index_format, but has
1106 its own set of \fCprintf(3)\fP\-like sequences:
1114 date/time folder was last modified
1117 filename (\(lq/\(rq is appended to directory names,
1118 \(lq@\(rq to symbolic links and \(lq*\(rq to executable
1125 group name (or numeric gid, if missing)
1128 number of hard links
1131 N if folder has new mail, blank otherwise
1137 \(lq*\(rq if the file is tagged, blank otherwise
1140 owner name (or numeric uid, if missing)
1143 right justify the rest of the string and pad with character \(lqX\(rq
1146 pad to the end of the line with character \(lqX\(rq
1149 soft\-fill with character \(lqX\(rq as pad
1153 For an explanation of \(lqsoft\-fill\(rq, see the $index_format documentation.
1163 Controls whether or not the \(lqMail\-Followup\-To:\(rq header field is
1164 generated when sending mail. When \fIset\fP, Mutt will generate this
1165 field when you are replying to a known mailing list, specified with
1166 the \(lqsubscribe\(rq or \(lqlists\(rq commands.
1168 This field has two purposes. First, preventing you from
1169 receiving duplicate copies of replies to messages which you send
1170 to mailing lists, and second, ensuring that you do get a reply
1171 separately for any messages sent to known lists to which you are
1174 The header will contain only the list's address
1175 for subscribed lists, and both the list address and your own
1176 email address for unsubscribed lists. Without this header, a
1177 group reply to your message sent to a subscribed list will be
1178 sent to both the list and your address, resulting in two copies
1179 of the same email for you.
1189 This variable is similar to $save_name, except that Mutt will
1190 store a copy of your outgoing message by the username of the address
1191 you are sending to even if that mailbox does not exist.
1193 Also see the $record variable.
1203 Controls the decoding of complex MIME messages into \fCtext/plain\fP when
1204 forwarding a message. The message header is also RFC2047 decoded.
1205 This variable is only used, if $mime_forward is \fIunset\fP,
1206 otherwise $mime_forward_decode is used instead.
1216 Controls the handling of encrypted messages when forwarding a message.
1217 When \fIset\fP, the outer layer of encryption is stripped off. This
1218 variable is only used if $mime_forward is \fIset\fP and
1219 $mime_forward_decode is \fIunset\fP.
1230 This quadoption controls whether or not the user is automatically
1231 placed in the editor when forwarding messages. For those who always want
1232 to forward with no modification, use a setting of \(lqno\(rq.
1239 Default: \(lq[%a: %s]\(rq
1242 This variable controls the default subject when forwarding a message.
1243 It uses the same format sequences as the $index_format variable.
1253 When \fIset\fP, forwarded messages included in the main body of the
1254 message (when $mime_forward is \fIunset\fP) will be quoted using
1261 Type: e-mail address
1265 When \fIset\fP, this variable contains a default from address. It
1266 can be overridden using \(lqmy_hdr\(rq (including from a \(lqsend-hook\(rq) and
1267 $reverse_name. This variable is ignored if $use_from is \fIunset\fP.
1269 This setting defaults to the contents of the environment variable \fC$EMAIL\fP.
1275 Type: regular expression
1276 Default: \(lq^[^,]*\(rq
1279 A regular expression used by mutt to parse the GECOS field of a password
1280 entry when expanding the alias. The default value
1281 will return the string up to the first \(lq,\(rq encountered.
1282 If the GECOS field contains a string like \(lqlastname, firstname\(rq then you
1283 should set it to \(lq\fC.*\fP\(rq.
1285 This can be useful if you see the following behavior: you address an e\-mail
1286 to user ID \(lqstevef\(rq whose full name is \(lqSteve Franklin\(rq. If mutt expands
1287 \(lqstevef\(rq to \(lq\(rqFranklin\(rq stevef@foo.bar\(rq then you should set the $gecos_mask to
1288 a regular expression that will match the whole name so mutt will expand
1289 \(lqFranklin\(rq to \(lqFranklin, Steve\(rq.
1299 When \fIunset\fP, the header fields normally added by the \(lqmy_hdr\(rq
1300 command are not created. This variable \fImust\fP be unset before
1301 composing a new message or replying in order to take effect. If \fIset\fP,
1302 the user defined header fields are added to every new message.
1312 When \fIset\fP, this variable causes Mutt to include the header
1313 of the message you are replying to into the edit buffer.
1314 The $weed setting applies.
1324 This variable points to the header cache database.
1325 If pointing to a directory Mutt will contain a header cache
1326 database file per folder, if pointing to a file that file will
1327 be a single global header cache. By default it is \fIunset\fP so no header
1328 caching will be used.
1330 Header caching can greatly improve speed when opening POP, IMAP
1331 MH or Maildir folders, see \(lqcaching\(rq for details.
1335 .B header_cache_compress
1341 When mutt is compiled with qdbm or tokyocabinet as header cache backend,
1342 this option determines whether the database will be compressed.
1343 Compression results in database files roughly being one fifth
1344 of the usual diskspace, but the uncompression can result in a
1345 slower opening of cached folder(s) which in general is still
1346 much faster than opening non header cached folders.
1350 .B header_cache_pagesize
1353 Default: \(lq16384\(rq
1356 When mutt is compiled with either gdbm or bdb4 as the header cache backend,
1357 this option changes the database page size. Too large or too small
1358 values can waste space, memory, or CPU time. The default should be more
1359 or less optimal for most use cases.
1369 When \fIset\fP, help lines describing the bindings for the major functions
1370 provided by each menu are displayed on the first line of the screen.
1372 \fBNote:\fP The binding will not be displayed correctly if the
1373 function is bound to a sequence rather than a single keystroke. Also,
1374 the help line may not be updated if a binding is changed while Mutt is
1375 running. Since this variable is primarily aimed at new users, neither
1376 of these should present a major problem.
1386 When \fIset\fP, mutt will skip the host name part of $hostname variable
1387 when adding the domain part to addresses. This variable does not
1388 affect the generation of Message\-IDs, and it will not lead to the
1389 cut\-off of first\-level domains.
1399 When \fIset\fP, mutt will not show the presence of messages that are hidden
1400 by limiting, in the thread tree.
1410 When \fIset\fP, mutt will not show the presence of missing messages in the
1415 .B hide_thread_subject
1421 When \fIset\fP, mutt will not show the subject of messages in the thread
1422 tree that have the same subject as their parent or closest previously
1433 When \fIset\fP, mutt will not show the presence of messages that are hidden
1434 by limiting, at the top of threads in the thread tree. Note that when
1435 $hide_limited is \fIset\fP, this option will have no effect.
1445 When \fIset\fP, mutt will not show the presence of missing messages at the
1446 top of threads in the thread tree. Note that when $hide_missing is
1447 \fIset\fP, this option will have no effect.
1457 This variable controls the size (in number of strings remembered) of
1458 the string history buffer per category. The buffer is cleared each time the
1466 Default: \(lq~/.mutthistory\(rq
1469 The file in which Mutt will save its history.
1473 .B honor_disposition
1479 When \fIset\fP, Mutt will not display attachments with a
1480 disposition of \(lqattachment\(rq inline even if it could
1481 render the part to plain text. These MIME parts can only
1482 be viewed from the attachment menu.
1484 If \fIunset\fP, Mutt will render all MIME parts it can
1485 properly transform to plain text.
1489 .B honor_followup_to
1495 This variable controls whether or not a Mail\-Followup\-To header is
1496 honored when group\-replying to a message.
1506 Specifies the fully\-qualified hostname of the system mutt is running on
1507 containing the host's name and the DNS domain it belongs to. It is used
1508 as the domain part (after \(lq@\(rq) for local email addresses as well as
1509 Message\-Id headers.
1511 Its value is determined at startup as follows: If the node's name
1512 as returned by the \fCuname(3)\fP function contains the hostname and the
1513 domain, these are used to construct $hostname. If there is no
1514 domain part returned, Mutt will look for a \(lqdomain\(rq or \(lqsearch\(rq
1515 line in \fC/etc/resolv.conf\fP to determine the domain. Optionally, Mutt
1516 can be compiled with a fixed domain name in which case a detected
1519 Also see $use_domain and $hidden_host.
1523 .B ignore_linear_white_space
1529 This option replaces linear\-white\-space between encoded\-word
1530 and text to a single space to prevent the display of MIME\-encoded
1531 \(lqSubject:\(rq field from being divided into multiple lines.
1535 .B ignore_list_reply_to
1541 Affects the behaviour of the \fC<reply>\fP function when replying to
1542 messages from mailing lists (as defined by the \(lqsubscribe\(rq or
1543 \(lqlists\(rq commands). When \fIset\fP, if the \(lqReply\-To:\(rq field is
1544 set to the same value as the \(lqTo:\(rq field, Mutt assumes that the
1545 \(lqReply\-To:\(rq field was set by the mailing list to automate responses
1546 to the list, and will ignore this field. To direct a response to the
1547 mailing list when this option is \fIset\fP, use the \fC<list-reply>\fP
1548 function; \fC<group\-reply>\fP will reply to both the sender and the
1553 .B imap_authenticators
1559 This is a colon\-delimited list of authentication methods mutt may
1560 attempt to use to log in to an IMAP server, in the order mutt should
1561 try them. Authentication methods are either \(lqlogin\(rq or the right
1562 side of an IMAP \(lqAUTH=xxx\(rq capability string, eg \(lqdigest\-md5\(rq, \(lqgssapi\(rq
1563 or \(lqcram\-md5\(rq. This option is case\-insensitive. If it's
1564 \fIunset\fP (the default) mutt will try all available methods,
1565 in order from most\-secure to least\-secure.
1574 set imap_authenticators=\(rqgssapi:cram\-md5:login\(rq
1581 \fBNote:\fP Mutt will only fall back to other authentication methods if
1582 the previous methods are unavailable. If a method is available but
1583 authentication fails, mutt will not connect to the IMAP server.
1587 .B imap_check_subscribed
1593 When \fIset\fP, mutt will fetch the set of subscribed folders from
1594 your server on connection, and add them to the set of mailboxes
1595 it polls for new mail just as if you had issued individual \(lqmailboxes\(rq
1606 This contains the list of characters which you would like to treat
1607 as folder separators for displaying IMAP paths. In particular it
1608 helps in using the \(lq=\(rq shortcut for your \fIfolder\fP variable.
1618 Mutt requests these header fields in addition to the default headers
1619 (\(lqDate:\(rq, \(lqFrom:\(rq, \(lqSubject:\(rq, \(lqTo:\(rq, \(lqCc:\(rq, \(lqMessage\-Id:\(rq,
1620 \(lqReferences:\(rq, \(lqContent\-Type:\(rq, \(lqContent\-Description:\(rq, \(lqIn\-Reply\-To:\(rq,
1621 \(lqReply\-To:\(rq, \(lqLines:\(rq, \(lqList\-Post:\(rq, \(lqX\-Label:\(rq) from IMAP
1622 servers before displaying the index menu. You may want to add more
1623 headers for spam detection.
1625 \fBNote:\fP This is a space separated list, items should be uppercase
1626 and not contain the colon, e.g. \(lqX\-BOGOSITY X\-SPAM\-STATUS\(rq for the
1627 \(lqX\-Bogosity:\(rq and \(lqX\-Spam\-Status:\(rq header fields.
1637 When \fIset\fP, mutt will attempt to use the IMAP IDLE extension
1638 to check for new mail in the current mailbox. Some servers
1639 (dovecot was the inspiration for this option) react badly
1640 to mutt's implementation. If your connection seems to freeze
1641 up periodically, try unsetting this.
1651 This variable specifies the maximum amount of time in seconds that mutt
1652 will wait before polling open IMAP connections, to prevent the server
1653 from closing them before mutt has finished with them. The default is
1654 well within the RFC\-specified minimum amount of time (30 minutes) before
1655 a server is allowed to do this, but in practice the RFC does get
1656 violated every now and then. Reduce this number if you find yourself
1657 getting disconnected from your IMAP server due to inactivity.
1661 .B imap_list_subscribed
1667 This variable configures whether IMAP folder browsing will look for
1668 only subscribed folders or all folders. This can be toggled in the
1669 IMAP browser with the \fC<toggle\-subscribed>\fP function.
1679 Your login name on the IMAP server.
1681 This variable defaults to the value of $imap_user.
1691 Specifies the password for your IMAP account. If \fIunset\fP, Mutt will
1692 prompt you for your password when you invoke the \fC<imap\-fetch\-mail>\fP function
1693 or try to open an IMAP folder.
1695 \fBWarning\fP: you should only use this option when you are on a
1696 fairly secure machine, because the superuser can read your muttrc even
1697 if you are the only one who can read the file.
1707 When \fIset\fP, mutt will not open new IMAP connections to check for new
1708 mail. Mutt will only check for new mail over existing IMAP
1709 connections. This is useful if you don't want to be prompted to
1710 user/password pairs on mutt invocation, or if opening the connection
1721 When \fIset\fP, mutt will avoid implicitly marking your mail as read whenever
1722 you fetch a message from the server. This is generally a good thing,
1723 but can make closing an IMAP folder somewhat slower. This option
1724 exists to appease speed freaks.
1728 .B imap_pipeline_depth
1734 Controls the number of IMAP commands that may be queued up before they
1735 are sent to the server. A deeper pipeline reduces the amount of time
1736 mutt must wait for the server, and can make IMAP servers feel much
1737 more responsive. But not all servers correctly handle pipelined commands,
1738 so if you have problems you might want to try setting this variable to 0.
1740 \fBNote:\fP Changes to this variable have no effect on open connections.
1750 When \fIset\fP, mutt will display warning messages from the IMAP
1751 server as error messages. Since these messages are often
1752 harmless, or generated due to configuration problems on the
1753 server which are out of the users' hands, you may wish to suppress
1764 The name of the user whose mail you intend to access on the IMAP
1767 This variable defaults to your user name on the local machine.
1771 .B implicit_autoview
1777 If set to \(lqyes\(rq, mutt will look for a mailcap entry with the
1778 \(lq\fCcopiousoutput\fP\(rq flag set for \fIevery\fP MIME attachment it doesn't have
1779 an internal viewer defined for. If such an entry is found, mutt will
1780 use the viewer defined in that entry to convert the body part to text
1791 Controls whether or not a copy of the message(s) you are replying to
1792 is included in your reply.
1796 .B include_onlyfirst
1802 Controls whether or not Mutt includes only the first attachment
1803 of the message you are replying.
1813 Specifies the string to prepend to each line of text quoted in a
1814 message to which you are replying. You are strongly encouraged not to
1815 change this value, as it tends to agitate the more fanatical netizens.
1817 The value of this option is ignored if $text_flowed is set, too because
1818 the quoting mechanism is strictly defined for format=flowed.
1820 This option is a format string, please see the description of
1821 $index_format for supported \fCprintf(3)\fP\-style sequences.
1828 Default: \(lq%4C %Z %{%b %d} %\-15.15L (%?l?%4l&%4c?) %s\(rq
1831 This variable allows you to customize the message index display to
1832 your personal taste.
1834 \(lqFormat strings\(rq are similar to the strings used in the C
1835 function \fCprintf(3)\fP to format output (see the man page for more details).
1836 The following sequences are defined in Mutt:
1841 address of the author
1844 reply\-to address (if present; otherwise: address of author)
1847 filename of the original message folder (think mailbox)
1850 the list to which the letter was sent, or else the folder name (%b).
1853 number of characters (bytes) in the message
1856 current message number
1859 date and time of the message in the format specified by
1860 $date_format converted to sender's time zone
1863 date and time of the message in the format specified by
1864 $date_format converted to the local time zone
1867 current message number in thread
1870 number of messages in current thread
1873 sender (address + real name), either From: or Return\-Path:
1876 author name, or recipient name if the message is from you
1879 spam attribute(s) of this message
1882 message\-id of the current message
1885 number of lines in the message (does not work with maildir,
1886 mh, and possibly IMAP folders)
1889 If an address in the \(lqTo:\(rq or \(lqCc:\(rq header field matches an address
1890 defined by the users \(lqsubscribe\(rq command, this displays
1891 \(rqTo <list\-name>\(rq, otherwise the same as %F.
1894 total number of message in the mailbox
1897 number of hidden messages if the thread is collapsed.
1903 author's real name (or address if missing)
1906 original save folder where mutt would formerly have
1907 stashed the message: list name or recipient name
1908 if not sent to a list
1911 progress indicator for the builtin pager (how much of the file has been displayed)
1914 subject of the message
1917 status of the message (\(lqN\(rq/\(lqD\(rq/\(lqd\(rq/\(lq!\(rq/\(lqr\(rq/*)
1920 \(lqTo:\(rq field (recipients)
1923 the appropriate character from the $to_chars string
1926 user (login) name of the author
1929 first name of the author, or the recipient if the message is from you
1932 number of attachments
1933 (please see the \(lqattachments\(rq section for possible speed effects)
1936 \(lqX\-Label:\(rq field, if present
1939 \(lqX\-Label:\(rq field, if present, and \fI(1)\fP not at part of a thread tree,
1940 \fI(2)\fP at the top of a thread, or \fI(3)\fP \(lqX\-Label:\(rq is different from
1941 preceding message's \(lqX\-Label:\(rq.
1944 message status flags
1947 the date and time of the message is converted to sender's
1948 time zone, and \(lqfmt\(rq is expanded by the library function
1949 \fCstrftime(3)\fP; a leading bang disables locales
1952 the date and time of the message is converted to the local
1953 time zone, and \(lqfmt\(rq is expanded by the library function
1954 \fCstrftime(3)\fP; a leading bang disables locales
1957 the local date and time when the message was received.
1958 \(lqfmt\(rq is expanded by the library function \fCstrftime(3)\fP;
1959 a leading bang disables locales
1962 the current local time. \(lqfmt\(rq is expanded by the library
1963 function \fCstrftime(3)\fP; a leading bang disables locales.
1966 right justify the rest of the string and pad with character \(lqX\(rq
1969 pad to the end of the line with character \(lqX\(rq
1972 soft\-fill with character \(lqX\(rq as pad
1976 \(lqSoft\-fill\(rq deserves some explanation: Normal right\-justification
1977 will print everything to the left of the \(lq%>\(rq, displaying padding and
1978 whatever lies to the right only if there's room. By contrast,
1979 soft\-fill gives priority to the right\-hand side, guaranteeing space
1980 to display it and showing padding only if there's still room. If
1981 necessary, soft\-fill will eat text leftwards to make room for
1984 Note that these expandos are supported in
1985 \(lqsave-hook\(rq, \(lqfcc-hook\(rq and \(lqfcc-save-hook\(rq, too.
1992 Default: \(lqispell\(rq
1995 How to invoke ispell (GNU's spell\-checking software).
2005 If \fIset\fP, read messages marked as flagged will not be moved
2006 from your spool mailbox to your $mbox mailbox, or as a result of
2007 a \(lqmbox-hook\(rq command.
2017 The locale used by \fCstrftime(3)\fP to format dates. Legal values are
2018 the strings your system accepts for the locale environment variable \fC$LC_TIME\fP.
2028 This variable configures how often (in seconds) mutt should look for
2029 new mail. Also see the $timeout variable.
2039 This variable specifies which files to consult when attempting to
2040 display MIME bodies not directly supported by Mutt.
2050 If \fIset\fP, mutt will restrict possible characters in mailcap % expandos
2051 to a well\-defined set of safe characters. This is the safe setting,
2052 but we are not sure it doesn't break some more advanced MIME stuff.
2054 \fBDON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE
2059 .B maildir_header_cache_verify
2065 Check for Maildir unaware programs other than mutt having modified maildir
2066 files when the header cache is in use. This incurs one \fCstat(2)\fP per
2067 message every time the folder is opened (which can be very slow for NFS
2078 If \fIset\fP, messages marked as deleted will be saved with the maildir
2079 trashed flag instead of unlinked. \fBNote:\fP this only applies
2080 to maildir\-style mailboxes. Setting it will have no effect on other
2091 Controls whether or not mutt marks \fInew\fP \fBunread\fP
2092 messages as \fIold\fP if you exit a mailbox without reading them.
2093 With this option \fIset\fP, the next time you start mutt, the messages
2094 will show up with an \(lqO\(rq next to them in the index menu,
2095 indicating that they are old.
2105 Controls the display of wrapped lines in the internal pager. If set, a
2106 \(lq+\(rq marker is displayed at the beginning of wrapped lines.
2108 Also see the $smart_wrap variable.
2114 Type: regular expression
2115 Default: \(lq!^\\.[^.]\(rq
2118 A regular expression used in the file browser, optionally preceded by
2119 the \fInot\fP operator \(lq!\(rq. Only files whose names match this mask
2120 will be shown. The match is always case\-sensitive.
2127 Default: \(lq~/mbox\(rq
2130 This specifies the folder into which read mail in your $spoolfile
2131 folder will be appended.
2133 Also see the $move variable.
2143 The default mailbox type used when creating new folders. May be any of
2144 \(lqmbox\(rq, \(lqMMDF\(rq, \(lqMH\(rq and \(lqMaildir\(rq. This is overriden by the
2145 \fC\-m\fP command\-line option.
2155 This variable controls the number of lines of context that are given
2156 when scrolling through menus. (Similar to $pager_context.)
2166 When \fIunset\fP, the bottom entry of menus will never scroll up past
2167 the bottom of the screen, unless there are less entries than lines.
2168 When \fIset\fP, the bottom entry may move off the bottom.
2178 When \fIset\fP, menus will be scrolled up or down one line when you
2179 attempt to move across a screen boundary. If \fIunset\fP, the screen
2180 is cleared and the next or previous page of the menu is displayed
2181 (useful for slow links to avoid many redraws).
2185 .B message_cache_clean
2191 If \fIset\fP, mutt will clean out obsolete entries from the message cache when
2192 the mailbox is synchronized. You probably only want to set it
2193 every once in a while, since it can be a little slow
2194 (especially for large folders).
2204 Set this to a directory and mutt will cache copies of messages from
2205 your IMAP and POP servers here. You are free to remove entries at any
2208 When setting this variable to a directory, mutt needs to fetch every
2209 remote message only once and can perform regular expression searches
2210 as fast as for local folders.
2212 Also see the $message_cache_clean variable.
2222 This is the string displayed in the \(lqattachment\(rq menu for
2223 attachments of type \fCmessage/rfc822\fP. For a full listing of defined
2224 \fCprintf(3)\fP\-like sequences see the section on $index_format.
2234 If \fIset\fP, forces Mutt to interpret keystrokes with the high bit (bit 8)
2235 set as if the user had pressed the Esc key and whatever key remains
2236 after having the high bit removed. For example, if the key pressed
2237 has an ASCII value of \fC0xf8\fP, then this is treated as if the user had
2238 pressed Esc then \(lqx\(rq. This is because the result of removing the
2239 high bit from \fC0xf8\fP is \fC0x78\fP, which is the ASCII character
2250 If \fIunset\fP, Mutt will remove your address (see the \(lqalternates\(rq
2251 command) from the list of recipients when replying to a message.
2261 When \fIunset\fP, mutt will mimic mh's behaviour and rename deleted messages
2262 to \fI,<old file name>\fP in mh folders instead of really deleting
2263 them. This leaves the message on disk but makes programs reading the folder
2264 ignore it. If the variable is \fIset\fP, the message files will simply be
2267 This option is similar to $maildir_trash for Maildir folders.
2274 Default: \(lqflagged\(rq
2277 The name of the MH sequence used for flagged messages.
2284 Default: \(lqreplied\(rq
2287 The name of the MH sequence used to tag replied messages.
2294 Default: \(lqunseen\(rq
2297 The name of the MH sequence used for unseen messages.
2307 When \fIset\fP, the message you are forwarding will be attached as a
2308 separate \fCmessage/rfc822\fP MIME part instead of included in the main body of the
2309 message. This is useful for forwarding MIME messages so the receiver
2310 can properly view the message as it was delivered to you. If you like
2311 to switch between MIME and not MIME from mail to mail, set this
2312 variable to \(lqask\-no\(rq or \(lqask\-yes\(rq.
2314 Also see $forward_decode and $mime_forward_decode.
2318 .B mime_forward_decode
2324 Controls the decoding of complex MIME messages into \fCtext/plain\fP when
2325 forwarding a message while $mime_forward is \fIset\fP. Otherwise
2326 $forward_decode is used instead.
2330 .B mime_forward_rest
2336 When forwarding multiple attachments of a MIME message from the attachment
2337 menu, attachments which cannot be decoded in a reasonable manner will
2338 be attached to the newly composed message if this option is \fIset\fP.
2345 Default: \(lq%4n %c %\-16s %a\(rq
2348 This variable describes the format of a remailer line on the mixmaster
2349 chain selection screen. The following \fCprintf(3)\fP\-like sequences are
2355 The running number on the menu.
2358 Remailer capabilities.
2361 The remailer's short name.
2364 The remailer's e\-mail address.
2372 Default: \(lqmixmaster\(rq
2375 This variable contains the path to the Mixmaster binary on your
2376 system. It is used with various sets of parameters to gather the
2377 list of known remailers, and to finally send a message through the
2388 Controls whether or not Mutt will move read messages
2389 from your spool mailbox to your $mbox mailbox, or as a result of
2390 a \(lqmbox-hook\(rq command.
2400 This variable, when \fIset\fP, makes the thread tree narrower, allowing
2401 deeper threads to fit on the screen.
2411 Operations that expect to transfer a large amount of data over the
2412 network will update their progress every $net_inc kilobytes.
2413 If set to 0, no progress messages will be displayed.
2415 See also $read_inc, $write_inc and $net_inc.
2422 Default: \(lqbuiltin\(rq
2425 This variable specifies which pager you would like to use to view
2426 messages. The value \(lqbuiltin\(rq means to use the builtin pager, otherwise this
2427 variable should specify the pathname of the external pager you would
2430 Using an external pager may have some disadvantages: Additional
2431 keystrokes are necessary because you can't call mutt functions
2432 directly from the pager, and screen resizes cause lines longer than
2433 the screen width to be badly formatted in the help menu.
2443 This variable controls the number of lines of context that are given
2444 when displaying the next or previous page in the internal pager. By
2445 default, Mutt will display the line after the last one on the screen
2446 at the top of the next page (0 lines of context).
2448 This variable also specifies the amount of context given for search
2449 results. If positive, this many lines will be given before a match,
2450 if 0, the match will be top\-aligned.
2457 Default: \(lq\-%Z\- %C/%m: %\-20.20n %s%* \-\- (%P)\(rq
2460 This variable controls the format of the one\-line message \(lqstatus\(rq
2461 displayed before each message in either the internal or an external
2462 pager. The valid sequences are listed in the $index_format
2467 .B pager_index_lines
2473 Determines the number of lines of a mini\-index which is shown when in
2474 the pager. The current message, unless near the top or bottom of the
2475 folder, will be roughly one third of the way down this mini\-index,
2476 giving the reader the context of a few messages before and after the
2477 message. This is useful, for example, to determine how many messages
2478 remain to be read in the current thread. One of the lines is reserved
2479 for the status bar from the index, so a setting of 6
2480 will only show 5 lines of the actual index. A value of 0 results in
2481 no index being shown. If the number of messages in the current folder
2482 is less than $pager_index_lines, then the index will only use as
2483 many lines as it needs.
2493 When \fIset\fP, the internal\-pager will \fBnot\fP move to the next message
2494 when you are at the end of a message and invoke the \fC<next\-page>\fP
2505 If \fIset\fP, mutt will automatically attempt to decrypt traditional PGP
2506 messages whenever the user performs an operation which ordinarily would
2507 result in the contents of the message being operated on. For example,
2508 if the user displays a pgp\-traditional message which has not been manually
2509 checked with the \fC<check-traditional-pgp>\fP function, mutt will automatically
2510 check the message for traditional pgp.
2520 This option controls whether Mutt generates old\-style inline
2521 (traditional) PGP encrypted or signed messages under certain
2522 circumstances. This can be overridden by use of the pgp menu,
2523 when inline is not required.
2525 Note that Mutt might automatically use PGP/MIME for messages
2526 which consist of more than a single MIME part. Mutt can be
2527 configured to ask before sending PGP/MIME messages when inline
2528 (traditional) would not work.
2530 Also see the $pgp_mime_auto variable.
2532 Also note that using the old\-style PGP message format is \fBstrongly\fP
2544 If \fIset\fP, mutt will check the exit code of the PGP subprocess when
2545 signing or encrypting. A non\-zero exit code means that the
2551 .B pgp_clearsign_command
2557 This format is used to create an old\-style \(lqclearsigned\(rq PGP
2558 message. Note that the use of this format is \fBstrongly\fP
2561 This is a format string, see the $pgp_decode_command command for
2562 possible \fCprintf(3)\fP\-like sequences.
2567 .B pgp_decode_command
2573 This format strings specifies a command which is used to decode
2574 application/pgp attachments.
2576 The PGP command formats have their own set of \fCprintf(3)\fP\-like sequences:
2581 Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty
2582 string otherwise. Note: This may be used with a %? construct.
2585 Expands to the name of a file containing a message.
2588 Expands to the name of a file containing the signature part
2589 of a \fCmultipart/signed\fP attachment when verifying it.
2592 The value of $pgp_sign_as.
2595 One or more key IDs.
2599 For examples on how to configure these formats for the various versions
2600 of PGP which are floating around, see the pgp and gpg sample configuration files in
2601 the \fCsamples/\fP subdirectory which has been installed on your system
2602 alongside the documentation.
2607 .B pgp_decrypt_command
2613 This command is used to decrypt a PGP encrypted message.
2615 This is a format string, see the $pgp_decode_command command for
2616 possible \fCprintf(3)\fP\-like sequences.
2621 .B pgp_encrypt_only_command
2627 This command is used to encrypt a body part without signing it.
2629 This is a format string, see the $pgp_decode_command command for
2630 possible \fCprintf(3)\fP\-like sequences.
2635 .B pgp_encrypt_sign_command
2641 This command is used to both sign and encrypt a body part.
2643 This is a format string, see the $pgp_decode_command command for
2644 possible \fCprintf(3)\fP\-like sequences.
2652 Default: \(lq%4n %t%f %4l/0x%k %\-4a %2c %u\(rq
2655 This variable allows you to customize the PGP key selection menu to
2656 your personal taste. This string is similar to $index_format, but
2657 has its own set of \fCprintf(3)\fP\-like sequences:
2683 trust/validity of the key\-uid association
2686 date of the key where <s> is an \fCstrftime(3)\fP expression
2694 .B pgp_export_command
2700 This command is used to export a public key from the user's
2703 This is a format string, see the $pgp_decode_command command for
2704 possible \fCprintf(3)\fP\-like sequences.
2709 .B pgp_getkeys_command
2715 This command is invoked whenever mutt will need public key information.
2716 Of the sequences supported by $pgp_decode_command, %r is the only
2717 \fCprintf(3)\fP\-like sequence used with this format.
2724 Type: regular expression
2728 If you assign a text to this variable, then a PGP signature is only
2729 considered verified if the output from $pgp_verify_command contains
2730 the text. Use this variable if the exit code from the command is 0
2731 even for bad signatures.
2736 .B pgp_ignore_subkeys
2742 Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead,
2743 the principal key will inherit the subkeys' capabilities. \fIUnset\fP this
2744 if you want to play interesting key selection games.
2749 .B pgp_import_command
2755 This command is used to import a key from a message into
2756 the user's public key ring.
2758 This is a format string, see the $pgp_decode_command command for
2759 possible \fCprintf(3)\fP\-like sequences.
2764 .B pgp_list_pubring_command
2770 This command is used to list the public key ring's contents. The
2771 output format must be analogous to the one used by
2778 gpg \-\-list\-keys \-\-with\-colons.
2785 This format is also generated by the \fCpgpring\fP utility which comes
2788 This is a format string, see the $pgp_decode_command command for
2789 possible \fCprintf(3)\fP\-like sequences.
2794 .B pgp_list_secring_command
2800 This command is used to list the secret key ring's contents. The
2801 output format must be analogous to the one used by:
2808 gpg \-\-list\-keys \-\-with\-colons.
2815 This format is also generated by the \fCpgpring\fP utility which comes
2818 This is a format string, see the $pgp_decode_command command for
2819 possible \fCprintf(3)\fP\-like sequences.
2830 If \fIset\fP, use 64 bit PGP key IDs, if \fIunset\fP use the normal 32 bit key IDs.
2841 This option controls whether Mutt will prompt you for
2842 automatically sending a (signed/encrypted) message using
2843 PGP/MIME when inline (traditional) fails (for any reason).
2845 Also note that using the old\-style PGP message format is \fBstrongly\fP
2857 Setting this variable will cause Mutt to always attempt to
2858 create an inline (traditional) message when replying to a
2859 message which is PGP encrypted/signed inline. This can be
2860 overridden by use of the pgp menu, when inline is not
2861 required. This option does not automatically detect if the
2862 (replied\-to) message is inline; instead it relies on Mutt
2863 internals for previously checked/flagged messages.
2865 Note that Mutt might automatically use PGP/MIME for messages
2866 which consist of more than a single MIME part. Mutt can be
2867 configured to ask before sending PGP/MIME messages when inline
2868 (traditional) would not work.
2870 Also see the $pgp_mime_auto variable.
2872 Also note that using the old\-style PGP message format is \fBstrongly\fP
2878 .B pgp_retainable_sigs
2884 If \fIset\fP, signed and encrypted messages will consist of nested
2885 \fCmultipart/signed\fP and \fCmultipart/encrypted\fP body parts.
2887 This is useful for applications like encrypted and signed mailing
2888 lists, where the outer layer (\fCmultipart/encrypted\fP) can be easily
2889 removed, while the inner \fCmultipart/signed\fP part is retained.
2894 .B pgp_show_unusable
2900 If \fIset\fP, mutt will display non\-usable keys on the PGP key selection
2901 menu. This includes keys which have been revoked, have expired, or
2902 have been marked as \(lqdisabled\(rq by the user.
2913 If you have more than one key pair, this option allows you to specify
2914 which of your private keys to use. It is recommended that you use the
2915 keyid form to specify your key (e.g. \fC0x00112233\fP).
2926 This command is used to create the detached PGP signature for a
2927 \fCmultipart/signed\fP PGP/MIME body part.
2929 This is a format string, see the $pgp_decode_command command for
2930 possible \fCprintf(3)\fP\-like sequences.
2941 Specifies how the entries in the pgp menu are sorted. The
2942 following are legal values:
2947 sort alphabetically by user id
2950 sort alphabetically by key id
2953 sort by key creation date
2956 sort by the trust of the key
2960 If you prefer reverse order of the above values, prefix it with
2972 If \fIset\fP, Mutt will automatically encode PGP/MIME signed messages as
2973 quoted\-printable. Please note that unsetting this variable may
2974 lead to problems with non\-verifyable PGP signatures, so only change
2975 this if you know what you are doing.
2986 The number of seconds after which a cached passphrase will expire if
2992 .B pgp_use_gpg_agent
2998 If \fIset\fP, mutt will use a possibly\-running \fCgpg\-agent(1)\fP process.
3003 .B pgp_verify_command
3009 This command is used to verify PGP signatures.
3011 This is a format string, see the $pgp_decode_command command for
3012 possible \fCprintf(3)\fP\-like sequences.
3017 .B pgp_verify_key_command
3023 This command is used to verify key information from the key selection
3026 This is a format string, see the $pgp_decode_command command for
3027 possible \fCprintf(3)\fP\-like sequences.
3038 Used in connection with the \fC<pipe\-message>\fP command. When \fIunset\fP,
3039 Mutt will pipe the messages without any preprocessing. When \fIset\fP, Mutt
3040 will weed headers and will attempt to decode the messages
3048 Default: \(lq\\n\(rq
3051 The separator to add between messages when piping a list of tagged
3052 messages to an external Unix command.
3062 Used in connection with the \fC<pipe\-message>\fP function following
3063 \fC<tag\-prefix>\fP. If this variable is \fIunset\fP, when piping a list of
3064 tagged messages Mutt will concatenate the messages and will pipe them
3065 all concatenated. When \fIset\fP, Mutt will pipe the messages one by one.
3066 In both cases the messages are piped in the current sorted order,
3067 and the $pipe_sep separator is added after each message.
3077 If \fIset\fP, Mutt will try all available authentication methods.
3078 When \fIunset\fP, Mutt will only fall back to other authentication
3079 methods if the previous methods are unavailable. If a method is
3080 available but authentication fails, Mutt will not connect to the POP server.
3084 .B pop_authenticators
3090 This is a colon\-delimited list of authentication methods mutt may
3091 attempt to use to log in to an POP server, in the order mutt should
3092 try them. Authentication methods are either \(lquser\(rq, \(lqapop\(rq or any
3093 SASL mechanism, eg \(lqdigest\-md5\(rq, \(lqgssapi\(rq or \(lqcram\-md5\(rq.
3094 This option is case\-insensitive. If this option is \fIunset\fP
3095 (the default) mutt will try all available methods, in order from
3096 most\-secure to least\-secure.
3105 set pop_authenticators=\(rqdigest\-md5:apop:user\(rq
3114 .B pop_checkinterval
3120 This variable configures how often (in seconds) mutt should look for
3121 new mail in the currently selected mailbox if it is a POP mailbox.
3131 If \fIset\fP, Mutt will delete successfully downloaded messages from the POP
3132 server when using the \fC<fetch-mail>\fP function. When \fIunset\fP, Mutt will
3133 download messages but also leave them on the POP server.
3143 The name of your POP server for the \fC<fetch-mail>\fP function. You
3144 can also specify an alternative port, username and password, ie:
3151 [pop[s]://][username[:password]@]popserver[:port]
3158 where \(lq[...]\(rq denotes an optional part.
3168 If this variable is \fIset\fP, mutt will try to use the \(lq\fCLAST\fP\(rq POP command
3169 for retrieving only unread messages from the POP server when using
3170 the \fC<fetch-mail>\fP function.
3180 Specifies the password for your POP account. If \fIunset\fP, Mutt will
3181 prompt you for your password when you open a POP mailbox.
3183 \fBWarning\fP: you should only use this option when you are on a
3184 fairly secure machine, because the superuser can read your muttrc
3185 even if you are the only one who can read the file.
3195 Controls whether or not Mutt will try to reconnect to the POP server if
3196 the connection is lost.
3206 Your login name on the POP server.
3208 This variable defaults to your user name on the local machine.
3212 .B post_indent_string
3218 Similar to the $attribution variable, Mutt will append this
3219 string after the inclusion of a message which is being replied to.
3229 Controls whether or not messages are saved in the $postponed
3230 mailbox when you elect not to send immediately.
3232 Also see the $recall variable.
3239 Default: \(lq~/postponed\(rq
3242 Mutt allows you to indefinitely \(lqpostpone sending a message\(rq which
3243 you are editing. When you choose to postpone a message, Mutt saves it
3244 in the mailbox specified by this variable.
3246 Also see the $postpone variable.
3256 If \fIset\fP, a shell command to be executed if mutt fails to establish
3257 a connection to the server. This is useful for setting up secure
3258 connections, e.g. with \fCssh(1)\fP. If the command returns a nonzero
3259 status, mutt gives up opening the server. Example:
3266 set preconnect=\(rqssh \-f \-q \-L 1234:mailhost.net:143 mailhost.net \\
3267 sleep 20 < /dev/null > /dev/null\(rq
3274 Mailbox \(lqfoo\(rq on \(lqmailhost.net\(rq can now be reached
3275 as \(lq{localhost:1234}foo\(rq.
3277 Note: For this example to work, you must be able to log in to the
3278 remote machine without having to enter a password.
3288 Controls whether or not Mutt really prints messages.
3289 This is set to \(lqask\-no\(rq by default, because some people
3290 accidentally hit \(lqp\(rq often.
3297 Default: \(lqlpr\(rq
3300 This specifies the command pipe that should be used to print messages.
3310 Used in connection with the \fC<print\-message>\fP command. If this
3311 option is \fIset\fP, the message is decoded before it is passed to the
3312 external command specified by $print_command. If this option
3313 is \fIunset\fP, no processing will be applied to the message when
3314 printing it. The latter setting may be useful if you are using
3315 some advanced printer filter which is able to properly format
3316 e\-mail messages for printing.
3326 Used in connection with the \fC<print\-message>\fP command. If this option
3327 is \fIset\fP, the command specified by $print_command is executed once for
3328 each message which is to be printed. If this option is \fIunset\fP,
3329 the command specified by $print_command is executed only once, and
3330 all the messages are concatenated, with a form feed as the message
3333 Those who use the \fCenscript\fP(1) program's mail\-printing mode will
3334 most likely want to \fIset\fP this option.
3344 If you use an \fIexternal\fP $pager, setting this variable will
3345 cause Mutt to prompt you for a command when the pager exits rather
3346 than returning to the index menu. If \fIunset\fP, Mutt will return to the
3347 index menu when the external pager exits.
3357 This specifies the command that mutt will use to make external address
3358 queries. The string should contain a \(lq%s\(rq, which will be substituted
3359 with the query string the user types. See \(lqquery\(rq for more
3367 Default: \(lq%4c %t %\-25.25a %\-25.25n %?e?(%e)?\(rq
3370 This variable describes the format of the \(lqquery\(rq menu. The
3371 following \fCprintf(3)\fP\-style sequences are understood:
3379 current entry number
3388 \(lq*\(rq if current entry is tagged, a space otherwise
3391 right justify the rest of the string and pad with \(lqX\(rq
3394 pad to the end of the line with \(lqX\(rq
3397 soft\-fill with character \(lqX\(rq as pad
3401 For an explanation of \(lqsoft\-fill\(rq, see the $index_format documentation.
3403 * = can be optionally printed if nonzero, see the $status_format documentation.
3413 This variable controls whether \(lqquit\(rq and \(lqexit\(rq actually quit
3414 from mutt. If this option is \fIset\fP, they do quit, if it is \fIunset\fP, they
3415 have no effect, and if it is set to \fIask\-yes\fP or \fIask\-no\fP, you are
3416 prompted for confirmation when you try to quit.
3422 Type: regular expression
3423 Default: \(lq^([ \\t]*[|>:}#])+\(rq
3426 A regular expression used in the internal pager to determine quoted
3427 sections of text in the body of a message. Quoted text may be filtered
3428 out using the \fC<toggle\-quoted>\fP command, or colored according to the
3429 \(lqcolor quoted\(rq family of directives.
3431 Higher levels of quoting may be colored differently (\(lqcolor quoted1\(rq,
3432 \(lqcolor quoted2\(rq, etc.). The quoting level is determined by removing
3433 the last character from the matched text and recursively reapplying
3434 the regular expression until it fails to produce a match.
3436 Match detection may be overridden by the $smileys regular expression.
3446 If set to a value greater than 0, Mutt will display which message it
3447 is currently on when reading a mailbox or when performing search actions
3448 such as search and limit. The message is printed after
3449 this many messages have been read or searched (e.g., if set to 25, Mutt will
3450 print a message when it is at message 25, and then again when it gets
3451 to message 50). This variable is meant to indicate progress when
3452 reading or searching large mailboxes which may take some time.
3453 When set to 0, only a single message will appear before the reading
3456 Also see the $write_inc, $net_inc and $time_inc variables and the
3457 \(lqtuning\(rq section of the manual for performance considerations.
3467 If \fIset\fP, all folders are opened in read\-only mode.
3477 This variable specifies what \(lqreal\(rq or \(lqpersonal\(rq name should be used
3478 when sending messages.
3480 By default, this is the GECOS field from \fC/etc/passwd\fP. Note that this
3481 variable will \fInot\fP be used when the user has set a real name
3482 in the $from variable.
3492 Controls whether or not Mutt recalls postponed messages
3493 when composing a new message.
3495 \fISetting\fP this variable to is not generally useful, and thus not
3498 Also see $postponed variable.
3505 Default: \(lq~/sent\(rq
3508 This specifies the file into which your outgoing messages should be
3509 appended. (This is meant as the primary method for saving a copy of
3510 your messages, but another way to do this is using the \(lqmy_hdr\(rq
3511 command to create a \(lqBcc:\(rq field with your email address in it.)
3513 The value of \fI$record\fP is overridden by the $force_name and
3514 $save_name variables, and the \(lqfcc-hook\(rq command.
3520 Type: regular expression
3521 Default: \(lq^(re([\\[0\-9\\]+])*|aw):[ \\t]*\(rq
3524 A regular expression used to recognize reply messages when threading
3525 and replying. The default value corresponds to the English \(rqRe:\(rq and
3526 the German \(rqAw:\(rq.
3536 If \fIunset\fP and you are replying to a message sent by you, Mutt will
3537 assume that you want to reply to the recipients of that message rather
3540 Also see the \(lqalternates\(rq command.
3550 If \fIset\fP, when replying to a message, Mutt will use the address listed
3551 in the Reply\-to: header as the recipient of the reply. If \fIunset\fP,
3552 it will use the address in the From: header field instead. This
3553 option is useful for reading a mailing list that sets the Reply\-To:
3554 header field to the list address and you want to send a private
3555 message to the author of a message.
3565 When \fIset\fP, the cursor will be automatically advanced to the next
3566 (possibly undeleted) message whenever a command that modifies the
3567 current message is executed.
3577 This variable controls whether or not Mutt will display the \(lqpersonal\(rq
3578 name from your aliases in the index menu if it finds an alias that
3579 matches the message's sender. For example, if you have the following
3587 alias juser abd30425@somewhere.net (Joe User)
3594 and then you receive mail which contains the following header:
3601 From: abd30425@somewhere.net
3608 It would be displayed in the index menu as \(lqJoe User\(rq instead of
3609 \(lqabd30425@somewhere.net.\(rq This is useful when the person's e\-mail
3610 address is not human friendly.
3620 It may sometimes arrive that you receive mail to a certain machine,
3621 move the messages to another machine, and reply to some the messages
3622 from there. If this variable is \fIset\fP, the default \fIFrom:\fP line of
3623 the reply messages is built using the address where you received the
3624 messages you are replying to \fBif\fP that address matches your
3625 \(lqalternates\(rq. If the variable is \fIunset\fP, or the address that would be
3626 used doesn't match your \(lqalternates\(rq, the \fIFrom:\fP line will use
3627 your address on the current machine.
3629 Also see the \(lqalternates\(rq command.
3639 This variable fine\-tunes the behaviour of the $reverse_name feature.
3640 When it is \fIset\fP, mutt will use the address from incoming messages as\-is,
3641 possibly including eventual real names. When it is \fIunset\fP, mutt will
3642 override any such real names with the setting of the $realname variable.
3646 .B rfc2047_parameters
3652 When this variable is \fIset\fP, Mutt will decode RFC2047\-encoded MIME
3653 parameters. You want to set this variable when mutt suggests you
3654 to save attachments to files named like:
3661 =?iso\-8859\-1?Q?file=5F=E4=5F991116=2Ezip?=
3668 When this variable is \fIset\fP interactively, the change won't be
3669 active until you change folders.
3671 Note that this use of RFC2047's encoding is explicitly
3672 prohibited by the standard, but nevertheless encountered in the
3675 Also note that setting this parameter will \fInot\fP have the effect
3676 that mutt \fIgenerates\fP this kind of encoding. Instead, mutt will
3677 unconditionally use the encoding specified in RFC2231.
3687 If \fIset\fP, mutt will take the sender's full address when choosing a
3688 default folder for saving a mail. If $save_name or $force_name
3689 is \fIset\fP too, the selection of the Fcc folder will be changed as well.
3699 When \fIunset\fP, mailboxes which contain no saved messages will be removed
3700 when closed (the exception is $spoolfile which is never removed).
3701 If \fIset\fP, mailboxes are never removed.
3703 \fBNote:\fP This only applies to mbox and MMDF folders, Mutt does not
3704 delete MH and Maildir directories.
3714 This variable controls the size of the history (per category) saved in the
3725 This variable controls how copies of outgoing messages are saved.
3726 When \fIset\fP, a check is made to see if a mailbox specified by the
3727 recipient address exists (this is done by searching for a mailbox in
3728 the $folder directory with the \fIusername\fP part of the
3729 recipient address). If the mailbox exists, the outgoing message will
3730 be saved to that mailbox, otherwise the message is saved to the
3733 Also see the $force_name variable.
3743 When this variable is \fIunset\fP, scoring is turned off. This can
3744 be useful to selectively disable scoring for certain folders when the
3745 $score_threshold_delete variable and related are used.
3749 .B score_threshold_delete
3755 Messages which have been assigned a score equal to or lower than the value
3756 of this variable are automatically marked for deletion by mutt. Since
3757 mutt scores are always greater than or equal to zero, the default setting
3758 of this variable will never mark a message for deletion.
3762 .B score_threshold_flag
3768 Messages which have been assigned a score greater than or equal to this
3769 variable's value are automatically marked \(rqflagged\(rq.
3773 .B score_threshold_read
3779 Messages which have been assigned a score equal to or lower than the value
3780 of this variable are automatically marked as read by mutt. Since
3781 mutt scores are always greater than or equal to zero, the default setting
3782 of this variable will never mark a message read.
3792 For the pager, this variable specifies the number of lines shown
3793 before search results. By default, search results will be top\-aligned.
3800 Default: \(lqus\-ascii:iso\-8859\-1:utf\-8\(rq
3803 A colon\-delimited list of character sets for outgoing messages. Mutt will use the
3804 first character set into which the text can be converted exactly.
3805 If your $charset is not \(lqiso\-8859\-1\(rq and recipients may not
3806 understand \(lqUTF\-8\(rq, it is advisable to include in the list an
3807 appropriate widely used standard character set (such as
3808 \(lqiso\-8859\-2\(rq, \(lqkoi8\-r\(rq or \(lqiso\-2022\-jp\(rq) either instead of or after
3809 \(lqiso\-8859\-1\(rq.
3811 In case the text cannot be converted into one of these exactly,
3812 mutt uses $charset as a fallback.
3819 Default: \(lq/usr/sbin/sendmail \-oem \-oi\(rq
3822 Specifies the program and arguments used to deliver mail sent by Mutt.
3823 Mutt expects that the specified program interprets additional
3824 arguments as recipient addresses.
3834 Specifies the number of seconds to wait for the $sendmail process
3835 to finish before giving up and putting delivery in the background.
3837 Mutt interprets the value of this variable as follows:
3842 number of seconds to wait for sendmail to finish before continuing
3845 wait forever for sendmail to finish
3848 always put sendmail in the background without waiting
3852 Note that if you specify a value other than 0, the output of the child
3853 process will be put in a temporary file. If there is some error, you
3854 will be informed as to where to find the output.
3864 Command to use when spawning a subshell. By default, the user's login
3865 shell from \fC/etc/passwd\fP is used.
3875 If \fIset\fP, a line containing \(lq\-\- \(rq (note the trailing space) will be inserted before your
3876 $signature. It is \fBstrongly\fP recommended that you not \fIunset\fP
3877 this variable unless your signature contains just your name. The
3878 reason for this is because many software packages use \(lq\-\- \\n\(rq to
3879 detect your signature. For example, Mutt has the ability to highlight
3880 the signature in a different color in the builtin pager.
3890 If \fIset\fP, the signature will be included before any quoted or forwarded
3891 text. It is \fBstrongly\fP recommended that you do not set this variable
3892 unless you really know what you are doing, and are prepared to take
3893 some heat from netiquette guardians.
3900 Default: \(lq~/.signature\(rq
3903 Specifies the filename of your signature, which is appended to all
3904 outgoing messages. If the filename ends with a pipe (\(lq|\(rq), it is
3905 assumed that filename is a shell command and input should be read from
3906 its standard output.
3913 Default: \(lq~f %s | ~s %s\(rq
3916 Specifies how Mutt should expand a simple search into a real search
3917 pattern. A simple search is one that does not contain any of the \(lq~\(rq pattern
3918 operators. See \(lqpatterns\(rq for more information on search patterns.
3920 For example, if you simply type \(lqjoe\(rq at a search or limit prompt, Mutt
3921 will automatically expand it to the value specified by this variable by
3922 replacing \(lq%s\(rq with the supplied string.
3923 For the default value, \(lqjoe\(rq would be expanded to: \(lq~f joe | ~s joe\(rq.
3933 Specifies time, in seconds, to pause while displaying certain informational
3934 messages, while moving from folder to folder and after expunging
3935 messages from the current folder. The default is to pause one second, so
3936 a value of zero for this option suppresses the pause.
3946 Controls the display of lines longer than the screen width in the
3947 internal pager. If \fIset\fP, long lines are wrapped at a word boundary. If
3948 \fIunset\fP, lines are simply wrapped at the screen edge. Also see the
3955 Type: regular expression
3956 Default: \(lq(>From )|(:[\-^]?[][)(><}{|/DP])\(rq
3959 The \fIpager\fP uses this variable to catch some common false
3960 positives of $quote_regexp, most notably smileys and not consider
3961 a line quoted text if it also matches $smileys. This mostly
3962 happens at the beginning of a line.
3966 .B smime_ask_cert_label
3972 This flag controls whether you want to be asked to enter a label
3973 for a certificate about to be added to the database or not. It is
3974 \fIset\fP by default.
3979 .B smime_ca_location
3985 This variable contains the name of either a directory, or a file which
3986 contains trusted certificates for use with OpenSSL.
3991 .B smime_certificates
3997 Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
3998 storage and retrieval of keys by itself. This is very basic right
3999 now, and keys and certificates are stored in two different
4000 directories, both named as the hash\-value retrieved from
4001 OpenSSL. There is an index file which contains mailbox\-address
4002 keyid pairs, and which can be manually edited. This option points to
4003 the location of the certificates.
4008 .B smime_decrypt_command
4014 This format string specifies a command which is used to decrypt
4015 \fCapplication/x\-pkcs7\-mime\fP attachments.
4017 The OpenSSL command formats have their own set of \fCprintf(3)\fP\-like sequences
4023 Expands to the name of a file containing a message.
4026 Expands to the name of a file containing the signature part
4027 of a \fCmultipart/signed\fP attachment when verifying it.
4030 The key\-pair specified with $smime_default_key
4033 One or more certificate IDs.
4036 The algorithm used for encryption.
4039 CA location: Depending on whether $smime_ca_location
4040 points to a directory or file, this expands to
4041 \(lq\-CApath $smime_ca_location\(rq or \(lq\-CAfile $smime_ca_location\(rq.
4045 For examples on how to configure these formats, see the \fCsmime.rc\fP in
4046 the \fCsamples/\fP subdirectory which has been installed on your system
4047 alongside the documentation.
4052 .B smime_decrypt_use_default_key
4058 If \fIset\fP (default) this tells mutt to use the default key for decryption. Otherwise,
4059 if managing multiple certificate\-key\-pairs, mutt will try to use the mailbox\-address
4060 to determine the key to use. It will ask you to supply a key, if it can't find one.
4065 .B smime_default_key
4071 This is the default key\-pair to use for signing. This must be set to the
4072 keyid (the hash\-value that OpenSSL generates) to work properly
4077 .B smime_encrypt_command
4083 This command is used to create encrypted S/MIME messages.
4085 This is a format string, see the $smime_decrypt_command command for
4086 possible \fCprintf(3)\fP\-like sequences.
4091 .B smime_encrypt_with
4097 This sets the algorithm that should be used for encryption.
4098 Valid choices are \(lqdes\(rq, \(lqdes3\(rq, \(lqrc2\-40\(rq, \(lqrc2\-64\(rq, \(lqrc2\-128\(rq.
4099 If \fIunset\fP, \(lq3des\(rq (TripleDES) is used.
4104 .B smime_get_cert_command
4110 This command is used to extract X509 certificates from a PKCS7 structure.
4112 This is a format string, see the $smime_decrypt_command command for
4113 possible \fCprintf(3)\fP\-like sequences.
4118 .B smime_get_cert_email_command
4124 This command is used to extract the mail address(es) used for storing
4125 X509 certificates, and for verification purposes (to check whether the
4126 certificate was issued for the sender's mailbox).
4128 This is a format string, see the $smime_decrypt_command command for
4129 possible \fCprintf(3)\fP\-like sequences.
4134 .B smime_get_signer_cert_command
4140 This command is used to extract only the signers X509 certificate from a S/MIME
4141 signature, so that the certificate's owner may get compared to the
4142 email's \(lqFrom:\(rq field.
4144 This is a format string, see the $smime_decrypt_command command for
4145 possible \fCprintf(3)\fP\-like sequences.
4150 .B smime_import_cert_command
4156 This command is used to import a certificate via smime_keys.
4158 This is a format string, see the $smime_decrypt_command command for
4159 possible \fCprintf(3)\fP\-like sequences.
4170 The default behaviour of mutt is to use PGP on all auto\-sign/encryption
4171 operations. To override and to use OpenSSL instead this must be \fIset\fP.
4172 However, this has no effect while replying, since mutt will automatically
4173 select the same application that was used to sign/encrypt the original
4174 message. (Note that this variable can be overridden by unsetting $crypt_autosmime.)
4185 Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
4186 storage and retrieval of keys/certs by itself. This is very basic right now,
4187 and stores keys and certificates in two different directories, both
4188 named as the hash\-value retrieved from OpenSSL. There is an index file
4189 which contains mailbox\-address keyid pair, and which can be manually
4190 edited. This option points to the location of the private keys.
4195 .B smime_pk7out_command
4201 This command is used to extract PKCS7 structures of S/MIME signatures,
4202 in order to extract the public X509 certificate(s).
4204 This is a format string, see the $smime_decrypt_command command for
4205 possible \fCprintf(3)\fP\-like sequences.
4210 .B smime_sign_command
4216 This command is used to created S/MIME signatures of type
4217 \fCmultipart/signed\fP, which can be read by all mail clients.
4219 This is a format string, see the $smime_decrypt_command command for
4220 possible \fCprintf(3)\fP\-like sequences.
4225 .B smime_sign_opaque_command
4231 This command is used to created S/MIME signatures of type
4232 \fCapplication/x\-pkcs7\-signature\fP, which can only be handled by mail
4233 clients supporting the S/MIME extension.
4235 This is a format string, see the $smime_decrypt_command command for
4236 possible \fCprintf(3)\fP\-like sequences.
4247 The number of seconds after which a cached passphrase will expire if
4253 .B smime_verify_command
4259 This command is used to verify S/MIME signatures of type \fCmultipart/signed\fP.
4261 This is a format string, see the $smime_decrypt_command command for
4262 possible \fCprintf(3)\fP\-like sequences.
4267 .B smime_verify_opaque_command
4273 This command is used to verify S/MIME signatures of type
4274 \fCapplication/x\-pkcs7\-mime\fP.
4276 This is a format string, see the $smime_decrypt_command command for
4277 possible \fCprintf(3)\fP\-like sequences.
4282 .B smtp_authenticators
4288 This is a colon\-delimited list of authentication methods mutt may
4289 attempt to use to log in to an SMTP server, in the order mutt should
4290 try them. Authentication methods are any SASL mechanism, eg
4291 \(lqdigest\-md5\(rq, \(lqgssapi\(rq or \(lqcram\-md5\(rq.
4292 This option is case\-insensitive. If it is \(lqunset\(rq
4293 (the default) mutt will try all available methods, in order from
4294 most\-secure to least\-secure.
4303 set smtp_authenticators=\(rqdigest\-md5:cram\-md5\(rq
4318 Specifies the password for your SMTP account. If \fIunset\fP, Mutt will
4319 prompt you for your password when you first send mail via SMTP.
4320 See $smtp_url to configure mutt to send mail via SMTP.
4322 \fBWarning\fP: you should only use this option when you are on a
4323 fairly secure machine, because the superuser can read your muttrc even
4324 if you are the only one who can read the file.
4334 Defines the SMTP smarthost where sent messages should relayed for
4335 delivery. This should take the form of an SMTP URL, eg:
4342 smtp[s]://[user[:pass]@]host[:port]/
4349 where \(lq[...]\(rq denotes an optional part.
4350 Setting this variable overrides the value of the $sendmail
4361 Specifies how to sort messages in the \(lqindex\(rq menu. Valid values
4366 \(hy date or date\-sent
4372 \(hy mailbox\-order (unsorted)
4388 You may optionally use the \(lqreverse\-\(rq prefix to specify reverse sorting
4389 order (example: \(lq\fCset sort=reverse\-date\-sent\fP\(rq).
4399 Specifies how the entries in the \(lqalias\(rq menu are sorted. The
4400 following are legal values:
4404 \(hy address (sort alphabetically by email address)
4406 \(hy alias (sort alphabetically by alias name)
4408 \(hy unsorted (leave in order specified in .muttrc)
4419 When sorting by threads, this variable controls how threads are sorted
4420 in relation to other threads, and how the branches of the thread trees
4421 are sorted. This can be set to any value that $sort can, except
4422 \(lqthreads\(rq (in that case, mutt will just use \(lqdate\-sent\(rq). You can also
4423 specify the \(lqlast\-\(rq prefix in addition to the \(lqreverse\-\(rq prefix, but \(lqlast\-\(rq
4424 must come after \(lqreverse\-\(rq. The \(lqlast\-\(rq prefix causes messages to be
4425 sorted against its siblings by which has the last descendant, using
4426 the rest of $sort_aux as an ordering. For instance,
4433 set sort_aux=last\-date\-received
4440 would mean that if a new message is received in a
4441 thread, that thread becomes the last one displayed (or the first, if
4442 you have \(lq\fCset sort=reverse\-threads\fP\(rq.)
4444 Note: For reversed $sort
4445 order $sort_aux is reversed again (which is not the right thing to do,
4446 but kept to not break any existing configuration setting).
4456 Specifies how to sort entries in the file browser. By default, the
4457 entries are sorted alphabetically. Valid values:
4461 \(hy alpha (alphabetically)
4471 You may optionally use the \(lqreverse\-\(rq prefix to specify reverse sorting
4472 order (example: \(lq\fCset sort_browser=reverse\-date\fP\(rq).
4482 This variable is only useful when sorting by threads with
4483 $strict_threads \fIunset\fP. In that case, it changes the heuristic
4484 mutt uses to thread messages by subject. With $sort_re \fIset\fP, mutt will
4485 only attach a message as the child of another message by subject if
4486 the subject of the child message starts with a substring matching the
4487 setting of $reply_regexp. With $sort_re \fIunset\fP, mutt will attach
4488 the message whether or not this is the case, as long as the
4489 non\-$reply_regexp parts of both messages are identical.
4499 This variable controls what happens when multiple spam headers
4500 are matched: if \fIunset\fP, each successive header will overwrite any
4501 previous matches value for the spam label. If \fIset\fP, each successive
4502 match will append to the previous, using this variable's value as a
4513 If your spool mailbox is in a non\-default place where Mutt cannot find
4514 it, you can specify its location with this variable. Mutt will
4515 initially set this variable to the value of the environment
4516 variable \fC$MAIL\fP or \fC$MAILDIR\fP if either is defined.
4520 .B ssl_ca_certificates_file
4526 This variable specifies a file containing trusted CA certificates.
4527 Any server certificate that is signed with one of these CA
4528 certificates is also automatically accepted.
4537 set ssl_ca_certificates_file=/etc/ssl/certs/ca\-certificates.crt
4552 The file containing a client certificate and its associated private
4563 If this variable is \fIset\fP, Mutt will require that all connections
4564 to remote servers be encrypted. Furthermore it will attempt to
4565 negotiate TLS even if the server does not advertise the capability,
4566 since it would otherwise have to abort the connection anyway. This
4567 option supersedes $ssl_starttls.
4571 .B ssl_min_dh_prime_bits
4577 This variable specifies the minimum acceptable prime size (in bits)
4578 for use in any Diffie\-Hellman key exchange. A value of 0 will use
4579 the default from the GNUTLS library.
4589 If \fIset\fP (the default), mutt will attempt to use \fCSTARTTLS\fP on servers
4590 advertising the capability. When \fIunset\fP, mutt will not attempt to
4591 use \fCSTARTTLS\fP regardless of the server's capabilities.
4601 This variable specifies whether to attempt to use SSLv2 in the
4602 SSL authentication process.
4612 This variable specifies whether to attempt to use SSLv3 in the
4613 SSL authentication process.
4623 This variable specifies whether to attempt to use TLSv1 in the
4624 SSL authentication process.
4628 .B ssl_usesystemcerts
4634 If set to \fIyes\fP, mutt will use CA certificates in the
4635 system\-wide certificate store when checking if a server certificate
4636 is signed by a trusted CA.
4646 If \fIset\fP (the default), mutt will not automatically accept a server
4647 certificate that is either not yet valid or already expired. You should
4648 only unset this for particular known hosts, using the
4649 \fC<account-hook>\fP function.
4659 If \fIset\fP (the default), mutt will not automatically accept a server
4660 certificate whose host name does not match the host used in your folder
4661 URL. You should only unset this for particular known hosts, using
4662 the \fC<account-hook>\fP function.
4669 Default: \(lq\-*%A\(rq
4672 Controls the characters used by the \(lq%r\(rq indicator in
4673 $status_format. The first character is used when the mailbox is
4674 unchanged. The second is used when the mailbox has been changed, and
4675 it needs to be resynchronized. The third is used if the mailbox is in
4676 read\-only mode, or if the mailbox will not be written when exiting
4677 that mailbox (You can toggle whether to write changes to a mailbox
4678 with the \fC<toggle\-write>\fP operation, bound by default to \(lq%\(rq). The fourth
4679 is used to indicate that the current folder has been opened in attach\-
4680 message mode (Certain operations like composing a new mail, replying,
4681 forwarding, etc. are not permitted in this mode).
4688 Default: \(lq\-%r\-Mutt: %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)\-\-\-\(rq
4691 Controls the format of the status line displayed in the \(lqindex\(rq
4692 menu. This string is similar to $index_format, but has its own
4693 set of \fCprintf(3)\fP\-like sequences:
4698 number of mailboxes with new mail *
4701 number of deleted messages *
4704 the full pathname of the current mailbox
4707 number of flagged messages *
4713 size (in bytes) of the current mailbox *
4716 size (in bytes) of the messages shown
4717 (i.e., which match the current limit) *
4720 the number of messages in the mailbox *
4723 the number of messages shown (i.e., which match the current limit) *
4726 number of new messages in the mailbox *
4729 number of old unread messages *
4732 number of postponed messages *
4735 percentage of the way through the index
4738 modified/read\-only/won't\-write/attach\-message indicator,
4739 according to $status_chars
4742 current sorting mode ($sort)
4745 current aux sorting method ($sort_aux)
4748 number of tagged messages *
4751 number of unread messages *
4757 currently active limit pattern, if any *
4760 right justify the rest of the string and pad with \(lqX\(rq
4763 pad to the end of the line with \(lqX\(rq
4766 soft\-fill with character \(lqX\(rq as pad
4770 For an explanation of \(lqsoft\-fill\(rq, see the $index_format documentation.
4772 * = can be optionally printed if nonzero
4774 Some of the above sequences can be used to optionally print a string
4775 if their value is nonzero. For example, you may only want to see the
4776 number of flagged messages if such messages exist, since zero is not
4777 particularly meaningful. To optionally print a string based upon one
4778 of the above sequences, the following construct is used:
4780 \fC%?<sequence_char>?<optional_string>?\fP
4782 where \fIsequence_char\fP is a character from the table above, and
4783 \fIoptional_string\fP is the string you would like printed if
4784 \fIsequence_char\fP is nonzero. \fIoptional_string\fP \fBmay\fP contain
4785 other sequences as well as normal text, but you may \fBnot\fP nest
4788 Here is an example illustrating how to optionally print the number of
4789 new messages in a mailbox:
4791 \fC%?n?%n new messages.?\fP
4793 You can also switch between two strings using the following construct:
4795 \fC%?<sequence_char>?<if_string>&<else_string>?\fP
4797 If the value of \fIsequence_char\fP is non\-zero, \fIif_string\fP will
4798 be expanded, otherwise \fIelse_string\fP will be expanded.
4800 You can force the result of any \fCprintf(3)\fP\-like sequence to be lowercase
4801 by prefixing the sequence character with an underscore (\(lq_\(rq) sign.
4802 For example, if you want to display the local hostname in lowercase,
4803 you would use: \(lq\fC%_h\fP\(rq.
4805 If you prefix the sequence character with a colon (\(lq:\(rq) character, mutt
4806 will replace any dots in the expansion by underscores. This might be helpful
4807 with IMAP folders that don't like dots in folder names.
4817 Setting this variable causes the \(lqstatus bar\(rq to be displayed on
4818 the first line of the screen rather than near the bottom. If $help
4819 is \fIset\fP, too it'll be placed at the bottom.
4829 If \fIset\fP, threading will only make use of the \(lqIn\-Reply\-To\(rq and
4830 \(lqReferences:\(rq fields when you $sort by message threads. By
4831 default, messages with the same subject are grouped together in
4832 \(lqpseudo threads.\(rq. This may not always be desirable, such as in a
4833 personal mailbox where you might have several unrelated messages with
4834 the subjects like \(lqhi\(rq which will get grouped together. See also
4835 $sort_re for a less drastic way of controlling this
4846 When \fIunset\fP, mutt won't stop when the user presses the terminal's
4847 \fIsusp\fP key, usually \(lq^Z\(rq. This is useful if you run mutt
4848 inside an xterm using a command like \(lq\fCxterm \-e mutt\fP\(rq.
4858 When \fIset\fP, mutt will generate \(lqformat=flowed\(rq bodies with a content type
4859 of \(lq\fCtext/plain; format=flowed\fP\(rq.
4860 This format is easier to handle for some mailing software, and generally
4861 just looks like ordinary text. To actually make use of this format's
4862 features, you'll need support in your editor.
4864 Note that $indent_string is ignored when this option is \fIset\fP.
4874 Affects the \fC~b\fP and \fC~h\fP search operations described in
4875 section \(lqpatterns\(rq. If \fIset\fP, the headers and body/attachments of
4876 messages to be searched are decoded before searching. If \fIunset\fP,
4877 messages are searched as they appear in the folder.
4879 Users searching attachments or for non\-ASCII characters should \fIset\fP
4880 this value because decoding also includes MIME parsing/decoding and possible
4881 character set conversions. Otherwise mutt will attempt to match against the
4882 raw message received (for example quoted\-printable encoded or with encoded
4883 headers) which may lead to incorrect search results.
4893 When \fIset\fP, mutt uses the date received rather than the date sent
4894 to thread messages by subject.
4904 When \fIset\fP, the internal\-pager will pad blank lines to the bottom of the
4905 screen with a tilde (\(lq~\(rq).
4915 Along with $read_inc, $write_inc, and $net_inc, this
4916 variable controls the frequency with which progress updates are
4917 displayed. It suppresses updates less than $time_inc milliseconds
4918 apart. This can improve throughput on systems with slow terminals,
4919 or when running mutt on a remote system.
4921 Also see the \(lqtuning\(rq section of the manual for performance considerations.
4931 When Mutt is waiting for user input either idleing in menus or
4932 in an interactive prompt, Mutt would block until input is
4933 present. Depending on the context, this would prevent certain
4934 operations from working, like checking for new mail or keeping
4935 an IMAP connection alive.
4937 This variable controls how many seconds Mutt will at most wait
4938 until it aborts waiting for input, performs these operations and
4939 continues to wait for input.
4941 A value of zero or less will cause Mutt to never time out.
4951 This variable allows you to specify where Mutt will place its
4952 temporary files needed for displaying and composing messages. If
4953 this variable is not set, the environment variable \fC$TMPDIR\fP is
4954 used. If \fC$TMPDIR\fP is not set then \(lq\fC/tmp\fP\(rq is used.
4961 Default: \(lq +TCFL\(rq
4964 Controls the character used to indicate mail addressed to you. The
4965 first character is the one used when the mail is \fInot\fP addressed to your
4966 address. The second is used when you are the only
4967 recipient of the message. The third is when your address
4968 appears in the \(lqTo:\(rq header field, but you are not the only recipient of
4969 the message. The fourth character is used when your
4970 address is specified in the \(lqCc:\(rq header field, but you are not the only
4971 recipient. The fifth character is used to indicate mail that was sent
4972 by \fIyou\fP. The sixth character is used to indicate when a mail
4973 was sent to a mailing\-list you subscribe to.
4983 Setting this variable will cause mutt to open a pipe to a command
4984 instead of a raw socket. You may be able to use this to set up
4985 preauthenticated connections to your IMAP/POP3/SMTP server. Example:
4992 set tunnel=\(rqssh \-q mailhost.net /usr/local/libexec/imapd\(rq
4999 Note: For this example to work you must be able to log in to the remote
5000 machine without having to enter a password.
5002 When set, Mutt uses the tunnel for all remote connections.
5003 Please see \(lqaccount-hook\(rq in the manual for how to use different
5004 tunnel commands per connection.
5014 When \fIset\fP, Mutt will jump to the next unread message, if any,
5015 when the current thread is \fIun\fPcollapsed.
5025 \fBWarning:\fP do not set this variable unless you are using a version
5026 of sendmail which supports the \fC\-B8BITMIME\fP flag (such as sendmail
5027 8.8.x) or you may not be able to send mail.
5029 When \fIset\fP, Mutt will invoke $sendmail with the \fC\-B8BITMIME\fP
5030 flag when sending 8\-bit messages to enable ESMTP negotiation.
5040 When \fIset\fP, Mutt will qualify all local addresses (ones without the
5041 \(lq@host\(rq portion) with the value of $hostname. If \fIunset\fP, no
5042 addresses will be qualified.
5046 .B use_envelope_from
5052 When \fIset\fP, mutt will set the \fIenvelope\fP sender of the message.
5053 If $envelope_from_address is \fIset\fP, it will be used as the sender
5054 address. If \fIunset\fP, mutt will attempt to derive the sender from the
5055 \(lqFrom:\(rq header.
5057 Note that this information is passed to sendmail command using the
5058 \fC\-f\fP command line switch. Therefore setting this option is not useful
5059 if the $sendmail variable already contains \fC\-f\fP or if the
5060 executable pointed to by $sendmail doesn't support the \fC\-f\fP switch.
5070 When \fIset\fP, Mutt will generate the \(lqFrom:\(rq header field when
5071 sending messages. If \fIunset\fP, no \(lqFrom:\(rq header field will be
5072 generated unless the user explicitly sets one using the \(lqmy_hdr\(rq
5083 When \fIset\fP, Mutt will show you international domain names decoded.
5084 Note: You can use IDNs for addresses even if this is \fIunset\fP.
5085 This variable only affects decoding.
5095 When \fIset\fP, Mutt will look for IPv6 addresses of hosts it tries to
5096 contact. If this option is \fIunset\fP, Mutt will restrict itself to IPv4 addresses.
5097 Normally, the default should work.
5107 When \fIset\fP, mutt will add a \(lqUser\-Agent:\(rq header to outgoing
5108 messages, indicating which version of mutt was used for composing
5119 Specifies the visual editor to invoke when the \(lq\fC~v\fP\(rq command is
5120 given in the builtin editor.
5130 Controls whether Mutt will ask you to press a key after an external command
5131 has been invoked by these functions: \fC<shell\-escape>\fP,
5132 \fC<pipe\-message>\fP, \fC<pipe\-entry>\fP, \fC<print\-message>\fP,
5133 and \fC<print\-entry>\fP commands.
5135 It is also used when viewing attachments with \(lqauto_view\(rq, provided
5136 that the corresponding mailcap entry has a \fIneedsterminal\fP flag,
5137 and the external program is interactive.
5139 When \fIset\fP, Mutt will always ask for a key. When \fIunset\fP, Mutt will wait
5140 for a key only if the external command returned a non\-zero status.
5150 When \fIset\fP, mutt will weed headers when displaying, forwarding,
5151 printing, or replying to messages.
5161 When set to a positive value, mutt will wrap text at $wrap characters.
5162 When set to a negative value, mutt will wrap text so that there are $wrap
5163 characters of empty space on the right side of the terminal.
5173 Controls whether searches wrap around the end.
5175 When \fIset\fP, searches will wrap around the first (or last) item. When
5176 \fIunset\fP, incremental searches will not wrap.
5186 (DEPRECATED) Equivalent to setting $wrap with a negative value.
5196 Controls whether mutt writes out the \(lqBcc:\(rq header when preparing
5197 messages to be sent. Exim users may wish to unset this. If mutt
5198 is set to deliver directly via SMTP (see $smtp_url), this
5199 option does nothing: mutt will never write out the \(lqBcc:\(rq header
5210 When writing a mailbox, a message will be printed every
5211 $write_inc messages to indicate progress. If set to 0, only a
5212 single message will be displayed before writing a mailbox.
5214 Also see the $read_inc, $net_inc and $time_inc variables and the
5215 \(lqtuning\(rq section of the manual for performance considerations.
development / attic / ports / opt-cross.git / blob