1neomuttrc(5) User Manuals neomuttrc(5)
2
6 neomuttrc - Configuration file for the NeoMutt Mail User Agent (MUA)
7
9 A NeoMutt configuration file consists of a series of “commands”. Each
10 line of the file may contain one or more commands. When multiple com‐
11 mands are used, they must be separated by a semicolon (“;”).
12 The hash mark, or pound sign (“#”), is used as a “comment” character.
14 You can use it to annotate your initialization file. All text after the
15 comment character to the end of the line is ignored.
16 Single quotes (“'”) and double quotes (“"”) can be used to quote
18 strings which contain spaces or other special characters. The differ‐
19 ence between the two types of quotes is similar to that of many popular
20 shell programs, namely that a single quote is used to specify a literal
21 string (one that is not interpreted for shell variables or quoting with
22 a backslash [see next paragraph]), while double quotes indicate a
23 string which should be evaluated. For example, backticks are evaluated
24 inside of double quotes, but not single quotes.
25 “\” quotes the next character, just as in shells such as Bash and Zsh.
27 For example, if you want to put quotes (“"”) inside of a string, you
28 can use “\” to force the next character to be a literal instead of in‐
29 terpreted character.
30 “\\” means to insert a literal “\” into the line. “\n” and “\r” have
32 their usual C meanings of line feed (LF) and carriage return (CR), re‐
33 spectively.
34 A “\” at the end of a line can be used to split commands over multiple
36 lines, provided that the split points don't appear in the middle of
37 command names.
38 It is also possible to substitute the output of a Unix command in an
40 initialization file. This is accomplished by enclosing the command in
41 backticks (`command`).
42 Unix environment variables can be accessed like the way it is done in
44 shells like sh and Bash: Prepend the name of the variable by a dollar
45 (“$”) sign.
46
48 Configuration Commands
49 The following are the commands understood by NeoMutt:
50 account-hook regex command
52 This hook is executed whenever you access a remote mailbox. Use‐
54 ful to adjust configuration settings to different IMAP or POP
55 servers.
56 alias [ -group name ... ] key address [, address ... ]
58 unalias [ -group name ... ] { * | key ... }
59 alias defines a surrogate key for the given address(es). Each
61 address will be resolved into either an email address (user@ex‐
62 ample.com) or a named email address (User Name <user@exam‐
63 ple.com>). The address may be specified in either format, or in
64 the format “user@example.com (User Name)”.
65 Note: If you want to create an alias for more than one address,
67 you must separate the addresses with a comma (“,”).
68 unalias removes the alias corresponding to the given key or all
70 aliases when “*” is used as an argument.
71 The optional -group flag causes the address(es) to be added to
73 or removed from the named group.
74 alternates [ -group name ... ] regex [ regex ... ]
76 unalternates [ -group name ... ] { * | regex ... }
77 alternates is used to inform NeoMutt about alternate addresses
79 where you receive mail; you can use regular expressions (regex)
80 to specify alternate addresses. This affects NeoMutt's idea
81 about messages from you, and messages addressed to you.
82 unalternates can be used to write exceptions to alternates regu‐
84 lar expression. To remove a regular expression from the alter‐
85 nates list, use the unalternates command with exactly the same
86 regex or use “*” to remove all entries.
87 The optional -group flag causes all of the subsequent regular
89 expressions to be added to or removed from the named group.
90 alternative_order mime-type[/mime-subtype] [ mime-type[/mime-subtype] ... ]
92 unalternative_order { * | mime-type[/mime-subtype] ... }
93 alternative_order command permits you to define an order of
95 preference that is used by NeoMutt to determine which part of a
96 multipart/alternative body to display. A mime-subtype of “*”
97 matches any multipart/alternative subtype, as does an empty
98 mime-subtype.
99 unalternative_order removes entries from the ordered list or
101 deletes the entire list when “*” is used as an argument.
102 attachments { + | - }disposition mime-type [ mime-type ... ]
104 unattachments { + | - }disposition mime-type [ mime-type ... ]
105 attachments ?
106 unattachments *
107 You can make your message index display the number of qualifying
109 attachments in each message, or search for messages by attach‐
110 ment count. You also can configure what kinds of attachments
111 qualify for this feature with the attachments and unattachments
112 commands.
113 disposition is the attachment's Content-Disposition type — ei‐
115 ther inline or attachment. You can abbreviate this to I or A.
116 Disposition is prefixed by either a + symbol or a - symbol. If
118 it's a +, you're saying that you want to allow this disposition
119 and MIME type to qualify. If it's a -, you're saying that this
120 disposition and MIME type is an exception to previous + rules.
121 mime-type is the MIME type of the attachment you want the com‐
123 mand to affect. A MIME type is always of the format major/minor.
124 The major part of mime-type must be literal text (or the special
125 token “*”, but the minor part may be a regular expression.
126 Therefore, “*/.*” matches any MIME type.
127 Note that the first MIME part is treated slightly differently:
129 It is almost always the message text. Thus, it is not counted
130 as an attachment if its disposition is inline and it is not a
131 multipart/* or message/* MIME-type.
132 Entering the command “attachments ?” as a command will list your
134 current settings in neomuttrc format, so that it can be pasted
135 elsewhere.
136 Entering the command “unattachments *” as a command will Clear
138 all attachment settings.
139 auto_view mime-type[/mime-subtype] [ mime-type[/mime-subtype] ... ]
141 unauto_view { * | mime-type[/mime-subtype] ... }
142 This commands permits you to specify that NeoMutt should auto‐
144 matically convert the given mime-types to text/plain when dis‐
145 playing messages. For this to work, there must be a mailcap(5)
146 entry for the given mime-type with the copiousoutput option set.
147 A mime-subtype of “*” matches any multipart/alternative subtype,
148 as does an empty mime-subtype.
149 bind map[,map ... ] key function
151 unbind { * | map | [,map...]} [ key ]
152 This command allows you to change the default or define addi‐
154 tional key bindings (operation invoked when pressing a key).
155 map specifies in which menu the binding belongs. Multiple maps
157 may be specified by separating them with commas (no additional
158 whitespace is allowed). The currently defined maps are: alias,
159 attach, browser, compose, editor, generic, index, mix, pager,
160 pgp, postpone, query and smime.
161 key is the key (or key sequence) you wish to bind, e.g. “\Ca”
163 for control-A. In addition, key may be specified as a three
164 digit octal number prefixed with a “\” or as a symbolic name.
165 The <what-key> function can be used to explore keycode and sym‐
166 bolic names for the keys on your keyboard.
167 function specifies which action to take when key is pressed.
169 Note that the function name is to be specified without angle
170 brackets.
171 Missing key sequence in unbind command means unbind all bindings
173 in menus given in map .
174 For more information on keys and functions, please consult the
176 NeoMutt manual.
177 charset-hook alias charset
179 iconv-hook charset local-charset
180 charset-hook defines an alias for a character set. This is use‐
182 ful to properly display messages which are tagged with a charac‐
183 ter set name not known to NeoMutt.
184 iconv-hook defines a system-specific name for a character set.
186 This is useful when your system's iconv(3) implementation does
187 not understand MIME character set names (such as iso-8859-1),
188 but instead insists on being fed with implementation-specific
189 character set names (such as 8859-1). In this specific case,
190 you'd put “iconv-hook iso-8859-1 8859-1” into your configuration
191 file.
192 color object [ attribute ... ] foreground background
194 color { header | body } [ attribute ... ] foreground background regex
195 color status foreground background [regex [ num ]]
196 color index-object [ attribute ... ] foreground background pattern
197 color compose composeobject foreground background
198 color compose composeobject [ attribute ... ] foreground background
199 uncolor { index-object | header | body } { * | pattern ... }
200 If your terminal supports color, these commands can be used to
202 assign foreground/background combinations to certain objects.
203 The currently defined objects are: attach_headers, attachment,
204 body, bold, error, hdrdefault, header, index, index_author, in‐
205 dex_collapsed, index_date, index_flags, index_label, index_num‐
206 ber, index_size, index_subject, index_tag, index_tags, indica‐
207 tor, markers, message, normal, progress, prompt, quoted, quot‐
208 edN, search, signature, status, stripe_even, stripe_odd, tilde,
209 tree, underline.
210 If the sidebar is enabled the following objects are also valid:
212 sidebar_background, sidebar_divider, sidebar_flagged, sidebar_
213 highlight, sidebar_indicator, sidebar_new, sidebar_ordinary,
214 sidebar_spool_file.
215 The body and header objects allow you to restrict the coloriza‐
217 tion to a regular expression. The index-object permits you to
218 select colored messages by pattern.
219 The header and body match regex in the header/body of a message,
221 index-object can match pattern in the message index. Note that
222 IMAP server-side searches (=b, =B, =h) are not supported for
223 color index patterns.
224 The status object optionally takes an regex and a match number.
226 If the regex is given, only the matching parts are colored. If
227 additionally the match number is given, only that sub-match of
228 the regex is colored.
229 Valid composeobjects include header, security_encrypt, secu‐
231 rity_sign, security_both, security_none.
232 Valid colors include: default, black, red, green, yellow, blue,
234 magenta, cyan, white, #RRGGBB, colorN.
235 Valid attributes include: none, bold, underline, reverse, and
237 standout.
238 The uncolor command can be applied to the index, header and body
240 objects only. It removes entries from the list. You must specify
241 the same pattern specified in the color command for it to be re‐
242 moved. The pattern “*” is a special token which means to clear
243 the color list of all entries.
244 For further information on colorization, please consult the Neo‐
246 Mutt manual.
247 crypt-hook regex keyid
249 The crypt-hook command provides a method by which you can spec‐
251 ify the ID of the public key to be used when encrypting messages
252 to a certain recipient. The meaning of keyid is to be taken
253 broadly: This can be a different email address, a numerical
254 keyid, or even just an arbitrary search string. You may use mul‐
255 tiple crypt-hooks with the same regex; multiple matching crypt-
256 hooks result in the use of multiple keyids for a recipient.
257 index-format-hook name [!]pattern format-string
259 This command is used to inject format strings dynamically into
260 $index_format based on pattern matching against the current mes‐
261 sage.
262 The $index_format expando %@name@ specifies a placeholder for
264 the injection. Index-format-hooks with the same name are matched
265 using pattern against the current message. Matching is done in
266 the order specified in the .neomuttrc, with the first match be‐
267 ing used. The hook's format-string is then substituted and eval‐
268 uated.
269 exec function [ function ... ]
271 This command can be used to execute any function. Functions are
273 listed in the function reference. “exec function” is equivalent
274 to “push <function>”.
275 fcc-save-hook pattern mailbox
277 fcc-hook pattern mailbox
278 save-hook pattern mailbox
279 fcc-save-hook is a shortcut, equivalent to doing both a fcc-hook
281 and a save-hook with its arguments, including %-expansion on
282 mailbox according to $index_format.
283 fcc-hook is used to save outgoing mail in a mailbox other than
285 $record. NeoMutt searches the initial list of message recipi‐
286 ents for the first matching pattern and uses mailbox as the de‐
287 fault “Fcc:” mailbox. If no match is found the message will be
288 saved to $record mailbox.
289 save-hook is used to override the default mailbox used when sav‐
291 ing messages. mailbox will be used as the default if the message
292 matches pattern.
293 To provide more flexibility and good defaults, NeoMutt applies
295 the expandos of $index_format to mailbox after it was expanded.
296 See PATTERNS section below or consult section “Message Matching
297 in Hooks” in NeoMutt manual for information on the exact format
298 of pattern.
299 folder-hook [-noregex] regex command
301 When NeoMutt enters a folder which matches regex (or, when regex
303 is preceded by an exclamation mark, does not match regex), the
304 given command is executed. The -noregex switch controls whether
305 regex is matches as simple string equality or full regex match.
306 When several folder-hooks match a given mail folder, they are
308 executed in the order given in the configuration file.
309 group [ -group name ... ] { -rx regex ... | -addr address ... }
311 ungroup [ -group name ... ] { * | -rx regex ... | -addr address ... }
312 group is used to directly add either addresses or regular ex‐
314 pressions to the specified group or groups. The different cate‐
315 gories of arguments to the group command can be in any order.
316 The flags -rx and -addr specify what the following strings (that
317 cannot begin with a hyphen) should be interpreted as: either a
318 regular expression or an email address, respectively.
319 ungroup is used to remove addresses or regular expressions from
321 the specified group or groups. The syntax is similar to the
322 group command, however the special character “*” can be used to
323 empty a group of all of its contents.
324 These address groups can also be created implicitly by the
326 alias, lists, subscribe and alternates commands by specifying
327 the optional -group option.
328 Once defined, these address groups can be used in patterns to
330 search for and limit the display to messages matching a group.
331 hdr_order header [ header ... ]
333 unhdr_order { * | header ... }
334 With the hdr_order command you can specify an order in which
336 NeoMutt will attempt to present these headers to you when view‐
337 ing messages.
338 “unhdr_order *” will clear all previous headers from the order
340 list, thus removing the header order effects set by the system-
341 wide startup file.
342 ifdef symbol "config-command [ args ... ]"
344 ifndef symbol "config-command [ args ... ]"
345 finish
346 The ifdef feature introduces three new commands to NeoMutt and
348 allow you to share one config file between versions of NeoMutt
349 that may have different features compiled in.
350 ┌──────────────────────────────────┬──────────────────────┐
352 │Example Symbol │ Description │
353 ├──────────────────────────────────┼──────────────────────┤
354 │sidebar_format │ Config variable │
355 │status-color, imap │ Compiled-in feature │
356 │pgp-menu, group-related │ Function │
357 │index-format-hook, tag-transforms │ Command │
358 │my_var │ My variable │
359 │lmdb, tokyocabinet │ Store (database) │
360 │HOME, COLUMNS │ Environment variable │
361 └──────────────────────────────────┴──────────────────────┘
362 A list of compile-time symbols can be seen in the output of the
363 command “neomutt -v” (in the “Compile options” section).
364 finish is particularly useful when combined with ifndef.
366 ignore string [ string ... ]
368 unignore { * | string ... }
369 The ignore command allows you to specify header fields which you
371 don't normally want to see in the pager. You do not need to
372 specify the full header field name. For example, “ignore con‐
373 tent-” will ignore all header fields that begin with the string
374 “content-”, “ignore *” will ignore all headers.
375 To remove a previously added token from the list, use the unig‐
377 nore command. For example, “unignore *” will remove all tokens
378 from the ignore list.
379 lists [ -group name ... ] regex [ regex ... ]
381 unlists [ -group name ... ] { * | regex ... }
382 subscribe [ -group name ... ] regex [ regex ... ]
383 unsubscribe [ -group name ... ] { * | regex ... }
384 NeoMutt maintains two lists of mailing list address regular ex‐
386 pressions, a list of subscribed mailing lists, and a list of
387 known mailing lists. All subscribed mailing lists are known.
388 The lists command adds a mailing list address to the list of
390 known mailing lists. The unlists command removes a mailing list
391 from the lists of known and subscribed mailing lists.
392 The subscribe command adds a mailing list to the lists of known
394 and subscribed mailing lists. The unsubscribe command removes it
395 from the list of subscribed mailing lists.
396 The -group flag adds all of the subsequent regular expressions
398 to the named group.
399 macro menu[,menu ... ] key sequence [ description ]
401 unmacro { * | menu | [,menu...]} [ key ]
402 This command binds the given sequence of keys to the given key
404 in the given menu or menus. For currently defined menus, see
405 bind command above. To specify multiple menus, put only a comma
406 between the menus.
407 Optionally you can specify a descriptive text after sequence,
409 which is shown in the help screens if they contain a descrip‐
410 tion.
411 Missing key sequence in unmacro command means unmacro all macros
413 in menus given in menu.
414 mailboxes [[-label label] | -nolabel]
416 [[-notify | -nonotify]
417 [-poll | -nopoll]
418 mailbox] [ ... ]
419 named-mailboxes label mailbox [label mailbox ... ]
420 unmailboxes { * | mailbox ... }
421 The mailboxes specifies folders which can receive mail and which
423 will be checked for new messages. When changing folders, press‐
424 ing space will cycle through folders with new mail.
425 The named-mailboxes is an alternative to mailboxes -label label.
427 NeoMutt can be configured to display the label instead of the
428 mailbox path.
429 The unmailboxes command is used to remove a file name from the
431 list of folders which can receive mail. If “*” is specified as
432 the file name, the list is emptied.
433 mailto_allow { * | header-field ... }
435 unmailto_allow { * | header-field ... }
436 As a security measure, NeoMutt will only add user-approved
438 header-fields from a mailto: URL. This is necessary since Neo‐
439 Mutt will handle certain header-fields, such as Attach, in a
440 special way. The mailto_allow and unmailto_allow commands allow
441 the user to modify the list of approved headers.
442 NeoMutt initializes the default list to contain only the Subject
444 and Body header-fields, which are the only requirement specified
445 by the mailto: specification in RFC2368, and the Cc, In-Reply-
446 To, References headers to aid with replies to mailing lists.
447 echo message
449 Prints message to the message window. After printing the mes‐
450 sage, echo will pause for the number of seconds specified by
451 $sleep_time.
452 cd directory
454 Changes the current working directory.
455 mbox-hook [-noregex] regex mailbox
457 When NeoMutt changes to a mail folder which matches regex, mail‐
459 box will be used as the “mbox” folder, i.e. read messages will
460 be moved to that folder when the mail folder is left. The
461 -noregex switch controls whether regex is matches as simple
462 string equality or full regex match.
463 Note that execution of mbox-hooks is dependent on the $move con‐
466 figuration variable. If set to “no” (the default), mbox-hooks
467 will not be executed.
468 The first matching mbox-hook applies.
470 message-hook pattern command
472 Before NeoMutt displays (or formats for replying or forwarding)
474 a message which matches the given pattern (or, when it is pre‐
475 ceded by an exclamation mark, does not match the pattern), the
476 given command is executed. When multiple message-hooks match,
477 they are executed in the order in which they occur in the con‐
478 figuration file.
479 mime_lookup mime-type[/mime-subtype] [ mime-type[/mime-subtype] ... ]
481 unmime_lookup { * | mime-type[/mime-subtype] ... }
482 This command permits you to define a list of “data” MIME content
484 types for which NeoMutt will try to determine the actual file
485 type from the file name, and not use a mailcap(5) entry given
486 for the original MIME type. For instance, you may add the appli‐
487 cation/octet-stream MIME type to this list.
488 In addition, the unmime_lookup command may be used to disable
490 this feature for any particular MIME type if it had been set,
491 for example in a global neomuttrc.
492 mono object attribute
494 mono { header | body } attribute regex
495 mono index-object attribute pattern
496 unmono { index-object | header | body } { * | pattern ... }
497 For terminals which don't support color, you can still assign
499 attributes to objects.
500 my_hdr string
502 unmy_hdr { * | field ... }
503 Using my_hdr, you can define headers which will be added to the
505 messages you compose. unmy_hdr will remove the given user-de‐
506 fined headers.
507 open-hook regex "shell-command"
509 close-hook regex "shell-command"
510 append-hook regex "shell-command"
511 These commands provide a way to handle compressed folders. The
513 given regex specifies which folders are taken as compressed
514 (e.g. "\.gz$"). The commands tell NeoMutt how to uncompress a
515 folder (open-hook), compress a folder (close-hook) or append a
516 compressed mail to a compressed folder (append-hook). The shell-
517 command is a printf(3) like format string and must contain two
518 placeholders for from (%f) and to (%t) filenames which should be
519 placed inside single-quotes to prevent unintended shell expan‐
520 sions. Examples:
521 append-hook '\.gz$' "gzip --stdout '%t' >> '%f'"
523 close-hook '\.gz$' "gzip --stdout '%t' > '%f'"
524 open-hook '\.gz$' "gzip --stdout --decompress '%f' > '%t'"
525 push string
527 This command adds the named string to the beginning of the key‐
529 board buffer. The string may contain control characters, key
530 names and function names like the sequence string in the macro
531 command. You may use it to automatically run a sequence of com‐
532 mands at startup, or when entering certain folders.
533 For using functions, it's important to use angle brackets (“<”
535 and “>”) to make NeoMutt recognize the input as a function name.
536 Otherwise it will simulate individual just keystrokes.
537 reply-hook pattern command
539 send-hook pattern command
540 send2-hook pattern command
541 These commands can be used to execute arbitrary configuration
543 commands based upon recipients of the message. pattern is used
544 to match the message, see section “Message Matching in Hooks” in
545 manual for details. command is executed when pattern matches.
546 reply-hook is matched against the message you are replying to,
548 instead of the message you are sending. send-hook is matched
549 against all messages, both new and replies. Note, reply-hooks
550 are matched before the send-hook, regardless of the order speci‐
551 fied in the user's configuration file.
552 send2-hook is matched every time a message is changed, either by
554 editing it, or by using the compose menu to change its recipi‐
555 ents or subject. send2-hook is executed after send-hook, and
556 can, e.g., be used to set parameters such as the $sendmail vari‐
557 able depending on the message's sender address. Note, send-hooks
558 are only executed once after getting the initial list of recipi‐
559 ents.
560 score pattern value
562 unscore { * | pattern ... }
563 The score command adds value to a message's score if pattern
565 matches it. pattern is a string in the format described in the
566 PATTERNS section below. value is a positive or negative integer.
567 A message's final score is the sum total of all matching score
568 entries.
569 The unscore command removes score entries from the list. You
571 must specify the same pattern specified in the score command for
572 it to be removed. The pattern “*” is a special token which means
573 to clear the list of all score entries.
574 set { [ no | inv | & | ? ]variable } [ ... ]
576 set { variable=value | variable+=increment | variable-=decrement } [ ... ]
577 unset variable [ variable ... ]
578 reset variable [ variable ... ]
579 toggle variable [ variable ... ]
580 set variable ?
581 These commands are used to set and manipulate configuration
583 variables.
584 NeoMutt knows four basic types of variables: boolean, number,
586 string, string list and quadoption. Boolean variables can be set
587 (true), unset (false), or toggled. Number variables can be as‐
588 signed a positive integer value. Value of number variables can
589 be incremented "+=" and decremented "-=". String list variables
590 use "+=" for appending increment to the string list and "-=" for
591 removal decrement from the string list.
592 String variables consist of any number of printable characters
594 and must be enclosed in quotes if they contain spaces or tabs.
595 You may also use the escape sequences “\n” and “\t” for newline
596 and tab, respectively. Content of a string variables can be ex‐
597 tended using "+="
598 Quadoption variables are used to control whether or not to be
600 prompted for certain actions, or to specify a default action. A
601 value of yes will cause the action to be carried out automati‐
602 cally as if you had answered “yes” to the question. Similarly, a
603 value of no will cause the action to be carried out as if you
604 had answered “no”. A value of ask-yes will cause a prompt with
605 a default answer of “yes” and ask-no will provide a default an‐
606 swer of “no”.
607 The toggle command automatically prepends the “inv” prefix to
609 all specified variables. The unset command automatically
610 prepends the “no” prefix to all specified variables. If you use
611 the command set and prefix the variable with “&” this has the
612 same behavior as the reset command.
613 The reset command resets all given variables to the compile time
615 defaults. With the reset command there exists the special vari‐
616 able all, which allows you to reset all variables to their sys‐
617 tem defaults.
618 Using the <enter-command> function, you can query the value of a
620 variable by suffixing the name of the variable with a question
621 mark: ":set allow_8bit?". The old prefix query syntax
622 (":set ?allow_8bit") is also still supported.
623 setenv { ?variable | variable value }
625 unsetenv variable
626 You can alter the environment that NeoMutt passes on to its
628 child processes using the setenv and unsetenv operators.
629 You can also query current environment values by prefixing a “?”
631 character.
632 sidebar_pin mailbox [ mailbox ...]
634 sidebar_unpin { * | mailbox ... }
635 The sidebar_pin command specifies mailboxes that will always be
637 displayed in the sidebar, even if $sidebar_new_mail_only is set
638 and the mailbox does not contain new mail.
639 The sidebar_unpin command is used to remove a mailbox from the
641 list of always displayed mailboxes. Use “sidebar_unpin *” to re‐
642 move all mailboxes.
643 source filename
645 This command allows the inclusion of initialization commands
647 from other files. If the filename begins with a tilde (“~”), it
648 will be expanded to the path of your home directory.
649 If the filename ends with a vertical bar (“|”), then filename is
651 considered to be an executable program from which to read input,
652 (e.g. “source ~/bin/myscript|”).
653 If the filename is relative and the command source is executed
655 from the context of a configuration file, then the filename is
656 interpreted relative to the directory of that configuration
657 file. If the command is executed outside of a configuration
658 file, e.g. from the prompt, then the filename is interpreted
659 relative to the current working directory (see cd on how to
660 change the current working directory at runtime).
661 Note: A hook remembers the configuration file it was defined in
663 and sets the context to that file when executing its commands.
664 As a result a source command inside a hook is executed in the
665 context of the configuration file the hook was defined in. Thus
666 relative filenames are interpreted relative to the configuration
667 file the hook is defined in.
668 spam regex format
670 nospam { * | regex }
671 NeoMutt has generalized support for external spam-scoring fil‐
673 ters. By defining your spam regexs with the spam and nospam com‐
674 mands, you can limit, search, and sort your mail based on its
675 spam attributes, as determined by the external filter. You also
676 can display the spam attributes in your index display using the
677 %H selector in the $index_format variable. (Tip: try
678 "%<H?[%H] >" to display spam tags only when they are defined for
679 a given message).
680 For further information on spam-scoring filters, please consult
682 the section “Spam Detection” in the NeoMutt manual.
683 subjectrx regex replacement
685 unsubjectrx { * | regex }
686 The subjectrx command specifies a regular expression which, if
688 detected in a message subject, causes the subject to be replaced
689 with the replacement value. The replacement is subject to sub‐
690 stitutions in the same way as for the spam command: %L for the
691 text to the left of the match, %R for text to the right of the
692 match, and %1 for the first subgroup in the match (etc). If you
693 simply want to erase the match, set it to “%L%R”. Any number of
694 subjectrx commands may coexist.
695 Note this well: the replacement value replaces the entire sub‐
697 ject, not just the match!
698 unsubjectrx removes a given subjectrx from the substitution
700 list. If “*” is used as the argument, all substitutions will be
701 removed.
702 subscribe-to imap-folder-uri
704 unsubscribe-from imap-folder-uri
705 Tell the IMAP server to subscribe to or unsubscribe from the
707 folder imap-folder-uri. The argument must be an IMAP URI, e.g.
708 “subscribe-to imaps://mail.example.org/inbox”.
709 Subscription is an IMAP protocol feature where the server man‐
711 ages a list of subscribed folders. This list can be queried by
712 clients like NeoMutt.
713 NeoMutt uses that list in various situations, see
715 $imap_list_subscribed and $imap_check_subscribed.
716 timeout-hook command
718 startup-hook command
719 shutdown-hook command
720 The Global Hooks feature introduces these hooks to NeoMutt. They
722 are called when global events take place in NeoMutt. startup-
723 hook and shutdown-hook are most likely to be useful to users of
724 notmuch(1).
725 timeout-hook runs a command periodically when NeoMutt checks for
727 new mail. This hook is called every $timeout seconds.
728 Before NeoMutt opens the first mailbox when first starting, Neo‐
730 Mutt will run the startup-hook for the given command.
731 Before NeoMutt is about to exit, and before the mailbox is
733 closed, NeoMutt will run the shutdown-hook for the given com‐
734 mand.
735 unhook { * | hook-type }
737 This command permits you to flush hooks you have previously de‐
739 fined. You can either remove all hooks by giving the “*” charac‐
740 ter as an argument, or you can remove all hooks of a specific
741 hook-type by saying something like “unhook send-hook”.
742
744 Pattern Modifier
745 Many of NeoMutt's commands allow you to specify a pattern to match mes‐
746 sages (limit, tag-pattern, delete-pattern, the above mentioned hook
747 commands etc.). The table “Pattern modifiers” shows several ways to se‐
748 lect messages.
749 ┌─────────────┬────────────────────────────────────────────────────────┐
751 │ Pattern │ Description │
752 ├─────────────┼────────────────────────────────────────────────────────┤
753 │ ~A │ all messages │
754 ├─────────────┼────────────────────────────────────────────────────────┤
755 │ =B STRING │ messages which contain STRING in the whole message. If │
756 │ │ IMAP is enabled, searches for STRING on the server, │
757 │ │ rather than downloading each message and searching it │
758 │ │ locally. │
759 ├─────────────┼────────────────────────────────────────────────────────┤
760 │ =b STRING │ messages which contain STRING in the message body. If │
761 │ │ IMAP is enabled, searches for STRING on the server, │
762 │ │ rather than downloading each message and searching it │
763 │ │ locally. │
764 ├─────────────┼────────────────────────────────────────────────────────┤
765 │ ~B EXPR │ messages which contain EXPR in the whole message │
766 ├─────────────┼────────────────────────────────────────────────────────┤
767 │ ~b EXPR │ messages which contain EXPR in the message body │
768 ├─────────────┼────────────────────────────────────────────────────────┤
769 │ %C GROUP │ messages either “To:”, “Cc:” or “Bcc:” to any member │
770 │ │ of GROUP │
771 ├─────────────┼────────────────────────────────────────────────────────┤
772 │ %c GROUP │ messages carbon-copied to any member of GROUP │
773 ├─────────────┼────────────────────────────────────────────────────────┤
774 │ ~C EXPR │ messages either “To:”, “Cc:” or “Bcc:” EXPR │
775 ├─────────────┼────────────────────────────────────────────────────────┤
776 │ ~c EXPR │ messages carbon-copied to EXPR │
777 ├─────────────┼────────────────────────────────────────────────────────┤
778 │ ~D │ deleted messages │
779 ├─────────────┼────────────────────────────────────────────────────────┤
780 │ ~d MIN-MAX │ messages with “date-sent” in a date range │
781 ├─────────────┼────────────────────────────────────────────────────────┤
782 │ %e GROUP │ messages which contain a member of GROUP in the │
783 │ │ “Sender:” field │
784 ├─────────────┼────────────────────────────────────────────────────────┤
785 │ ~E │ expired messages │
786 ├─────────────┼────────────────────────────────────────────────────────┤
787 │ ~e EXPR │ messages which contain EXPR in the “Sender:” field │
788 ├─────────────┼────────────────────────────────────────────────────────┤
789 │ %f GROUP │ messages originating from any member of GROUP │
790 ├─────────────┼────────────────────────────────────────────────────────┤
791 │ ~F │ flagged messages │
792 ├─────────────┼────────────────────────────────────────────────────────┤
793 │ ~f EXPR │ messages originating from EXPR │
794 ├─────────────┼────────────────────────────────────────────────────────┤
795 │ ~G │ cryptographically encrypted messages │
796 ├─────────────┼────────────────────────────────────────────────────────┤
797 │ ~g │ cryptographically signed messages │
798 ├─────────────┼────────────────────────────────────────────────────────┤
799 │ =h STRING │ messages which contain STRING in the message header. │
800 │ │ If IMAP is enabled, searches for STRING on the server, │
801 │ │ rather than downloading each message and searching it │
802 │ │ locally; STRING must be of the form “Header: sub‐ │
803 │ │ string” (see below). │
804 ├─────────────┼────────────────────────────────────────────────────────┤
805 │ ~H EXPR │ messages with spam attribute matching EXPR │
806 ├─────────────┼────────────────────────────────────────────────────────┤
807 │ ~h EXPR │ messages which contain EXPR in the message header │
808 ├─────────────┼────────────────────────────────────────────────────────┤
809 │ ~i EXPR │ messages which match EXPR in the “Message-ID:” field │
810 ├─────────────┼────────────────────────────────────────────────────────┤
811 │ ~I QUERY │ messages whose Message-ID field is included in the re‐ │
812 │ │ sults returned from an external search program, when │
813 │ │ the program is run with QUERY as its argument. See │
814 │ │ $external_search_command │
815 ├─────────────┼────────────────────────────────────────────────────────┤
816 │ ~k │ messages containing PGP key material │
817 ├─────────────┼────────────────────────────────────────────────────────┤
818 │ ~K EXPR │ messages blind carbon-copied to EXPR │
819 ├─────────────┼────────────────────────────────────────────────────────┤
820 │ %L GROUP │ messages either originated or received by any member │
821 │ │ of GROUP │
822 ├─────────────┼────────────────────────────────────────────────────────┤
823 │ ~L EXPR │ messages either originated or received by EXPR │
824 ├─────────────┼────────────────────────────────────────────────────────┤
825 │ ~l │ messages addressed to a known mailing list │
826 ├─────────────┼────────────────────────────────────────────────────────┤
827 │ ~M EXPR │ messages which contain a mime Content-Type matching │
828 │ │ EXPR │
829 ├─────────────┼────────────────────────────────────────────────────────┤
830 │ ~m <MAX │ messages with numbers less than MAX *) │
831 ├─────────────┼────────────────────────────────────────────────────────┤
832 │ ~m >MIN │ messages with numbers greater than MIN *) │
833 ├─────────────┼────────────────────────────────────────────────────────┤
834 │ ~m MIN,MAX │ messages with offsets (from selected message) in the │
835 │ │ range MIN to MAX *) │
836 ├─────────────┼────────────────────────────────────────────────────────┤
837 │ ~m MIN-MAX │ message in the range MIN to MAX *) │
838 ├─────────────┼────────────────────────────────────────────────────────┤
839 │ ~m N │ just message number N *) │
840 ├─────────────┼────────────────────────────────────────────────────────┤
841 │ ~N │ new messages │
842 ├─────────────┼────────────────────────────────────────────────────────┤
843 │ ~n MIN-MAX │ messages with a score in the range MIN to MAX **) │
844 ├─────────────┼────────────────────────────────────────────────────────┤
845 │ ~O │ old messages │
846 ├─────────────┼────────────────────────────────────────────────────────┤
847 │ ~P │ messages from you (consults $from, alternates, and lo‐ │
848 │ │ cal account/hostname information) │
849 ├─────────────┼────────────────────────────────────────────────────────┤
850 │ ~p │ messages addressed to you (consults $from, alternates, │
851 │ │ and local account/hostname information) │
852 ├─────────────┼────────────────────────────────────────────────────────┤
853 │ ~Q │ messages which have been replied to │
854 ├─────────────┼────────────────────────────────────────────────────────┤
855 │ ~R │ read messages │
856 ├─────────────┼────────────────────────────────────────────────────────┤
857 │ ~r MIN-MAX │ messages with “date-received” in a date range │
858 ├─────────────┼────────────────────────────────────────────────────────┤
859 │ ~S │ superseded messages │
860 ├─────────────┼────────────────────────────────────────────────────────┤
861 │ ~s EXPR │ messages having EXPR in the “Subject:” field │
862 ├─────────────┼────────────────────────────────────────────────────────┤
863 │ ~T │ tagged messages │
864 ├─────────────┼────────────────────────────────────────────────────────┤
865 │ ~t EXPR │ messages addressed to EXPR │
866 ├─────────────┼────────────────────────────────────────────────────────┤
867 │ ~U │ unread messages │
868 ├─────────────┼────────────────────────────────────────────────────────┤
869 │ ~u │ messages addressed to a subscribed mailing list │
870 ├─────────────┼────────────────────────────────────────────────────────┤
871 │ ~V │ cryptographically verified messages │
872 ├─────────────┼────────────────────────────────────────────────────────┤
873 │ ~v │ message is part of a collapsed thread. │
874 ├─────────────┼────────────────────────────────────────────────────────┤
875 │ ~w EXPR │ newsgroups matching EXPR │
876 ├─────────────┼────────────────────────────────────────────────────────┤
877 │ ~X MIN-MAX │ messages with MIN to MAX attachments **) │
878 ├─────────────┼────────────────────────────────────────────────────────┤
879 │ ~x EXPR │ messages which contain EXPR in the “References:” or │
880 │ │ “In-Reply-To:” field │
881 ├─────────────┼────────────────────────────────────────────────────────┤
882 │ ~y EXPR │ messages which contain EXPR in their keywords │
883 ├─────────────┼────────────────────────────────────────────────────────┤
884 │ ~Y EXPR │ messages whose tags match EXPR │
885 ├─────────────┼────────────────────────────────────────────────────────┤
886 │ ~z MIN-MAX │ messages with a size in the range MIN to MAX **) ***) │
887 ├─────────────┼────────────────────────────────────────────────────────┤
888 │ =/ STRING │ IMAP custom server-side search for STRING. Currently │
889 │ │ only defined for Gmail. See section “Gmail Patterns” │
890 │ │ in NeoMutt manual. │
891 ├─────────────┼────────────────────────────────────────────────────────┤
892 │ ~= │ duplicated messages (see $duplicate_threads) │
893 ├─────────────┼────────────────────────────────────────────────────────┤
894 │ ~# │ broken threads (see $strict_threads) │
895 ├─────────────┼────────────────────────────────────────────────────────┤
896 │ ~$ │ unreferenced message (requires threaded view) │
897 ├─────────────┼────────────────────────────────────────────────────────┤
898 │ ~(PATTERN) │ messages in threads containing messages matching PAT‐ │
899 │ │ TERN, e.g. all threads containing messages from you: │
900 │ │ ~(~P) │
901 ├─────────────┼────────────────────────────────────────────────────────┤
902 │ ~<(PATTERN) │ messages whose immediate parent matches PATTERN, e.g. │
903 │ │ replies to your messages: ~<(~P) │
904 ├─────────────┼────────────────────────────────────────────────────────┤
905 │ ~>(PATTERN) │ messages having an immediate child matching PATTERN, │
906 │ │ e.g. messages you replied to: ~>(~P) │
907 ├─────────────┴────────────────────────────────────────────────────────┤
908 │ Where EXPR is a regular expression, and GROUP is an address group. │
909 │ │
910 │ *) The message number ranges (introduced by “~m”) are even │
911 │ more general and powerful than the other types of ranges. │
912 │ Read on and see section “Message Ranges” in manual. │
913 │ **) The forms “<MAX”, “>MIN”, “MIN-” and “-MAX” are allowed, │
914 │ too. │
915 │ ***) The suffixes “K” and “M” are allowed to specify kilobyte │
916 │ and megabyte respectively. │
917 └──────────────────────────────────────────────────────────────────────┘
918 Special attention has to be paid when using regular expressions inside
919 of patterns. Specifically, NeoMutt's parser for these patterns will
920 strip one level of backslash (“\”), which is normally used for quoting.
921 If it is your intention to use a backslash in the regular expression,
922 you will need to use two backslashes (“\\”) instead.
923 You can force NeoMutt to treat EXPR as a simple STRING instead of a
925 regular expression by using “=” instead of “~” in the pattern name. For
926 example, “=b *.*” will find all messages that contain the literal
927 STRING “*.*”. Simple substring matches are less powerful than regular
928 expressions but can be considerably faster. This is especially true for
929 IMAP folders, because substring matches can be performed on the server
930 instead of by fetching every message. IMAP treats “=h” specially: it
931 must be of the form “Header: substring” and will not partially match
932 header names. The substring part may be omitted if you simply wish to
933 find messages containing a particular header without regard to its
934 value.
935 Patterns matching lists of addresses (notably c, C, p, P and t) match
937 if there is at least one match in the whole list. If you want to make
938 sure that all elements of that list match, you need to prefix your pat‐
939 tern with “^”.
940 This example matches all mails which only has recipients from Germany.
942 Matching all addresses in address lists: ^~C \.de$
944 You can restrict address pattern matching to aliases that you have de‐
946 fined with the “@” modifier. This example matches messages whose recip‐
947 ients are all from Germany and who are known to your alias list.
948 Matching restricted to aliases: ^@~C \.de$
950 To match any defined alias, use a regular expression that matches any
952 string. This example matches messages whose senders are known aliases.
953 Matching any defined alias: @~f .
955 Nesting and Boolean Operators
957 Logical AND is performed by specifying more than one criterion.
958 For example: ~t work ~f smith
960 would select messages which contain the word “work” in the list of re‐
962 cipients and that have the word “elkins” in the “From:” header field.
963 NeoMutt also recognizes the following operators to create more complex
965 search patterns:
966 • “!” — logical NOT operator
968 • “|” — logical OR operator
969 • “()” — logical grouping operator
970 Here is an example illustrating a complex search pattern. This pattern
972 will select all messages which do not contain “work” in the “To:” or
973 “Cc:” field and which are from “elkins”.
974 Using boolean operators in patterns: !(~t work|~c work) ~f smith
976 Here is an example using white space in the regular expression (note
978 the “'” and “"” delimiters). For this to match, the mail's subject must
979 match the “^Junk +From +Me$” and it must be from either “Jim +Somebody”
980 or “Ed +SomeoneElse”:
981 Quoting regex: '~s "^Junk +From +Me$" ~f ("Jim +Somebody"|"Ed
983 +SomeoneElse")'
984 Note: If a regular expression contains parenthesis, or a vertical bar
986 (“|”), you must enclose the expression in double or single quotes since
987 those characters are also used to separate different parts of NeoMutt's
988 pattern language.
989 For example: ~f "user@(home\.org|work\.com)"
991 Without the quotes, the parenthesis wouldn't end. This would be sepa‐
993 rated to two OR'd patterns: ~f user@(home\.org and work\.com). They are
994 never what you want.
995 Searching by Date
997 NeoMutt supports two types of dates, absolute and relative for the “~d”
998 and “~r” pattern.
999 Absolute Dates
1001 Dates must be in dd[/mm[/[CC]YY]] format (day, month, century and year
1002 — all parts, with the exception of day, are optional, defaulting to the
1003 current month and year). An example of a valid range of dates is:
1004 Limit to messages matching: ~d 20/1/95-31/10
1006 Alternatively, you may use YYYYMMDD to specify a date.
1008 When given a two-digit year, NeoMutt will interpret values less than
1010 “70” as lying in the 21st century (i.e., “38” means 2038 and not 1938,
1011 and “00” is interpreted as 2000), and values greater than or equal to
1012 “70” as lying in the 20th century.
1013 If you omit the MINimum (first) date, and just specify -dd/mm/YY, all
1015 messages before the given date will be selected. If you omit the MAXi‐
1016 mum (second) date, and specify dd/mm/YY-, all messages after the given
1017 date will be selected. If you specify a single date with no dash (“-”),
1018 only messages sent/received on the given date will be selected.
1019 You can add error margins to absolute dates. An error margin is a sign
1021 (“+” or “-”), followed by a digit, followed by one of the units in ta‐
1022 ble “Date units” below. As a special case, you can replace the sign by
1023 a “*” character, which is equivalent to giving identical plus and minus
1024 error margins.
1025 ┌─────────────┬──────┬───────┬────────┬───────┐
1027 │ Date Unit │ d │ w │ m │ y │
1028 ├─────────────┼──────┼───────┼────────┼───────┤
1029 │ Description │ Days │ Weeks │ Months │ Years │
1030 └─────────────┴──────┴───────┴────────┴───────┘
1031 ┌─────────────┬─────────┬─────────┬───────┐
1032 │ Date Unit │ S │ M │ H │
1033 ├─────────────┼─────────┼─────────┼───────┤
1034 │ Description │ Seconds │ Minutes │ Hours │
1035 └─────────────┴─────────┴─────────┴───────┘
1036 Example: To select any messages two weeks around January 15, 2001,
1037 you'd use the following pattern:
1038 Limit to messages matching: ~d 15/1/2001*2w
1040 It is possible to give multiple error margins:
1042 which cumulate: ~d 1/1/2001-1w+2w*3d
1044 Relative Dates
1046 This type of date is relative to the current date, and may be specified
1047 as:
1048 • “<offset” for messages newer than offset units
1050 • “=offset” for messages exactly offset units old
1051 • “>offset” for messages older than offset units
1052 offset is specified as a positive number with one of the units from ta‐
1054 ble “Date units”.
1055 Example: To select messages less than 1 month old, you would use:
1057 Limit to messages matching: ~d <1m
1059 Note: All dates used when searching are relative to the local time
1061 zone, so unless you change the setting of your $index_format to include
1062 a “%[...]” format, these are not the dates shown in the main index.
1063
1065 abort_backspace
1066 Type: boolean
1067 Default: yes
1068 If set, hitting backspace against an empty prompt aborts the
1070 prompt.
1071 abort_key
1075 Type: string
1076 Default: "007"
1077 Specifies the key that can be used to abort prompts. The format
1079 is the same as used in "bind" commands. The default is equiva‐
1080 lent to "Ctrl-G". Note that the specified key should not be
1081 used in other bindings, as the abort operation has higher prece‐
1082 dence and the binding will not have the desired effect.
1083 Example:
1085 set abort_key = "<Esc>"
1088 Please note that when using <Esc> as the abort key, you may also
1091 want to set the environment variable ESCDELAY to a low value or
1092 even 0 which will reduce the time that ncurses waits to distin‐
1093 guish singular <Esc> key presses from the start of a terminal
1094 escape sequence. The default time is 1000 milliseconds and thus
1095 quite noticeable.
1096 abort_noattach
1100 Type: quadoption
1101 Default: no
1102 If set to yes, when composing messages containing the regular
1104 expression specified by $abort_noattach_regex and no attachments
1105 are given, composition will be aborted. If set to no, composing
1106 messages as such will never be aborted.
1107 Example:
1109 set abort_noattach_regex = "\\<attach(|ed|ments?)\\>"
1112 abort_noattach_regex
1117 Type: regular expression
1118 Default: "\<(attach|attached|attachments?)\>"
1119 Specifies a regular expression to match against the body of the
1121 message, to determine if an attachment was mentioned but mistak‐
1122 enly forgotten. If it matches, $abort_noattach will be con‐
1123 sulted to determine if message sending will be aborted.
1124 Like other regular expressions in NeoMutt, the search is case
1126 sensitive if the pattern contains at least one upper case let‐
1127 ter, and case insensitive otherwise.
1128 abort_nosubject
1132 Type: quadoption
1133 Default: ask-yes
1134 If set to yes, when composing messages and no subject is given
1136 at the subject prompt, composition will be aborted. If set to
1137 no, composing messages with no subject given at the subject
1138 prompt will never be aborted.
1139 abort_unmodified
1143 Type: quadoption
1144 Default: yes
1145 If set to yes, composition will automatically abort after edit‐
1147 ing the message body if no changes are made to the file (this
1148 check only happens after the first edit of the file). When set
1149 to no, composition will never be aborted.
1150 account_command
1154 Type: command
1155 Default: ""
1156 If set, this command is used to retrieve account credentials.
1158 The command is invoked passing a number of --key value arguments
1159 with the specifics of the account to lookup. The command writes
1160 to standard output a number of key: value lines. Currently sup‐
1161 ported arguments are --hostname, --username, and --type, where
1162 type can be any of imap, imaps, pop, pops, smtp, smtps, nntp,
1163 and nntps. Currently supported output lines are login, username,
1164 and password.
1165 alias_file
1169 Type: path
1170 Default: "~/.neomuttrc"
1171 The default file in which to save aliases created by the <cre‐
1173 ate-alias> function. Entries added to this file are encoded in
1174 the character set specified by $config_charset if it is set or
1175 the current character set otherwise.
1176 Note: NeoMutt will not automatically source this file; you must
1178 explicitly use the "source" command for it to be executed in
1179 case this option points to a dedicated alias file.
1180 The default for this option is the currently used neomuttrc
1182 file, or "~/.neomuttrc" if no user neomuttrc was found.
1183 alias_format
1187 Type: string
1188 Default: "%3n %f%t %-15a %-56r | %c"
1189 Specifies the format of the data displayed for the "alias" menu.
1191 The following printf(3)-style sequences are available:
1192 %a Alias name
1193 %c Comment
1194 %f Flags - currently, a "d" for an alias marked for deletion
1195 %n Index number
1196 %r Address which alias expands to
1197 %t Character which indicates if the alias is tagged for in‐
1198 clusion
1199 %>X right justify the rest of the string and pad with charac‐
1200 ter "X"
1201 %|X pad to the end of the line with character "X"
1202 %*X soft-fill with character "X" as pad
1203 allow_8bit
1206 Type: boolean
1207 Default: yes
1208 Controls whether 8-bit data is converted to 7-bit using either
1210 Quoted- Printable or Base64 encoding when sending mail.
1211 allow_ansi
1215 Type: boolean
1216 Default: no
1217 Controls whether ANSI color codes in messages (and color tags in
1219 rich text messages) are to be interpreted. Messages containing
1220 these codes are rare, but if this option is set, their text will
1221 be colored accordingly. Note that this may override your color
1222 choices, and even present a security problem, since a message
1223 could include a line like
1224 [-- PGP output follows ...
1227 and give it the same color as your attachment color (see also
1230 $crypt_timestamp).
1231 arrow_cursor
1235 Type: boolean
1236 Default: no
1237 When set, an arrow ("->") will be used to indicate the current
1239 entry in menus instead of highlighting the whole line. On slow
1240 network or modem links this will make response faster because
1241 there is less that has to be redrawn on the screen when moving
1242 to the next or previous entries in the menu.
1243 arrow_string
1247 Type: string
1248 Default: "->"
1249 Specifies the string of arrow_cursor when arrow_cursor enabled.
1251 ascii_chars
1255 Type: boolean
1256 Default: no
1257 If set, NeoMutt will use plain ASCII characters when displaying
1259 thread and attachment trees, instead of the default ACS charac‐
1260 ters.
1261 ask_bcc
1265 Type: boolean
1266 Default: no
1267 If set, NeoMutt will prompt you for blind-carbon-copy (Bcc) re‐
1269 cipients before editing an outgoing message.
1270 ask_cc
1274 Type: boolean
1275 Default: no
1276 If set, NeoMutt will prompt you for carbon-copy (Cc) recipients
1278 before editing the body of an outgoing message.
1279 ask_followup_to
1283 Type: boolean
1284 Default: no
1285 If set, NeoMutt will prompt you for follow-up groups before
1287 editing the body of an outgoing message.
1288 ask_x_comment_to
1292 Type: boolean
1293 Default: no
1294 If set, NeoMutt will prompt you for x-comment-to field before
1296 editing the body of an outgoing message.
1297 assumed_charset
1301 Type: string list
1302 Default: ""
1303 This variable is a colon-separated list of character encoding
1305 schemes for messages without character encoding indication.
1306 Header field values and message body content without character
1307 encoding indication would be assumed that they are written in
1308 one of this list. By default, all the header fields and message
1309 body without any charset indication are assumed to be in
1310 "us-ascii".
1311 For example, Japanese users might prefer this:
1313 set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
1316 However, only the first content is valid for the message body.
1319 attach_charset
1323 Type: string list
1324 Default: ""
1325 This variable is a colon-separated list of character encoding
1327 schemes for text file attachments. NeoMutt uses this setting to
1328 guess which encoding files being attached are encoded in to con‐
1329 vert them to a proper character set given in $send_charset.
1330 If unset, the value of $charset will be used instead. For exam‐
1332 ple, the following configuration would work for Japanese text
1333 handling:
1334 set attach_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
1337 Note: for Japanese users, "iso-2022-*" must be put at the head
1340 of the value as shown above if included.
1341 attach_format
1345 Type: string
1346 Default: "%u%D%I %t%4n %T%d %> [%.7m/%.10M, %.6e%<C?, %C>, %s] "
1347 This variable describes the format of the "attachment" menu.
1349 The following printf(3)-style sequences are understood:
1350 %C Charset
1351 %c Requires charset conversion ("n" or "c")
1352 %D Deleted flag
1353 %d Description (if none, falls back to %F)
1354 %e MIME content-transfer-encoding
1355 %f Filename
1356 %F Filename in content-disposition header (if none, falls
1357 back to %f)
1358 %I Disposition ("I" for inline, "A" for attachment)
1359 %m Major MIME type
1360 %M MIME subtype
1361 %n Attachment number
1362 %Q "Q", if MIME part qualifies for attachment counting
1363 %s Size (see formatstrings-size)
1364 %T Graphic tree characters
1365 %t Tagged flag
1366 %u Unlink (=to delete) flag
1367 %X Number of qualifying MIME parts in this part and its
1368 children (please see the "attachments" section for possi‐
1369 ble speed effects)
1370 %>X Right justify the rest of the string and pad with charac‐
1371 ter "X"
1372 %|X Pad to the end of the line with character "X"
1373 %*X Soft-fill with character "X" as pad
1374 For an explanation of "soft-fill", see the $index_format docu‐
1376 mentation.
1377 attach_save_dir
1381 Type: path
1382 Default: "./"
1383 The directory where attachments are saved.
1385 attach_save_without_prompting
1389 Type: boolean
1390 Default: no
1391 This variable, when set to true, will cause attachments to be
1393 saved to the 'attach_save_dir' location without prompting the
1394 user for the filename.
1395 attach_sep
1397 Type: string
1398 Default: "\n"
1399 The separator to add between attachments when operating (saving,
1401 printing, piping, etc) on a list of tagged attachments.
1402 attach_split
1406 Type: boolean
1407 Default: yes
1408 If this variable is unset, when operating (saving, printing,
1410 piping, etc) on a list of tagged attachments, NeoMutt will con‐
1411 catenate the attachments and will operate on them as a single
1412 attachment. The $attach_sep separator is added after each at‐
1413 tachment. When set, NeoMutt will operate on the attachments one
1414 by one.
1415 attribution_intro
1419 Type: string
1420 Default: "On %d, %n wrote:"
1421 This is the string that will precede a replied-to message which
1423 is quoted in the main body of the reply (this is the case when
1424 $include is set).
1425 For a full listing of defined printf(3)-like sequences see the
1427 section on $index_format. See also $attribution_locale.
1428 attribution_locale
1432 Type: string
1433 Default: ""
1434 The locale used by strftime(3) to format dates in the attribu‐
1436 tion strings. Legal values are the strings your system accepts
1437 for the locale environment variable $LC_TIME.
1438 This variable is to allow the attribution date format to be cus‐
1440 tomized by recipient or folder using hooks. By default, NeoMutt
1441 will use your locale environment, so there is no need to set
1442 this except to override that default.
1443 Affected variables are: $attribution_intro, $attribu‐
1445 tion_trailer, $forward_attribution_intro, $forward_attribu‐
1446 tion_trailer, $indent_string.
1447 attribution_trailer
1451 Type: string
1452 Default: ""
1453 Similar to the $attribution_intro variable, this is the string
1455 that will come after a replied-to message which is quoted in the
1456 main body of the reply (this is the case when $include is set).
1457 For a full listing of defined printf(3)-like sequences see the
1459 section on $index_format. See also $attribution_locale.
1460 auto_edit
1464 Type: boolean
1465 Default: no
1466 When set along with $edit_headers, NeoMutt will skip the initial
1468 send-menu (prompting for subject and recipients) and allow you
1469 to immediately begin editing the body of your message. The
1470 send-menu may still be accessed once you have finished editing
1471 the body of your message.
1472 Note: when this option is set, you can't use send-hooks that de‐
1474 pend on the recipients when composing a new (non-reply) message,
1475 as the initial list of recipients is empty.
1476 Also see $fast_reply.
1478 auto_subscribe
1482 Type: boolean
1483 Default: no
1484 When set, NeoMutt assumes the presence of a List-Post header
1486 means the recipient is subscribed to the list. Unless the mail‐
1487 ing list is in the "unsubscribe" or "unlist" lists, it will be
1488 added to the "subscribe" list. Parsing and checking these
1489 things slows header reading down, so this option is disabled by
1490 default.
1491 auto_tag
1495 Type: boolean
1496 Default: no
1497 When set, functions in the index menu which affect a message
1499 will be applied to all tagged messages (if there are any). When
1500 unset, you must first use the <tag-prefix> function (bound to
1501 ";" by default) to make the next function apply to all tagged
1502 messages.
1503 autocrypt
1507 Type: boolean
1508 Default: no
1509 When set, enables autocrypt, which provides passive encryption
1511 protection with keys exchanged via headers. See "autocryptdoc"
1512 for more details. (Autocrypt only)
1513 autocrypt_acct_format
1517 Type: string
1518 Default: "%4n %-30a %20p %10s"
1519 This variable describes the format of the "autocrypt account"
1521 menu. The following printf(3)-style sequences are understood
1522 %a email address
1523 %k gpg keyid
1524 %n current entry number
1525 %p prefer-encrypt flag
1526 %s status flag (active/inactive)
1527 (Autocrypt only)
1529 autocrypt_dir
1533 Type: path
1534 Default: "~/.mutt/autocrypt"
1535 This variable sets where autocrypt files are stored, including
1537 the GPG keyring and SQLite database. See "autocryptdoc" for
1538 more details. (Autocrypt only)
1539 autocrypt_reply
1543 Type: boolean
1544 Default: yes
1545 When set, replying to an autocrypt email automatically enables
1547 autocrypt in the reply. You may want to unset this if you're
1548 using the same key for autocrypt as normal web-of-trust, so that
1549 autocrypt isn't forced on for all encrypted replies. (Autocrypt
1550 only)
1551 beep
1555 Type: boolean
1556 Default: yes
1557 When this variable is set, NeoMutt will beep when an error oc‐
1559 curs.
1560 beep_new
1564 Type: boolean
1565 Default: no
1566 When this variable is set, NeoMutt will beep whenever it prints
1568 a message notifying you of new mail. This is independent of the
1569 setting of the $beep variable.
1570 bounce
1574 Type: quadoption
1575 Default: ask-yes
1576 Controls whether you will be asked to confirm bouncing messages.
1578 If set to yes you don't get asked if you want to bounce a mes‐
1579 sage. Setting this variable to no is not generally useful, and
1580 thus not recommended, because you are unable to bounce messages.
1581 bounce_delivered
1585 Type: boolean
1586 Default: yes
1587 When this variable is set, NeoMutt will include Delivered-To
1589 headers when bouncing messages. Postfix users may wish to unset
1590 this variable.
1591 braille_friendly
1595 Type: boolean
1596 Default: no
1597 When this variable is set, NeoMutt will place the cursor at the
1599 beginning of the current line in menus, even when the $ar‐
1600 row_cursor variable is unset, making it easier for blind persons
1601 using Braille displays to follow these menus. The option is un‐
1602 set by default because many visual terminals don't permit making
1603 the cursor invisible.
1604 browser_abbreviate_mailboxes
1608 Type: boolean
1609 Default: yes
1610 When this variable is set, NeoMutt will abbreviate mailbox names
1612 in the browser mailbox list, using '~' and '=' shortcuts.
1613 The default "alpha" setting of $sort_browser uses locale-based
1615 sorting (using strcoll(3)), which ignores some punctuation.
1616 This can lead to some situations where the order doesn't make
1617 intuitive sense. In those cases, it may be desirable to unset
1618 this variable.
1619 catchup_newsgroup
1623 Type: quadoption
1624 Default: ask-yes
1625 If this variable is set, NeoMutt will mark all articles in news‐
1627 group as read when you quit the newsgroup (catchup newsgroup).
1628 certificate_file
1632 Type: path
1633 Default: "~/.mutt_certificates"
1634 This variable specifies the file where the certificates you
1636 trust are saved. When an unknown certificate is encountered, you
1637 are asked if you accept it or not. If you accept it, the cer‐
1638 tificate can also be saved in this file and further connections
1639 are automatically accepted.
1640 You can also manually add CA certificates in this file. Any
1642 server certificate that is signed with one of these CA certifi‐
1643 cates is also automatically accepted.
1644 Example:
1646 set certificate_file=~/.neomutt/certificates
1649 change_folder_next
1654 Type: boolean
1655 Default: no
1656 When this variable is set, the <change-folder> function mailbox
1658 suggestion will start at the next folder in your "mailboxes"
1659 list, instead of starting at the first folder in the list.
1660 charset
1664 Type: string
1665 Default: ""
1666 Character set your terminal uses to display and enter textual
1668 data. It is also the fallback for $send_charset.
1669 Upon startup NeoMutt tries to derive this value from environment
1671 variables such as $LC_CTYPE or $LANG.
1672 Note: It should only be set in case NeoMutt isn't able to deter‐
1674 mine the character set used correctly.
1675 check_mbox_size
1679 Type: boolean
1680 Default: no
1681 When this variable is set, NeoMutt will use file size attribute
1683 instead of access time when checking for new mail in mbox and
1684 mmdf folders.
1685 This variable is unset by default and should only be enabled
1687 when new mail detection for these folder types is unreliable or
1688 doesn't work.
1689 Note that enabling this variable should happen before any "mail‐
1691 boxes" directives occur in configuration files regarding mbox or
1692 mmdf folders because NeoMutt needs to determine the initial new
1693 mail status of such a mailbox by performing a fast mailbox scan
1694 when it is defined. Afterwards the new mail status is tracked
1695 by file size changes.
1696 check_new
1700 Type: boolean
1701 Default: yes
1702 Note: this option only affects maildir and MH style mailboxes.
1704 When set, NeoMutt will check for new mail delivered while the
1706 mailbox is open. Especially with MH mailboxes, this operation
1707 can take quite some time since it involves scanning the direc‐
1708 tory and checking each file to see if it has already been looked
1709 at. If this variable is unset, no check for new mail is per‐
1710 formed while the mailbox is open.
1711 collapse_all
1715 Type: boolean
1716 Default: no
1717 When set, NeoMutt will collapse all threads when entering a
1719 folder.
1720 collapse_flagged
1724 Type: boolean
1725 Default: yes
1726 When unset, NeoMutt will not collapse a thread if it contains
1728 any flagged messages.
1729 collapse_unread
1733 Type: boolean
1734 Default: yes
1735 When unset, NeoMutt will not collapse a thread if it contains
1737 any unread messages.
1738 color_directcolor
1742 Type: boolean
1743 Default: no
1744 When set, NeoMutt will use and allow 24bit colours (aka true‐
1746 color aka directcolor). For colours to work properly support
1747 from the terminal is required as well as a properly set TERM en‐
1748 vironment variable advertising the terminals directcolor capa‐
1749 bility, e.g. "TERM=xterm-direct".
1750 NeoMutt tries to detect whether the terminal supports 24bit
1752 colours and enables this variable if it does. If this fails for
1753 some reason, you can force 24bit colours by setting this vari‐
1754 able manually. You may also try to force a certain TERM envi‐
1755 ronment variable by starting NeoMutt from a terminal as follows
1756 (this results in wrong colours if the terminal does not imple‐
1757 ment directcolors):
1758 TERM=xterm-direct neomutt
1761 Note: This variable must be set before using any `color` com‐
1764 mands.
1765 compose_format
1767 Type: string
1768 Default: "-- NeoMutt: Compose [Approx. msg size: %l Atts: %a]%>-"
1769 Controls the format of the status line displayed in the "com‐
1771 pose" menu. This string is similar to $status_format, but has
1772 its own set of printf(3)-like sequences:
1773 %a Total number of attachments
1774 %h Local hostname
1775 %l Approximate size (in bytes) of the current message (see
1776 formatstrings-size)
1777 %v NeoMutt version string
1778 %>X right justify the rest of the string and pad with charac‐
1779 ter "X"
1780 %|X pad to the end of the line with character "X"
1781 %*X soft-fill with character "X" as pad
1782 See the text describing the $status_format option for more in‐
1784 formation on how to set $compose_format.
1785 compose_show_user_headers
1789 Type: boolean
1790 Default: yes
1791 When set, Neomutt will display user-defined headers (set via
1793 my_hdr or from editing with edit-headers).
1794 config_charset
1798 Type: string
1799 Default: ""
1800 When defined, NeoMutt will recode commands in rc files from this
1802 encoding to the current character set as specified by $charset
1803 and aliases written to $alias_file from the current character
1804 set.
1805 Please note that if setting $charset it must be done before set‐
1807 ting $config_charset.
1808 Recoding should be avoided as it may render unconvertable char‐
1810 acters as question marks which can lead to undesired side ef‐
1811 fects (for example in regular expressions).
1812 confirm_append
1816 Type: boolean
1817 Default: yes
1818 When set, NeoMutt will prompt for confirmation when appending
1820 messages to an existing mailbox.
1821 confirm_create
1825 Type: boolean
1826 Default: yes
1827 When set, NeoMutt will prompt for confirmation when saving mes‐
1829 sages to a mailbox which does not yet exist before creating it.
1830 content_type
1834 Type: string
1835 Default: "text/plain"
1836 Sets the default Content-Type for the body of newly composed
1838 messages.
1839 copy
1843 Type: quadoption
1844 Default: yes
1845 This variable controls whether or not copies of your outgoing
1847 messages will be saved for later references. Also see $record,
1848 $save_name, $force_name and "fcc-hook".
1849 copy_decode_weed
1853 Type: boolean
1854 Default: no
1855 Controls whether NeoMutt will weed headers when invoking the
1857 <decode-copy> or <decode-save> functions.
1858 count_alternatives
1862 Type: boolean
1863 Default: no
1864 When set, NeoMutt will recurse inside multipart/alternatives
1866 while performing attachment searching and counting(see attach‐
1867 ments).
1868 Traditionally, multipart/alternative parts have simply repre‐
1870 sented different encodings of the main content of the email.
1871 Unfortunately, some mail clients have started to place email at‐
1872 tachments inside one of alternatives. Setting this will allow
1873 NeoMutt to find and count matching attachments hidden there, and
1874 include them in the index via %X or through ~X pattern matching.
1875 crypt_auto_encrypt
1879 Type: boolean
1880 Default: no
1881 Setting this variable will cause NeoMutt to always attempt to
1883 PGP encrypt outgoing messages. This is probably only useful in
1884 connection to the "send-hook" command. It can be overridden by
1885 use of the pgp menu, when encryption is not required or signing
1886 is requested as well. If $smime_is_default is set, then OpenSSL
1887 is used instead to create S/MIME messages and settings can be
1888 overridden by use of the smime menu instead. (Crypto only)
1889 crypt_auto_pgp
1893 Type: boolean
1894 Default: yes
1895 This variable controls whether or not NeoMutt may automatically
1897 enable PGP encryption/signing for messages. See also
1898 $crypt_auto_encrypt, $crypt_reply_encrypt, $crypt_auto_sign,
1899 $crypt_reply_sign and $smime_is_default.
1900 crypt_auto_sign
1904 Type: boolean
1905 Default: no
1906 Setting this variable will cause NeoMutt to always attempt to
1908 cryptographically sign outgoing messages. This can be overrid‐
1909 den by use of the pgp menu, when signing is not required or en‐
1910 cryption is requested as well. If $smime_is_default is set, then
1911 OpenSSL is used instead to create S/MIME messages and settings
1912 can be overridden by use of the smime menu instead of the pgp
1913 menu. (Crypto only)
1914 crypt_auto_smime
1918 Type: boolean
1919 Default: yes
1920 This variable controls whether or not NeoMutt may automatically
1922 enable S/MIME encryption/signing for messages. See also
1923 $crypt_auto_encrypt, $crypt_reply_encrypt, $crypt_auto_sign,
1924 $crypt_reply_sign and $smime_is_default.
1925 crypt_chars
1929 Type: character string
1930 Default: "SPsK "
1931 Controls the characters used in cryptography flags.
1933 Character
1934 Default Description
1935 1 S The mail is signed, and the signature is successfully
1936 verified.
1937 2 P The mail is PGP encrypted.
1938 3 s The mail is signed.
1939 4 K The mail contains a PGP public key.
1940 5 <space> The mail has no crypto info.
1941 crypt_confirm_hook
1944 Type: boolean
1945 Default: yes
1946 If set, then you will be prompted for confirmation of keys when
1948 using the crypt-hook command. If unset, no such confirmation
1949 prompt will be presented. This is generally considered unsafe,
1950 especially where typos are concerned.
1951 crypt_opportunistic_encrypt
1955 Type: boolean
1956 Default: no
1957 Setting this variable will cause NeoMutt to automatically enable
1959 and disable encryption, based on whether all message recipient
1960 keys can be located by NeoMutt.
1961 When this option is enabled, NeoMutt will enable/disable encryp‐
1963 tion each time the TO, CC, and BCC lists are edited. If
1964 $edit_headers is set, NeoMutt will also do so each time the mes‐
1965 sage is edited.
1966 While this is set, encryption can't be manually enabled/dis‐
1968 abled. The pgp or smime menus provide a selection to temporar‐
1969 ily disable this option for the current message.
1970 If $crypt_auto_encrypt or $crypt_reply_encrypt enable encryption
1972 for a message, this option will be disabled for that message.
1973 It can be manually re-enabled in the pgp or smime menus.
1974 (Crypto only)
1975 crypt_opportunistic_encrypt_strong_keys
1979 Type: boolean
1980 Default: no
1981 When set, this modifies the behavior of $crypt_opportunistic_en‐
1983 crypt to only search for "strong keys", that is, keys with full
1984 validity according to the web-of-trust algorithm. A key with
1985 marginal or no validity will not enable opportunistic encryp‐
1986 tion.
1987 For S/MIME, the behavior depends on the backend. Classic S/MIME
1989 will filter for certificates with the 't'(trusted) flag in the
1990 .index file. The GPGME backend will use the same filters as
1991 with OpenPGP, and depends on GPGME's logic for assigning the
1992 GPGME_VALIDITY_FULL and GPGME_VALIDITY_ULTIMATE validity flag.
1993 crypt_protected_headers_read
1997 Type: boolean
1998 Default: yes
1999 When set, NeoMutt will display protected headers ("Memory Hole")
2001 in the pager, When set, NeoMutt will display protected headers
2002 in the pager, and will update the index and header cache with
2003 revised headers.
2004 Protected headers are stored inside the encrypted or signed part
2006 of an an email, to prevent disclosure or tampering. For more
2007 information see https://github.com/autocrypt/protected-headers
2008 Currently NeoMutt only supports the Subject header.
2009 Encrypted messages using protected headers often substitute the
2011 exposed Subject header with a dummy value (see $crypt_pro‐
2012 tected_headers_subject). NeoMutt will update its concept of the
2013 correct subject after the message is opened, i.e. via the <dis‐
2014 play-message> function. If you reply to a message before open‐
2015 ing it, NeoMutt will end up using the dummy Subject header, so
2016 be sure to open such a message first. (Crypto only)
2017 crypt_protected_headers_save
2021 Type: boolean
2022 Default: no
2023 When $crypt_protected_headers_read is set, and a message with a
2025 protected Subject is opened, NeoMutt will save the updated Sub‐
2026 ject into the header cache by default. This allows search‐
2027 ing/limiting based on the protected Subject header if the mail‐
2028 box is re-opened, without having to re-open the message each
2029 time. However, for mbox/mh mailbox types, or if header caching
2030 is not set up, you would need to re-open the message each time
2031 the mailbox was reopened before you could see or search/limit on
2032 the protected subject again.
2033 When this variable is set, NeoMutt additionally saves the pro‐
2035 tected Subject back in the clear-text message headers. This
2036 provides better usability, but with the tradeoff of reduced se‐
2037 curity. The protected Subject header, which may have previously
2038 been encrypted, is now stored in clear-text in the message head‐
2039 ers. Copying the message elsewhere, via NeoMutt or external
2040 tools, could expose this previously encrypted data. Please make
2041 sure you understand the consequences of this before you enable
2042 this variable. (Crypto only)
2043 crypt_protected_headers_subject
2047 Type: string
2048 Default: "..."
2049 When $crypt_protected_headers_write is set, and the message is
2051 marked for encryption, this will be substituted into the Subject
2052 field in the message headers.
2053 To prevent a subject from being substituted, unset this vari‐
2055 able, or set it to the empty string. (Crypto only)
2056 crypt_protected_headers_write
2060 Type: boolean
2061 Default: no
2062 When set, NeoMutt will generate protected headers for signed and
2064 encrypted emails.
2065 Protected headers are stored inside the encrypted or signed part
2067 of an an email, to prevent disclosure or tampering. For more
2068 information see https://github.com/autocrypt/protected-headers
2069 Currently NeoMutt only supports the Subject header. (Crypto
2071 only)
2072 crypt_reply_encrypt
2076 Type: boolean
2077 Default: yes
2078 If set, automatically PGP or OpenSSL encrypt replies to messages
2080 which are encrypted. (Crypto only)
2081 crypt_reply_sign
2085 Type: boolean
2086 Default: no
2087 If set, automatically PGP or OpenSSL sign replies to messages
2089 which are signed.
2090 Note: this does not work on messages that are encrypted and
2092 signed! (Crypto only)
2093 crypt_reply_sign_encrypted
2097 Type: boolean
2098 Default: no
2099 If set, automatically PGP or OpenSSL sign replies to messages
2101 which are encrypted. This makes sense in combination with
2102 $crypt_reply_encrypt, because it allows you to sign all messages
2103 which are automatically encrypted. This works around the prob‐
2104 lem noted in $crypt_reply_sign, that NeoMutt is not able to find
2105 out whether an encrypted message is also signed. (Crypto only)
2106 crypt_timestamp
2110 Type: boolean
2111 Default: yes
2112 If set, NeoMutt will include a time stamp in the lines surround‐
2114 ing PGP or S/MIME output, so spoofing such lines is more diffi‐
2115 cult. If you are using colors to mark these lines, and rely on
2116 these, you may unset this setting. (Crypto only)
2117 crypt_use_gpgme
2121 Type: boolean
2122 Default: yes
2123 This variable controls the use of the GPGME-enabled crypto back‐
2125 ends. If it is set and NeoMutt was built with GPGME support,
2126 the gpgme code for S/MIME and PGP will be used instead of the
2127 classic code. Note that you need to set this option in .neomut‐
2128 trc; it won't have any effect when used interactively.
2129 Note that the GPGME backend does not support creating old-style
2131 inline (traditional) PGP encrypted or signed messages (see
2132 $pgp_auto_inline).
2133 crypt_use_pka
2137 Type: boolean
2138 Default: no
2139 Controls whether NeoMutt uses PKA (see
2141 http://www.g10code.de/docs/pka-intro.de.pdf) during signature
2142 verification (only supported by the GPGME backend).
2143 crypt_verify_sig
2147 Type: quadoption
2148 Default: yes
2149 If "yes", always attempt to verify PGP or S/MIME signatures. If
2151 "ask-*", ask whether or not to verify the signature. If "no",
2152 never attempt to verify cryptographic signatures. (Crypto only)
2153 date_format
2157 Type: string
2158 Default: "!%a, %b %d, %Y at %I:%M:%S%p %Z"
2159 Instead of using $date_format it is encouraged to use "%[fmt]"
2161 directly in the corresponding format strings, where "fmt" is the
2162 value of $date_format. This allows for a more fine grained con‐
2163 trol of the different menu needs.
2164 This variable controls the format of the date printed by the
2166 "%d" sequence in $index_format. This is passed to the strf‐
2167 time(3) function to process the date, see the man page for the
2168 proper syntax.
2169 Unless the first character in the string is a bang ("!"), the
2171 month and week day names are expanded according to the locale.
2172 If the first character in the string is a bang, the bang is dis‐
2173 carded, and the month and week day names in the rest of the
2174 string are expanded in the C locale (that is in US English).
2175 Format strings using this variable are:
2177 UI: $folder_format, $index_format, $mailbox_folder_format, $mes‐
2179 sage_format.IP Composing: $attribution_intro, $forward_attribu‐
2180 tion_intro, $forward_attribution_trailer, $forward_format, $in‐
2181 dent_string.
2182 debug_file
2184 Type: path
2185 Default: "~/.neomuttdebug"
2186 Debug logging is controlled by the variables $debug_file and
2188 $debug_level. $debug_file specifies the root of the filename.
2189 NeoMutt will add "0" to the end. Each time NeoMutt is run with
2190 logging enabled, the log files are rotated. A maximum of five
2191 log files are kept, numbered 0 (most recent) to 4 (oldest).
2192 This option can be enabled on the command line, "neomutt -l my‐
2194 log"
2195 See also: $debug_level
2197 debug_level
2201 Type: number
2202 Default: 0
2203 Debug logging is controlled by the variables $debug_file and
2205 $debug_level.
2206 The debug level controls how much information is saved to the
2208 log file. If you have a problem with NeoMutt, then enabling
2209 logging may help find the cause. Levels 1-3 will usually pro‐
2210 vide enough information for writing a bug report. Levels 4,5
2211 will be extremely verbose.
2212 Warning: Logging at high levels may save private information to
2214 the file.
2215 This option can be enabled on the command line, "neomutt -d 2"
2217 See also: $debug_file
2219 default_hook
2223 Type: string
2224 Default: "~f %s !~P | (~P ~C %s)"
2225 This variable controls how some hooks are interpreted if their
2227 pattern is a plain string or a regex. i.e. they don't contain a
2228 pattern, like ~f
2229 The hooks are: fcc-hook, fcc-save-hook, index-format-hook, mes‐
2231 sage-hook, reply-hook, save-hook, send-hook and send2-hook.
2232 The hooks are expanded when they are declared, so a hook will be
2234 interpreted according to the value of this variable at the time
2235 the hook is declared.
2236 The default value matches if the message is either from a user
2238 matching the regular expression given, or if it is from you (if
2239 the from address matches "alternates") and is to or cc'ed to a
2240 user matching the given regular expression.
2241 delete
2245 Type: quadoption
2246 Default: ask-yes
2247 Controls whether or not messages are really deleted when closing
2249 or synchronizing a mailbox. If set to yes, messages marked for
2250 deleting will automatically be purged without prompting. If set
2251 to no, messages marked for deletion will be kept in the mailbox.
2252 delete_untag
2256 Type: boolean
2257 Default: yes
2258 If this option is set, NeoMutt will untag messages when marking
2260 them for deletion. This applies when you either explicitly
2261 delete a message, or when you save it to another folder.
2262 digest_collapse
2266 Type: boolean
2267 Default: yes
2268 If this option is set, NeoMutt's received-attachments menu will
2270 not show the subparts of individual messages in a multipart/di‐
2271 gest. To see these subparts, press "v" on that menu.
2272 display_filter
2276 Type: command
2277 Default: ""
2278 When set, specifies a command used to filter messages. When a
2280 message is viewed it is passed as standard input to $dis‐
2281 play_filter, and the filtered message is read from the standard
2282 output.
2283 When preparing the message, NeoMutt inserts some escape se‐
2285 quences into the text. They are of the form: <esc>]9;XXX<bel>
2286 where "XXX" is a random 64-bit number.
2287 If these escape sequences interfere with your filter, they can
2289 be removed using a tool like ansifilter or sed
2290 's/^\x1b]9;[0-9]\+\x7//'
2291 If they are removed, then PGP and MIME headers will no longer be
2293 coloured. This can be fixed by adding this to your config:
2294 color body magenta default '^\[-- .* --\]$'.
2295 dsn_notify
2299 Type: string
2300 Default: ""
2301 This variable sets the request for when notification is re‐
2303 turned. The string consists of a comma separated list (no spa‐
2304 ces!) of one or more of the following: never, to never request
2305 notification, failure, to request notification on transmission
2306 failure, delay, to be notified of message delays, success, to be
2307 notified of successful transmission.
2308 Example:
2310 set dsn_notify="failure,delay"
2313 Note: when using $sendmail for delivery, you should not enable
2316 this unless you are either using Sendmail 8.8.x or greater or a
2317 MTA providing a sendmail(1)-compatible interface supporting the
2318 -N option for DSN. For SMTP delivery, DSN support is auto-de‐
2319 tected so that it depends on the server whether DSN will be used
2320 or not.
2321 dsn_return
2325 Type: string
2326 Default: ""
2327 This variable controls how much of your message is returned in
2329 DSN messages. It may be set to either hdrs to return just the
2330 message header, or full to return the full message.
2331 Example:
2333 set dsn_return=hdrs
2336 Note: when using $sendmail for delivery, you should not enable
2339 this unless you are either using Sendmail 8.8.x or greater or a
2340 MTA providing a sendmail(1)-compatible interface supporting the
2341 -R option for DSN. For SMTP delivery, DSN support is auto-de‐
2342 tected so that it depends on the server whether DSN will be used
2343 or not.
2344 duplicate_threads
2348 Type: boolean
2349 Default: yes
2350 This variable controls whether NeoMutt, when $sort is set to
2352 threads, threads messages with the same Message-Id together. If
2353 it is set, it will indicate that it thinks they are duplicates
2354 of each other with an equals sign in the thread tree.
2355 edit_headers
2359 Type: boolean
2360 Default: no
2361 This option allows you to edit the header of your outgoing mes‐
2363 sages along with the body of your message.
2364 Although the compose menu may have localized header labels, the
2366 labels passed to your editor will be standard RFC2822 headers,
2367 (e.g. To:, Cc:, Subject:). Headers added in your editor must
2368 also be RFC2822 headers, or one of the pseudo headers listed in
2369 "edit-header". NeoMutt will not understand localized header la‐
2370 bels, just as it would not when parsing an actual email.
2371 Note that changes made to the References: and Date: headers are
2373 ignored for interoperability reasons.
2374 editor
2378 Type: command
2379 Default: ""
2380 This variable specifies which editor is used by NeoMutt. It de‐
2382 faults to the value of the $VISUAL, or $EDITOR, environment
2383 variable, or to the string "vi" if neither of those are set.
2384 The $editor string may contain a %s escape, which will be re‐
2386 placed by the name of the file to be edited. If the %s escape
2387 does not appear in $editor, a space and the name to be edited
2388 are appended.
2389 The resulting string is then executed by running
2391 sh -c 'string'
2394 where string is the expansion of $editor described above.
2397 empty_subject
2401 Type: string
2402 Default: "Re: your mail"
2403 This variable specifies the subject to be used when replying to
2405 an email with an empty subject. It defaults to "Re: your mail".
2406 encode_from
2410 Type: boolean
2411 Default: no
2412 When set, NeoMutt will quoted-printable encode messages when
2414 they contain the string "From " (note the trailing space) in the
2415 beginning of a line. This is useful to avoid the tampering cer‐
2416 tain mail delivery and transport agents tend to do with messages
2417 (in order to prevent tools from misinterpreting the line as a
2418 mbox message separator).
2419 entropy_file
2423 Type: path
2424 Default: ""
2425 The file which includes random data that is used to initialize
2427 SSL library functions.
2428 envelope_from_address
2432 Type: e-mail address
2433 Default: ""
2434 Manually sets the envelope sender for outgoing messages. This
2436 value is ignored if $use_envelope_from is unset.
2437 external_search_command
2441 Type: command
2442 Default: ""
2443 If set, contains the name of the external program used by "~I"
2445 patterns. This will usually be a wrapper script around mairix,
2446 mu, or similar indexers other than notmuch (for which there is
2447 optional special support).
2448 Here is an example how it works. Let's assume $exter‐
2450 nal_search_command is set to "mairix_filter", and mairix_filter
2451 is a script which runs the old but well loved mairix indexer
2452 with the arguments given to mairix_filter, in the "raw" mode of
2453 mairix, producing on the standard output a list of Message-IDs,
2454 one per line.
2455 If possible, it also filters down the results coming from mairix
2457 such that only messages in the current folder remain. It can do
2458 this because it gets a hidden first argument which is the path
2459 to the folder. (This can be the type of clean and simple script
2460 called a one-liner.)
2461 Now if NeoMutt gets a limit or tag command followed by the pat‐
2463 tern "~I '-t s:bleeping='", mairix_filter runs mairix with the
2464 arguments from inside the quotes (the quotes are needed because
2465 of the space after "-t"), mairix finds all messages with "bleep‐
2466 ing" in the Subject plus all messages sharing threads with these
2467 and outputs their file names, and mairix_filter translates the
2468 file names into Message-IDs. Finally, NeoMutt reads the Mes‐
2469 sage-IDs and targets the matching messages with the command
2470 given to it.
2471 You, the user, still have to rewrite the mairix_filter script to
2473 match the behavior of your indexer, but this should help users
2474 of indexers other than notmuch to integrate them cleanly with
2475 NeoMutt.
2476 fast_reply
2480 Type: boolean
2481 Default: no
2482 When set, the initial prompt for recipients (to, cc, bcc) and
2484 subject are skipped when the relevant information is already
2485 provided. These cases include replying to messages and passing
2486 the relevant command line arguments. The initial prompt for re‐
2487 cipients is also skipped when composing a new message to the
2488 current message sender, while the initial prompt for subject is
2489 also skipped when forwarding messages.
2490 Note: this variable has no effect when the $auto_edit variable
2492 is set.
2493 See also: $auto_edit, $edit_headers, $ask_cc, $ask_bcc
2495 fcc_attach
2499 Type: quadoption
2500 Default: yes
2501 This variable controls whether or not attachments on outgoing
2503 messages are saved along with the main body of your message.
2504 Note: $fcc_before_send forces the default (set) behavior of this
2506 option.
2507 fcc_before_send
2511 Type: boolean
2512 Default: no
2513 When this variable is set, FCCs will occur before sending the
2515 message. Before sending, the message cannot be manipulated, so
2516 it will be stored the exact same as sent: $fcc_attach and
2517 $fcc_clear will be ignored (using their default values).
2518 When unset, the default, FCCs will occur after sending. Vari‐
2520 ables $fcc_attach and $fcc_clear will be respected, allowing it
2521 to be stored without attachments or encryption/signing if de‐
2522 sired.
2523 fcc_clear
2527 Type: boolean
2528 Default: no
2529 When this variable is set, FCCs will be stored unencrypted and
2531 unsigned, even when the actual message is encrypted and/or
2532 signed.
2533 Note: $fcc_before_send forces the default (unset) behavior of
2535 this option. (PGP only)
2536 See also $pgp_self_encrypt, $smime_self_encrypt
2538 flag_chars
2542 Type: character string
2543 Default: "*!DdrONon- "
2544 Controls the characters used in several flags.
2546 Character
2547 Default Description
2548 1 * The mail is tagged.
2549 2 ! The mail is flagged as important.
2550 3 D The mail is marked for deletion.
2551 4 d The mail has attachments marked for deletion.
2552 5 r The mail has been replied to.
2553 6 O The mail is Old (Unread but seen).
2554 7 N The mail is New (Unread but not seen).
2555 8 o The mail thread is Old (Unread but seen).
2556 9 n The mail thread is New (Unread but not seen).
2557 10 - The mail is read - %S expando.
2558 11 <space> The mail is read - %Z expando.
2559 flag_safe
2562 Type: boolean
2563 Default: no
2564 If set, flagged messages can't be deleted.
2566 folder
2570 Type: mailbox
2571 Default: "~/Mail"
2572 Specifies the default location of your mailboxes. A "+" or "="
2574 at the beginning of a pathname will be expanded to the value of
2575 this variable. Note that if you change this variable (from the
2576 default) value you need to make sure that the assignment occurs
2577 before you use "+" or "=" for any other variables since expan‐
2578 sion takes place when handling the "mailboxes" command.
2579 folder_format
2583 Type: string
2584 Default: "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %i"
2585 This variable allows you to customize the file browser display
2587 to your personal taste. This string is similar to $index_for‐
2588 mat, but has its own set of printf(3)-like sequences:
2589 %C
2590 Current file number
2592 %d
2593 Date/time folder was last modified
2595 %D
2596 Date/time folder was last modified using $date_format.
2598 It is encouraged to use "%[fmt]" instead, where "fmt" is
2599 the value of $date_format.
2600 %f
2601 Filename ("/" is appended to directory names, "@" to sym‐
2603 bolic links and "*" to executable files)
2604 %F
2605 File permissions
2607 %g
2608 Group name (or numeric gid, if missing)
2610 %i
2611 Description of the folder
2613 %l
2614 Number of hard links
2616 %m * Number of messages in the mailbox
2617 %n * Number of unread messages in the mailbox
2618 %N
2619 "N" if mailbox has new mail, " " (space) otherwise
2621 %s
2622 Size in bytes (see formatstrings-size)
2624 %t
2625 "*" if the file is tagged, blank otherwise
2627 %u
2628 Owner name (or numeric uid, if missing)
2630 %[fmt]
2631 Date/time folder was last modified using an strftime(3)
2633 expression
2634 %>X
2635 Right justify the rest of the string and pad with charac‐
2637 ter "X"
2638 %|X
2639 Pad to the end of the line with character "X"
2641 %*X
2642 Soft-fill with character "X" as pad
2644 For an explanation of "soft-fill", see the $index_format docu‐
2646 mentation.
2647 * = can be optionally printed if nonzero
2649 %m, %n, and %N only work for monitored mailboxes. %m requires
2651 $mail_check_stats to be set. %n requires $mail_check_stats to
2652 be set (except for IMAP mailboxes).
2653 followup_to
2657 Type: boolean
2658 Default: yes
2659 Controls whether or not the "Mail-Followup-To:" header field is
2661 generated when sending mail. When set, NeoMutt will generate
2662 this field when you are replying to a known mailing list, speci‐
2663 fied with the "subscribe" or "lists" commands.
2664 This field has two purposes. First, preventing you from receiv‐
2666 ing duplicate copies of replies to messages which you send to
2667 mailing lists, and second, ensuring that you do get a reply sep‐
2668 arately for any messages sent to known lists to which you are
2669 not subscribed.
2670 The header will contain only the list's address for subscribed
2672 lists, and both the list address and your own email address for
2673 unsubscribed lists. Without this header, a group reply to your
2674 message sent to a subscribed list will be sent to both the list
2675 and your address, resulting in two copies of the same email for
2676 you.
2677 followup_to_poster
2681 Type: quadoption
2682 Default: ask-yes
2683 If this variable is set and the keyword "poster" is present in
2685 Followup-To header, follow-up to newsgroup function is not per‐
2686 mitted. The message will be mailed to the submitter of the mes‐
2687 sage via mail.
2688 force_name
2692 Type: boolean
2693 Default: no
2694 This variable is similar to $save_name, except that NeoMutt will
2696 store a copy of your outgoing message by the username of the ad‐
2697 dress you are sending to even if that mailbox does not exist.
2698 Also see the $record variable.
2700 forward_attachments
2704 Type: quadoption
2705 Default: ask-yes
2706 When forwarding inline (i.e. $mime_forward unset or answered
2708 with "no" and $forward_decode set), attachments which cannot be
2709 decoded in a reasonable manner will be attached to the newly
2710 composed message if this quadoption is set or answered with
2711 "yes".
2712 forward_attribution_intro
2716 Type: string
2717 Default: "----- Forwarded message from %f -----"
2718 This is the string that will precede a message which has been
2720 forwarded in the main body of a message (when $mime_forward is
2721 unset). For a full listing of defined printf(3)-like sequences
2722 see the section on $index_format. See also $attribution_locale.
2723 forward_attribution_trailer
2727 Type: string
2728 Default: "----- End forwarded message -----"
2729 This is the string that will follow a message which has been
2731 forwarded in the main body of a message (when $mime_forward is
2732 unset). For a full listing of defined printf(3)-like sequences
2733 see the section on $index_format. See also $attribution_locale.
2734 forward_decode
2738 Type: boolean
2739 Default: yes
2740 Controls the decoding of complex MIME messages into text/plain
2742 when forwarding a message. The message header is also RFC2047
2743 decoded. This variable is only used, if $mime_forward is unset,
2744 otherwise $mime_forward_decode is used instead.
2745 forward_decrypt
2749 Type: boolean
2750 Default: yes
2751 Controls the handling of encrypted messages when forwarding a
2753 message. When set, the outer layer of encryption is stripped
2754 off. This variable is only used if $mime_forward is set and
2755 $mime_forward_decode is unset.
2756 forward_edit
2760 Type: quadoption
2761 Default: yes
2762 This quadoption controls whether or not the user is automati‐
2764 cally placed in the editor when forwarding messages. For those
2765 who always want to forward with no modification, use a setting
2766 of "no".
2767 forward_format
2771 Type: string
2772 Default: "[%a: %s]"
2773 This variable controls the default subject when forwarding a
2775 message. It uses the same format sequences as the $index_format
2776 variable.
2777 forward_quote
2781 Type: boolean
2782 Default: no
2783 When set, forwarded messages included in the main body of the
2785 message (when $mime_forward is unset) will be quoted using $in‐
2786 dent_string.
2787 forward_references
2791 Type: boolean
2792 Default: no
2793 When set, forwarded messages set the "In-Reply-To:" and "Refer‐
2795 ences:" headers in the same way as normal replies would. Hence
2796 the forwarded message becomes part of the original thread in‐
2797 stead of starting a new one.
2798 from
2802 Type: e-mail address
2803 Default: ""
2804 When set, this variable contains a default "from" address. It
2806 can be overridden using "my_hdr" (including from a "send-hook")
2807 and $reverse_name. This variable is ignored if $use_from is un‐
2808 set.
2809 If not specified, then it may be read from the environment vari‐
2811 able $EMAIL.
2812 from_chars
2816 Type: character string
2817 Default: ""
2818 Controls the character used to prefix the %F and %L fields in
2820 the index.
2821 Character
2822 Description
2823 1 Mail is written by you and has a To address, or has a
2824 known mailing list in the To address.
2825 2 Mail is written by you and has a Cc address, or has a
2826 known mailing list in the Cc address.
2827 3 Mail is written by you and has a Bcc address.
2828 4 All remaining cases.
2829 If this is empty or unset (default), the traditional long "To ",
2831 "Cc " and "Bcc " prefixes are used. If set but too short to in‐
2832 clude a character for a particular case, a single space will be
2833 prepended to the field. To prevent any prefix at all from being
2834 added in a particular case, use the special value CR (aka ^M)
2835 for the corresponding character.
2836 This slightly odd interface is necessitated by NeoMutt's han‐
2838 dling of string variables; one can't tell a variable that is un‐
2839 set from one that is set to the empty string.
2840 gecos_mask
2844 Type: regular expression
2845 Default: "^[^,]*"
2846 A regular expression used by NeoMutt to parse the GECOS field of
2848 a password entry when expanding the alias. The default value
2849 will return the string up to the first "," encountered. If the
2850 GECOS field contains a string like "lastname, firstname" then
2851 you should set it to ".*".
2852 This can be useful if you see the following behavior: you ad‐
2854 dress an e-mail to user ID "stevef" whose full name is "Steve
2855 Franklin". If NeoMutt expands "stevef" to '"Franklin"
2856 stevef@foo.bar' then you should set the $gecos_mask to a regular
2857 expression that will match the whole name so NeoMutt will expand
2858 "Franklin" to "Franklin, Steve".
2859 greeting
2863 Type: string
2864 Default: ""
2865 When set, this is the string that will precede every message as
2867 a greeting phrase to the recipients.
2868 "Format strings" are similar to the strings used in the "C"
2870 function printf to format output (see the man page for more de‐
2871 tail). The following sequences are defined in NeoMutt:
2872 %n Recipient's real name
2874 %u User (login) name of recipient
2875 %v First name of recipient
2876 group_index_format
2879 Type: string
2880 Default: "%4C %M%N %5s %-45.45f %d"
2881 This variable allows you to customize the newsgroup browser dis‐
2883 play to your personal taste. This string is similar to "in‐
2884 dex_format", but has its own set of printf()-like sequences:
2885 %C Current newsgroup number
2886 %d Description of newsgroup (becomes from server)
2887 %f Newsgroup name
2888 %M - if newsgroup not allowed for direct post (moderated for
2889 example)
2890 %N N if newsgroup is new, u if unsubscribed, blank otherwise
2891 %n Number of new articles in newsgroup
2892 %s Number of unread articles in newsgroup
2893 %>X Right justify the rest of the string and pad with charac‐
2894 ter "X"
2895 %|X Pad to the end of the line with character "X"
2896 hdrs
2899 Type: boolean
2900 Default: yes
2901 When unset, the header fields normally added by the "my_hdr"
2903 command are not created. This variable must be unset before
2904 composing a new message or replying in order to take effect. If
2905 set, the user defined header fields are added to every new mes‐
2906 sage.
2907 header
2911 Type: boolean
2912 Default: no
2913 When set, this variable causes NeoMutt to include the header of
2915 the message you are replying to into the edit buffer. The $weed
2916 setting applies.
2917 header_cache
2921 Type: path
2922 Default: ""
2923 This variable points to the header cache database. If the path
2925 points to an existing directory, NeoMutt will create a dedicated
2926 header cache database per folder. Otherwise, the path points to
2927 a regular file, which will be created as needed and used as a
2928 shared global header cache for all folders. By default it is
2929 unset so no header caching will be used.
2930 Header caching can greatly improve speed when opening POP, IMAP
2932 MH or Maildir folders, see "caching" in the NeoMutt Guide for
2933 details.
2934 header_cache_backend
2938 Type: string
2939 Default: ""
2940 This variable specifies the header cache backend. If no backend
2942 is specified, the first available backend will be used in the
2943 following order: tokyocabinet, kyotocabinet, qdbm, rocksdb,
2944 gdbm, bdb, tdb, lmdb.
2945 header_cache_compress_level
2949 Type: number
2950 Default: 1
2951 When NeoMutt is compiled with lz4, zstd or zlib, this option can
2953 be used to setup the compression level.
2954 header_cache_compress_method
2958 Type: string
2959 Default: ""
2960 When NeoMutt is compiled with lz4, zstd or zlib, the header
2962 cache backend can use these compression methods for compressing
2963 the cache files. This results in much smaller cache file sizes
2964 and may even improve speed.
2965 header_color_partial
2969 Type: boolean
2970 Default: no
2971 When set, color header regexes behave like color body regexes:
2973 color is applied to the exact text matched by the regex. When
2974 unset, color is applied to the entire header.
2975 One use of this option might be to apply color to just the
2977 header labels.
2978 See "color" for more details.
2980 help
2984 Type: boolean
2985 Default: yes
2986 When set, help lines describing the bindings for the major func‐
2988 tions provided by each menu are displayed on the first line of
2989 the screen.
2990 Note: The binding will not be displayed correctly if the func‐
2992 tion is bound to a sequence rather than a single keystroke.
2993 Also, the help line may not be updated if a binding is changed
2994 while NeoMutt is running. Since this variable is primarily
2995 aimed at new users, neither of these should present a major
2996 problem.
2997 hidden_host
3001 Type: boolean
3002 Default: no
3003 When set, NeoMutt will skip the host name part of $hostname
3005 variable when adding the domain part to addresses.
3006 hidden_tags
3010 Type: string list
3011 Default: "unread,draft,flagged,passed,replied,attachment,signed,encrypted"
3012 This variable specifies a list of comma-separated private not‐
3014 much/imap tags which should not be printed on screen.
3015 hide_limited
3019 Type: boolean
3020 Default: no
3021 When set, NeoMutt will not show the presence of messages that
3023 are hidden by limiting, in the thread tree.
3024 hide_missing
3028 Type: boolean
3029 Default: yes
3030 When set, NeoMutt will not show the presence of missing messages
3032 in the thread tree.
3033 hide_thread_subject
3037 Type: boolean
3038 Default: yes
3039 When set, NeoMutt will not show the subject of messages in the
3041 thread tree that have the same subject as their parent or clos‐
3042 est previously displayed sibling.
3043 hide_top_limited
3047 Type: boolean
3048 Default: no
3049 When set, NeoMutt will not show the presence of messages that
3051 are hidden by limiting, at the top of threads in the thread
3052 tree. Note that when $hide_limited is set, this option will
3053 have no effect.
3054 hide_top_missing
3058 Type: boolean
3059 Default: yes
3060 When set, NeoMutt will not show the presence of missing messages
3062 at the top of threads in the thread tree. Note that when
3063 $hide_missing is set, this option will have no effect.
3064 history
3068 Type: number
3069 Default: 10
3070 This variable controls the size (in number of strings remem‐
3072 bered) of the string history buffer per category. The buffer is
3073 cleared each time the variable is set.
3074 Note that strings (e.g. commands) starting with a space are
3076 never recorded in the history. This is for example useful to
3077 prevent leaking sensitive information into the history file or
3078 for one off tests.
3079 Also note that a string is not added to the history if it ex‐
3081 actly matches its immediate predecessor, e.g. executing the same
3082 command twice in a row results in only one copy being added to
3083 the history. To prevent duplicates over all entries use $his‐
3084 tory_remove_dups.
3085 history_file
3089 Type: path
3090 Default: "~/.mutthistory"
3091 The file in which NeoMutt will save its history.
3093 Also see $save_history.
3095 history_remove_dups
3099 Type: boolean
3100 Default: no
3101 When set, all of the string history will be scanned for dupli‐
3103 cates when a new entry is added. Duplicate entries in the $his‐
3104 tory_file will also be removed when it is periodically com‐
3105 pacted.
3106 honor_disposition
3110 Type: boolean
3111 Default: no
3112 When set, NeoMutt will not display attachments with a disposi‐
3114 tion of "attachment" inline even if it could render the part to
3115 plain text. These MIME parts can only be viewed from the attach‐
3116 ment menu.
3117 If unset, NeoMutt will render all MIME parts it can properly
3119 transform to plain text.
3120 honor_followup_to
3124 Type: quadoption
3125 Default: yes
3126 This variable controls whether or not a Mail-Followup-To header
3128 is honored when group-replying to a message.
3129 hostname
3133 Type: string
3134 Default: ""
3135 Specifies the fully-qualified hostname of the system NeoMutt is
3137 running on containing the host's name and the DNS domain it be‐
3138 longs to. It is used as the domain part (after "@") for local
3139 email addresses.
3140 If not specified in a config file, then NeoMutt will try to de‐
3142 termine the hostname itself.
3143 Optionally, NeoMutt can be compiled with a fixed domain name.
3145 Also see $use_domain and $hidden_host.
3147 idn_decode
3151 Type: boolean
3152 Default: yes
3153 When set, NeoMutt will show you international domain names de‐
3155 coded. Note: You can use IDNs for addresses even if this is un‐
3156 set. This variable only affects decoding. (IDN only)
3157 idn_encode
3161 Type: boolean
3162 Default: yes
3163 When set, NeoMutt will encode international domain names using
3165 IDN. Unset this if your SMTP server can handle newer (RFC6531)
3166 UTF-8 encoded domains. (IDN only)
3167 ignore_list_reply_to
3171 Type: boolean
3172 Default: no
3173 Affects the behavior of the <reply> function when replying to
3175 messages from mailing lists (as defined by the "subscribe" or
3176 "lists" commands). When set, if the "Reply-To:" field is set to
3177 the same value as the "To:" field, NeoMutt assumes that the "Re‐
3178 ply-To:" field was set by the mailing list to automate responses
3179 to the list, and will ignore this field. To direct a response
3180 to the mailing list when this option is set, use the <list-re‐
3181 ply> function; <group-reply> will reply to both the sender and
3182 the list.
3183 imap_authenticators
3187 Type: string list
3188 Default: ""
3189 This is a colon-separated list of authentication methods NeoMutt
3191 may attempt to use to log in to an IMAP server, in the order
3192 NeoMutt should try them. Authentication methods are either "lo‐
3193 gin" or the right side of an IMAP "AUTH=xxx" capability string,
3194 e.g. "digest-md5", "gssapi" or "cram-md5". This option is
3195 case-insensitive. If it's unset (the default) NeoMutt will try
3196 all available methods, in order from most-secure to least-se‐
3197 cure.
3198 Example:
3200 set imap_authenticators="gssapi:cram-md5:login"
3203 Note: NeoMutt will only fall back to other authentication meth‐
3206 ods if the previous methods are unavailable. If a method is
3207 available but authentication fails, NeoMutt will not connect to
3208 the IMAP server.
3209 imap_check_subscribed
3213 Type: boolean
3214 Default: no
3215 When set, NeoMutt will fetch the set of subscribed folders from
3217 your server whenever a mailbox is selected, and add them to the
3218 set of mailboxes it polls for new mail just as if you had issued
3219 individual "mailboxes" commands.
3220 imap_condstore
3224 Type: boolean
3225 Default: no
3226 When set, NeoMutt will use the CONDSTORE extension (RFC7162) if
3228 advertised by the server. NeoMutt's current implementation is
3229 basic, used only for initial message fetching and flag updates.
3230 For some IMAP servers, enabling this will slightly speed up
3232 downloading initial messages. Unfortunately, Gmail is not one
3233 those, and displays worse performance when enabled. Your
3234 mileage may vary.
3235 imap_deflate
3239 Type: boolean
3240 Default: yes
3241 When set, NeoMutt will use the COMPRESS=DEFLATE extension
3243 (RFC4978) if advertised by the server.
3244 In general a good compression efficiency can be achieved, which
3246 speeds up reading large mailboxes also on fairly good connec‐
3247 tions.
3248 imap_delim_chars
3252 Type: string
3253 Default: "/."
3254 This contains the list of characters that NeoMutt will use as
3256 folder separators for IMAP paths, when no separator is provided
3257 on the IMAP connection.
3258 imap_fetch_chunk_size
3262 Type: number (long)
3263 Default: 0
3264 When set to a value greater than 0, new headers will be down‐
3266 loaded in groups of this many headers per request. If you have
3267 a very large mailbox, this might prevent a timeout and discon‐
3268 nect when opening the mailbox, by sending a FETCH per set of
3269 this many headers, instead of a single FETCH for all new head‐
3270 ers.
3271 imap_headers
3275 Type: string
3276 Default: ""
3277 NeoMutt requests these header fields in addition to the default
3279 headers ("Date:", "From:", "Sender:", "Subject:", "To:", "Cc:",
3280 "Message-Id:", "References:", "Content-Type:", "Content-Descrip‐
3281 tion:", "In-Reply-To:", "Reply-To:", "Lines:", "List-Post:",
3282 "X-Label:") from IMAP servers before displaying the index menu.
3283 You may want to add more headers for spam detection.
3284 Note: This is a space separated list, items should be uppercase
3286 and not contain the colon, e.g. "X-BOGOSITY X-SPAM-STATUS" for
3287 the "X-Bogosity:" and "X-Spam-Status:" header fields.
3288 imap_idle
3292 Type: boolean
3293 Default: no
3294 When set, NeoMutt will attempt to use the IMAP IDLE extension to
3296 check for new mail in the current mailbox. Some servers (dovecot
3297 was the inspiration for this option) react badly to NeoMutt's
3298 implementation. If your connection seems to freeze up periodi‐
3299 cally, try unsetting this.
3300 imap_keep_alive
3304 Type: number
3305 Default: 300
3306 This variable specifies the maximum amount of time in seconds
3308 that NeoMutt will wait before polling open IMAP connections, to
3309 prevent the server from closing them before NeoMutt has finished
3310 with them. The default is well within the RFC-specified minimum
3311 amount of time (30 minutes) before a server is allowed to do
3312 this, but in practice the RFC does get violated every now and
3313 then. Reduce this number if you find yourself getting discon‐
3314 nected from your IMAP server due to inactivity.
3315 imap_list_subscribed
3319 Type: boolean
3320 Default: no
3321 This variable configures whether IMAP folder browsing will look
3323 for only subscribed folders or all folders. This can be toggled
3324 in the IMAP browser with the <toggle-subscribed> function.
3325 imap_login
3329 Type: string
3330 Default: ""
3331 Your login name on the IMAP server.
3333 This variable defaults to the value of $imap_user.
3335 imap_oauth_refresh_command
3339 Type: command
3340 Default: ""
3341 The command to run to generate an OAUTH refresh token for autho‐
3343 rizing your connection to your IMAP server. This command will
3344 be run on every connection attempt that uses the OAUTHBEARER or
3345 XOAUTH2 authentication mechanisms. See "oauth" for details.
3346 imap_pass
3350 Type: string
3351 Default: ""
3352 Specifies the password for your IMAP account. If unset, NeoMutt
3354 will prompt you for your password when you invoke the
3355 <imap-fetch-mail> function or try to open an IMAP folder.
3356 Warning: you should only use this option when you are on a
3358 fairly secure machine, because the superuser can read your neo‐
3359 muttrc even if you are the only one who can read the file.
3360 imap_passive
3364 Type: boolean
3365 Default: yes
3366 When set, NeoMutt will not open new IMAP connections to check
3368 for new mail. NeoMutt will only check for new mail over exist‐
3369 ing IMAP connections. This is useful if you don't want to be
3370 prompted for user/password pairs on NeoMutt invocation, or if
3371 opening the connection is slow.
3372 imap_peek
3376 Type: boolean
3377 Default: yes
3378 When set, NeoMutt will avoid implicitly marking your mail as
3380 read whenever you fetch a message from the server. This is gen‐
3381 erally a good thing, but can make closing an IMAP folder some‐
3382 what slower. This option exists to appease speed freaks.
3383 imap_pipeline_depth
3387 Type: number
3388 Default: 15
3389 Controls the number of IMAP commands that may be queued up be‐
3391 fore they are sent to the server. A deeper pipeline reduces the
3392 amount of time NeoMutt must wait for the server, and can make
3393 IMAP servers feel much more responsive. But not all servers cor‐
3394 rectly handle pipelined commands, so if you have problems you
3395 might want to try setting this variable to 0.
3396 Note: Changes to this variable have no effect on open connec‐
3398 tions.
3399 imap_poll_timeout
3403 Type: number
3404 Default: 15
3405 This variable specifies the maximum amount of time in seconds
3407 that NeoMutt will wait for a response when polling IMAP connec‐
3408 tions for new mail, before timing out and closing the connec‐
3409 tion. Set to 0 to disable timing out.
3410 imap_qresync
3414 Type: boolean
3415 Default: no
3416 When set, NeoMutt will use the QRESYNC extension (RFC7162) if
3418 advertised by the server. NeoMutt's current implementation is
3419 basic, used only for initial message fetching and flag updates.
3420 Note: this feature is currently experimental. If you experience
3422 strange behavior, such as duplicate or missing messages please
3423 file a bug report to let us know.
3424 imap_rfc5161
3428 Type: boolean
3429 Default: yes
3430 When set, NeoMutt will use the IMAP ENABLE extension (RFC5161)
3432 to select CAPABILITIES. Some servers (notably Coremail System
3433 IMap Server) do not properly respond to ENABLE commands, which
3434 might cause NeoMutt to hang. If your connection seems to freeze
3435 at login, try unsetting this. See also https://github.com/neo‐
3436 mutt/neomutt/issues/1689
3437 imap_server_noise
3441 Type: boolean
3442 Default: yes
3443 When set, NeoMutt will display warning messages from the IMAP
3445 server as error messages. Since these messages are often harm‐
3446 less, or generated due to configuration problems on the server
3447 which are out of the users' hands, you may wish to suppress them
3448 at some point.
3449 imap_user
3453 Type: string
3454 Default: ""
3455 The name of the user whose mail you intend to access on the IMAP
3457 server.
3458 This variable defaults to your user name on the local machine.
3460 imap_send_id
3464 Type: boolean
3465 Default: no
3466 When set, NeoMutt will send an IMAP ID command (RFC2971) to the
3468 server when logging in if advertised by the server. This command
3469 provides information about the IMAP client, such as "NeoMutt"
3470 and the current version.
3471 implicit_auto_view
3475 Type: boolean
3476 Default: no
3477 If set to "yes", NeoMutt will look for a mailcap entry with the
3479 "copiousoutput" flag set for every MIME attachment it doesn't
3480 have an internal viewer defined for. If such an entry is found,
3481 NeoMutt will use the viewer defined in that entry to convert the
3482 body part to text form.
3483 include
3487 Type: quadoption
3488 Default: ask-yes
3489 Controls whether or not a copy of the message(s) you are reply‐
3491 ing to is included in your reply.
3492 include_encrypted
3496 Type: boolean
3497 Default: no
3498 Controls whether or not NeoMutt includes separately encrypted
3500 attachment contents when replying.
3501 This variable was added to prevent accidental exposure of en‐
3503 crypted contents when replying to an attacker. If a previously
3504 encrypted message were attached by the attacker, they could
3505 trick an unwary recipient into decrypting and including the mes‐
3506 sage in their reply.
3507 include_only_first
3511 Type: boolean
3512 Default: no
3513 Controls whether or not NeoMutt includes only the first attach‐
3515 ment of the message you are replying.
3516 indent_string
3520 Type: string
3521 Default: "> "
3522 Specifies the string to prepend to each line of text quoted in a
3524 message to which you are replying. You are strongly encouraged
3525 not to change this value, as it tends to agitate the more fanat‐
3526 ical netizens.
3527 The value of this option is ignored if $text_flowed is set, be‐
3529 cause the quoting mechanism is strictly defined for for‐
3530 mat=flowed.
3531 This option is a format string, please see the description of
3533 $index_format for supported printf(3)-style sequences.
3534 index_format
3538 Type: string
3539 Default: "%4C %Z %{%b %d} %-15.15L (%<l?%4l&%4c>) %s"
3540 This variable allows you to customize the message index display
3542 to your personal taste.
3543 "Format strings" are similar to the strings used in the C func‐
3545 tion printf(3) to format output (see the man page for more de‐
3546 tails). For an explanation of the %<...> construct, see the
3547 status_format description. The following sequences are defined
3548 in NeoMutt:
3549 %a Address of the author
3550 %A Reply-to address (if present; otherwise: address of au‐
3551 thor)
3552 %b Filename of the original message folder (think mailbox)
3553 %B Same as %K
3554 %C Current message number
3555 %c Number of characters (bytes) in the body of the message
3556 (see formatstrings-size)
3557 %cr Number of characters (bytes) in the raw message, includ‐
3558 ing the header (see formatstrings-size)
3559 %D Date and time of message using date_format and local
3560 timezone It is encouraged to use "%[fmt]" instead, where
3561 "fmt" is the value of $date_format.
3562 %d Date and time of message using date_format and sender's
3563 timezone It is encouraged to use "%{fmt}" instead, where
3564 "fmt" is the value of $date_format.
3565 %e Current message number in thread
3566 %E Number of messages in current thread
3567 %F Author name, or recipient name if the message is from you
3568 %Fp Like %F, but plain. No contextual formatting is applied
3569 to recipient name
3570 %f Sender (address + real name), either From: or Re‐
3571 turn-Path:
3572 %g Newsgroup name (if compiled with NNTP support)
3573 %g Message tags (e.g. notmuch tags/imap flags)
3574 %Gx Individual message tag (e.g. notmuch tags/imap flags)
3575 %H Spam attribute(s) of this message
3576 %I Initials of author
3577 %i Message-id of the current message
3578 %J Message tags (if present, tree unfolded, and != parent's
3579 tags)
3580 %K The list to which the letter was sent (if any; otherwise:
3581 empty)
3582 %L If an address in the "To:" or "Cc:" header field matches
3583 an address Defined by the user's "subscribe" command,
3584 this displays "To <list-name>", otherwise the same as %F
3585 %l number of lines in the unprocessed message (may not work
3586 with maildir, mh, and IMAP folders)
3587 %M Number of hidden messages if the thread is collapsed
3588 %m Total number of message in the mailbox
3589 %N Message score
3590 %n Author's real name (or address if missing)
3591 %O Original save folder where NeoMutt would formerly have
3592 Stashed the message: list name or recipient name If not
3593 sent to a list
3594 %P Progress indicator for the built-in pager (how much of
3595 the file has been displayed)
3596 %q Newsgroup name (if compiled with NNTP support)
3597 %R Comma separated list of "Cc:" recipients
3598 %r Comma separated list of "To:" recipients
3599 %S Single character status of the message
3600 ("N"/"O"/"D"/"d"/"!"/"r"/"*")
3601 %s Subject of the message
3602 %T The appropriate character from the $to_chars string
3603 %t "To:" field (recipients)
3604 %u User (login) name of the author
3605 %v First name of the author, or the recipient if the message
3606 is from you
3607 %W Name of organization of author ("Organization:" field)
3608 %x "X-Comment-To:" field (if present and compiled with NNTP
3609 support)
3610 %X Number of MIME attachments (please see the "attachments"
3611 section for possible speed effects)
3612 %Y "X-Label:" field, if present, and [4m(1) not at part of a
3613 thread tree, [4m(2) at the top of a thread, or [4m(3) "X-La‐
3614 bel:" is different from Preceding message's "X-Label:"
3615 %y "X-Label:" field, if present
3616 %Z A three character set of message status flags. The first
3617 character is new/read/replied flags
3618 ("n"/"o"/"r"/"O"/"N"). The second is deleted or encryp‐
3619 tion flags ("D"/"d"/"S"/"P"/"s"/"K"). The third is ei‐
3620 ther tagged/flagged ("*"/"!"), or one of the characters
3621 Listed in $to_chars.
3622 %zc Message crypto flags
3623 %zs Message status flags
3624 %zt Message tag flags
3625 %@name@
3626 insert and evaluate format-string from the matching "in‐
3627 dex-format-hook" command
3628 %{fmt} the date and time of the message is converted to sender's
3629 time zone, and "fmt" is expanded by the library function
3630 strftime(3); if the first character inside the braces is
3631 a bang ("!"), the date is formatted ignoring any locale
3632 settings. Note that the sender's time zone might only be
3633 available as a numerical offset, so "%Z" behaves like
3634 "%z".
3635 %[fmt] the date and time of the message is converted to the lo‐
3636 cal time zone, and "fmt" is expanded by the library func‐
3637 tion strftime(3); if the first character inside the
3638 brackets is a bang ("!"), the date is formatted ignoring
3639 any locale settings.
3640 %(fmt) the local date and time when the message was received,
3641 and "fmt" is expanded by the library function strf‐
3642 time(3); if the first character inside the parentheses is
3643 a bang ("!"), the date is formatted ignoring any locale
3644 settings.
3645 %>X right justify the rest of the string and pad with charac‐
3646 ter "X"
3647 %|X pad to the end of the line with character "X"
3648 %*X soft-fill with character "X" as pad
3649 Date format expressions can be constructed based on relative
3651 dates. Using the date formatting operators along with nested
3652 conditionals, the date format can be modified based on how old a
3653 message is. See the section on "Conditional Dates" for an ex‐
3654 planation and examples
3655 Note that for mbox/mmdf, "%l" applies to the unprocessed mes‐
3657 sage, and for maildir/mh, the value comes from the "Lines:"
3658 header field when present (the meaning is normally the same).
3659 Thus the value depends on the encodings used in the different
3660 parts of the message and has little meaning in practice.
3661 "Soft-fill" deserves some explanation: Normal right-justifica‐
3663 tion will print everything to the left of the "%>", displaying
3664 padding and whatever lies to the right only if there's room. By
3665 contrast, soft-fill gives priority to the right-hand side, guar‐
3666 anteeing space to display it and showing padding only if there's
3667 still room. If necessary, soft-fill will eat text leftwards to
3668 make room for rightward text.
3669 Note that these expandos are supported in "save-hook", "fcc-
3671 hook" and "fcc-save-hook", too.
3672 inews
3676 Type: command
3677 Default: ""
3678 If set, specifies the program and arguments used to deliver news
3680 posted by NeoMutt. Otherwise, NeoMutt posts article using cur‐
3681 rent connection to news server. The following printf-style se‐
3682 quence is understood:
3683 %a account url
3684 %p port
3685 %P port if specified
3686 %s news server name
3687 %S url schema
3688 %u username
3689 Example:
3691 set inews="/usr/local/bin/inews -hS"
3694 ispell
3699 Type: command
3700 Default: "ispell"
3701 How to invoke ispell (GNU's spell-checking software).
3703 keep_flagged
3707 Type: boolean
3708 Default: no
3709 If set, read messages marked as flagged will not be moved from
3711 your spool mailbox to your $mbox mailbox or to the "mbox" speci‐
3712 fied by a mbox-hook command.
3713 Note that $keep_flagged only has an effect if $move is set.
3715 local_date_header
3719 Type: boolean
3720 Default: yes
3721 If set, the date in the Date header of emails that you send will
3723 be in your local timezone. If unset a UTC date will be used in‐
3724 stead to avoid leaking information about your current location.
3725 mail_check
3729 Type: number
3730 Default: 5
3731 This variable configures how often (in seconds) NeoMutt should
3733 look for new mail. Also see the $timeout variable.
3734 mail_check_recent
3738 Type: boolean
3739 Default: yes
3740 When set, NeoMutt will only notify you about new mail that has
3742 been received since the last time you opened the mailbox. When
3743 unset, NeoMutt will notify you if any new mail exists in the
3744 mailbox, regardless of whether you have visited it recently.
3745 When $mark_old is set, NeoMutt does not consider the mailbox to
3747 contain new mail if only old messages exist.
3748 mail_check_stats
3752 Type: boolean
3753 Default: no
3754 When set, NeoMutt will periodically calculate message statistics
3756 of a mailbox while polling for new mail. It will check for un‐
3757 read, flagged, and total message counts. Because this operation
3758 is more performance intensive, it defaults to unset, and has a
3759 separate option, $mail_check_stats_interval, to control how of‐
3760 ten to update these counts.
3761 Message statistics can also be explicitly calculated by invoking
3763 the <check-stats> function.
3764 mail_check_stats_interval
3768 Type: number
3769 Default: 60
3770 When $mail_check_stats is set, this variable configures how of‐
3772 ten (in seconds) NeoMutt will update message counts.
3773 mailbox_folder_format
3777 Type: string
3778 Default: "%2C %<n?%6n& > %6m %i"
3779 This variable allows you to customize the file browser display
3781 to your personal taste. It's only used to customize network
3782 mailboxes (e.g. imap). This string is identical in formatting
3783 to the one used by "$folder_format".
3784 mailcap_path
3788 Type: string list
3789 Default: "~/.mailcap:/usr/share/neomutt/mailcap:/etc/mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap"
3790 This variable specifies a list of colon-separated files to con‐
3792 sult when attempting to display MIME bodies not directly sup‐
3793 ported by NeoMutt. The default value is generated during
3794 startup: see the "mailcap" section of the manual.
3795 $mailcap_path is overridden by the environment variable $MAIL‐
3797 CAPS.
3798 The default search path is from RFC1524.
3800 mailcap_sanitize
3804 Type: boolean
3805 Default: yes
3806 If set, NeoMutt will restrict possible characters in mailcap %
3808 expandos to a well-defined set of safe characters. This is the
3809 safe setting, but we are not sure it doesn't break some more ad‐
3810 vanced MIME stuff.
3811 DON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU
3813 ARE DOING!
3814 maildir_check_cur
3818 Type: boolean
3819 Default: no
3820 If set, NeoMutt will poll both the new and cur directories of a
3822 maildir folder for new messages. This might be useful if other
3823 programs interacting with the folder (e.g. dovecot) are moving
3824 new messages to the cur directory. Note that setting this op‐
3825 tion may slow down polling for new messages in large folders,
3826 since NeoMutt has to scan all cur messages.
3827 maildir_field_delimiter
3831 Type: string
3832 Default: ":"
3833 Use the value as maildir field delimiter. This is a single-char‐
3835 acter used to accommodate maildir mailboxes on platforms where
3836 `:` is not allowed in a filename. The recommended alternative on
3837 such platforms is `;`. Neomutt supports all non-alphanumeric
3838 values except for `-`, `.`, `\`, `/`. Note: this only applies
3839 to maildir-style mailboxes. Setting it will have no effect on
3840 other mailbox types.
3841 maildir_header_cache_verify
3845 Type: boolean
3846 Default: yes
3847 Check for Maildir unaware programs other than NeoMutt having
3849 modified maildir files when the header cache is in use. This
3850 incurs one stat(2) per message every time the folder is opened
3851 (which can be very slow for NFS folders).
3852 maildir_trash
3856 Type: boolean
3857 Default: no
3858 If set, messages marked as deleted will be saved with the
3860 maildir trashed flag instead of unlinked. Note: this only ap‐
3861 plies to maildir-style mailboxes. Setting it will have no ef‐
3862 fect on other mailbox types.
3863 mark_macro_prefix
3867 Type: string
3868 Default: "'"
3869 Prefix for macros created using mark-message. A new macro auto‐
3871 matically generated with <mark-message>a will be composed from
3872 this prefix and the letter a.
3873 mark_old
3877 Type: boolean
3878 Default: yes
3879 Controls whether or not NeoMutt marks new unread messages as old
3881 if you exit a mailbox without reading them. With this option
3882 set, the next time you start NeoMutt, the messages will show up
3883 with an "O" next to them in the index menu, indicating that they
3884 are old.
3885 markers
3889 Type: boolean
3890 Default: yes
3891 Controls the display of wrapped lines in the internal pager. If
3893 set, a "+" marker is displayed at the beginning of wrapped
3894 lines.
3895 Also see the $smart_wrap variable.
3897 mask
3901 Type: regular expression
3902 Default: "!^\.[^.]"
3903 A regular expression used in the file browser, optionally pre‐
3905 ceded by the not operator "!". Only files whose names match
3906 this mask will be shown. The match is always case-sensitive.
3907 mbox
3911 Type: mailbox
3912 Default: "~/mbox"
3913 This specifies the folder into which read mail in your
3915 $spool_file folder will be appended.
3916 Also see the $move variable.
3918 mbox_type
3922 Type: enumeration
3923 Default: mbox
3924 The default mailbox type used when creating new folders. May be
3926 any of "mbox", "MMDF", "MH" or "Maildir".
3927 This can also be set using the -m command-line option.
3929 me_too
3933 Type: boolean
3934 Default: no
3935 If unset, NeoMutt will remove your address (see the "alternates"
3937 command) from the list of recipients when replying to a message.
3938 menu_context
3942 Type: number
3943 Default: 0
3944 This variable controls the number of lines of context that are
3946 given when scrolling through menus. (Similar to $pager_context.)
3947 menu_move_off
3951 Type: boolean
3952 Default: yes
3953 When unset, the bottom entry of menus will never scroll up past
3955 the bottom of the screen, unless there are less entries than
3956 lines. When set, the bottom entry may move off the bottom.
3957 menu_scroll
3961 Type: boolean
3962 Default: no
3963 When set, menus will be scrolled up or down one line when you
3965 attempt to move across a screen boundary. If unset, the screen
3966 is cleared and the next or previous page of the menu is dis‐
3967 played (useful for slow links to avoid many redraws).
3968 message_cache_clean
3972 Type: boolean
3973 Default: no
3974 If set, NeoMutt will clean out obsolete entries from the message
3976 cache when the mailbox is synchronized. You probably only want
3977 to set it every once in a while, since it can be a little slow
3978 (especially for large folders).
3979 message_cache_dir
3983 Type: path
3984 Default: ""
3985 Set this to a directory and NeoMutt will cache copies of mes‐
3987 sages from your IMAP and POP servers here. You are free to re‐
3988 move entries at any time.
3989 When setting this variable to a directory, NeoMutt needs to
3991 fetch every remote message only once and can perform regular ex‐
3992 pression searches as fast as for local folders.
3993 Also see the $message_cache_clean variable.
3995 message_format
3999 Type: string
4000 Default: "%s"
4001 This is the string displayed in the "attachment" menu for at‐
4003 tachments of type message/rfc822. For a full listing of defined
4004 printf(3)-like sequences see the section on $index_format.
4005 meta_key
4009 Type: boolean
4010 Default: no
4011 If set, forces NeoMutt to interpret keystrokes with the high bit
4013 (bit 8) set as if the user had pressed the Esc key and whatever
4014 key remains after having the high bit removed. For example, if
4015 the key pressed has an ASCII value of 0xf8, then this is treated
4016 as if the user had pressed Esc then "x". This is because the
4017 result of removing the high bit from 0xf8 is 0x78, which is the
4018 ASCII character "x".
4019 mh_purge
4023 Type: boolean
4024 Default: no
4025 When unset, NeoMutt will mimic mh's behavior and rename deleted
4027 messages to ,<old file name> in mh folders instead of really
4028 deleting them. This leaves the message on disk but makes pro‐
4029 grams reading the folder ignore it. If the variable is set, the
4030 message files will simply be deleted.
4031 This option is similar to $maildir_trash for Maildir folders.
4033 mh_seq_flagged
4037 Type: string
4038 Default: "flagged"
4039 The name of the MH sequence used for flagged messages.
4041 mh_seq_replied
4045 Type: string
4046 Default: "replied"
4047 The name of the MH sequence used to tag replied messages.
4049 mh_seq_unseen
4053 Type: string
4054 Default: "unseen"
4055 The name of the MH sequence used for unseen messages.
4057 mime_forward
4061 Type: quadoption
4062 Default: no
4063 When set, the message you are forwarding will be attached as a
4065 separate message/rfc822 MIME part instead of included in the
4066 main body of the message. This is useful for forwarding MIME
4067 messages so the receiver can properly view the message as it was
4068 delivered to you. If you like to switch between MIME and not
4069 MIME from mail to mail, set this variable to "ask-no" or
4070 "ask-yes".
4071 Also see $forward_decode and $mime_forward_decode.
4073 mime_forward_decode
4077 Type: boolean
4078 Default: no
4079 Controls the decoding of complex MIME messages into text/plain
4081 when forwarding a message while $mime_forward is set. Otherwise
4082 $forward_decode is used instead.
4083 mime_forward_rest
4087 Type: quadoption
4088 Default: yes
4089 When forwarding multiple attachments of a MIME message from the
4091 attachment menu, attachments which can't be decoded in a reason‐
4092 able manner will be attached to the newly composed message if
4093 this option is set.
4094 mime_type_query_command
4098 Type: command
4099 Default: ""
4100 This specifies a command to run, to determine the mime type of a
4102 new attachment when composing a message. Unless
4103 $mime_type_query_first is set, this will only be run if the at‐
4104 tachment's extension is not found in the mime.types file.
4105 The string may contain a "%s", which will be substituted with
4107 the attachment filename. NeoMutt will add quotes around the
4108 string substituted for "%s" automatically according to shell
4109 quoting rules, so you should avoid adding your own. If no "%s"
4110 is found in the string, NeoMutt will append the attachment file‐
4111 name to the end of the string.
4112 The command should output a single line containing the attach‐
4114 ment's mime type.
4115 Suggested values are "xdg-mime query filetype" or "file -bi".
4117 mime_type_query_first
4121 Type: boolean
4122 Default: no
4123 When set, the $mime_type_query_command will be run before the
4125 mime.types lookup.
4126 mix_entry_format
4130 Type: string
4131 Default: "%4n %c %-16s %a"
4132 This variable describes the format of a remailer line on the
4134 mixmaster chain selection screen. The following printf(3)-like
4135 sequences are supported:
4136 %a The remailer's e-mail address
4137 %c Remailer capabilities
4138 %n The running number on the menu
4139 %s The remailer's short name
4140 %>X right justify the rest of the string and pad with charac‐
4141 ter "X"
4142 %|X pad to the end of the line with character "X"
4143 %*X soft-fill with character "X" as pad
4144 mixmaster
4147 Type: command
4148 Default: "mixmaster"
4149 This variable contains the path to the Mixmaster binary on your
4151 system. It is used with various sets of parameters to gather
4152 the list of known remailers, and to finally send a message
4153 through the mixmaster chain.
4154 move
4158 Type: quadoption
4159 Default: no
4160 If this variable is set, then NeoMutt will move read messages
4162 from your spool mailbox to your $mbox mailbox or to the "mbox"
4163 specified by a mbox-hook command.
4164 See also $keep_flagged.
4166 narrow_tree
4170 Type: boolean
4171 Default: no
4172 This variable, when set, makes the thread tree narrower, allow‐
4174 ing deeper threads to fit on the screen.
4175 net_inc
4179 Type: number
4180 Default: 10
4181 Operations that expect to transfer a large amount of data over
4183 the network will update their progress every $net_inc kilobytes.
4184 If set to 0, no progress messages will be displayed.
4185 See also $read_inc, $write_inc and $net_inc.
4187 new_mail_command
4191 Type: command
4192 Default: ""
4193 If set, NeoMutt will call this command after a new message is
4195 received. See the $status_format documentation for the values
4196 that can be formatted into this command.
4197 news_cache_dir
4201 Type: path
4202 Default: "~/.neomutt"
4203 This variable pointing to directory where NeoMutt will save
4205 cached news articles and headers in. If unset, articles and
4206 headers will not be saved at all and will be reloaded from the
4207 server each time.
4208 news_server
4212 Type: string
4213 Default: ""
4214 This variable specifies domain name or address of NNTP server.
4216 You can also specify username and an alternative port for each
4218 news server, e.g. [[s]news://][username[:pass‐
4219 word]@]server[:port]
4220 This option can also be set using the command line option "-g",
4222 the environment variable $NNTPSERVER, or putting the server name
4223 in the file "/etc/nntpserver".
4224 newsgroups_charset
4228 Type: string
4229 Default: "utf-8"
4230 Character set of newsgroups descriptions.
4232 newsrc
4236 Type: path
4237 Default: "~/.newsrc"
4238 The file, containing info about subscribed newsgroups - names
4240 and indexes of read articles. The following printf-style se‐
4241 quence is understood:
4242 Expando
4243 Description Example
4244 %a Account url news:news.gmane.org
4245 %p Port 119
4246 %P Port if specified 10119
4247 %s News server name news.gmane.org
4248 %S Url schema news
4249 %u Username username
4250 nm_config_file
4253 Type: path
4254 Default: "auto"
4255 Configuration file for notmuch. Use 'auto' to detect configura‐
4257 tion.
4258 nm_config_profile
4262 Type: string
4263 Default: ""
4264 Configuration profile for notmuch.
4266 nm_db_limit
4270 Type: number
4271 Default: 0
4272 This variable specifies the default limit used in notmuch
4274 queries.
4275 nm_default_url
4279 Type: string
4280 Default: ""
4281 This variable specifies the default Notmuch database in format
4283 notmuch://<absolute path>.
4284 nm_exclude_tags
4288 Type: string
4289 Default: ""
4290 The messages tagged with these tags are excluded and not loaded
4292 from notmuch DB to NeoMutt unless specified explicitly.
4293 nm_flagged_tag
4297 Type: string
4298 Default: "flagged"
4299 This variable specifies notmuch tag which is used for flagged
4301 messages. The variable is used to count flagged messages in DB
4302 and set the flagged flag when modifying tags. All other NeoMutt
4303 commands use standard (e.g. maildir) flags.
4304 nm_open_timeout
4308 Type: number
4309 Default: 5
4310 This variable specifies the timeout for database open in sec‐
4312 onds.
4313 nm_query_type
4317 Type: string
4318 Default: "messages"
4319 This variable specifies the default query type (threads or mes‐
4321 sages) used in notmuch queries.
4322 nm_query_window_current_position
4326 Type: number
4327 Default: 0
4328 This variable contains the position of the current search for
4330 window based vfolder.
4331 nm_query_window_current_search
4335 Type: string
4336 Default: ""
4337 This variable contains the currently setup notmuch search for
4339 window based vfolder.
4340 nm_query_window_duration
4344 Type: number
4345 Default: 0
4346 This variable sets the time duration of a windowed notmuch
4348 query. Accepted values all non negative integers. A value of 0
4349 disables the feature.
4350 nm_query_window_enable
4354 Type: boolean
4355 Default: no
4356 This variable enables windowed notmuch queries even if window
4358 duration is 0.
4359 nm_query_window_or_terms
4363 Type: string
4364 Default: ""
4365 This variable contains additional notmuch search terms for mes‐
4367 sages to be shown regardless of date.
4368 Example:
4370 Using "notmuch://?query=tag:inbox" as the mailbox and
4372 "tag:flagged and tag:unread" as the or terms, NeoMutt will pro‐
4373 duce a query window such as:
4374 notmuch://?query=tag:inbox and (date:... or (tag:flagged and
4376 tag:unread))
4377 nm_query_window_timebase
4381 Type: string
4382 Default: "week"
4383 This variable sets the time base of a windowed notmuch query.
4385 Accepted values are 'minute', 'hour', 'day', 'week', 'month',
4386 'year'
4387 nm_record
4391 Type: boolean
4392 Default: no
4393 This variable specifies whether, when writing a just-sent mes‐
4395 sage to the $record, the message should also be added to the
4396 notmuch DB. Replies inherit the notmuch tags from the original
4397 message. See $nm_record_tags for how to modify the set of not‐
4398 much tags assigned to sent messages written to the record.
4399 nm_record_tags
4403 Type: string
4404 Default: ""
4405 This variable specifies the notmuch tag modifications (addition,
4407 removal, toggling) applied to messages added to the Neomutt
4408 record when $nm_record is true. See the description of the <mod‐
4409 ify-labels> function for the syntax.
4410 nm_replied_tag
4414 Type: string
4415 Default: "replied"
4416 This variable specifies notmuch tag which is used for replied
4418 messages. The variable is used to set the replied flag when mod‐
4419 ifying tags. All other NeoMutt commands use standard (e.g.
4420 maildir) flags.
4421 nm_unread_tag
4425 Type: string
4426 Default: "unread"
4427 This variable specifies notmuch tag which is used for unread
4429 messages. The variable is used to count unread messages in DB
4430 and set the unread flag when modifiying tags. All other NeoMutt
4431 commands use standard (e.g. maildir) flags.
4432 nntp_authenticators
4436 Type: string
4437 Default: ""
4438 This is a colon-delimited list of authentication methods NeoMutt
4440 may attempt to use to log in to a news server, in the order Neo‐
4441 Mutt should try them. Authentication methods are either "user"
4442 or any SASL mechanism, e.g. "digest-md5", "gssapi" or
4443 "cram-md5". This option is case-insensitive. If it's unset
4444 (the default) NeoMutt will try all available methods, in order
4445 from most-secure to least-secure.
4446 Example:
4448 set nntp_authenticators="digest-md5:user"
4451 Note: NeoMutt will only fall back to other authentication meth‐
4454 ods if the previous methods are unavailable. If a method is
4455 available but authentication fails, NeoMutt will not connect to
4456 the IMAP server.
4457 nntp_context
4461 Type: number (long)
4462 Default: 1000
4463 This variable defines number of articles which will be in index
4465 when newsgroup entered. If active newsgroup have more articles
4466 than this number, oldest articles will be ignored. Also con‐
4467 trols how many articles headers will be saved in cache when you
4468 quit newsgroup.
4469 nntp_listgroup
4473 Type: boolean
4474 Default: yes
4475 This variable controls whether or not existence of each article
4477 is checked when newsgroup is entered.
4478 nntp_load_description
4482 Type: boolean
4483 Default: yes
4484 This variable controls whether or not descriptions for each
4486 newsgroup must be loaded when newsgroup is added to list (first
4487 time list loading or new newsgroup adding).
4488 nntp_pass
4492 Type: string
4493 Default: ""
4494 Your password for NNTP account.
4496 nntp_poll
4500 Type: number
4501 Default: 60
4502 The time in seconds until any operations on newsgroup except
4504 post new article will cause recheck for new news. If set to 0,
4505 NeoMutt will recheck newsgroup on each operation in index (step‐
4506 ping, read article, etc.).
4507 nntp_user
4511 Type: string
4512 Default: ""
4513 Your login name on the NNTP server. If unset and NNTP server
4515 requires authentication, NeoMutt will prompt you for your ac‐
4516 count name when you connect to news server.
4517 pager
4521 Type: command
4522 Default: "builtin"
4523 This variable specifies which pager you would like to use to
4525 view messages. The value "builtin" means to use the built-in
4526 pager, otherwise this variable should specify the pathname of
4527 the external pager you would like to use.
4528 Using an external pager may have some disadvantages: Additional
4530 keystrokes are necessary because you can't call NeoMutt func‐
4531 tions directly from the pager, and screen resizes cause lines
4532 longer than the screen width to be badly formatted in the help
4533 menu.
4534 pager_context
4538 Type: number
4539 Default: 0
4540 This variable controls the number of lines of context that are
4542 given when displaying the next or previous page in the internal
4543 pager. By default, NeoMutt will display the line after the last
4544 one on the screen at the top of the next page (0 lines of con‐
4545 text).
4546 This variable also specifies the amount of context given for
4548 search results. If positive, this many lines will be given be‐
4549 fore a match, if 0, the match will be top-aligned.
4550 pager_format
4554 Type: string
4555 Default: "-%Z- %C/%m: %-20.20n %s%* -- (%P)"
4556 This variable controls the format of the one-line message "sta‐
4558 tus" displayed before each message in either the internal or an
4559 external pager. The valid sequences are listed in the $in‐
4560 dex_format section.
4561 pager_index_lines
4565 Type: number
4566 Default: 0
4567 Determines the number of lines of a mini-index which is shown
4569 when in the pager. The current message, unless near the top or
4570 bottom of the folder, will be roughly one third of the way down
4571 this mini-index, giving the reader the context of a few messages
4572 before and after the message. This is useful, for example, to
4573 determine how many messages remain to be read in the current
4574 thread. A value of 0 results in no index being shown.
4575 pager_read_delay
4579 Type: number
4580 Default: 0
4581 Determines the number of seconds that must elapse after first
4583 opening a new message in the pager before that message will be
4584 marked as read. A value of 0 results in the message being
4585 marked read unconditionally; for other values, navigating to an‐
4586 other message or exiting the pager before the timeout will leave
4587 the message marked unread. This setting is ignored if $pager is
4588 not builtin.
4589 pager_skip_quoted_context
4593 Type: number
4594 Default: 0
4595 Determines the number of lines of context to show before the un‐
4597 quoted text when using the <skip-quoted> function. When set to a
4598 positive number at most that many lines of the previous quote
4599 are displayed. If the previous quote is shorter the whole quote
4600 is displayed.
4601 The (now deprecated) skip_quoted_offset is an alias for this
4603 variable, and should no longer be used.
4604 pager_stop
4608 Type: boolean
4609 Default: no
4610 When set, the internal-pager will not move to the next message
4612 when you are at the end of a message and invoke the <next-page>
4613 function.
4614 pattern_format
4618 Type: string
4619 Default: "%2n %-15e %d"
4620 This variable describes the format of the "pattern completion"
4622 menu. The following printf(3)-style sequences are understood:
4623 %d pattern description
4624 %e pattern expression
4625 %n index number
4626 pgp_auto_decode
4628 Type: boolean
4629 Default: no
4630 If set, NeoMutt will automatically attempt to decrypt tradi‐
4632 tional PGP messages whenever the user performs an operation
4633 which ordinarily would result in the contents of the message be‐
4634 ing operated on. For example, if the user displays a pgp-tradi‐
4635 tional message which has not been manually checked with the
4636 <check-traditional-pgp> function, NeoMutt will automatically
4637 check the message for traditional pgp.
4638 pgp_auto_inline
4642 Type: boolean
4643 Default: no
4644 This option controls whether NeoMutt generates old-style inline
4646 (traditional) PGP encrypted or signed messages under certain
4647 circumstances. This can be overridden by use of the pgp menu,
4648 when inline is not required. The GPGME backend does not support
4649 this option.
4650 Note that NeoMutt might automatically use PGP/MIME for messages
4652 which consist of more than a single MIME part. NeoMutt can be
4653 configured to ask before sending PGP/MIME messages when inline
4654 (traditional) would not work.
4655 Also see the $pgp_mime_auto variable.
4657 Also note that using the old-style PGP message format is
4659 strongly deprecated. (PGP only)
4660 pgp_check_exit
4664 Type: boolean
4665 Default: yes
4666 If set, NeoMutt will check the exit code of the PGP subprocess
4668 when signing or encrypting. A non-zero exit code means that the
4669 subprocess failed. (PGP only)
4670 pgp_check_gpg_decrypt_status_fd
4674 Type: boolean
4675 Default: yes
4676 If set, NeoMutt will check the status file descriptor output of
4678 $pgp_decrypt_command and $pgp_decode_command for GnuPG status
4679 codes indicating successful decryption. This will check for the
4680 presence of DECRYPTION_OKAY, absence of DECRYPTION_FAILED, and
4681 that all PLAINTEXT occurs between the BEGIN_DECRYPTION and
4682 END_DECRYPTION status codes.
4683 If unset, NeoMutt will instead match the status fd output
4685 against $pgp_decryption_okay. (PGP only)
4686 pgp_clear_sign_command
4690 Type: command
4691 Default: ""
4692 This format is used to create an old-style "clearsigned" PGP
4694 message. Note that the use of this format is strongly depre‐
4695 cated.
4696 This is a format string, see the $pgp_decode_command command for
4698 possible printf(3)-like sequences. Note that in this case, %r
4699 expands to the search string, which is a list of one or more
4700 quoted values such as email address, name, or keyid. (PGP only)
4701 pgp_decode_command
4705 Type: command
4706 Default: ""
4707 This format strings specifies a command which is used to decode
4709 application/pgp attachments.
4710 The PGP command formats have their own set of printf(3)-like se‐
4712 quences:
4713 %a The value of $pgp_sign_as if set, otherwise the value of
4714 $pgp_default_key.
4715 %f Expands to the name of a file containing a message.
4716 %p Expands to PGPPASSFD=0 when a pass phrase is needed, to
4717 an empty string otherwise. Note: This may be used with a
4718 %<...> construct.
4719 %r One or more key IDs (or fingerprints if available).
4720 %s Expands to the name of a file containing the signature
4721 part of a multipart/signed attachment when verifying it.
4722 (PGP only)
4724 pgp_decrypt_command
4728 Type: command
4729 Default: ""
4730 This command is used to decrypt a PGP encrypted message.
4732 This is a format string, see the $pgp_decode_command command for
4734 possible printf(3)-like sequences. (PGP only)
4735 Note: When decrypting messages using gpg, a pinentry program
4737 needs to be invoked unless the password is cached within
4738 gpg-agent. Currently, the pinentry-tty program (usually dis‐
4739 tributed with gpg) isn't suitable for being invoked by NeoMutt.
4740 You are encouraged to use a different pinentry-program when run‐
4741 ning NeoMutt in order to avoid problems.
4742 See also: https://github.com/neomutt/neomutt/issues/1014
4744 pgp_decryption_okay
4748 Type: regular expression
4749 Default: ""
4750 If you assign text to this variable, then an encrypted PGP mes‐
4752 sage is only considered successfully decrypted if the output
4753 from $pgp_decrypt_command contains the text. This is used to
4754 protect against a spoofed encrypted message, with multipart/en‐
4755 crypted headers but containing a block that is not actually en‐
4756 crypted. (e.g. simply signed and ascii armored text).
4757 Note that if $pgp_check_gpg_decrypt_status_fd is set, this vari‐
4759 able is ignored. (PGP only)
4760 pgp_default_key
4764 Type: string
4765 Default: ""
4766 This is the default key-pair to use for PGP operations. It will
4768 be used for encryption (see $postpone_encrypt and $pgp_self_en‐
4769 crypt).
4770 It will also be used for signing unless $pgp_sign_as is set.
4772 The (now deprecated) pgp_self_encrypt_as is an alias for this
4774 variable, and should no longer be used. (PGP only)
4775 pgp_encrypt_only_command
4779 Type: command
4780 Default: ""
4781 This command is used to encrypt a body part without signing it.
4783 This is a format string, see the $pgp_decode_command command for
4785 possible printf(3)-like sequences. Note that in this case, %r
4786 expands to the search string, which is a list of one or more
4787 quoted values such as email address, name, or keyid. (PGP only)
4788 pgp_encrypt_sign_command
4792 Type: command
4793 Default: ""
4794 This command is used to both sign and encrypt a body part.
4796 This is a format string, see the $pgp_decode_command command for
4798 possible printf(3)-like sequences. (PGP only)
4799 pgp_entry_format
4803 Type: string
4804 Default: "%4n %t%f %4l/0x%k %-4a %2c %u"
4805 This variable allows you to customize the PGP key selection menu
4807 to your personal taste. If $crypt_use_gpgme is set, then it ap‐
4808 plies to S/MIME key selection menu also. This string is similar
4809 to $index_format, but has its own set of printf(3)-like se‐
4810 quences:
4811 %a Algorithm
4812 %c Capabilities
4813 %f Flags
4814 %i Key fingerprint (or long key id if non-existent)
4815 %k Key id
4816 %l Key length
4817 %n Number
4818 %p Protocol
4819 %t Trust/validity of the key-uid association
4820 %u User id
4821 %[<s>] Date of the key where <s> is an strftime(3) expression
4822 See the section "Sending Cryptographically Signed/Encrypted Mes‐
4824 sages" of the user manual for the meaning of the letters some of
4825 these sequences expand to.
4826 (Crypto only) or (PGP only when GPGME disabled)
4828 pgp_export_command
4832 Type: command
4833 Default: ""
4834 This command is used to export a public key from the user's key
4836 ring.
4837 This is a format string, see the $pgp_decode_command command for
4839 possible printf(3)-like sequences. (PGP only)
4840 pgp_get_keys_command
4844 Type: command
4845 Default: ""
4846 This command is invoked whenever NeoMutt needs to fetch the pub‐
4848 lic key associated with an email address. Of the sequences sup‐
4849 ported by $pgp_decode_command, %r is the only printf(3)-like se‐
4850 quence used with this format. Note that in this case, %r ex‐
4851 pands to the email address, not the public key ID (the key ID is
4852 unknown, which is why NeoMutt is invoking this command). (PGP
4853 only)
4854 pgp_good_sign
4858 Type: regular expression
4859 Default: ""
4860 If you assign a text to this variable, then a PGP signature is
4862 only considered verified if the output from $pgp_verify_command
4863 contains the text. Use this variable if the exit code from the
4864 command is 0 even for bad signatures. (PGP only)
4865 pgp_ignore_subkeys
4869 Type: boolean
4870 Default: yes
4871 Setting this variable will cause NeoMutt to ignore OpenPGP sub‐
4873 keys. Instead, the principal key will inherit the subkeys' capa‐
4874 bilities. Unset this if you want to play interesting key selec‐
4875 tion games. (PGP only)
4876 pgp_import_command
4880 Type: command
4881 Default: ""
4882 This command is used to import a key from a message into the
4884 user's public key ring.
4885 This is a format string, see the $pgp_decode_command command for
4887 possible printf(3)-like sequences. (PGP only)
4888 pgp_list_pubring_command
4892 Type: command
4893 Default: ""
4894 This command is used to list the public key ring's contents.
4896 The output format must be analogous to the one used by
4897 gpg --list-keys --with-colons --with-fingerprint
4900 Note: gpg's fixed-list-mode option should not be used. It pro‐
4903 duces a different date format which may result in NeoMutt show‐
4904 ing incorrect key generation dates.
4905 This is a format string, see the $pgp_decode_command command for
4907 possible printf(3)-like sequences. (PGP only)
4908 pgp_list_secring_command
4912 Type: command
4913 Default: ""
4914 This command is used to list the secret key ring's contents.
4916 The output format must be analogous to the one used by:
4917 gpg --list-keys --with-colons --with-fingerprint
4920 Note: gpg's fixed-list-mode option should not be used. It pro‐
4923 duces a different date format which may result in NeoMutt show‐
4924 ing incorrect key generation dates.
4925 This is a format string, see the $pgp_decode_command command for
4927 possible printf(3)-like sequences. (PGP only)
4928 pgp_long_ids
4932 Type: boolean
4933 Default: yes
4934 If set, use 64 bit PGP key IDs, if unset use the normal 32 bit
4936 key IDs. NOTE: Internally, NeoMutt has transitioned to using
4937 fingerprints (or long key IDs as a fallback). This option now
4938 only controls the display of key IDs in the key selection menu
4939 and a few other places. (PGP only)
4940 pgp_mime_auto
4944 Type: quadoption
4945 Default: ask-yes
4946 This option controls whether NeoMutt will prompt you for auto‐
4948 matically sending a (signed/encrypted) message using PGP/MIME
4949 when inline (traditional) fails (for any reason).
4950 Also note that using the old-style PGP message format is
4952 strongly deprecated. (PGP only)
4953 pgp_reply_inline
4957 Type: boolean
4958 Default: no
4959 Setting this variable will cause NeoMutt to always attempt to
4961 create an inline (traditional) message when replying to a mes‐
4962 sage which is PGP encrypted/signed inline. This can be overrid‐
4963 den by use of the pgp menu, when inline is not required. This
4964 option does not automatically detect if the (replied-to) message
4965 is inline; instead it relies on NeoMutt internals for previously
4966 checked/flagged messages.
4967 Note that NeoMutt might automatically use PGP/MIME for messages
4969 which consist of more than a single MIME part. NeoMutt can be
4970 configured to ask before sending PGP/MIME messages when inline
4971 (traditional) would not work.
4972 Also see the $pgp_mime_auto variable.
4974 Also note that using the old-style PGP message format is
4976 strongly deprecated. (PGP only)
4977 pgp_retainable_sigs
4981 Type: boolean
4982 Default: no
4983 If set, signed and encrypted messages will consist of nested
4985 multipart/signed and multipart/encrypted body parts.
4986 This is useful for applications like encrypted and signed mail‐
4988 ing lists, where the outer layer (multipart/encrypted) can be
4989 easily removed, while the inner multipart/signed part is re‐
4990 tained. (PGP only)
4991 pgp_self_encrypt
4995 Type: boolean
4996 Default: yes
4997 When set, PGP encrypted messages will also be encrypted using
4999 the key in $pgp_default_key. (PGP only)
5000 pgp_show_unusable
5004 Type: boolean
5005 Default: yes
5006 If set, NeoMutt will display non-usable keys on the PGP key se‐
5008 lection menu. This includes keys which have been revoked, have
5009 expired, or have been marked as "disabled" by the user. (PGP
5010 only)
5011 pgp_sign_as
5015 Type: string
5016 Default: ""
5017 If you have a different key pair to use for signing, you should
5019 set this to the signing key. Most people will only need to set
5020 $pgp_default_key. It is recommended that you use the keyid form
5021 to specify your key (e.g. 0x00112233). (PGP only)
5022 pgp_sign_command
5026 Type: command
5027 Default: ""
5028 This command is used to create the detached PGP signature for a
5030 multipart/signed PGP/MIME body part.
5031 This is a format string, see the $pgp_decode_command command for
5033 possible printf(3)-like sequences. (PGP only)
5034 pgp_sort_keys
5038 Type: sort order
5039 Default: address
5040 Specifies how the entries in the pgp menu are sorted. The fol‐
5042 lowing are legal values:
5043 address
5044 sort alphabetically by user id
5045 keyid sort alphabetically by key id
5046 date sort by key creation date
5047 trust sort by the trust of the key
5048 If you prefer reverse order of the above values, prefix it with
5050 "reverse-". (PGP only)
5051 pgp_strict_enc
5055 Type: boolean
5056 Default: yes
5057 If set, NeoMutt will automatically encode PGP/MIME signed mes‐
5059 sages as quoted-printable. Please note that unsetting this
5060 variable may lead to problems with non-verifyable PGP signa‐
5061 tures, so only change this if you know what you are doing. (PGP
5062 only)
5063 pgp_timeout
5067 Type: number (long)
5068 Default: 300
5069 The number of seconds after which a cached passphrase will ex‐
5071 pire if not used. (PGP only)
5072 pgp_use_gpg_agent
5076 Type: boolean
5077 Default: yes
5078 If set, NeoMutt expects a gpg-agent(1) process will handle pri‐
5080 vate key passphrase prompts. If unset, NeoMutt will prompt for
5081 the passphrase and pass it via stdin to the pgp command.
5082 Note that as of version 2.1, GnuPG automatically spawns an agent
5084 and requires the agent be used for passphrase management. Since
5085 that version is increasingly prevalent, this variable now de‐
5086 faults set.
5087 NeoMutt works with a GUI or curses pinentry program. A TTY
5089 pinentry should not be used.
5090 If you are using an older version of GnuPG without an agent run‐
5092 ning, or another encryption program without an agent, you will
5093 need to unset this variable. (PGP only)
5094 pgp_verify_command
5098 Type: command
5099 Default: ""
5100 This command is used to verify PGP signatures.
5102 This is a format string, see the $pgp_decode_command command for
5104 possible printf(3)-like sequences. (PGP only)
5105 pgp_verify_key_command
5109 Type: command
5110 Default: ""
5111 This command is used to verify key information from the key se‐
5113 lection menu.
5114 This is a format string, see the $pgp_decode_command command for
5116 possible printf(3)-like sequences. (PGP only)
5117 pipe_decode
5121 Type: boolean
5122 Default: no
5123 Used in connection with the <pipe-message> function. When un‐
5125 set, NeoMutt will pipe the messages without any preprocessing.
5126 When set, NeoMutt will attempt to decode the messages first.
5127 Also see $pipe_decode_weed, which controls whether headers will
5129 be weeded when this is set.
5130 pipe_decode_weed
5134 Type: boolean
5135 Default: yes
5136 For <pipe-message>, when $pipe_decode is set, this further con‐
5138 trols whether NeoMutt will weed headers.
5139 pipe_sep
5143 Type: string
5144 Default: "\n"
5145 The separator to add between messages when piping a list of
5147 tagged messages to an external Unix command.
5148 pipe_split
5152 Type: boolean
5153 Default: no
5154 Used in connection with the <pipe-message> function following
5156 <tag-prefix>. If this variable is unset, when piping a list of
5157 tagged messages NeoMutt will concatenate the messages and will
5158 pipe them all concatenated. When set, NeoMutt will pipe the
5159 messages one by one. In both cases the messages are piped in
5160 the current sorted order, and the $pipe_sep separator is added
5161 after each message.
5162 pop_auth_try_all
5166 Type: boolean
5167 Default: yes
5168 If set, NeoMutt will try all available authentication methods.
5170 When unset, NeoMutt will only fall back to other authentication
5171 methods if the previous methods are unavailable. If a method is
5172 available but authentication fails, NeoMutt will not connect to
5173 the POP server.
5174 pop_authenticators
5178 Type: string list
5179 Default: ""
5180 This is a colon-separated list of authentication methods NeoMutt
5182 may attempt to use to log in to an POP server, in the order Neo‐
5183 Mutt should try them. Authentication methods are either "user",
5184 "apop" or any SASL mechanism, e.g. "digest-md5", "gssapi" or
5185 "cram-md5". This option is case-insensitive. If this option is
5186 unset (the default) NeoMutt will try all available methods, in
5187 order from most-secure to least-secure.
5188 Example:
5190 set pop_authenticators="digest-md5:apop:user"
5193 pop_check_interval
5198 Type: number
5199 Default: 60
5200 This variable configures how often (in seconds) NeoMutt should
5202 look for new mail in the currently selected mailbox if it is a
5203 POP mailbox.
5204 pop_delete
5208 Type: quadoption
5209 Default: ask-no
5210 If set, NeoMutt will delete successfully downloaded messages
5212 from the POP server when using the <fetch-mail> function. When
5213 unset, NeoMutt will download messages but also leave them on the
5214 POP server.
5215 pop_host
5219 Type: string
5220 Default: ""
5221 The name of your POP server for the <fetch-mail> function. You
5223 can also specify an alternative port, username and password,
5224 i.e.:
5225 [pop[s]://][username[:password]@]popserver[:port]
5228 where "[...]" denotes an optional part.
5231 pop_last
5235 Type: boolean
5236 Default: no
5237 If this variable is set, NeoMutt will try to use the "LAST" POP
5239 command for retrieving only unread messages from the POP server
5240 when using the <fetch-mail> function.
5241 pop_oauth_refresh_command
5245 Type: command
5246 Default: ""
5247 The command to run to generate an OAUTH refresh token for autho‐
5249 rizing your connection to your POP server. This command will be
5250 run on every connection attempt that uses the OAUTHBEARER au‐
5251 thentication mechanism. See "oauth" for details.
5252 pop_pass
5256 Type: string
5257 Default: ""
5258 Specifies the password for your POP account. If unset, NeoMutt
5260 will prompt you for your password when you open a POP mailbox.
5261 Warning: you should only use this option when you are on a
5263 fairly secure machine, because the superuser can read your neo‐
5264 muttrc even if you are the only one who can read the file.
5265 pop_reconnect
5269 Type: quadoption
5270 Default: ask-yes
5271 Controls whether or not NeoMutt will try to reconnect to the POP
5273 server if the connection is lost.
5274 pop_user
5278 Type: string
5279 Default: ""
5280 Your login name on the POP server.
5282 This variable defaults to your user name on the local machine.
5284 post_moderated
5288 Type: quadoption
5289 Default: ask-yes
5290 If set to yes, NeoMutt will post article to newsgroup that have
5292 not permissions to posting (e.g. moderated). Note: if news
5293 server does not support posting to that newsgroup or totally
5294 read-only, that posting will not have an effect.
5295 postpone
5299 Type: quadoption
5300 Default: ask-yes
5301 Controls whether or not messages are saved in the $postponed
5303 mailbox when you elect not to send immediately. If set to
5304 ask-yes or ask-no, you will be prompted with "Save (postpone)
5305 draft message?" when quitting from the "compose" screen.
5306 Also see the $recall variable.
5308 postpone_encrypt
5312 Type: boolean
5313 Default: no
5314 When set, postponed messages that are marked for encryption will
5316 be self-encrypted. NeoMutt will first try to encrypt using the
5317 value specified in $pgp_default_key or $smime_default_key. If
5318 those are not set, it will try the deprecated $postpone_en‐
5319 crypt_as. (Crypto only)
5320 postpone_encrypt_as
5324 Type: string
5325 Default: ""
5326 This is a deprecated fall-back variable for $postpone_encrypt.
5328 Please use $pgp_default_key or $smime_default_key. (Crypto
5329 only)
5330 postponed
5334 Type: mailbox
5335 Default: "~/postponed"
5336 NeoMutt allows you to indefinitely "postpone sending a message"
5338 which you are editing. When you choose to postpone a message,
5339 NeoMutt saves it in the mailbox specified by this variable.
5340 Also see the $postpone variable.
5342 preconnect
5346 Type: string
5347 Default: ""
5348 If set, a shell command to be executed if NeoMutt fails to es‐
5350 tablish a connection to the server. This is useful for setting
5351 up secure connections, e.g. with ssh(1). If the command returns
5352 a nonzero status, NeoMutt gives up opening the server. Example:
5353 set preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net \
5356 sleep 20 < /dev/null > /dev/null"
5357 Mailbox "foo" on "mailhost.net" can now be reached as "{local‐
5360 host:1234}foo".
5361 Note: For this example to work, you must be able to log in to
5363 the remote machine without having to enter a password.
5364 preferred_languages
5368 Type: string list
5369 Default: ""
5370 This variable specifies a list of comma-separated languages.
5372 RFC8255 : user preferred languages to be searched in parts and
5373 display. Example:
5374 set preferred_languages="en,fr,de"
5377 print
5382 Type: quadoption
5383 Default: ask-no
5384 Controls whether or not NeoMutt really prints messages. This is
5386 set to "ask-no" by default, because some people accidentally hit
5387 "p" often.
5388 print_command
5392 Type: command
5393 Default: "lpr"
5394 This specifies the command pipe that should be used to print
5396 messages.
5397 print_decode
5401 Type: boolean
5402 Default: yes
5403 Used in connection with the <print-message> function. If this
5405 option is set, the message is decoded before it is passed to the
5406 external command specified by $print_command. If this option is
5407 unset, no processing will be applied to the message when print‐
5408 ing it. The latter setting may be useful if you are using some
5409 advanced printer filter which is able to properly format e-mail
5410 messages for printing.
5411 Also see $print_decode_weed, which controls whether headers will
5413 be weeded when this is set.
5414 print_decode_weed
5418 Type: boolean
5419 Default: yes
5420 For <print-message>, when $print_decode is set, this further
5422 controls whether NeoMutt will weed headers.
5423 print_split
5427 Type: boolean
5428 Default: no
5429 Used in connection with the <print-message> function. If this
5431 option is set, the command specified by $print_command is exe‐
5432 cuted once for each message which is to be printed. If this op‐
5433 tion is unset, the command specified by $print_command is exe‐
5434 cuted only once, and all the messages are concatenated, with a
5435 form feed as the message separator.
5436 Those who use the enscript(1) program's mail-printing mode will
5438 most likely want to set this option.
5439 prompt_after
5443 Type: boolean
5444 Default: yes
5445 If you use an external $pager, setting this variable will cause
5447 NeoMutt to prompt you for a command when the pager exits rather
5448 than returning to the index menu. If unset, NeoMutt will return
5449 to the index menu when the external pager exits.
5450 query_command
5454 Type: command
5455 Default: ""
5456 This specifies the command NeoMutt will use to make external ad‐
5458 dress queries. The string may contain a "%s", which will be
5459 substituted with the query string the user types. NeoMutt will
5460 add quotes around the string substituted for "%s" automatically
5461 according to shell quoting rules, so you should avoid adding
5462 your own. If no "%s" is found in the string, NeoMutt will ap‐
5463 pend the user's query to the end of the string. See "query"
5464 (https://neomutt.org/guide/advancedusage.html#query) for more
5465 information.
5466 query_format
5470 Type: string
5471 Default: "%3c %t %-25.25n %-25.25a | %e"
5472 This variable describes the format of the "query" menu. The fol‐
5474 lowing printf(3)-style sequences are understood:
5475 %a
5476 Destination address
5478 %c
5479 Current entry number
5481 %e * Extra information
5482 %n
5483 Destination name
5485 %t
5486 "*" if current entry is tagged, a space otherwise
5488 %>X
5489 Right justify the rest of the string and pad with "X"
5491 %|X
5492 Pad to the end of the line with "X"
5494 %*X
5495 Soft-fill with character "X" as pad
5497 For an explanation of "soft-fill", see the $index_format docu‐
5499 mentation.
5500 * = can be optionally printed if nonzero, see the $status_format
5502 documentation.
5503 quit
5507 Type: quadoption
5508 Default: yes
5509 This variable controls whether "quit" and "exit" actually quit
5511 from NeoMutt. If this option is set, they do quit, if it is un‐
5512 set, they have no effect, and if it is set to ask-yes or ask-no,
5513 you are prompted for confirmation when you try to quit.
5514 In order to quit from NeoMutt if this variable is unset, you
5516 must send the signal SIGINT to NeoMutt. This can usually be
5517 achieved by pressing CTRL-C in the terminal.
5518 quote_regex
5522 Type: regular expression
5523 Default: "^([ \t]*[|>:}#])+"
5524 A regular expression used in the internal pager to determine
5526 quoted sections of text in the body of a message. Quoted text
5527 may be filtered out using the <toggle-quoted> command, or col‐
5528 ored according to the "color quoted" family of directives.
5529 Higher levels of quoting may be colored differently ("color
5531 quoted1", "color quoted2", etc.). The quoting level is deter‐
5532 mined by removing the last character from the matched text and
5533 recursively reapplying the regular expression until it fails to
5534 produce a match.
5535 Match detection may be overridden by the $smileys regular ex‐
5537 pression.
5538 read_inc
5542 Type: number
5543 Default: 10
5544 If set to a value greater than 0, NeoMutt will display which
5546 message it is currently on when reading a mailbox or when per‐
5547 forming search actions such as search and limit. The message is
5548 printed after this many messages have been read or searched
5549 (e.g., if set to 25, NeoMutt will print a message when it is at
5550 message 25, and then again when it gets to message 50). This
5551 variable is meant to indicate progress when reading or searching
5552 large mailboxes which may take some time. When set to 0, only a
5553 single message will appear before the reading the mailbox.
5554 Also see the $write_inc, $net_inc and $time_inc variables and
5556 the "tuning" section of the manual for performance considera‐
5557 tions.
5558 read_only
5562 Type: boolean
5563 Default: no
5564 If set, all folders are opened in read-only mode.
5566 real_name
5570 Type: string
5571 Default: ""
5572 This variable specifies what "real" or "personal" name should be
5574 used when sending messages.
5575 If not specified, then the user's "real name" will be read from
5577 /etc/passwd. This option will not be used, if "$from" is set.
5578 recall
5582 Type: quadoption
5583 Default: ask-yes
5584 Controls whether or not NeoMutt recalls postponed messages when
5586 composing a new message.
5587 Setting this variable to yes is not generally useful, and thus
5589 not recommended. Note that the <recall-message> function can be
5590 used to manually recall postponed messages.
5591 Also see $postponed variable.
5593 record
5597 Type: mailbox
5598 Default: "~/sent"
5599 This specifies the file into which your outgoing messages should
5601 be appended. (This is meant as the primary method for saving a
5602 copy of your messages, but another way to do this is using the
5603 "my_hdr" command to create a "Bcc:" field with your email ad‐
5604 dress in it.)
5605 The value of $record is overridden by the $force_name and
5607 $save_name variables, and the "fcc-hook" command. Also see
5608 $copy and $write_bcc.
5609 reflow_space_quotes
5613 Type: boolean
5614 Default: yes
5615 This option controls how quotes from format=flowed messages are
5617 displayed in the pager and when replying (with $text_flowed un‐
5618 set). When set, this option adds spaces after each level of
5619 quote marks, turning ">>>foo" into "> > > foo".
5620 Note: If $reflow_text is unset, this option has no effect.
5622 Also, this option does not affect replies when $text_flowed is
5623 set.
5624 reflow_text
5628 Type: boolean
5629 Default: yes
5630 When set, NeoMutt will reformat paragraphs in text/plain parts
5632 marked format=flowed. If unset, NeoMutt will display paragraphs
5633 unaltered from how they appear in the message body. See RFC3676
5634 for details on the format=flowed format.
5635 Also see $reflow_wrap, and $wrap.
5637 reflow_wrap
5641 Type: number
5642 Default: 78
5643 This variable controls the maximum paragraph width when refor‐
5645 matting text/plain parts when $reflow_text is set. When the
5646 value is 0, paragraphs will be wrapped at the terminal's right
5647 margin. A positive value sets the paragraph width relative to
5648 the left margin. A negative value set the paragraph width rela‐
5649 tive to the right margin.
5650 Be aware that the reformatted lines of a paragraph are still
5652 subject to $wrap. This means if $reflow_wrap is 40 and $wrap is
5653 30, then the paragraph gets reformatted to 40 characters a line
5654 (due to $reflow_wrap) and afterwards each 40-character-line is
5655 split at 30 characters (due to $wrap), resulting in alternating
5656 line lengths of 30 and 10 characters.
5657 Also see $wrap.
5659 reply_regex
5663 Type: regular expression
5664 Default: "^((re|aw|sv)(\[[0-9]+\])*:[ \t]*)*"
5665 A regular expression used to recognize reply messages when
5667 threading and replying. The default value corresponds to the
5668 English "Re:", the German "Aw:" and the Swedish "Sv:".
5669 reply_self
5673 Type: boolean
5674 Default: no
5675 If unset and you are replying to a message sent by you, NeoMutt
5677 will assume that you want to reply to the recipients of that
5678 message rather than to yourself.
5679 Also see the "alternates" command.
5681 reply_to
5685 Type: quadoption
5686 Default: ask-yes
5687 If set, when replying to a message, NeoMutt will use the address
5689 listed in the Reply-to: header as the recipient of the reply.
5690 If unset, it will use the address in the From: header field in‐
5691 stead. This option is useful for reading a mailing list that
5692 sets the Reply-To: header field to the list address and you want
5693 to send a private message to the author of a message.
5694 reply_with_xorig
5698 Type: boolean
5699 Default: no
5700 This variable provides a toggle. When active, the From: header
5702 will be extracted from the current mail's 'X-Original-To:'
5703 header. This setting does not have precedence over "re‐
5704 verse_real_name".
5705 Assuming 'fast_reply' is disabled, this option will prompt the
5707 user with a prefilled From: header.
5708 resolve
5712 Type: boolean
5713 Default: yes
5714 When set, the cursor in a list will be automatically advanced to
5716 the next (possibly undeleted) message/attachment/entry whenever
5717 a command that modifies the current message/attachment/entry is
5718 executed.
5719 Examples of such commands are tagging a message, deleting an en‐
5721 try, or saving an attachment.
5722 resume_draft_files
5726 Type: boolean
5727 Default: no
5728 If set, draft files (specified by -H on the command line) are
5730 processed similarly to when resuming a postponed message. Re‐
5731 cipients are not prompted for; send-hooks are not evaluated; no
5732 alias expansion takes place; user-defined headers and signatures
5733 are not added to the message.
5734 resume_edited_draft_files
5738 Type: boolean
5739 Default: yes
5740 If set, draft files previously edited (via -E -H on the command
5742 line) will have $resume_draft_files automatically set when they
5743 are used as a draft file again.
5744 The first time a draft file is saved, NeoMutt will add a header,
5746 X-Mutt-Resume-Draft to the saved file. The next time the draft
5747 file is read in, if NeoMutt sees the header, it will set $re‐
5748 sume_draft_files.
5749 This option is designed to prevent multiple signatures, user-de‐
5751 fined headers, and other processing effects from being made mul‐
5752 tiple times to the draft file.
5753 reverse_alias
5757 Type: boolean
5758 Default: no
5759 This variable controls whether or not NeoMutt will display the
5761 "personal" name from your aliases in the index menu if it finds
5762 an alias that matches the message's sender. For example, if you
5763 have the following alias:
5764 alias juser abd30425@somewhere.net (Joe User)
5767 and then you receive mail which contains the following header:
5770 From: abd30425@somewhere.net
5773 It would be displayed in the index menu as "Joe User" instead of
5776 "abd30425@somewhere.net." This is useful when the person's
5777 e-mail address is not human friendly.
5778 reverse_name
5782 Type: boolean
5783 Default: no
5784 It may sometimes arrive that you receive mail to a certain ma‐
5786 chine, move the messages to another machine, and reply to some
5787 the messages from there. If this variable is set, the default
5788 From: line of the reply messages is built using the address
5789 where you received the messages you are replying to if that ad‐
5790 dress matches your "alternates". If the variable is unset, or
5791 the address that would be used doesn't match your "alternates",
5792 the From: line will use your address on the current machine.
5793 Also see the "alternates" command and $reverse_real_name.
5795 reverse_real_name
5799 Type: boolean
5800 Default: yes
5801 This variable fine-tunes the behavior of the $reverse_name fea‐
5803 ture.
5804 When it is unset, NeoMutt will remove the real name part of a
5806 matching address. This allows the use of the email address
5807 without having to also use what the sender put in the real name
5808 field.
5809 When it is set, NeoMutt will use the matching address as-is.
5811 In either case, a missing real name will be filled in afterwards
5813 using the value of $real_name.
5814 rfc2047_parameters
5818 Type: boolean
5819 Default: yes
5820 When this variable is set, NeoMutt will decode RFC2047-encoded
5822 MIME parameters. You want to set this variable when NeoMutt sug‐
5823 gests you to save attachments to files named like:
5824 =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
5827 =?utf-8?Q?z=C4=99ta.png?=
5828 When this variable is set interactively, the change won't be ac‐
5831 tive until you change folders.
5832 Note that this use of RFC2047's encoding is explicitly prohib‐
5834 ited by the standard, but nevertheless encountered in the wild
5835 and produced by, e.g., Outlook.
5836 Also note that setting this parameter will not have the effect
5838 that NeoMutt generates this kind of encoding. Instead, NeoMutt
5839 will unconditionally use the encoding specified in RFC2231.
5840 save_address
5844 Type: boolean
5845 Default: no
5846 If set, NeoMutt will take the sender's full address when choos‐
5848 ing a default folder for saving a mail. If $save_name or
5849 $force_name is set too, the selection of the Fcc folder will be
5850 changed as well.
5851 save_empty
5855 Type: boolean
5856 Default: yes
5857 When unset, mailboxes which contain no saved messages will be
5859 removed when closed (the exception is $spool_file which is never
5860 removed). If set, mailboxes are never removed.
5861 Note: This only applies to mbox and MMDF folders, NeoMutt does
5863 not delete MH and Maildir directories.
5864 save_history
5868 Type: number
5869 Default: 0
5870 This variable controls the size of the history (per category)
5872 saved in the $history_file file.
5873 Setting this to a value greater than $history is possible. How‐
5875 ever, there will never be more than $history entries to select
5876 from even if more are recorded in the history file.
5877 save_name
5881 Type: boolean
5882 Default: no
5883 This variable controls how copies of outgoing messages are
5885 saved. When set, a check is made to see if a mailbox specified
5886 by the recipient address exists (this is done by searching for a
5887 mailbox in the $folder directory with the username part of the
5888 recipient address). If the mailbox exists, the outgoing message
5889 will be saved to that mailbox, otherwise the message is saved to
5890 the $record mailbox.
5891 Also see the $force_name variable.
5893 save_unsubscribed
5897 Type: boolean
5898 Default: no
5899 When set, info about unsubscribed newsgroups will be saved into
5901 "newsrc" file and into cache.
5902 score
5906 Type: boolean
5907 Default: yes
5908 When this variable is unset, scoring is turned off. This can be
5910 useful to selectively disable scoring for certain folders when
5911 the $score_threshold_delete variable and related are used.
5912 score_threshold_delete
5916 Type: number
5917 Default: -1
5918 Messages which have been assigned a score equal to or lower than
5920 the value of this variable are automatically marked for deletion
5921 by NeoMutt. Since NeoMutt scores are always greater than or
5922 equal to zero, the default setting of this variable will never
5923 mark a message for deletion.
5924 score_threshold_flag
5928 Type: number
5929 Default: 9999
5930 Messages which have been assigned a score greater than or equal
5932 to this variable's value are automatically marked "flagged".
5933 score_threshold_read
5937 Type: number
5938 Default: -1
5939 Messages which have been assigned a score equal to or lower than
5941 the value of this variable are automatically marked as read by
5942 NeoMutt. Since NeoMutt scores are always greater than or equal
5943 to zero, the default setting of this variable will never mark a
5944 message read.
5945 search_context
5949 Type: number
5950 Default: 0
5951 For the pager, this variable specifies the number of lines shown
5953 before search results. By default, search results will be
5954 top-aligned.
5955 send_charset
5959 Type: string list
5960 Default: "us-ascii:iso-8859-1:utf-8"
5961 A colon-delimited list of character sets for outgoing messages.
5963 NeoMutt will use the first character set into which the text can
5964 be converted exactly. If your $charset is not "iso-8859-1" and
5965 recipients may not understand "UTF-8", it is advisable to in‐
5966 clude in the list an appropriate widely used standard character
5967 set (such as "iso-8859-2", "koi8-r" or "iso-2022-jp") either in‐
5968 stead of or after "iso-8859-1".
5969 In case the text can't be converted into one of these exactly,
5971 NeoMutt uses $charset as a fallback.
5972 sendmail
5976 Type: command
5977 Default: "/usr/sbin/sendmail -oem -oi"
5978 Specifies the program and arguments used to deliver mail sent by
5980 NeoMutt. NeoMutt expects that the specified program interprets
5981 additional arguments as recipient addresses. NeoMutt appends
5982 all recipients after adding a -- delimiter (if not already
5983 present). Additional flags, such as for $use_8bit_mime,
5984 $use_envelope_from, $dsn_notify, or $dsn_return will be added
5985 before the delimiter.
5986 See also: $write_bcc.
5988 sendmail_wait
5992 Type: number
5993 Default: 0
5994 Specifies the number of seconds to wait for the $sendmail
5996 process to finish before giving up and putting delivery in the
5997 background.
5998 NeoMutt interprets the value of this variable as follows:
6000 >0 number of seconds to wait for sendmail to finish before
6001 continuing
6002 0 wait forever for sendmail to finish
6003 <0 always put sendmail in the background without waiting
6004 Note that if you specify a value other than 0, the output of the
6006 child process will be put in a temporary file. If there is some
6007 error, you will be informed as to where to find the output.
6008 shell
6012 Type: command
6013 Default: "/bin/sh"
6014 Command to use when spawning a subshell. If not specified, then
6016 the user's login shell from /etc/passwd is used.
6017 show_multipart_alternative
6021 Type: string
6022 Default: ""
6023 When set to info, the multipart/alternative information is
6025 shown. When set to inline, all of the alternatives are dis‐
6026 played. When not set, the default behavior is to show only the
6027 chosen alternative.
6028 show_new_news
6032 Type: boolean
6033 Default: yes
6034 If set, news server will be asked for new newsgroups on entering
6036 the browser. Otherwise, it will be done only once for a news
6037 server. Also controls whether or not number of new articles of
6038 subscribed newsgroups will be then checked.
6039 show_only_unread
6043 Type: boolean
6044 Default: no
6045 If set, only subscribed newsgroups that contain unread articles
6047 will be displayed in browser.
6048 sidebar_component_depth
6052 Type: number
6053 Default: 0
6054 By default the sidebar will show the mailbox's path, relative to
6056 the $folder variable. This specifies the number of parent direc‐
6057 tories to hide from display in the sidebar. For example: If a
6058 maildir is normally displayed in the sidebar as
6059 dir1/dir2/dir3/maildir, setting sidebar_component_depth=2 will
6060 display it as dir3/maildir, having truncated the 2 highest di‐
6061 rectories.
6062 See also: $sidebar_short_path
6064 sidebar_delim_chars
6068 Type: string
6069 Default: "/."
6070 This contains the list of characters which you would like to
6072 treat as folder separators for displaying paths in the sidebar.
6073 Local mail is often arranged in directories: 'dir1/dir2/mail‐
6075 box'.
6076 set sidebar_delim_chars='/'
6079 IMAP mailboxes are often named: 'folder1.folder2.mailbox'.
6082 set sidebar_delim_chars='.'
6085 See also: $sidebar_short_path, $sidebar_folder_indent, $side‐
6088 bar_indent_string.
6089 sidebar_divider_char
6093 Type: string
6094 Default: "|"
6095 The default is a Unicode vertical line.
6097 This specifies the characters to be drawn between the sidebar
6099 (when visible) and the other NeoMutt panels. ASCII and Unicode
6100 line-drawing characters are supported.
6101 The divider char can be set to an empty string for some extra
6103 space. If empty, setting the sidebar_background color may help
6104 distinguish the sidebar from other panels.
6105 sidebar_folder_indent
6109 Type: boolean
6110 Default: no
6111 Set this to indent mailboxes in the sidebar.
6113 See also: $sidebar_short_path, $sidebar_indent_string, $side‐
6115 bar_delim_chars.
6116 sidebar_format
6120 Type: string
6121 Default: "%D%* %n"
6122 This variable allows you to customize the sidebar display. This
6124 string is similar to $index_format, but has its own set of
6125 printf(3)-like sequences:
6126 %B
6127 Name of the mailbox
6129 %d * @ Number of deleted messages in the mailbox
6130 %D
6131 Descriptive name of the mailbox
6133 %F * Number of flagged messages in the mailbox
6134 %L * @ Number of messages after limiting
6135 %n
6136 "N" if mailbox has new mail, " " (space) otherwise
6138 %N * Number of unread messages in the mailbox (seen or un‐
6139 seen)
6140 %o * Number of old messages in the mailbox (unread, seen)
6141 %r * Number of read messages in the mailbox (read, seen)
6142 %S * Size of mailbox (total number of messages)
6143 %t * @ Number of tagged messages in the mailbox
6144 %Z * Number of new messages in the mailbox (unread, unseen)
6145 %!
6146 "!" : one flagged message; "!!" : two flagged messages;
6148 "n!" : n flagged messages (for n > 2). Otherwise prints
6149 nothing.
6150 %>X
6151 Right justify the rest of the string and pad with "X"
6153 %|X
6154 Pad to the end of the line with "X"
6156 %*X
6157 Soft-fill with character "X" as pad
6159 * = Can be optionally printed if nonzero
6161 @ = Only applicable to the current folder
6163 In order to use %S, %N, %F, and %!, $mail_check_stats must be
6165 set. When thus set, a suggested value for this option is
6166 "%B%<F? [%F]>%* %<N?%N/>%S".
6167 sidebar_indent_string
6171 Type: string
6172 Default: " "
6173 This specifies the string that is used to indent mailboxes in
6175 the sidebar. It defaults to two spaces.
6176 See also: $sidebar_short_path, $sidebar_folder_indent, $side‐
6178 bar_delim_chars.
6179 sidebar_new_mail_only
6183 Type: boolean
6184 Default: no
6185 When set, the sidebar will only display mailboxes containing
6187 new, or flagged, mail.
6188 See also: sidebar_pin, $sidebar_non_empty_mailbox_only.
6190 sidebar_next_new_wrap
6194 Type: boolean
6195 Default: no
6196 When set, the <sidebar-next-new> command will not stop at the
6198 end of the list of mailboxes, but wrap around to the beginning.
6199 The <sidebar-prev-new> command is similarly affected, wrapping
6200 around to the end of the list.
6201 sidebar_non_empty_mailbox_only
6205 Type: boolean
6206 Default: no
6207 When set, the sidebar will only display mailboxes that contain
6209 one or more mails.
6210 See also: $sidebar_new_mail_only, sidebar_pin.
6212 sidebar_on_right
6216 Type: boolean
6217 Default: no
6218 When set, the sidebar will appear on the right-hand side of the
6220 screen.
6221 sidebar_short_path
6225 Type: boolean
6226 Default: no
6227 By default the sidebar will show the mailbox's path, relative to
6229 the $folder variable. Setting sidebar_shortpath=yes will shorten
6230 the names relative to the previous name. Here's an example:
6231 shortpath=no
6232 shortpath=yes shortpath=yes, folderindent=yes, in‐
6233 dentstr=".."
6234 fruit fruit fruit
6235 fruit.apple
6236 apple ..apple
6237 fruit.banana
6238 banana ..banana
6239 fruit.cherry
6240 cherry ..cherry
6241 See also: $sidebar_delim_chars, $sidebar_folder_indent, $side‐
6243 bar_indent_string, $sidebar_component_depth.
6244 sidebar_sort_method
6248 Type: sort order
6249 Default: order
6250 Specifies how to sort mailbox entries in the sidebar. By de‐
6252 fault, the entries are unsorted. Valid values:
6253 ‐ path (alphabetically)
6254 ‐ count (all message count)
6255 ‐ flagged (flagged message count)
6256 ‐ unread (unread message count)
6257 ‐ unsorted
6258 You may optionally use the "reverse-" prefix to specify reverse
6260 sorting order (example: "set sidebar_sort_method=reverse-path").
6261 The alpha and name values are synonyms for path. The new value
6263 is a synonym for unread.
6264 sidebar_visible
6268 Type: boolean
6269 Default: no
6270 This specifies whether or not to show sidebar. The sidebar shows
6272 a list of all your mailboxes.
6273 See also: $sidebar_format, $sidebar_width
6275 sidebar_width
6279 Type: number
6280 Default: 30
6281 This controls the width of the sidebar. It is measured in
6283 screen columns. For example: sidebar_width=20 could display 20
6284 ASCII characters, or 10 Chinese characters.
6285 sig_dashes
6289 Type: boolean
6290 Default: yes
6291 If set, a line containing "-- " (note the trailing space) will
6293 be inserted before your $signature. It is strongly recommended
6294 that you not unset this variable unless your signature contains
6295 just your name. The reason for this is because many software
6296 packages use "-- \n" to detect your signature. For example,
6297 NeoMutt has the ability to highlight the signature in a differ‐
6298 ent color in the built-in pager.
6299 sig_on_top
6303 Type: boolean
6304 Default: no
6305 If set, the signature will be included before any quoted or for‐
6307 warded text. It is strongly recommended that you do not set
6308 this variable unless you really know what you are doing, and are
6309 prepared to take some heat from netiquette guardians.
6310 signature
6314 Type: path
6315 Default: "~/.signature"
6316 Specifies the filename of your signature, which is appended to
6318 all outgoing messages. If the filename ends with a pipe ("|"),
6319 it is assumed that filename is a shell command and input should
6320 be read from its standard output.
6321 simple_search
6325 Type: string
6326 Default: "~f %s | ~s %s"
6327 Specifies how NeoMutt should expand a simple search into a real
6329 search pattern. A simple search is one that does not contain
6330 any of the "~" pattern operators. See "patterns" for more in‐
6331 formation on search patterns.
6332 simple_search applies to several functions, e.g. <delete-pat‐
6334 tern>, <limit>, searching in the index, and all of the index
6335 colors.
6336 For example, if you simply type "joe" at a search or limit
6338 prompt, NeoMutt will automatically expand it to the value speci‐
6339 fied by this variable by replacing "%s" with the supplied
6340 string. For the default value, "joe" would be expanded to: "~f
6341 joe | ~s joe".
6342 size_show_bytes
6346 Type: boolean
6347 Default: no
6348 If set, message sizes will display bytes for values less than 1
6350 kilobyte. See formatstrings-size.
6351 size_show_fractions
6355 Type: boolean
6356 Default: yes
6357 If set, message sizes will be displayed with a single decimal
6359 value for sizes from 0 to 10 kilobytes and 1 to 10 megabytes.
6360 See formatstrings-size.
6361 size_show_mb
6365 Type: boolean
6366 Default: yes
6367 If set, message sizes will display megabytes for values greater
6369 than or equal to 1 megabyte. See formatstrings-size.
6370 size_units_on_left
6374 Type: boolean
6375 Default: no
6376 If set, message sizes units will be displayed to the left of the
6378 number. See formatstrings-size.
6379 sleep_time
6383 Type: number
6384 Default: 1
6385 Specifies time, in seconds, to pause while displaying certain
6387 informational messages, while moving from folder to folder and
6388 after expunging messages from the current folder. The default
6389 is to pause one second, so a value of zero for this option sup‐
6390 presses the pause.
6391 smart_wrap
6395 Type: boolean
6396 Default: yes
6397 Controls the display of lines longer than the screen width in
6399 the internal pager. If set, long lines are wrapped at a word
6400 boundary. If unset, lines are simply wrapped at the screen
6401 edge. Also see the $markers variable.
6402 smileys
6406 Type: regular expression
6407 Default: "(>From )|(:[-^]?[][)(><}{|/DP])"
6408 The pager uses this variable to catch some common false posi‐
6410 tives of $quote_regex, most notably smileys and not consider a
6411 line quoted text if it also matches $smileys. This mostly hap‐
6412 pens at the beginning of a line.
6413 smime_ask_cert_label
6417 Type: boolean
6418 Default: yes
6419 This flag controls whether you want to be asked to enter a label
6421 for a certificate about to be added to the database or not. It
6422 is set by default. (S/MIME only)
6423 smime_ca_location
6427 Type: path
6428 Default: ""
6429 This variable contains the name of either a directory, or a file
6431 which contains trusted certificates for use with OpenSSL.
6432 (S/MIME only)
6433 smime_certificates
6437 Type: path
6438 Default: ""
6439 Since for S/MIME there is no pubring/secring as with PGP, Neo‐
6441 Mutt has to handle storage and retrieval of keys by itself. This
6442 is very basic right now, and keys and certificates are stored in
6443 two different directories, both named as the hash-value re‐
6444 trieved from OpenSSL. There is an index file which contains
6445 mailbox-address keyid pairs, and which can be manually edited.
6446 This option points to the location of the certificates. (S/MIME
6447 only)
6448 smime_decrypt_command
6452 Type: command
6453 Default: ""
6454 This format string specifies a command which is used to decrypt
6456 application/pkcs7-mime attachments.
6457 The OpenSSL command formats have their own set of printf(3)-like
6459 sequences similar to PGP's:
6460 %f Expands to the name of a file containing a message.
6461 %s Expands to the name of a file containing the signature
6462 part of a multipart/signed attachment when verifying it.
6463 %k The key-pair specified with $smime_default_key
6464 %i Intermediate certificates
6465 %c One or more certificate IDs.
6466 %a The algorithm used for encryption.
6467 %d The message digest algorithm specified with
6468 $smime_sign_digest_alg.
6469 %C CA location: Depending on whether $smime_ca_location
6470 points to a directory or file, this expands to "-CApath
6471 $smime_ca_location" or "-CAfile $smime_ca_location".
6472 For examples on how to configure these formats, see the smime.rc
6474 in the samples/ subdirectory which has been installed on your
6475 system alongside the documentation. (S/MIME only)
6476 smime_decrypt_use_default_key
6480 Type: boolean
6481 Default: yes
6482 If set (default) this tells NeoMutt to use the default key for
6484 decryption. Otherwise, if managing multiple certifi‐
6485 cate-key-pairs, NeoMutt will try to use the mailbox-address to
6486 determine the key to use. It will ask you to supply a key, if it
6487 can't find one. (S/MIME only)
6488 smime_default_key
6492 Type: string
6493 Default: ""
6494 This is the default key-pair to use for S/MIME operations, and
6496 must be set to the keyid (the hash-value that OpenSSL generates)
6497 to work properly.
6498 It will be used for encryption (see $postpone_encrypt and
6500 $smime_self_encrypt).
6501 It will be used for decryption unless $smime_decrypt_use_de‐
6503 fault_key is unset.
6504 It will also be used for signing unless $smime_sign_as is set.
6506 The (now deprecated) smime_self_encrypt_as is an alias for this
6508 variable, and should no longer be used. (S/MIME only)
6509 smime_encrypt_command
6513 Type: command
6514 Default: ""
6515 This command is used to create encrypted S/MIME messages.
6517 This is a format string, see the $smime_decrypt_command command
6519 for possible printf(3)-like sequences. (S/MIME only)
6520 Encrypt the message to $smime_default_key too. (S/MIME only)
6522 smime_encrypt_with
6526 Type: string
6527 Default: "aes256"
6528 This sets the algorithm that should be used for encryption.
6530 Valid choices are "aes128", "aes192", "aes256", "des", "des3",
6531 "rc2-40", "rc2-64", "rc2-128". (S/MIME only)
6532 smime_get_cert_command
6536 Type: command
6537 Default: ""
6538 This command is used to extract X509 certificates from a PKCS7
6540 structure.
6541 This is a format string, see the $smime_decrypt_command command
6543 for possible printf(3)-like sequences. (S/MIME only)
6544 smime_get_cert_email_command
6548 Type: command
6549 Default: ""
6550 This command is used to extract the mail address(es) used for
6552 storing X509 certificates, and for verification purposes (to
6553 check whether the certificate was issued for the sender's mail‐
6554 box).
6555 This is a format string, see the $smime_decrypt_command command
6557 for possible printf(3)-like sequences. (S/MIME only)
6558 smime_get_signer_cert_command
6562 Type: command
6563 Default: ""
6564 This command is used to extract only the signers X509 certifi‐
6566 cate from a S/MIME signature, so that the certificate's owner
6567 may get compared to the email's "From:" field.
6568 This is a format string, see the $smime_decrypt_command command
6570 for possible printf(3)-like sequences. (S/MIME only)
6571 smime_import_cert_command
6575 Type: command
6576 Default: ""
6577 This command is used to import a certificate via smime_keys.
6579 This is a format string, see the $smime_decrypt_command command
6581 for possible printf(3)-like sequences. NOTE: %c and %k will de‐
6582 fault to $smime_sign_as if set, otherwise $smime_default_key.
6583 (S/MIME only)
6584 smime_is_default
6588 Type: boolean
6589 Default: no
6590 The default behavior of NeoMutt is to use PGP on all
6592 auto-sign/encryption operations. To override and to use OpenSSL
6593 instead this must be set. However, this has no effect while re‐
6594 plying, since NeoMutt will automatically select the same appli‐
6595 cation that was used to sign/encrypt the original message.
6596 (Note that this variable can be overridden by unsetting
6597 $crypt_auto_smime.) (S/MIME only)
6598 smime_keys
6602 Type: path
6603 Default: ""
6604 Since for S/MIME there is no pubring/secring as with PGP, Neo‐
6606 Mutt has to handle storage and retrieval of keys/certs by it‐
6607 self. This is very basic right now, and stores keys and certifi‐
6608 cates in two different directories, both named as the hash-value
6609 retrieved from OpenSSL. There is an index file which contains
6610 mailbox-address keyid pair, and which can be manually edited.
6611 This option points to the location of the private keys. (S/MIME
6612 only)
6613 smime_pk7out_command
6617 Type: command
6618 Default: ""
6619 This command is used to extract PKCS7 structures of S/MIME sig‐
6621 natures, in order to extract the public X509 certificate(s).
6622 This is a format string, see the $smime_decrypt_command command
6624 for possible printf(3)-like sequences. (S/MIME only)
6625 smime_self_encrypt
6629 Type: boolean
6630 Default: yes
6631 When set, S/MIME encrypted messages will also be encrypted using
6633 the certificate in $smime_default_key. (S/MIME only)
6634 smime_sign_as
6638 Type: string
6639 Default: ""
6640 If you have a separate key to use for signing, you should set
6642 this to the signing key. Most people will only need to set
6643 $smime_default_key. (S/MIME only)
6644 smime_sign_command
6648 Type: command
6649 Default: ""
6650 This command is used to created S/MIME signatures of type multi‐
6652 part/signed, which can be read by all mail clients.
6653 This is a format string, see the $smime_decrypt_command command
6655 for possible printf(3)-like sequences. (S/MIME only)
6656 smime_sign_digest_alg
6660 Type: string
6661 Default: "sha256"
6662 This sets the algorithm that should be used for the signature
6664 message digest. Valid choices are "md5", "sha1", "sha224",
6665 "sha256", "sha384", "sha512". (S/MIME only)
6666 smime_timeout
6670 Type: number
6671 Default: 300
6672 The number of seconds after which a cached passphrase will ex‐
6674 pire if not used. (S/MIME only)
6675 smime_verify_command
6679 Type: command
6680 Default: ""
6681 This command is used to verify S/MIME signatures of type multi‐
6683 part/signed.
6684 This is a format string, see the $smime_decrypt_command command
6686 for possible printf(3)-like sequences. (S/MIME only)
6687 smime_verify_opaque_command
6691 Type: command
6692 Default: ""
6693 This command is used to verify S/MIME signatures of type appli‐
6695 cation/pkcs7-mime.
6696 This is a format string, see the $smime_decrypt_command command
6698 for possible printf(3)-like sequences. (S/MIME only)
6699 smtp_authenticators
6703 Type: string list
6704 Default: ""
6705 This is a colon-separated list of authentication methods NeoMutt
6707 may attempt to use to log in to an SMTP server, in the order
6708 NeoMutt should try them. Authentication methods are any SASL
6709 mechanism, e.g. "plain", "digest-md5", "gssapi" or "cram-md5".
6710 This option is case-insensitive. If it is "unset" (the default)
6711 NeoMutt will try all available methods, in order from most-se‐
6712 cure to least-secure. Support for the "plain" mechanism is bun‐
6713 dled; other mechanisms are provided by an external SASL library
6714 (look for '+sasl' in the output of neomutt -v).
6715 Example:
6717 set smtp_authenticators="digest-md5:cram-md5"
6720 smtp_oauth_refresh_command
6725 Type: command
6726 Default: ""
6727 The command to run to generate an OAUTH refresh token for autho‐
6729 rizing your connection to your SMTP server. This command will
6730 be run on every connection attempt that uses the OAUTHBEARER or
6731 XOAUTH2 authentication mechanisms. See "oauth" for details.
6732 smtp_pass
6736 Type: string
6737 Default: ""
6738 Specifies the password for your SMTP account. If unset, NeoMutt
6740 will prompt you for your password when you first send mail via
6741 SMTP. See $smtp_url to configure NeoMutt to send mail via SMTP.
6742 Warning: you should only use this option when you are on a
6744 fairly secure machine, because the superuser can read your neo‐
6745 muttrc even if you are the only one who can read the file.
6746 smtp_url
6750 Type: string
6751 Default: ""
6752 Defines the SMTP smarthost where sent messages should relayed
6754 for delivery. This should take the form of an SMTP URL, e.g.:
6755 smtp[s]://[user[:pass]@]host[:port]
6758 where "[...]" denotes an optional part. Setting this variable
6761 overrides the value of the $sendmail variable.
6762 Also see $write_bcc.
6764 smtp_user
6768 Type: string
6769 Default: ""
6770 The username for the SMTP server.
6772 This variable defaults to your user name on the local machine.
6774 socket_timeout
6778 Type: number
6779 Default: 30
6780 Causes NeoMutt to timeout any socket connect/read/write opera‐
6782 tion (for IMAP, POP or SMTP) after this many seconds. A nega‐
6783 tive value causes NeoMutt to wait indefinitely.
6784 sort
6788 Type: sort order
6789 Default: date
6790 Specifies how to sort messages in the "index" menu. Valid val‐
6792 ues are:
6793 ‐ date
6794 ‐ date-received
6795 ‐ from
6796 ‐ score
6797 ‐ size
6798 ‐ spam
6799 ‐ subject
6800 ‐ threads
6801 ‐ to
6802 ‐ unsorted
6803 You may optionally use the "reverse-" prefix to specify reverse
6805 sorting order, or the "last-" prefix to sort threads based on
6806 the corresponding attribute of the last descendant rather than
6807 the thread root. If both prefixes are in use, "reverse-" must
6808 come before "last-". The "last-" prefix has no effect on a flat
6809 view.
6810 Any ties in the primary sort are broken by $sort_aux. When
6812 $use_threads is "threads" or "reverse", $sort controls the sort‐
6813 ing between threads, and $sort_aux controls the sorting within a
6814 thread.
6815 The "date-sent" value is a synonym for "date". The "mailbox-or‐
6817 der" value is a synonym for "unsorted".
6818 The values of "threads" and "reverse-threads" are legacy op‐
6820 tions, which cause the value of $sort_aux to also control sort‐
6821 ing between threads, and they may not be used with the "last-"
6822 prefix. The preferred way to enable a threaded view is via
6823 $use_threads. This variable can also be set via the <sort-mail‐
6824 box> and <sort-reverse> functions.
6825 Note: When $use_threads is "threads", the last thread sorts to
6827 the bottom; when it is "reversed", the last thread sorts to the
6828 top. The use of "reverse-" in $sort swaps which end the last
6829 thread will sort to.
6830 See the "Use Threads Feature" section for further explanation
6832 and examples, https://neomutt.org/feature/use-threads
6833 sort_alias
6837 Type: sort order
6838 Default: alias
6839 Specifies how the entries in the "alias" menu are sorted. The
6841 following are legal values:
6842 ‐ address (sort alphabetically by email address)
6843 ‐ alias (sort alphabetically by alias name)
6844 ‐ unsorted (leave in order specified in .neomuttrc)
6845 Note: This also affects the entries of the address query menu,
6847 thus potentially overruling the order of entries as generated by
6848 $query_command.
6849 sort_aux
6853 Type: sort order
6854 Default: date
6855 This provides a secondary sort for messages in the "index" menu,
6857 used when the $sort value is equal for two messages.
6858 When sorting by threads, this variable controls how subthreads
6860 are sorted within a single thread (for the order between
6861 threads, see $sort). This can be set to any value that $sort
6862 can, including with the use of "reverse-" and "last-" prefixes,
6863 except for variations using "threads" (in that case, NeoMutt
6864 will just use "date"). For instance,
6865 set sort_aux=last-date-received
6868 would mean that if a new message is received in a thread, that
6871 subthread becomes the last one displayed (or the first, if you
6872 have "set use_threads=reverse".) When using $use_threads, it is
6873 more common to use "last-" with $sort and not with $sort_aux.
6874 See the "Use Threads Feature" section for further explanation
6876 and examples, https://neomutt.org/feature/use-threads
6877 sort_browser
6881 Type: sort order
6882 Default: alpha
6883 Specifies how to sort entries in the file browser. By default,
6885 the entries are sorted alphabetically. Valid values:
6886 ‐ alpha (alphabetically)
6887 ‐ count (all message count)
6888 ‐ date
6889 ‐ desc (description)
6890 ‐ new (new message count)
6891 ‐ size
6892 ‐ unsorted
6893 You may optionally use the "reverse-" prefix to specify reverse
6895 sorting order (example: "set sort_browser=reverse-date").
6896 The "unread" value is a synonym for "new".
6898 browser_sort_dirs_first
6902 Type: boolean
6903 Default: no
6904 If this variable is set, the browser will group directories be‐
6906 fore files.
6907 sort_re
6911 Type: boolean
6912 Default: yes
6913 This variable is only useful when sorting by threads with
6915 $strict_threads unset. In that case, it changes the heuristic
6916 neomutt uses to thread messages by subject. With $sort_re set,
6917 neomutt will only attach a message as the child of another mes‐
6918 sage by subject if the subject of the child message starts with
6919 a substring matching the setting of $reply_regex. With $sort_re
6920 unset, neomutt will attach the message whether or not this is
6921 the case, as long as the non-$reply_regex parts of both messages
6922 are identical.
6923 spam_separator
6927 Type: string
6928 Default: ","
6929 This variable controls what happens when multiple spam headers
6931 are matched: if unset, each successive header will overwrite any
6932 previous matches value for the spam label. If set, each succes‐
6933 sive match will append to the previous, using this variable's
6934 value as a separator.
6935 spool_file
6939 Type: mailbox
6940 Default: ""
6941 If your spool mailbox is in a non-default place where NeoMutt
6943 can't find it, you can specify its location with this variable.
6944 The description from "named-mailboxes" or "virtual-mailboxes"
6945 may be used for the spool_file.
6946 If not specified, then the environment variables $MAIL and
6948 $MAILDIR will be checked.
6949 ssl_ca_certificates_file
6953 Type: path
6954 Default: ""
6955 This variable specifies a file containing trusted CA certifi‐
6957 cates. Any server certificate that is signed with one of these
6958 CA certificates is also automatically accepted. (GnuTLS only)
6959 Example:
6961 set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
6964 ssl_ciphers
6969 Type: string
6970 Default: ""
6971 Contains a colon-separated list of ciphers to use when using
6973 SSL. For OpenSSL, see ciphers(1) for the syntax of the string.
6974 For GnuTLS, this option will be used in place of "NORMAL" at the
6976 start of the priority string. See gnutls_priority_init(3) for
6977 the syntax and more details. (Note: GnuTLS version 2.1.7 or
6978 higher is required.)
6979 ssl_client_cert
6983 Type: path
6984 Default: ""
6985 The file containing a client certificate and its associated pri‐
6987 vate key.
6988 ssl_force_tls
6992 Type: boolean
6993 Default: yes
6994 If this variable is set, NeoMutt will require that all connec‐
6996 tions to remote servers be encrypted. Furthermore it will at‐
6997 tempt to negotiate TLS even if the server does not advertise the
6998 capability, since it would otherwise have to abort the connec‐
6999 tion anyway. This option supersedes $ssl_starttls.
7000 ssl_min_dh_prime_bits
7004 Type: number
7005 Default: 0
7006 This variable specifies the minimum acceptable prime size (in
7008 bits) for use in any Diffie-Hellman key exchange. A value of 0
7009 will use the default from the GNUTLS library. (GnuTLS only)
7010 ssl_starttls
7014 Type: quadoption
7015 Default: yes
7016 If set (the default), NeoMutt will attempt to use STARTTLS on
7018 servers advertising the capability. When unset, NeoMutt will not
7019 attempt to use STARTTLS regardless of the server's capabilities.
7020 Note that STARTTLS is subject to many kinds of attacks, includ‐
7022 ing the ability of a machine-in-the-middle to suppress the ad‐
7023 vertising of support. Setting $ssl_force_tls is recommended if
7024 you rely on STARTTLS.
7025 ssl_use_sslv2
7029 Type: boolean
7030 Default: no
7031 If set , NeoMutt will use SSLv2 when communicating with servers
7033 that request it. N.B. As of 2011, SSLv2 is considered insecure,
7034 and using is inadvisable. See
7035 https://tools.ietf.org/html/rfc6176 (OpenSSL only)
7036 ssl_use_sslv3
7040 Type: boolean
7041 Default: no
7042 If set , NeoMutt will use SSLv3 when communicating with servers
7044 that request it. N.B. As of 2015, SSLv3 is considered insecure,
7045 and using it is inadvisable. See
7046 https://tools.ietf.org/html/rfc7525
7047 ssl_use_system_certs
7051 Type: boolean
7052 Default: yes
7053 If set to yes, NeoMutt will use CA certificates in the sys‐
7055 tem-wide certificate store when checking if a server certificate
7056 is signed by a trusted CA. (OpenSSL only)
7057 ssl_use_tlsv1
7061 Type: boolean
7062 Default: no
7063 If set , NeoMutt will use TLSv1.0 when communicating with
7065 servers that request it. N.B. As of 2015, TLSv1.0 is considered
7066 insecure, and using it is inadvisable. See
7067 https://tools.ietf.org/html/rfc7525
7068 ssl_use_tlsv1_1
7072 Type: boolean
7073 Default: no
7074 If set , NeoMutt will use TLSv1.1 when communicating with
7076 servers that request it. N.B. As of 2015, TLSv1.1 is considered
7077 insecure, and using it is inadvisable. See
7078 https://tools.ietf.org/html/rfc7525
7079 ssl_use_tlsv1_2
7083 Type: boolean
7084 Default: yes
7085 If set , NeoMutt will use TLSv1.2 when communicating with
7087 servers that request it.
7088 ssl_use_tlsv1_3
7092 Type: boolean
7093 Default: yes
7094 If set , NeoMutt will use TLSv1.3 when communicating with
7096 servers that request it.
7097 ssl_verify_dates
7101 Type: boolean
7102 Default: yes
7103 If set (the default), NeoMutt will not automatically accept a
7105 server certificate that is either not yet valid or already ex‐
7106 pired. You should only unset this for particular known hosts,
7107 using the <account-hook> function.
7108 ssl_verify_host
7112 Type: boolean
7113 Default: yes
7114 If set (the default), NeoMutt will not automatically accept a
7116 server certificate whose host name does not match the host used
7117 in your folder URL. You should only unset this for particular
7118 known hosts, using the <account-hook> function.
7119 ssl_verify_partial_chains
7123 Type: boolean
7124 Default: no
7125 This option should not be changed from the default unless you
7127 understand what you are doing.
7128 Setting this variable to yes will permit verifying partial cer‐
7130 tification chains, i. e. a certificate chain where not the root,
7131 but an intermediate certificate CA, or the host certificate, are
7132 marked trusted (in $certificate_file), without marking the root
7133 signing CA as trusted.
7134 (OpenSSL 1.0.2b and newer only).
7136 status_chars
7140 Type: character string
7141 Default: "-*%A"
7142 Controls the characters used by the "%r" indicator in $sta‐
7144 tus_format.
7145 Character
7146 Default Description
7147 1 - Mailbox is unchanged
7148 2 * Mailbox has been changed and needs to be resynchronized
7149 3 % Mailbox is read-only, or will not be written when exit‐
7150 ing. (You can toggle whether to write changes to a mail‐
7151 box with the <toggle-write> operation, bound by default
7152 to "%")
7153 4 A Folder opened in attach-message mode. (Certain opera‐
7154 tions like composing a new mail, replying, forwarding,
7155 etc. are not permitted in this mode)
7156 status_format
7159 Type: string
7160 Default: "-%r-NeoMutt: %D [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>]---(%<T?%T/>%s/%S)-%>-(%P)---"
7161 Controls the format of the status line displayed in the "index"
7163 menu. This string is similar to $index_format, but has its own
7164 set of printf(3)-like sequences:
7165 %b * Number of mailboxes with new mail
7166 %d * Number of deleted messages
7167 %D
7168 Description of the mailbox
7170 %f
7171 The full pathname of the current mailbox
7173 %F * Number of flagged messages
7174 %h
7175 Local hostname
7177 %l * Size (in bytes) of the current mailbox (see format‐
7178 strings-size)
7179 %L * Size (in bytes) of the messages shown (i.e., which
7180 match the current limit) (see formatstrings-size)
7181 %m * The number of messages in the mailbox
7182 %M * The number of messages shown (i.e., which match the
7183 current limit)
7184 %n * Number of new messages in the mailbox (unread, unseen)
7185 %o * Number of old messages in the mailbox (unread, seen)
7186 %p * Number of postponed messages
7187 %P
7188 Percentage of the way through the index
7190 %r
7191 Modified/read-only/won't-write/attach-message indicator,
7193 According to $status_chars
7194 %R * Number of read messages in the mailbox (read, seen)
7195 %s
7196 Current sorting mode ($sort)
7198 %S
7199 Current aux sorting method ($sort_aux)
7201 %t * Number of tagged messages in the mailbox
7202 %T * Current threading mode ($use_threads)
7203 %u * Number of unread messages in the mailbox (seen or un‐
7204 seen)
7205 %v
7206 NeoMutt version string
7208 %V * Currently active limit pattern, if any
7209 %>X
7210 Right justify the rest of the string and pad with "X"
7212 %|X
7213 Pad to the end of the line with "X"
7215 %*X
7216 Soft-fill with character "X" as pad
7218 For an explanation of "soft-fill", see the $index_format docu‐
7220 mentation.
7221 * = can be optionally printed if nonzero
7223 Some of the above sequences can be used to optionally print a
7225 string if their value is nonzero. For example, you may only
7226 want to see the number of flagged messages if such messages ex‐
7227 ist, since zero is not particularly meaningful. To optionally
7228 print a string based upon one of the above sequences, the fol‐
7229 lowing construct is used:
7230 %<sequence_char?optional_string>
7232 where sequence_char is a character from the table above, and op‐
7234 tional_string is the string you would like printed if se‐
7235 quence_char is nonzero. optional_string may contain other se‐
7236 quences as well as normal text.
7237 Here is an example illustrating how to optionally print the num‐
7239 ber of new messages in a mailbox:
7240 %<n?%n new messages>
7242 You can also switch between two strings using the following con‐
7244 struct:
7245 %<sequence_char?if_string&else_string>
7247 If the value of sequence_char is non-zero, if_string will be ex‐
7249 panded, otherwise else_string will be expanded.
7250 As another example, here is how to show either $sort and
7252 $sort_aux or $use_threads and $sort, based on whether threads
7253 are enabled with $use_threads:
7254 %<T?%s/%S&%T/%s>
7256 You can force the result of any printf(3)-like sequence to be
7258 lowercase by prefixing the sequence character with an underscore
7259 ("_") sign. For example, if you want to display the local host‐
7260 name in lowercase, you would use: "%_h".
7261 If you prefix the sequence character with a colon (":") charac‐
7263 ter, NeoMutt will replace any dots in the expansion by under‐
7264 scores. This might be helpful with IMAP folders that don't like
7265 dots in folder names.
7266 status_on_top
7270 Type: boolean
7271 Default: no
7272 Setting this variable causes the "status bar" to be displayed on
7274 the first line of the screen rather than near the bottom. If
7275 $help is set too, it'll be placed at the bottom.
7276 strict_threads
7280 Type: boolean
7281 Default: no
7282 If set, threading will only make use of the "In-Reply-To" and
7284 "References:" fields when you $sort by message threads. By de‐
7285 fault, messages with the same subject are grouped together in
7286 "pseudo threads.". This may not always be desirable, such as in
7287 a personal mailbox where you might have several unrelated mes‐
7288 sages with the subjects like "hi" which will get grouped to‐
7289 gether. See also $sort_re for a less drastic way of controlling
7290 this behavior.
7291 suspend
7295 Type: boolean
7296 Default: yes
7297 When unset, NeoMutt won't stop when the user presses the termi‐
7299 nal's susp key, usually "^Z". This is useful if you run NeoMutt
7300 inside an xterm using a command like "xterm -e neomutt".
7301 On startup NeoMutt tries to detect if it is the process session
7303 leader. If so, the default of suspend is "no" otherwise "yes".
7304 This default covers the above mentioned use case of "xterm -e
7305 neomutt".
7306 text_flowed
7310 Type: boolean
7311 Default: no
7312 When set, NeoMutt will generate "format=flowed" bodies with a
7314 content type of "text/plain; format=flowed". This format is
7315 easier to handle for some mailing software, and generally just
7316 looks like ordinary text. To actually make use of this format's
7317 features, you'll need support in your editor.
7318 The option only controls newly composed messages. Postponed
7320 messages, resent messages, and draft messages (via -H on the
7321 command line) will use the content-type of the source message.
7322 Note that $indent_string is ignored when this option is set.
7324 thorough_search
7328 Type: boolean
7329 Default: yes
7330 Affects the ~b, ~B, and ~h search operations described in sec‐
7332 tion "patterns". If set, the headers and body/attachments of
7333 messages to be searched are decoded before searching. If unset,
7334 messages are searched as they appear in the folder.
7335 Users searching attachments or for non-ASCII characters should
7337 set this value because decoding also includes MIME parsing/de‐
7338 coding and possible character set conversions. Otherwise NeoMutt
7339 will attempt to match against the raw message received (for ex‐
7340 ample quoted-printable encoded or with encoded headers) which
7341 may lead to incorrect search results.
7342 thread_received
7346 Type: boolean
7347 Default: no
7348 If $strict_threads is unset, then messages may also be grouped
7350 by subject. Unlike threading by "In-Reply-To:" and "Refer‐
7351 ences:" header, grouping by subject does not imply a par‐
7352 ent-child relation between two messages.
7353 To determine the ancestry between messages grouped by subject,
7355 Neomutt uses their date: only newer messages can be descendants
7356 of older ones.
7357 When $thread_received is set, NeoMutt uses the date received
7359 rather than the date sent when comparing messages for the date.
7360 See also $strict_threads, and $sort_re.
7362 tilde
7366 Type: boolean
7367 Default: no
7368 When set, the internal-pager will pad blank lines to the bottom
7370 of the screen with a tilde ("~").
7371 time_inc
7375 Type: number
7376 Default: 0
7377 Along with $read_inc, $write_inc, and $net_inc, this variable
7379 controls the frequency with which progress updates are dis‐
7380 played. It suppresses updates less than $time_inc milliseconds
7381 apart. This can improve throughput on systems with slow termi‐
7382 nals, or when running NeoMutt on a remote system.
7383 Also see the "tuning" section of the manual for performance con‐
7385 siderations.
7386 timeout
7390 Type: number
7391 Default: 600
7392 When NeoMutt is waiting for user input either idling in menus or
7394 in an interactive prompt, NeoMutt would block until input is
7395 present. Depending on the context, this would prevent certain
7396 operations from working, like checking for new mail or keeping
7397 an IMAP connection alive.
7398 This variable controls how many seconds NeoMutt will at most
7400 wait until it aborts waiting for input, performs these opera‐
7401 tions and continues to wait for input.
7402 A value of zero or less will cause NeoMutt to never time out.
7404 tmp_dir
7408 Type: path
7409 Default: "/tmp"
7410 This variable allows you to specify where NeoMutt will place its
7412 temporary files needed for displaying and composing messages.
7413 If this variable is not set, the environment variable $TMPDIR is
7415 used. Failing that, then "/tmp" is used.
7416 to_chars
7420 Type: character string
7421 Default: " +TCFLR"
7422 Controls the character used to indicate mail addressed to you.
7424 Character
7425 Default Description
7426 1 <space> The mail is not addressed to your address.
7427 2 + You are the only recipient of the message.
7428 3 T Your address appears in the "To:" header field, but you
7429 are not the only recipient of the message.
7430 4 C Your address is specified in the "Cc:" header field,
7431 but you are not the only recipient.
7432 5 F Indicates the mail that was sent by you.
7433 6 L Indicates the mail was sent to a mailing-list you sub‐
7434 scribe to.
7435 7 R Your address appears in the "Reply-To:" header field
7436 but none of the above applies.
7437 toggle_quoted_show_levels
7440 Type: number
7441 Default: 0
7442 Quoted text may be filtered out using the <toggle-quoted> com‐
7444 mand. If set to a number greater than 0, then the <tog‐
7445 gle-quoted> command will only filter out quote levels above this
7446 number.
7447 trash
7451 Type: mailbox
7452 Default: ""
7453 If set, this variable specifies the path of the trash folder
7455 where the mails marked for deletion will be moved, instead of
7456 being irremediably purged.
7457 NOTE: When you delete a message in the trash folder, it is re‐
7459 ally deleted, so that you have a way to clean the trash.
7460 ts_enabled
7464 Type: boolean
7465 Default: no
7466 Controls whether NeoMutt tries to set the terminal status line
7468 and icon name. Most terminal emulators emulate the status line
7469 in the window title.
7470 ts_icon_format
7474 Type: string
7475 Default: "M%<n?AIL&ail>"
7476 Controls the format of the icon title, as long as "$ts_enabled"
7478 is set. This string is identical in formatting to the one used
7479 by "$status_format".
7480 ts_status_format
7484 Type: string
7485 Default: "NeoMutt with %<m?%m messages&no messages>%<n? [%n NEW]>"
7486 Controls the format of the terminal status line (or window ti‐
7488 tle), provided that "$ts_enabled" has been set. This string is
7489 identical in formatting to the one used by "$status_format".
7490 tunnel
7494 Type: command
7495 Default: ""
7496 Setting this variable will cause NeoMutt to open a pipe to a
7498 command instead of a raw socket. You may be able to use this to
7499 set up preauthenticated connections to your IMAP/POP3/SMTP
7500 server. Example:
7501 set tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
7504 Note: For this example to work you must be able to log in to the
7507 remote machine without having to enter a password.
7508 When set, NeoMutt uses the tunnel for all remote connections.
7510 Please see "account-hook" in the manual for how to use different
7511 tunnel commands per connection.
7512 tunnel_is_secure
7516 Type: boolean
7517 Default: yes
7518 When set, NeoMutt will assume the $tunnel connection does not
7520 need STARTTLS to be enabled. It will also allow IMAP PREAUTH
7521 server responses inside a tunnel to proceed. This is appropri‐
7522 ate if $tunnel uses ssh or directly invokes the server locally.
7523 When unset, NeoMutt will negotiate STARTTLS according to the
7525 ssl_starttls and ssl_force_tls variables. If ssl_force_tls is
7526 set, NeoMutt will abort connecting if an IMAP server responds
7527 with PREAUTH. This setting is appropriate if $tunnel does not
7528 provide security and could be tampered with by attackers.
7529 uncollapse_jump
7533 Type: boolean
7534 Default: no
7535 When set, NeoMutt will jump to the next unread message, if any,
7537 when the current thread is uncollapsed.
7538 uncollapse_new
7542 Type: boolean
7543 Default: yes
7544 When set, NeoMutt will automatically uncollapse any collapsed
7546 thread that receives a new message. When unset, collapsed
7547 threads will remain collapsed. the presence of the new message
7548 will still affect index sorting, though.
7549 use_8bit_mime
7553 Type: boolean
7554 Default: no
7555 Warning: do not set this variable unless you are using a version
7557 of sendmail which supports the -B8BITMIME flag (such as sendmail
7558 8.8.x) or you may not be able to send mail.
7559 When set, NeoMutt will invoke $sendmail with the -B8BITMIME flag
7561 when sending 8-bit messages to enable ESMTP negotiation.
7562 use_domain
7566 Type: boolean
7567 Default: yes
7568 When set, NeoMutt will qualify all local addresses (ones without
7570 the "@host" portion) with the value of $hostname. If unset, no
7571 addresses will be qualified.
7572 use_envelope_from
7576 Type: boolean
7577 Default: no
7578 When set, NeoMutt will set the envelope sender of the message.
7580 If $envelope_from_address is set, it will be used as the sender
7581 address. If unset, NeoMutt will attempt to derive the sender
7582 from the "From:" header.
7583 Note that this information is passed to sendmail command using
7585 the -f command line switch. Therefore setting this option is not
7586 useful if the $sendmail variable already contains -f or if the
7587 executable pointed to by $sendmail doesn't support the -f
7588 switch.
7589 use_from
7593 Type: boolean
7594 Default: yes
7595 When set, NeoMutt will generate the "From:" header field when
7597 sending messages. If unset, no "From:" header field will be
7598 generated unless the user explicitly sets one using the "my_hdr"
7599 command.
7600 use_ipv6
7604 Type: boolean
7605 Default: yes
7606 When set, NeoMutt will look for IPv6 addresses of hosts it tries
7608 to contact. If this option is unset, NeoMutt will restrict it‐
7609 self to IPv4 addresses. Normally, the default should work.
7610 use_threads
7614 Type: enumeration
7615 Default: unset
7616 The style of threading used in the index. May be one of "flat"
7618 (no threading), "threads" (threaded, with subthreads below root
7619 message) or "reverse" (threaded, with subthreads above root mes‐
7620 sage). For convenience, the value "yes" is a synonym for
7621 "threads", and "no" is a synonym for "flat".
7622 If this variable is never set, then $sort controls whether
7624 threading is used, $sort_aux controls both the sorting of
7625 threads and subthreads, and using <sort-mailbox> to select
7626 threads affects only $sort. Once this variable is set, attempt‐
7627 ing to set $sort to a value using "threads" will warn, the value
7628 of $sort controls the sorting between threads while $sort_aux
7629 controls sorting within a thread, and <sort-mailbox> toggles
7630 $use_threads.
7631 Example:
7633 set use_threads=yes
7636 See the "Use Threads Feature" section for further explanation
7639 and examples.
7640 user_agent
7644 Type: boolean
7645 Default: no
7646 When set, NeoMutt will add a "User-Agent:" header to outgoing
7648 messages, indicating which version of NeoMutt was used for com‐
7649 posing them.
7650 virtual_spool_file
7654 Type: boolean
7655 Default: no
7656 This command is now unnecessary. $spool_file has been extended
7658 to support mailbox descriptions as a value.
7659 When set, NeoMutt will use the first defined virtual mailbox
7661 (see virtual-mailboxes) as a spool file.
7662 wait_key
7666 Type: boolean
7667 Default: yes
7668 Controls whether NeoMutt will ask you to press a key after an
7670 external command has been invoked by these functions: <shell-es‐
7671 cape>, <pipe-message>, <pipe-entry>, <print-message>, and
7672 <print-entry> commands.
7673 It is also used when viewing attachments with "auto_view", pro‐
7675 vided that the corresponding mailcap entry has a needsterminal
7676 flag, and the external program is interactive.
7677 When set, NeoMutt will always ask for a key. When unset, NeoMutt
7679 will wait for a key only if the external command returned a
7680 non-zero status.
7681 weed
7685 Type: boolean
7686 Default: yes
7687 When set, NeoMutt will weed headers when displaying, forwarding,
7689 or replying to messages.
7690 Also see $copy_decode_weed, $pipe_decode_weed, $print_de‐
7692 code_weed.
7693 wrap
7697 Type: number
7698 Default: 0
7699 When set to a positive value, NeoMutt will wrap text at $wrap
7701 characters. When set to a negative value, NeoMutt will wrap
7702 text so that there are $wrap characters of empty space on the
7703 right side of the terminal. Setting it to zero makes NeoMutt
7704 wrap at the terminal width.
7705 Also see $reflow_wrap.
7707 wrap_headers
7711 Type: number
7712 Default: 78
7713 This option specifies the number of characters to use for wrap‐
7715 ping an outgoing message's headers. Allowed values are between
7716 78 and 998 inclusive.
7717 Note: This option usually shouldn't be changed. RFC5233 recom‐
7719 mends a line length of 78 (the default), so please only change
7720 this setting when you know what you're doing.
7721 wrap_search
7725 Type: boolean
7726 Default: yes
7727 Controls whether searches wrap around the end.
7729 When set, searches will wrap around the first (or last) item.
7731 When unset, incremental searches will not wrap.
7732 write_bcc
7736 Type: boolean
7737 Default: no
7738 Controls whether NeoMutt writes out the "Bcc:" header when pre‐
7740 paring messages to be sent. Some MTAs, such as Exim and
7741 Courier, do not strip the "Bcc:" header; so it is advisable to
7742 leave this unset unless you have a particular need for the
7743 header to be in the sent message.
7744 If NeoMutt is set to deliver directly via SMTP(see $smtp_url),
7746 this option does nothing: NeoMutt will never write out the
7747 "Bcc:" header in this case.
7748 Note this option only affects the sending of messages. Fcc'ed
7750 copies of a message will always contain the "Bcc:" header if one
7751 exists.
7752 write_inc
7756 Type: number
7757 Default: 10
7758 When writing a mailbox, a message will be printed every
7760 $write_inc messages to indicate progress. If set to 0, only a
7761 single message will be displayed before writing a mailbox.
7762 Also see the $read_inc, $net_inc and $time_inc variables and the
7764 "tuning" section of the manual for performance considerations.
7765 x_comment_to
7769 Type: boolean
7770 Default: no
7771 If set, NeoMutt will add "X-Comment-To:" field (that contains
7773 full name of original article author) to article that followuped
7774 to newsgroup.
7775
7779 iconv(1), neomutt(1), notmuch(1), iconv(3), printf(3), strftime(3),
7780 mailcap(5), maildir(5), mbox(5), regex(7).
7781 For further NeoMutt information:
7783 • the full manual, /usr/share/doc/neomutt/manual.{html,pdf,txt}
7785 • the home page, <https://neomutt.org>
7786
7788 Michael Elkins, and others. Use <neomutt-devel@neomutt.org> to contact
7789 the developers.
7790Unix 2023-11-03 neomuttrc(5)