All patches and comments are welcome. Please squash your changes to logical
commits before using git-format-patch and git-send-email to
patches@git.madduck.net.
If you'd read over the Git project's submission guidelines and adhered to them,
I'd be especially grateful.
1 # Auto-generated using mkconf from manual.txt
2 # on 2025-01-21 08:53:04
12 # If set, hitting backspace against an empty prompt aborts the prompt.
21 # Specifies the key that can be used to abort prompts. The format is the same as
22 # used in "bind" commands. The default is equivalent to "Ctrl-G". Note that the
23 # specified key should not be used in other bindings, as the abort operation has
24 # higher precedence and the binding will not have the desired effect.
28 # set abort_key = "<Esc>"
30 # Please note that when using <Esc> as the abort key, you may also want to set
31 # the environment variable ESCDELAY to a low value or even 0 which will reduce
32 # the time that ncurses waits to distinguish singular <Esc> key presses from the
33 # start of a terminal escape sequence. The default time is 1000 milliseconds and
34 # thus quite noticeable.
43 # If set to yes, when composing messages containing the regular expression
44 # specified by $abort_noattach_regex and no attachments are given, composition
45 # will be aborted. If set to no, composing messages as such will never be
50 # set abort_noattach_regex = "\<attach(|ed|ments?)\>"
52 set abort_noattach=ask-yes
55 # 3.4. abort_noattach_regex
57 # Type: regular expression
58 # Default: “<(attach|attached|attachments?)>”
60 # Specifies a regular expression to match against the body of the message, to
61 # determine if an attachment was mentioned but mistakenly forgotten. If it
62 # matches, $abort_noattach will be consulted to determine if message sending will
65 # Like other regular expressions in NeoMutt, the search is case sensitive if the
66 # pattern contains at least one upper case letter, and case insensitive
71 # 3.5. abort_nosubject
76 # If set to yes, when composing messages and no subject is given at the subject
77 # prompt, composition will be aborted. If set to no, composing messages with no
78 # subject given at the subject prompt will never be aborted.
82 # 3.6. abort_unmodified
87 # If set to yes, composition will automatically abort after editing the message
88 # body if no changes are made to the file (this check only happens after the
89 # first edit of the file). When set to no, composition will never be aborted.
93 # 3.7. account_command
98 # If set, this command is used to retrieve account credentials. The command is
99 # invoked passing a number of --key value arguments with the specifics of the
100 # account to lookup. The command writes to standard output a number of key: value
101 # lines. Currently supported arguments are --hostname, --username, and --type,
102 # where type can be any of imap, imaps, pop, pops, smtp, smtps, nntp, and nntps.
103 # Currently supported output lines are login, username, and password.
110 # Default: “~/.neomuttrc”
112 # The default file in which to save aliases created by the <create-alias>
113 # function. Entries added to this file are encoded in the character set specified
114 # by $config_charset if it is set or the current character set otherwise.
116 # Note: NeoMutt will not automatically source this file; you must explicitly use
117 # the "source" command for it to be executed in case this option points to a
118 # dedicated alias file.
120 # The default for this option is the currently used neomuttrc file, or "~
121 # /.neomuttrc" if no user neomuttrc was found.
123 set alias_file="$my_confdir/aliases"
129 # Default: “%3i %f%t %-15a %-56A | %C%> %Y”
131 # Specifies the format of the data displayed for the "alias" menu. The following
132 # printf(3)-style sequences are available:
134 # ┌───┬───────────────────────────────────────────────────────────────┐
136 # ├───┼───────────────────────────────────────────────────────────────┤
137 # │%A │Full Address (Name and Email) │
138 # ├───┼───────────────────────────────────────────────────────────────┤
140 # ├───┼───────────────────────────────────────────────────────────────┤
141 # │%E │Email Address │
142 # ├───┼───────────────────────────────────────────────────────────────┤
143 # │%f │Flags - currently, a "d" for an alias marked for deletion │
144 # ├───┼───────────────────────────────────────────────────────────────┤
145 # │%i │Index number │
146 # ├───┼───────────────────────────────────────────────────────────────┤
148 # ├───┼───────────────────────────────────────────────────────────────┤
149 # │%t │Alias is tagged (selected) │
150 # ├───┼───────────────────────────────────────────────────────────────┤
151 # │%Y │User-defined tags (labels) │
152 # ├───┼───────────────────────────────────────────────────────────────┤
153 # │%>X│right justify the rest of the string and pad with character "X"│
154 # ├───┼───────────────────────────────────────────────────────────────┤
155 # │%|X│pad to the end of the line with character "X" │
156 # ├───┼───────────────────────────────────────────────────────────────┤
157 # │%*X│soft-fill with character "X" as pad │
158 # └───┴───────────────────────────────────────────────────────────────┘
160 # For an explanation of "soft-fill", see the $index_format documentation.
162 # The following sequences are deprecated; they will be removed in the future.
164 # ┌──┬───────────────┐
165 # │%c│Use %C instead │
166 # ├──┼───────────────┤
167 # │%n│Use %i instead │
168 # ├──┼───────────────┤
169 # │%r│Use %A instead │
170 # └──┴───────────────┘
179 # Specifies how the entries in the "alias" menu are sorted. The following are
182 # • address (sort alphabetically by email address)
184 # • alias (sort alphabetically by alias name)
186 # • unsorted (leave in order specified in .neomuttrc)
188 # Note: This also affects the entries of the address query menu, thus potentially
189 # overruling the order of entries as generated by $query_command.
198 # Controls whether 8-bit data is converted to 7-bit using either Quoted-
199 # Printable or Base64 encoding when sending mail.
208 # Controls whether ANSI color codes in messages (and color tags in rich text
209 # messages) are to be interpreted. Messages containing these codes are rare, but
210 # if this option is set, their text will be colored accordingly. Note that this
211 # may override your color choices, and even present a security problem, since a
212 # message could include a line like
214 # [-- PGP output follows ...
216 # and give it the same color as your attachment color (see also $crypt_timestamp
226 # When set, an arrow ("->") will be used to indicate the current entry in menus
227 # instead of highlighting the whole line. On slow network or modem links this
228 # will make response faster because there is less that has to be redrawn on the
229 # screen when moving to the next or previous entries in the menu.
238 # Specifies the string of arrow_cursor when arrow_cursor enabled.
247 # If set, NeoMutt will use plain ASCII characters when displaying thread and
248 # attachment trees, instead of the default ACS characters.
257 # If set, NeoMutt will prompt you for blind-carbon-copy (Bcc) recipients before
258 # editing an outgoing message.
267 # If set, NeoMutt will prompt you for carbon-copy (Cc) recipients before editing
268 # the body of an outgoing message.
272 # 3.18. ask_followup_to
277 # If set, NeoMutt will prompt you for follow-up groups before editing the body of
278 # an outgoing message.
282 # 3.19. ask_x_comment_to
287 # If set, NeoMutt will prompt you for x-comment-to field before editing the body
288 # of an outgoing message.
292 # 3.20. assumed_charset
297 # This variable is a colon-separated list of character encoding schemes for
298 # messages without character encoding indication. Header field values and message
299 # body content without character encoding indication would be assumed that they
300 # are written in one of this list. By default, all the header fields and message
301 # body without any charset indication are assumed to be in "us-ascii".
303 # For example, Japanese users might prefer this:
305 # set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
307 # However, only the first content is valid for the message body.
311 # 3.21. attach_charset
316 # This variable is a colon-separated list of character encoding schemes for text
317 # file attachments. NeoMutt uses this setting to guess which encoding files being
318 # attached are encoded in to convert them to a proper character set given in
321 # If unset, the value of $charset will be used instead. For example, the
322 # following configuration would work for Japanese text handling:
324 # set attach_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
326 # Note: for Japanese users, "iso-2022-*" must be put at the head of the value as
327 # shown above if included.
331 # 3.22. attach_format
334 # Default: “%u%D%I %t%4n %T%d %> [%.7m/%.10M, %.6e%<C?, %C>, %s] ”
336 # This variable describes the format of the "attachment" menu. The following
337 # printf(3)-style sequences are understood:
339 # ┌───┬─────────────────────────────────────────────────────────────────────────┐
341 # ├───┼─────────────────────────────────────────────────────────────────────────┤
342 # │%c │Requires charset conversion ("n" or "c") │
343 # ├───┼─────────────────────────────────────────────────────────────────────────┤
344 # │%D │Deleted flag │
345 # ├───┼─────────────────────────────────────────────────────────────────────────┤
346 # │%d │Description (if none, falls back to %F) │
347 # ├───┼─────────────────────────────────────────────────────────────────────────┤
348 # │%e │MIME content-transfer-encoding │
349 # ├───┼─────────────────────────────────────────────────────────────────────────┤
351 # ├───┼─────────────────────────────────────────────────────────────────────────┤
352 # │%F │Filename in content-disposition header (if none, falls back to %f) │
353 # ├───┼─────────────────────────────────────────────────────────────────────────┤
354 # │%I │Disposition ("I" for inline, "A" for attachment) │
355 # ├───┼─────────────────────────────────────────────────────────────────────────┤
356 # │%m │Major MIME type │
357 # ├───┼─────────────────────────────────────────────────────────────────────────┤
358 # │%M │MIME subtype │
359 # ├───┼─────────────────────────────────────────────────────────────────────────┤
360 # │%n │Attachment number │
361 # ├───┼─────────────────────────────────────────────────────────────────────────┤
362 # │%Q │"Q", if MIME part qualifies for attachment counting │
363 # ├───┼─────────────────────────────────────────────────────────────────────────┤
364 # │%s │Size (see formatstrings-size) │
365 # ├───┼─────────────────────────────────────────────────────────────────────────┤
366 # │%T │Graphic tree characters │
367 # ├───┼─────────────────────────────────────────────────────────────────────────┤
369 # ├───┼─────────────────────────────────────────────────────────────────────────┤
370 # │%u │Unlink (=to delete) flag │
371 # ├───┼─────────────────────────────────────────────────────────────────────────┤
372 # │%X │Number of qualifying MIME parts in this part and its children (please see│
373 # │ │the "attachments" section for possible speed effects) │
374 # ├───┼─────────────────────────────────────────────────────────────────────────┤
375 # │%>X│Right justify the rest of the string and pad with character "X" │
376 # ├───┼─────────────────────────────────────────────────────────────────────────┤
377 # │%|X│Pad to the end of the line with character "X" │
378 # ├───┼─────────────────────────────────────────────────────────────────────────┤
379 # │%*X│Soft-fill with character "X" as pad │
380 # └───┴─────────────────────────────────────────────────────────────────────────┘
382 # For an explanation of "soft-fill", see the $index_format documentation.
386 # 3.23. attach_save_dir
391 # The directory where attachments are saved.
393 set attach_save_dir=$tmpdir
396 # 3.24. attach_save_without_prompting
401 # This variable, when set to true, will cause attachments to be saved to the
402 # 'attach_save_dir' location without prompting the user for the filename.
411 # The separator to add between attachments when operating (saving, printing,
412 # piping, etc) on a list of tagged attachments.
421 # If this variable is unset, when operating (saving, printing, piping, etc) on a
422 # list of tagged attachments, NeoMutt will concatenate the attachments and will
423 # operate on them as a single attachment. The $attach_sep separator is added
424 # after each attachment. When set, NeoMutt will operate on the attachments one by
429 # 3.27. attribution_intro
432 # Default: “On %d, %n wrote:”
434 # This is the string that will precede a replied-to message which is quoted in
435 # the main body of the reply (this is the case when $include is set).
437 # For a full listing of defined printf(3)-like sequences see the section on
438 # $index_format. See also $attribution_locale.
442 # 3.28. attribution_locale
447 # The locale used by strftime(3) to format dates in the attribution strings.
448 # Legal values are the strings your system accepts for the locale environment
451 # This variable is to allow the attribution date format to be customized by
452 # recipient or folder using hooks. By default, NeoMutt will use your locale
453 # environment, so there is no need to set this except to override that default.
455 # Affected variables are: $attribution_intro, $attribution_trailer,
456 # $forward_attribution_intro, $forward_attribution_trailer, $indent_string.
460 # 3.29. attribution_trailer
465 # Similar to the $attribution_intro variable, this is the string that will come
466 # after a replied-to message which is quoted in the main body of the reply (this
467 # is the case when $include is set).
469 # For a full listing of defined printf(3)-like sequences see the section on
470 # $index_format. See also $attribution_locale.
479 # When set along with $edit_headers, NeoMutt will skip the initial send-menu
480 # (prompting for subject and recipients) and allow you to immediately begin
481 # editing the body of your message. The send-menu may still be accessed once you
482 # have finished editing the body of your message.
484 # Note: when this option is set, you can't use send-hooks that depend on the
485 # recipients when composing a new (non-reply) message, as the initial list of
486 # recipients is empty.
488 # Also see $fast_reply.
493 # 3.31. auto_subscribe
498 # When set, NeoMutt assumes the presence of a List-Post header means the
499 # recipient is subscribed to the list. Unless the mailing list is in the
500 # "unsubscribe" or "unlist" lists, it will be added to the "subscribe" list.
501 # Parsing and checking these things slows header reading down, so this option is
502 # disabled by default.
511 # When set, functions in the index menu which affect a message will be applied to
512 # all tagged messages (if there are any). When unset, you must first use the
513 # <tag-prefix> function (bound to ";" by default) to make the next function apply
514 # to all tagged messages.
523 # When set, enables autocrypt, which provides passive encryption protection with
524 # keys exchanged via headers. See "autocryptdoc" for more details. (Autocrypt
529 # 3.34. autocrypt_acct_format
532 # Default: “%4n %-30a %20p %10s”
534 # This variable describes the format of the "autocrypt account" menu. The
535 # following printf(3)-style sequences are understood
537 # ┌───┬───────────────────────────────────────────────────────────────┐
538 # │%a │email address │
539 # ├───┼───────────────────────────────────────────────────────────────┤
541 # ├───┼───────────────────────────────────────────────────────────────┤
542 # │%n │current entry number │
543 # ├───┼───────────────────────────────────────────────────────────────┤
544 # │%p │prefer-encrypt flag │
545 # ├───┼───────────────────────────────────────────────────────────────┤
546 # │%s │status flag (active/inactive) │
547 # ├───┼───────────────────────────────────────────────────────────────┤
548 # │%>X│right justify the rest of the string and pad with character "X"│
549 # ├───┼───────────────────────────────────────────────────────────────┤
550 # │%|X│pad to the end of the line with character "X" │
551 # ├───┼───────────────────────────────────────────────────────────────┤
552 # │%*X│soft-fill with character "X" as pad │
553 # └───┴───────────────────────────────────────────────────────────────┘
559 # 3.35. autocrypt_dir
562 # Default: “~/.mutt/autocrypt”
564 # This variable sets where autocrypt files are stored, including the GPG keyring
565 # and SQLite database. See "autocryptdoc" for more details. (Autocrypt only)
569 # 3.36. autocrypt_reply
574 # When set, replying to an autocrypt email automatically enables autocrypt in the
575 # reply. You may want to unset this if you're using the same key for autocrypt as
576 # normal web-of-trust, so that autocrypt isn't forced on for all encrypted
577 # replies. (Autocrypt only)
586 # When this variable is set, NeoMutt will beep when an error occurs.
596 # When this variable is set, NeoMutt will beep whenever it prints a message
597 # notifying you of new mail. This is independent of the setting of the $beep
607 # Controls whether you will be asked to confirm bouncing messages. If set to yes
608 # you don't get asked if you want to bounce a message. Setting this variable to
609 # no is not generally useful, and thus not recommended, because you are unable to
614 # 3.40. bounce_delivered
619 # When this variable is set, NeoMutt will include Delivered-To headers when
620 # bouncing messages. Postfix users may wish to unset this variable.
622 # Note: On Debian systems, this option is unset by default in /etc/neomuttrc.
624 set bounce_delivered=no
627 # 3.41. braille_friendly
632 # When this variable is set, NeoMutt will place the cursor at the beginning of
633 # the current line in menus, even when the $arrow_cursor variable is unset,
634 # making it easier for blind persons using Braille displays to follow these
635 # menus. The option is unset by default because many visual terminals don't
636 # permit making the cursor invisible.
640 # 3.42. browser_abbreviate_mailboxes
645 # When this variable is set, NeoMutt will abbreviate mailbox names in the browser
646 # mailbox list, using '~' and '=' shortcuts.
648 # The default "alpha" setting of $browser_sort uses locale-based sorting (using
649 # strcoll(3)), which ignores some punctuation. This can lead to some situations
650 # where the order doesn't make intuitive sense. In those cases, it may be
651 # desirable to unset this variable.
660 # Specifies how to sort entries in the file browser. By default, the entries are
661 # sorted alphabetically. Valid values:
663 # • alpha (alphabetically by name)
665 # • count (total message count)
669 # • desc (description)
671 # • new (new message count)
677 # You may optionally use the "reverse-" prefix to specify reverse sorting order
678 # (example: "set browser_sort=reverse-date").
680 # The "unread" value is a synonym for "new".
684 # 3.44. browser_sort_dirs_first
689 # If this variable is set, the browser will group directories before files.
693 # 3.45. catchup_newsgroup
698 # If this variable is set, NeoMutt will mark all articles in newsgroup as read
699 # when you quit the newsgroup (catchup newsgroup).
703 # 3.46. certificate_file
706 # Default: “~/.mutt_certificates”
708 # This variable specifies the file where the certificates you trust are saved.
709 # When an unknown certificate is encountered, you are asked if you accept it or
710 # not. If you accept it, the certificate can also be saved in this file and
711 # further connections are automatically accepted.
713 # You can also manually add CA certificates in this file. Any server certificate
714 # that is signed with one of these CA certificates is also automatically
719 # set certificate_file=~/.neomutt/certificates
721 # (OpenSSL and GnuTLS only)
725 # 3.47. change_folder_next
730 # When this variable is set, the <change-folder> function mailbox suggestion will
731 # start at the next folder in your "mailboxes" list, instead of starting at the
732 # first folder in the list.
741 # Character set your terminal uses to display and enter textual data. It is also
742 # the fallback for $send_charset.
744 # Upon startup NeoMutt tries to derive this value from environment variables such
745 # as $LC_CTYPE or $LANG.
747 # Note: It should only be set in case NeoMutt isn't able to determine the
748 # character set used correctly.
752 # 3.49. check_mbox_size
757 # When this variable is set, NeoMutt will use file size attribute instead of
758 # access time when checking for new mail in mbox and mmdf folders.
760 # This variable is unset by default and should only be enabled when new mail
761 # detection for these folder types is unreliable or doesn't work.
763 # Note that enabling this variable should happen before any "mailboxes"
764 # directives occur in configuration files regarding mbox or mmdf folders because
765 # NeoMutt needs to determine the initial new mail status of such a mailbox by
766 # performing a fast mailbox scan when it is defined. Afterwards the new mail
767 # status is tracked by file size changes.
776 # Note: this option only affects maildir and MH style mailboxes.
778 # When set, NeoMutt will check for new mail delivered while the mailbox is open.
779 # Especially with MH mailboxes, this operation can take quite some time since it
780 # involves scanning the directory and checking each file to see if it has already
781 # been looked at. If this variable is unset, no check for new mail is performed
782 # while the mailbox is open.
791 # When set, NeoMutt will collapse all threads when entering a folder.
795 # 3.52. collapse_flagged
800 # When unset, NeoMutt will not collapse a thread if it contains any flagged
805 # 3.53. collapse_unread
810 # When unset, NeoMutt will not collapse a thread if it contains any unread
815 # 3.54. color_directcolor
820 # When set, NeoMutt will use and allow 24bit colours (aka truecolor aka
821 # directcolor). For colours to work properly support from the terminal is
822 # required as well as a properly set TERM environment variable advertising the
823 # terminals directcolor capability, e.g. "TERM=xterm-direct".
825 # NeoMutt tries to detect whether the terminal supports 24bit colours and enables
826 # this variable if it does. If this fails for some reason, you can force 24bit
827 # colours by setting this variable manually. You may also try to force a certain
828 # TERM environment variable by starting NeoMutt from a terminal as follows (this
829 # results in wrong colours if the terminal does not implement directcolors):
831 # TERM=xterm-direct neomutt
833 # Note: This variable must be set before using any `color` commands.
837 # 3.55. compose_confirm_detach_first
842 # When set, NeoMutt will prompt for confirmation when trying to use <detach-file>
843 # on the first entry in the compose menu. This is to help prevent irreversible
844 # loss of the typed message by accidentally hitting 'D' in the menu.
846 # Note: NeoMutt only prompts for the first entry. It doesn't keep track of which
847 # message is the typed message if the entries are reordered, or if the first
848 # entry was already deleted.
852 # 3.56. compose_format
855 # Default: “-- NeoMutt: Compose [Approx. msg size: %l Atts: %a]%>-”
857 # Controls the format of the status line displayed in the "compose" menu. This
858 # string is similar to $status_format, but has its own set of printf(3)-like
861 # ┌───┬─────────────────────────────────────────────────────────────────────────┐
862 # │%a │Total number of attachments │
863 # ├───┼─────────────────────────────────────────────────────────────────────────┤
864 # │%h │Local hostname │
865 # ├───┼─────────────────────────────────────────────────────────────────────────┤
866 # │%l │Approximate size (in bytes) of the current message (see │
867 # │ │formatstrings-size) │
868 # ├───┼─────────────────────────────────────────────────────────────────────────┤
869 # │%v │NeoMutt version string │
870 # ├───┼─────────────────────────────────────────────────────────────────────────┤
871 # │%>X│right justify the rest of the string and pad with character "X" │
872 # ├───┼─────────────────────────────────────────────────────────────────────────┤
873 # │%|X│pad to the end of the line with character "X" │
874 # ├───┼─────────────────────────────────────────────────────────────────────────┤
875 # │%*X│soft-fill with character "X" as pad │
876 # └───┴─────────────────────────────────────────────────────────────────────────┘
878 # See the text describing the $status_format option for more information on how
879 # to set $compose_format.
883 # 3.57. compose_preview_min_rows
888 # This variable specifies the minimum number of rows that have to be available
889 # for the message preview window to shown.
893 # 3.58. compose_preview_above_attachments
898 # Show the message preview above the attachments list. By default it is shown
903 # 3.59. compose_show_preview
908 # When set, Neomutt will display a preview of message in the compose view.
912 # 3.60. compose_show_user_headers
917 # When set, Neomutt will display user-defined headers (set via my_hdr or from
918 # editing with edit-headers).
920 set compose_show_user_headers=no
923 # 3.61. config_charset
928 # When defined, NeoMutt will recode commands in rc files from this encoding to
929 # the current character set as specified by $charset and aliases written to
930 # $alias_file from the current character set.
932 # Please note that if setting $charset it must be done before setting
935 # Recoding should be avoided as it may render unconvertible characters as
936 # question marks which can lead to undesired side effects (for example in regular
941 # 3.62. confirm_append
946 # When set, NeoMutt will prompt for confirmation when appending messages to an
949 set confirm_append=no
952 # 3.63. confirm_create
957 # When set, NeoMutt will prompt for confirmation when saving messages to a
958 # mailbox which does not yet exist before creating it.
965 # Default: “text/plain”
967 # Sets the default Content-Type for the body of newly composed messages.
969 set content_type="text/plain; markup=markdown"
977 # This variable controls whether or not copies of your outgoing messages will be
978 # saved for later references. Also see $record, $save_name, $force_name and "
984 # 3.66. copy_decode_weed
989 # Controls whether NeoMutt will weed headers when invoking the <decode-copy> or
990 # <decode-save> functions.
994 # 3.67. count_alternatives
999 # When set, NeoMutt will recurse inside multipart/alternatives while performing
1000 # attachment searching and counting(see attachments).
1002 # Traditionally, multipart/alternative parts have simply represented different
1003 # encodings of the main content of the email. Unfortunately, some mail clients
1004 # have started to place email attachments inside one of alternatives. Setting
1005 # this will allow NeoMutt to find and count matching attachments hidden there,
1006 # and include them in the index via %X or through ~X pattern matching.
1010 # 3.68. crypt_auto_encrypt
1015 # Setting this variable will cause NeoMutt to always attempt to PGP encrypt
1016 # outgoing messages. This is probably only useful in connection to the "send-hook
1017 # " command. It can be overridden by use of the pgp menu, when encryption is not
1018 # required or signing is requested as well. If $smime_is_default is set, then
1019 # OpenSSL is used instead to create S/MIME messages and settings can be
1020 # overridden by use of the smime menu instead. (Crypto only)
1024 # 3.69. crypt_auto_pgp
1029 # This variable controls whether or not NeoMutt may automatically enable PGP
1030 # encryption/signing for messages. See also $crypt_auto_encrypt,
1031 # $crypt_reply_encrypt, $crypt_auto_sign, $crypt_reply_sign and $smime_is_default
1036 # 3.70. crypt_auto_sign
1041 # Setting this variable will cause NeoMutt to always attempt to cryptographically
1042 # sign outgoing messages. This can be overridden by use of the pgp menu, when
1043 # signing is not required or encryption is requested as well. If
1044 # $smime_is_default is set, then OpenSSL is used instead to create S/MIME
1045 # messages and settings can be overridden by use of the smime menu instead of the
1046 # pgp menu. (Crypto only)
1050 # 3.71. crypt_auto_smime
1055 # This variable controls whether or not NeoMutt may automatically enable S/MIME
1056 # encryption/signing for messages. See also $crypt_auto_encrypt,
1057 # $crypt_reply_encrypt, $crypt_auto_sign, $crypt_reply_sign and $smime_is_default
1064 # Type: character string
1067 # Controls the characters used in cryptography flags.
1069 # ┌─────────┬───────┬───────────────────────────────────────────────────────────┐
1070 # │Character│Default│Description │
1071 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤
1072 # │1 │S │The mail is signed, and the signature is successfully │
1074 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤
1075 # │2 │P │The mail is PGP encrypted. │
1076 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤
1077 # │3 │s │The mail is signed. │
1078 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤
1079 # │4 │K │The mail contains a PGP public key. │
1080 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤
1081 # │5 │<space>│The mail has no crypto info. │
1082 # └─────────┴───────┴───────────────────────────────────────────────────────────┘
1086 # 3.73. crypt_confirm_hook
1091 # If set, then you will be prompted for confirmation of keys when using the
1092 # crypt-hook command. If unset, no such confirmation prompt will be presented.
1093 # This is generally considered unsafe, especially where typos are concerned.
1097 # 3.74. crypt_opportunistic_encrypt
1102 # Setting this variable will cause NeoMutt to automatically enable and disable
1103 # encryption, based on whether all message recipient keys can be located by
1106 # When this option is enabled, NeoMutt will enable/disable encryption each time
1107 # the TO, CC, and BCC lists are edited. If $edit_headers is set, NeoMutt will
1108 # also do so each time the message is edited.
1110 # While this is set, encryption can't be manually enabled/disabled. The pgp or
1111 # smime menus provide a selection to temporarily disable this option for the
1114 # If $crypt_auto_encrypt or $crypt_reply_encrypt enable encryption for a message,
1115 # this option will be disabled for that message. It can be manually re-enabled in
1116 # the pgp or smime menus. (Crypto only)
1118 set crypt_opportunistic_encrypt=no
1121 # 3.75. crypt_opportunistic_encrypt_strong_keys
1126 # When set, this modifies the behavior of $crypt_opportunistic_encrypt to only
1127 # search for "strong keys", that is, keys with full validity according to the
1128 # web-of-trust algorithm. A key with marginal or no validity will not enable
1129 # opportunistic encryption.
1131 # For S/MIME, the behavior depends on the backend. Classic S/MIME will filter for
1132 # certificates with the 't'(trusted) flag in the .index file. The GPGME backend
1133 # will use the same filters as with OpenPGP, and depends on GPGME's logic for
1134 # assigning the GPGME_VALIDITY_FULL and GPGME_VALIDITY_ULTIMATE validity flag.
1138 # 3.76. crypt_protected_headers_read
1143 # When set, NeoMutt will display protected headers ("Memory Hole") in the pager,
1144 # When set, NeoMutt will display protected headers in the pager, and will update
1145 # the index and header cache with revised headers.
1147 # Protected headers are stored inside the encrypted or signed part of an an
1148 # email, to prevent disclosure or tampering. For more information see https://
1149 # github.com/autocrypt/protected-headers Currently NeoMutt only supports the
1152 # Encrypted messages using protected headers often substitute the exposed Subject
1153 # header with a dummy value (see $crypt_protected_headers_subject). NeoMutt will
1154 # update its concept of the correct subject after the message is opened, i.e. via
1155 # the <display-message> function. If you reply to a message before opening it,
1156 # NeoMutt will end up using the dummy Subject header, so be sure to open such a
1157 # message first. (Crypto only)
1161 # 3.77. crypt_protected_headers_save
1166 # When $crypt_protected_headers_read is set, and a message with a protected
1167 # Subject is opened, NeoMutt will save the updated Subject into the header cache
1168 # by default. This allows searching/limiting based on the protected Subject
1169 # header if the mailbox is re-opened, without having to re-open the message each
1170 # time. However, for mbox/mh mailbox types, or if header caching is not set up,
1171 # you would need to re-open the message each time the mailbox was reopened before
1172 # you could see or search/limit on the protected subject again.
1174 # When this variable is set, NeoMutt additionally saves the protected Subject
1175 # back in the clear-text message headers. This provides better usability, but
1176 # with the tradeoff of reduced security. The protected Subject header, which may
1177 # have previously been encrypted, is now stored in clear-text in the message
1178 # headers. Copying the message elsewhere, via NeoMutt or external tools, could
1179 # expose this previously encrypted data. Please make sure you understand the
1180 # consequences of this before you enable this variable. (Crypto only)
1184 # 3.78. crypt_protected_headers_subject
1189 # When $crypt_protected_headers_write is set, and the message is marked for
1190 # encryption, this will be substituted into the Subject field in the message
1193 # To prevent a subject from being substituted, unset this variable, or set it to
1194 # the empty string. (Crypto only)
1198 # 3.79. crypt_protected_headers_weed
1203 # Controls whether NeoMutt will weed protected header fields. (Crypto only)
1207 # 3.80. crypt_protected_headers_write
1212 # When set, NeoMutt will generate protected headers for signed and encrypted
1215 # Protected headers are stored inside the encrypted or signed part of an an
1216 # email, to prevent disclosure or tampering. For more information see https://
1217 # github.com/autocrypt/protected-headers
1219 # Currently NeoMutt only supports the Subject header. (Crypto only)
1223 # 3.81. crypt_reply_encrypt
1228 # If set, automatically PGP or OpenSSL encrypt replies to messages which are
1229 # encrypted. (Crypto only)
1233 # 3.82. crypt_reply_sign
1238 # If set, automatically PGP or OpenSSL sign replies to messages which are signed.
1240 # Note: this does not work on messages that are encrypted and signed! (Crypto
1245 # 3.83. crypt_reply_sign_encrypted
1250 # If set, automatically PGP or OpenSSL sign replies to messages which are
1251 # encrypted. This makes sense in combination with $crypt_reply_encrypt, because
1252 # it allows you to sign all messages which are automatically encrypted. This
1253 # works around the problem noted in $crypt_reply_sign, that NeoMutt is not able
1254 # to find out whether an encrypted message is also signed. (Crypto only)
1258 # 3.84. crypt_encryption_info
1263 # If set, NeoMutt will include an informative block before an encrypted part,
1264 # with details about the encryption. (Crypto only)
1268 # 3.85. crypt_timestamp
1273 # If set, NeoMutt will include a time stamp in the lines surrounding PGP or S/
1274 # MIME output, so spoofing such lines is more difficult. If you are using colors
1275 # to mark these lines, and rely on these, you may unset this setting. (Crypto
1280 # 3.86. crypt_use_gpgme
1285 # This variable controls the use of the GPGME-enabled crypto backends. If it is
1286 # set and NeoMutt was built with GPGME support, the gpgme code for S/MIME and PGP
1287 # will be used instead of the classic code. Note that you need to set this option
1288 # in .neomuttrc; it won't have any effect when used interactively.
1290 # Note that the GPGME backend does not support creating old-style inline
1291 # (traditional) PGP encrypted or signed messages (see $pgp_auto_inline).
1295 # 3.87. crypt_use_pka
1300 # Controls whether NeoMutt uses PKA (see http://www.g10code.de/docs/
1301 # pka-intro.de.pdf) during signature verification (only supported by the GPGME
1304 set crypt_use_pka=yes
1307 # 3.88. crypt_verify_sig
1312 # If "yes", always attempt to verify PGP or S/MIME signatures. If "ask-*", ask
1313 # whether or not to verify the signature. If "no", never attempt to verify
1314 # cryptographic signatures. (Crypto only)
1321 # Default: “!%a, %b %d, %Y at %I:%M:%S%p %Z”
1323 # Instead of using $date_format it is encouraged to use "%[fmt]" directly in the
1324 # corresponding format strings, where "fmt" is the value of $date_format. This
1325 # allows for a more fine grained control of the different menu needs.
1327 # This variable controls the format of the date printed by the "%d" sequence in
1328 # $index_format. This is passed to the strftime(3) function to process the date,
1329 # see the man page for the proper syntax.
1331 # Unless the first character in the string is a bang ("!"), the month and week
1332 # day names are expanded according to the locale. If the first character in the
1333 # string is a bang, the bang is discarded, and the month and week day names in
1334 # the rest of the string are expanded in the C locale (that is in US English).
1336 # Format strings using this variable are:
1338 # UI: $folder_format, $index_format, $mailbox_folder_format, $message_format
1340 # Composing: $attribution_intro, $forward_attribution_intro,
1341 # $forward_attribution_trailer, $forward_format, $indent_string.
1343 set date_format="%F"
1349 # Default: “~/.neomuttdebug”
1351 # Debug logging is controlled by the variables $debug_file and $debug_level.
1352 # $debug_file specifies the root of the filename. NeoMutt will add "0" to the
1353 # end. Each time NeoMutt is run with logging enabled, the log files are rotated.
1354 # A maximum of five log files are kept, numbered 0 (most recent) to 4 (oldest).
1356 # This option can be enabled on the command line, "neomutt -l mylog"
1358 # See also: $debug_level
1367 # Debug logging is controlled by the variables $debug_file and $debug_level.
1369 # The debug level controls how much information is saved to the log file. If you
1370 # have a problem with NeoMutt, then enabling logging may help find the cause.
1371 # Levels 1-3 will usually provide enough information for writing a bug report.
1372 # Levels 4,5 will be extremely verbose.
1374 # Warning: Logging at high levels may save private information to the file.
1376 # This option can be enabled on the command line, "neomutt -d 2"
1378 # See also: $debug_file
1382 # 3.92. default_hook
1385 # Default: “~f %s !~P | (~P ~C %s)”
1387 # This variable controls how some hooks are interpreted if their pattern is a
1388 # plain string or a regex. i.e. they don't contain a pattern, like ~f
1390 # The hooks are: fcc-hook, fcc-save-hook, index-format-hook, message-hook,
1391 # reply-hook, save-hook, send-hook and send2-hook.
1393 # The hooks are expanded when they are declared, so a hook will be interpreted
1394 # according to the value of this variable at the time the hook is declared.
1396 # The default value matches if the message is either from a user matching the
1397 # regular expression given, or if it is from you (if the from address matches "
1398 # alternates") and is to or cc'ed to a user matching the given regular
1408 # Controls whether or not messages are really deleted when closing or
1409 # synchronizing a mailbox. If set to yes, messages marked for deleting will
1410 # automatically be purged without prompting. If set to no, messages marked for
1411 # deletion will be kept in the mailbox.
1416 # 3.94. delete_untag
1421 # If this option is set, NeoMutt will untag messages when marking them for
1422 # deletion. This applies when you either explicitly delete a message, or when you
1423 # save it to another folder.
1427 # 3.95. devel_security
1432 # If this option is set, NeoMutt will enable the Security development features.
1433 # See: https://github.com/neomutt/neomutt/discussions/4251
1437 # 3.96. digest_collapse
1442 # If this option is set, NeoMutt's received-attachments menu will not show the
1443 # subparts of individual messages in a multipart/digest. To see these subparts,
1444 # press "v" on that menu.
1448 # 3.97. display_filter
1453 # When set, specifies a command used to filter messages. When a message is viewed
1454 # it is passed as standard input to $display_filter, and the filtered message is
1455 # read from the standard output.
1457 # When preparing the message, NeoMutt inserts some escape sequences into the
1458 # text. They are of the form: <esc>]9;XXX<bel> where "XXX" is a random 64-bit
1461 # If these escape sequences interfere with your filter, they can be removed using
1462 # a tool like ansifilter or sed 's/^x1b]9;[0-9]+x7//'
1464 # If they are removed, then PGP and MIME headers will no longer be coloured. This
1465 # can be fixed by adding this to your config: color body magenta default '^[--
1475 # This variable sets the request for when notification is returned. The string
1476 # consists of a comma separated list (no spaces!) of one or more of the
1477 # following: never, to never request notification, failure, to request
1478 # notification on transmission failure, delay, to be notified of message delays,
1479 # success, to be notified of successful transmission.
1483 # set dsn_notify="failure,delay"
1485 # Note: when using $sendmail for delivery, you should not enable this unless you
1486 # are either using Sendmail 8.8.x or greater or a MTA providing a sendmail(1)
1487 # -compatible interface supporting the -N option for DSN. For SMTP delivery, DSN
1488 # support is auto-detected so that it depends on the server whether DSN will be
1498 # This variable controls how much of your message is returned in DSN messages. It
1499 # may be set to either hdrs to return just the message header, or full to return
1504 # set dsn_return=hdrs
1506 # Note: when using $sendmail for delivery, you should not enable this unless you
1507 # are either using Sendmail 8.8.x or greater or a MTA providing a sendmail(1)
1508 # -compatible interface supporting the -R option for DSN. For SMTP delivery, DSN
1509 # support is auto-detected so that it depends on the server whether DSN will be
1514 # 3.100. duplicate_threads
1519 # This variable controls whether NeoMutt, when $sort is set to threads, threads
1520 # messages with the same Message-Id together. If it is set, it will indicate that
1521 # it thinks they are duplicates of each other with an equals sign in the thread
1526 # 3.101. edit_headers
1531 # This option allows you to edit the header of your outgoing messages along with
1532 # the body of your message.
1534 # Although the compose menu may have localized header labels, the labels passed
1535 # to your editor will be standard RFC2822 headers, (e.g. To:, Cc:, Subject:).
1536 # Headers added in your editor must also be RFC2822 headers, or one of the pseudo
1537 # headers listed in "edit-header". NeoMutt will not understand localized header
1538 # labels, just as it would not when parsing an actual email.
1540 # Note that changes made to the References: and Date: headers are ignored for
1541 # interoperability reasons.
1543 set edit_headers=yes
1551 # This variable specifies which editor is used by NeoMutt. It defaults to the
1552 # value of the $VISUAL, or $EDITOR, environment variable, or to the string "/usr/
1553 # bin/editor" if neither of those are set.
1555 # The $editor string may contain a %s escape, which will be replaced by the name
1556 # of the file to be edited. If the %s escape does not appear in $editor, a space
1557 # and the name to be edited are appended.
1559 # The resulting string is then executed by running
1563 # where string is the expansion of $editor described above.
1565 set editor="mailplate --edit --auto --keep-unknown"
1568 # 3.103. empty_subject
1571 # Default: “Re: your mail”
1573 # This variable specifies the subject to be used when replying to an email with
1574 # an empty subject. It defaults to "Re: your mail".
1578 # 3.104. encode_from
1583 # When set, NeoMutt will quoted-printable encode messages when they contain the
1584 # string "From " (note the trailing space) in the beginning of a line. This is
1585 # useful to avoid the tampering certain mail delivery and transport agents tend
1586 # to do with messages (in order to prevent tools from misinterpreting the line as
1587 # a mbox message separator).
1591 # 3.105. entropy_file
1596 # The file which includes random data that is used to initialize SSL library
1597 # functions. (OpenSSL only)
1601 # 3.106. envelope_from_address
1603 # Type: e-mail address
1606 # Manually sets the envelope sender for outgoing messages. This value is ignored
1607 # if $use_envelope_from is unset.
1611 # 3.107. external_search_command
1616 # If set, contains the name of the external program used by "~I" patterns. This
1617 # will usually be a wrapper script around mairix, mu, or similar indexers other
1618 # than notmuch (for which there is optional special support).
1620 # Here is an example how it works. Let's assume $external_search_command is set
1621 # to "mairix_filter", and mairix_filter is a script which runs the old but well
1622 # loved mairix indexer with the arguments given to mairix_filter, in the "raw"
1623 # mode of mairix, producing on the standard output a list of Message-IDs, one per
1626 # If possible, it also filters down the results coming from mairix such that only
1627 # messages in the current folder remain. It can do this because it gets a hidden
1628 # first argument which is the path to the folder. (This can be the type of clean
1629 # and simple script called a one-liner.)
1631 # Now if NeoMutt gets a limit or tag command followed by the pattern "~I '-t
1632 # s:bleeping='", mairix_filter runs mairix with the arguments from inside the
1633 # quotes (the quotes are needed because of the space after "-t"), mairix finds
1634 # all messages with "bleeping" in the Subject plus all messages sharing threads
1635 # with these and outputs their file names, and mairix_filter translates the file
1636 # names into Message-IDs. Finally, NeoMutt reads the Message-IDs and targets the
1637 # matching messages with the command given to it.
1639 # You, the user, still have to rewrite the mairix_filter script to match the
1640 # behavior of your indexer, but this should help users of indexers other than
1641 # notmuch to integrate them cleanly with NeoMutt.
1650 # When set, the initial prompt for recipients (to, cc, bcc) and subject are
1651 # skipped when the relevant information is already provided. These cases include
1652 # replying to messages and passing the relevant command line arguments. The
1653 # initial prompt for recipients is also skipped when composing a new message to
1654 # the current message sender, while the initial prompt for subject is also
1655 # skipped when forwarding messages.
1657 # Note: this variable has no effect when the $auto_edit variable is set.
1659 # See also: $auto_edit, $edit_headers, $ask_cc, $ask_bcc
1668 # This variable controls whether or not attachments on outgoing messages are
1669 # saved along with the main body of your message.
1671 # Note: $fcc_before_send forces the default (set) behavior of this option.
1675 # 3.110. fcc_before_send
1680 # When this variable is set, FCCs will occur before sending the message. Before
1681 # sending, the message cannot be manipulated, so it will be stored the exact same
1682 # as sent: $fcc_attach and $fcc_clear will be ignored (using their default
1685 # When unset, the default, FCCs will occur after sending. Variables $fcc_attach
1686 # and $fcc_clear will be respected, allowing it to be stored without attachments
1687 # or encryption/signing if desired.
1696 # When this variable is set, FCCs will be stored unencrypted and unsigned, even
1697 # when the actual message is encrypted and/or signed.
1699 # Note: $fcc_before_send forces the default (unset) behavior of this option. (PGP
1702 # See also $pgp_self_encrypt, $smime_self_encrypt
1708 # Type: character string
1709 # Default: “*!DdrONon- ”
1711 # Controls the characters used in several flags.
1713 # ┌─────────┬───────┬─────────────────────────────────────────────┐
1714 # │Character│Default│Description │
1715 # ├─────────┼───────┼─────────────────────────────────────────────┤
1716 # │1 │* │The mail is tagged. │
1717 # ├─────────┼───────┼─────────────────────────────────────────────┤
1718 # │2 │! │The mail is flagged as important. │
1719 # ├─────────┼───────┼─────────────────────────────────────────────┤
1720 # │3 │D │The mail is marked for deletion. │
1721 # ├─────────┼───────┼─────────────────────────────────────────────┤
1722 # │4 │d │The mail has attachments marked for deletion.│
1723 # ├─────────┼───────┼─────────────────────────────────────────────┤
1724 # │5 │r │The mail has been replied to. │
1725 # ├─────────┼───────┼─────────────────────────────────────────────┤
1726 # │6 │O │The mail is Old (Unread but seen). │
1727 # ├─────────┼───────┼─────────────────────────────────────────────┤
1728 # │7 │N │The mail is New (Unread but not seen). │
1729 # ├─────────┼───────┼─────────────────────────────────────────────┤
1730 # │8 │o │The mail thread is Old (Unread but seen). │
1731 # ├─────────┼───────┼─────────────────────────────────────────────┤
1732 # │9 │n │The mail thread is New (Unread but not seen).│
1733 # ├─────────┼───────┼─────────────────────────────────────────────┤
1734 # │10 │- │The mail is read - %S expando. │
1735 # ├─────────┼───────┼─────────────────────────────────────────────┤
1736 # │11 │<space>│The mail is read - %Z expando. │
1737 # └─────────┴───────┴─────────────────────────────────────────────┘
1746 # If set, flagged messages can't be deleted.
1755 # Specifies the default location of your mailboxes. A "+" or "=" at the beginning
1756 # of a pathname will be expanded to the value of this variable. Note that if you
1757 # change this variable (from the default) value you need to make sure that the
1758 # assignment occurs before you use "+" or "=" for any other variables since
1759 # expansion takes place when handling the "mailboxes" command.
1764 # 3.115. folder_format
1767 # Default: “%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %i”
1769 # This variable allows you to customize the file browser display to your personal
1770 # taste. This string is similar to $index_format, but has its own set of printf
1771 # (3)-like sequences:
1773 # ┌─────┬─┬─────────────────────────────────────────────────────────────────────┐
1774 # │%a │ │Alert: 1 if user is notified of new mail │
1775 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1776 # │%C │ │Current file number │
1777 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1778 # │%d │ │Date/time folder was last modified │
1779 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1780 # │ │ │Date/time folder was last modified using $date_format. It is │
1781 # │%D │ │encouraged to use "%[fmt]" instead, where "fmt" is the value of │
1782 # │ │ │$date_format. │
1783 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1784 # │%f │ │Filename ("/" is appended to directory names, "@" to symbolic links │
1785 # │ │ │and "*" to executable files) │
1786 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1787 # │%F │ │File permissions │
1788 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1789 # │%g │ │Group name (or numeric gid, if missing) │
1790 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1791 # │%i │ │Description of the folder │
1792 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1793 # │%l │ │Number of hard links │
1794 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1795 # │%m │*│Number of messages in the mailbox │
1796 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1797 # │%n │*│Number of unread messages in the mailbox │
1798 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1799 # │%N │ │"N" if mailbox has new mail, " " (space) otherwise │
1800 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1801 # │%p │ │Poll: 1 if Mailbox is checked for new mail │
1802 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1803 # │%s │ │Size in bytes (see formatstrings-size) │
1804 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1805 # │%t │ │"*" if the file is tagged, blank otherwise │
1806 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1807 # │%u │ │Owner name (or numeric uid, if missing) │
1808 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1809 # │% │ │Date/time folder was last modified using an strftime(3) expression │
1811 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1812 # │%>X │ │Right justify the rest of the string and pad with character "X" │
1813 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1814 # │%|X │ │Pad to the end of the line with character "X" │
1815 # ├─────┼─┼─────────────────────────────────────────────────────────────────────┤
1816 # │%*X │ │Soft-fill with character "X" as pad │
1817 # └─────┴─┴─────────────────────────────────────────────────────────────────────┘
1819 # For an explanation of "soft-fill", see the $index_format documentation.
1821 # * = can be optionally printed if nonzero
1823 # %m, %n, and %N only work for monitored mailboxes. %m requires $mail_check_stats
1824 # to be set. %n requires $mail_check_stats to be set (except for IMAP mailboxes).
1826 set folder_format='%t%N%2C %D %4s %f'
1829 # 3.116. followup_to
1834 # Controls whether or not the "Mail-Followup-To:" header field is generated when
1835 # sending mail. When set, NeoMutt will generate this field when you are replying
1836 # to a known mailing list, specified with the "subscribe" or "lists" commands.
1838 # This field has two purposes. First, preventing you from receiving duplicate
1839 # copies of replies to messages which you send to mailing lists, and second,
1840 # ensuring that you do get a reply separately for any messages sent to known
1841 # lists to which you are not subscribed.
1843 # The header will contain only the list's address for subscribed lists, and both
1844 # the list address and your own email address for unsubscribed lists. Without
1845 # this header, a group reply to your message sent to a subscribed list will be
1846 # sent to both the list and your address, resulting in two copies of the same
1851 # 3.117. followup_to_poster
1856 # If this variable is set and the keyword "poster" is present in Followup-To
1857 # header, follow-up to newsgroup function is not permitted. The message will be
1858 # mailed to the submitter of the message via mail.
1867 # This variable is similar to $save_name, except that NeoMutt will store a copy
1868 # of your outgoing message by the username of the address you are sending to even
1869 # if that mailbox does not exist.
1871 # Also see the $record variable.
1875 # 3.119. forward_attachments
1880 # When forwarding inline (i.e. $mime_forward unset or answered with "no" and
1881 # $forward_decode set), attachments which cannot be decoded in a reasonable
1882 # manner will be attached to the newly composed message if this quadoption is set
1883 # or answered with "yes".
1887 # 3.120. forward_attribution_intro
1890 # Default: “----- Forwarded message from %f -----”
1892 # This is the string that will precede a message which has been forwarded in the
1893 # main body of a message (when $mime_forward is unset). For a full listing of
1894 # defined printf(3)-like sequences see the section on $index_format. See also
1895 # $attribution_locale.
1899 # 3.121. forward_attribution_trailer
1902 # Default: “----- End forwarded message -----”
1904 # This is the string that will follow a message which has been forwarded in the
1905 # main body of a message (when $mime_forward is unset). For a full listing of
1906 # defined printf(3)-like sequences see the section on $index_format. See also
1907 # $attribution_locale.
1911 # 3.122. forward_decode
1916 # Controls the decoding of complex MIME messages into text/plain when forwarding
1917 # a message. The message header is also RFC2047 decoded. This variable is only
1918 # used, if $mime_forward is unset, otherwise $mime_forward_decode is used
1923 # 3.123. forward_decrypt
1928 # Controls the handling of encrypted messages when forwarding a message. When set
1929 # , the outer layer of encryption is stripped off. This variable is only used if
1930 # $mime_forward is set and $mime_forward_decode is unset.
1934 # 3.124. forward_edit
1939 # This quadoption controls whether or not the user is automatically placed in the
1940 # editor when forwarding messages. For those who always want to forward with no
1941 # modification, use a setting of "no".
1945 # 3.125. forward_format
1948 # Default: “[%a: %s]”
1950 # This variable controls the default subject when forwarding a message. It uses
1951 # the same format sequences as the $index_format variable.
1953 set forward_format="(fwd) %s"
1956 # 3.126. forward_quote
1961 # When set, forwarded messages included in the main body of the message (when
1962 # $mime_forward is unset) will be quoted using $indent_string.
1966 # 3.127. forward_references
1971 # When set, forwarded messages set the "In-Reply-To:" and "References:" headers
1972 # in the same way as normal replies would. Hence the forwarded message becomes
1973 # part of the original thread instead of starting a new one.
1979 # Type: e-mail address
1982 # When set, this variable contains a default "from" address. It can be overridden
1983 # using "my_hdr" (including from a "send-hook") and $reverse_name. This variable
1984 # is ignored if $use_from is unset.
1986 # If not specified, then it may be read from the environment variable $EMAIL.
1988 set from='martin f krafft <madduck@madduck.net>'
1993 # Type: character string
1996 # Controls the character used to prefix the %F and %L fields in the index.
1998 # ┌─────────┬───────────────────────────────────────────────────────────────────┐
1999 # │Character│Description │
2000 # ├─────────┼───────────────────────────────────────────────────────────────────┤
2001 # │1 │Mail is written by you and has a To address, or has a known mailing│
2002 # │ │list in the To address. │
2003 # ├─────────┼───────────────────────────────────────────────────────────────────┤
2004 # │2 │Mail is written by you and has a Cc address, or has a known mailing│
2005 # │ │list in the Cc address. │
2006 # ├─────────┼───────────────────────────────────────────────────────────────────┤
2007 # │3 │Mail is written by you and has a Bcc address. │
2008 # ├─────────┼───────────────────────────────────────────────────────────────────┤
2009 # │4 │All remaining cases. │
2010 # └─────────┴───────────────────────────────────────────────────────────────────┘
2012 # If this is empty or unset (default), the traditional long "To ", "Cc " and "Bcc
2013 # " prefixes are used. If set but too short to include a character for a
2014 # particular case, a single space will be prepended to the field. To prevent any
2015 # prefix at all from being added in a particular case, use the special value CR
2016 # (aka ^M) for the corresponding character.
2018 # This slightly odd interface is necessitated by NeoMutt's handling of string
2019 # variables; one can't tell a variable that is unset from one that is set to the
2026 # Type: regular expression
2029 # A regular expression used by NeoMutt to parse the GECOS field of a password
2030 # entry when expanding the alias. The default value will return the string up to
2031 # the first "," encountered. If the GECOS field contains a string like "lastname,
2032 # firstname" then you should set it to ".*".
2034 # This can be useful if you see the following behavior: you address an e-mail to
2035 # user ID "stevef" whose full name is "Steve Franklin". If NeoMutt expands
2036 # "stevef" to '"Franklin" stevef@foo.bar' then you should set the $gecos_mask to
2037 # a regular expression that will match the whole name so NeoMutt will expand
2038 # "Franklin" to "Franklin, Steve".
2047 # When set, this is the string that will precede every message as a greeting
2048 # phrase to the recipients.
2050 # "Format strings" are similar to the strings used in the "C" function printf to
2051 # format output (see the man page for more detail). The following sequences are
2052 # defined in NeoMutt:
2054 # ┌──┬──────────────────────────────┐
2055 # │%n│Recipient's real name │
2056 # ├──┼──────────────────────────────┤
2057 # │%u│User (login) name of recipient│
2058 # ├──┼──────────────────────────────┤
2059 # │%v│First name of recipient │
2060 # └──┴──────────────────────────────┘
2064 # 3.132. group_index_format
2067 # Default: “%4C %M%N %5s %-45.45f %d”
2069 # This variable allows you to customize the newsgroup browser display to your
2070 # personal taste. This string is similar to "index_format", but has its own set
2071 # of printf()-like sequences:
2073 # ┌───┬──────────────────────────────────────────────────────────────────┐
2074 # │%a │Alert: 1 if user is notified of new mail │
2075 # ├───┼──────────────────────────────────────────────────────────────────┤
2076 # │%C │Current newsgroup number │
2077 # ├───┼──────────────────────────────────────────────────────────────────┤
2078 # │%d │Description of newsgroup (becomes from server) │
2079 # ├───┼──────────────────────────────────────────────────────────────────┤
2080 # │%f │Newsgroup name │
2081 # ├───┼──────────────────────────────────────────────────────────────────┤
2082 # │%M │- if newsgroup not allowed for direct post (moderated for example)│
2083 # ├───┼──────────────────────────────────────────────────────────────────┤
2084 # │%N │N if newsgroup is new, u if unsubscribed, blank otherwise │
2085 # ├───┼──────────────────────────────────────────────────────────────────┤
2086 # │%n │Number of new articles in newsgroup │
2087 # ├───┼──────────────────────────────────────────────────────────────────┤
2088 # │%p │Poll: 1 if Mailbox is checked for new mail │
2089 # ├───┼──────────────────────────────────────────────────────────────────┤
2090 # │%s │Number of unread articles in newsgroup │
2091 # ├───┼──────────────────────────────────────────────────────────────────┤
2092 # │%>X│Right justify the rest of the string and pad with character "X" │
2093 # ├───┼──────────────────────────────────────────────────────────────────┤
2094 # │%|X│Pad to the end of the line with character "X" │
2095 # ├───┼──────────────────────────────────────────────────────────────────┤
2096 # │%*X│Soft-fill with character "X" as pad │
2097 # └───┴──────────────────────────────────────────────────────────────────┘
2106 # When unset, the header fields normally added by the "my_hdr" command are not
2107 # created. This variable must be unset before composing a new message or replying
2108 # in order to take effect. If set, the user defined header fields are added to
2109 # every new message.
2118 # When set, this variable causes NeoMutt to include the header of the message you
2119 # are replying to into the edit buffer. The $weed setting applies.
2123 # 3.135. header_cache
2128 # This variable points to the header cache database. If the path points to an
2129 # existing directory, NeoMutt will create a dedicated header cache database per
2130 # folder. Otherwise, the path points to a regular file, which will be created as
2131 # needed and used as a shared global header cache for all folders. By default it
2132 # is unset so no header caching will be used.
2134 # Header caching can greatly improve speed when opening POP, IMAP MH or Maildir
2135 # folders, see "caching" in the NeoMutt Guide for details.
2137 set header_cache="~/.var/neomutt/header_cache"
2140 # 3.136. header_cache_backend
2145 # This variable specifies the header cache backend. If no backend is specified,
2146 # the first available backend will be used in the following order: tokyocabinet,
2147 # kyotocabinet, qdbm, rocksdb, gdbm, bdb, tdb, lmdb.
2151 # 3.137. header_cache_compress_level
2156 # When NeoMutt is compiled with lz4, zstd or zlib, this option can be used to
2157 # setup the compression level.
2161 # 3.138. header_cache_compress_method
2166 # When NeoMutt is compiled with lz4, zstd or zlib, the header cache backend can
2167 # use these compression methods for compressing the cache files. This results in
2168 # much smaller cache file sizes and may even improve speed.
2172 # 3.139. header_color_partial
2177 # When set, color header regexes behave like color body regexes: color is applied
2178 # to the exact text matched by the regex. When unset, color is applied to the
2181 # One use of this option might be to apply color to just the header labels.
2183 # See "color" for more details.
2192 # When set, help lines describing the bindings for the major functions provided
2193 # by each menu are displayed on the first line of the screen.
2195 # Note: The binding will not be displayed correctly if the function is bound to a
2196 # sequence rather than a single keystroke. Also, the help line may not be updated
2197 # if a binding is changed while NeoMutt is running. Since this variable is
2198 # primarily aimed at new users, neither of these should present a major problem.
2202 # 3.141. hidden_host
2207 # When set, NeoMutt will skip the host name part of $hostname variable when
2208 # adding the domain part to addresses.
2212 # 3.142. hidden_tags
2215 # Default: “unread,draft,flagged,passed,replied,attachment,signed,encrypted”
2217 # This variable specifies a list of comma-separated private notmuch/imap tags
2218 # which should not be printed on screen.
2222 # 3.143. hide_limited
2227 # When set, NeoMutt will not show the presence of messages that are hidden by
2228 # limiting, in the thread tree.
2232 # 3.144. hide_missing
2237 # When set, NeoMutt will not show the presence of missing messages in the thread
2242 # 3.145. hide_thread_subject
2247 # When set, NeoMutt will not show the subject of messages in the thread tree that
2248 # have the same subject as their parent or closest previously displayed sibling.
2252 # 3.146. hide_top_limited
2257 # When set, NeoMutt will not show the presence of messages that are hidden by
2258 # limiting, at the top of threads in the thread tree. Note that when
2259 # $hide_limited is set, this option will have no effect.
2263 # 3.147. hide_top_missing
2268 # When set, NeoMutt will not show the presence of missing messages at the top of
2269 # threads in the thread tree. Note that when $hide_missing is set, this option
2270 # will have no effect.
2279 # This variable controls the size (in number of strings remembered) of the string
2280 # history buffer per category. The buffer is cleared each time the variable is
2283 # Note that strings (e.g. commands) starting with a space are never recorded in
2284 # the history. This is for example useful to prevent leaking sensitive
2285 # information into the history file or for one off tests.
2287 # Also note that a string is not added to the history if it exactly matches its
2288 # immediate predecessor, e.g. executing the same command twice in a row results
2289 # in only one copy being added to the history. To prevent duplicates over all
2290 # entries use $history_remove_dups.
2294 # 3.149. history_file
2297 # Default: “~/.mutthistory”
2299 # The file in which NeoMutt will save its history.
2301 # Also see $save_history.
2303 set history_file="~/.var/neomutt/history"
2306 # 3.150. history_format
2311 # Controls the format of the entries of the history list. This string is similar
2312 # to $index_format, but has its own set of printf(3)-like sequences:
2314 # ┌───┬───────────────────────────────────────────────────────────────┐
2315 # │%C │Line number │
2316 # ├───┼───────────────────────────────────────────────────────────────┤
2317 # │%s │History match │
2318 # ├───┼───────────────────────────────────────────────────────────────┤
2319 # │%>X│right justify the rest of the string and pad with character "X"│
2320 # ├───┼───────────────────────────────────────────────────────────────┤
2321 # │%|X│pad to the end of the line with character "X" │
2322 # ├───┼───────────────────────────────────────────────────────────────┤
2323 # │%*X│soft-fill with character "X" as pad │
2324 # └───┴───────────────────────────────────────────────────────────────┘
2328 # 3.151. history_remove_dups
2333 # When set, all of the string history will be scanned for duplicates when a new
2334 # entry is added. Duplicate entries in the $history_file will also be removed
2335 # when it is periodically compacted.
2339 # 3.152. honor_disposition
2344 # When set, NeoMutt will not display attachments with a disposition of
2345 # "attachment" inline even if it could render the part to plain text. These MIME
2346 # parts can only be viewed from the attachment menu.
2348 # If unset, NeoMutt will render all MIME parts it can properly transform to plain
2353 # 3.153. honor_followup_to
2358 # This variable controls whether or not a Mail-Followup-To header is honored when
2359 # group-replying to a message.
2368 # Specifies the fully-qualified hostname of the system NeoMutt is running on
2369 # containing the host's name and the DNS domain it belongs to. It is used as the
2370 # domain part (after "@") for local email addresses.
2372 # If not specified in a config file, then NeoMutt will try to determine the
2375 # Optionally, NeoMutt can be compiled with a fixed domain name.
2377 # Also see $use_domain and $hidden_host.
2379 # Note: On Debian systems, the default for this variable is obtained from /etc/
2380 # mailname when NeoMutt starts.
2389 # When set, NeoMutt will show you international domain names decoded. Note: You
2390 # can use IDNs for addresses even if this is unset. This variable only affects
2391 # decoding. (IDN only)
2400 # When set, NeoMutt will encode international domain names using IDN. Unset this
2401 # if your SMTP server can handle newer (RFC6531) UTF-8 encoded domains. (IDN
2406 # 3.157. ignore_list_reply_to
2411 # Affects the behavior of the <reply> function when replying to messages from
2412 # mailing lists (as defined by the "subscribe" or "lists" commands). When set, if
2413 # the "Reply-To:" field is set to the same value as the "To:" field, NeoMutt
2414 # assumes that the "Reply-To:" field was set by the mailing list to automate
2415 # responses to the list, and will ignore this field. To direct a response to the
2416 # mailing list when this option is set, use the <list-reply> function;
2417 # <group-reply> will reply to both the sender and the list.
2419 set ignore_list_reply_to=yes
2422 # 3.158. imap_authenticators
2427 # This is a colon-separated list of authentication methods NeoMutt may attempt to
2428 # use to log in to an IMAP server, in the order NeoMutt should try them.
2429 # Authentication methods are either "login" or the right side of an IMAP "AUTH=
2430 # xxx" capability string, e.g. "digest-md5", "gssapi" or "cram-md5". This option
2431 # is case-insensitive. If it's unset (the default) NeoMutt will try all available
2432 # methods, in order from most-secure to least-secure.
2436 # set imap_authenticators="gssapi:cram-md5:login"
2438 # Note: NeoMutt will only fall back to other authentication methods if the
2439 # previous methods are unavailable. If a method is available but authentication
2440 # fails, NeoMutt will not connect to the IMAP server.
2444 # 3.159. imap_check_subscribed
2449 # When set, NeoMutt will fetch the set of subscribed folders from your server
2450 # whenever a mailbox is selected, and add them to the set of mailboxes it polls
2451 # for new mail just as if you had issued individual "mailboxes" commands.
2455 # 3.160. imap_condstore
2460 # When set, NeoMutt will use the CONDSTORE extension (RFC7162) if advertised by
2461 # the server. NeoMutt's current implementation is basic, used only for initial
2462 # message fetching and flag updates.
2464 # For some IMAP servers, enabling this will slightly speed up downloading initial
2465 # messages. Unfortunately, Gmail is not one those, and displays worse performance
2466 # when enabled. Your mileage may vary.
2470 # 3.161. imap_deflate
2475 # When set, NeoMutt will use the COMPRESS=DEFLATE extension (RFC4978) if
2476 # advertised by the server.
2478 # In general a good compression efficiency can be achieved, which speeds up
2479 # reading large mailboxes also on fairly good connections.
2483 # 3.162. imap_delim_chars
2488 # This contains the list of characters that NeoMutt will use as folder separators
2489 # for IMAP paths, when no separator is provided on the IMAP connection.
2493 # 3.163. imap_fetch_chunk_size
2495 # Type: number (long)
2498 # When set to a value greater than 0, new headers will be downloaded in groups of
2499 # this many headers per request. If you have a very large mailbox, this might
2500 # prevent a timeout and disconnect when opening the mailbox, by sending a FETCH
2501 # per set of this many headers, instead of a single FETCH for all new headers.
2505 # 3.164. imap_headers
2510 # NeoMutt requests these header fields in addition to the default headers
2511 # ("Date:", "From:", "Sender:", "Subject:", "To:", "Cc:", "Message-Id:",
2512 # "References:", "Content-Type:", "Content-Description:", "In-Reply-To:",
2513 # "Reply-To:", "Lines:", "List-Post:", "X-Label:") from IMAP servers before
2514 # displaying the index menu. You may want to add more headers for spam detection.
2516 # Note: This is a space separated list, items should be uppercase and not contain
2517 # the colon, e.g. "X-BOGOSITY X-SPAM-STATUS" for the "X-Bogosity:" and
2518 # "X-Spam-Status:" header fields.
2527 # When set, NeoMutt will attempt to use the IMAP IDLE extension to check for new
2528 # mail in the current mailbox. Some servers (dovecot was the inspiration for this
2529 # option) react badly to NeoMutt's implementation. If your connection seems to
2530 # freeze up periodically, try unsetting this.
2534 # 3.166. imap_keep_alive
2539 # This variable specifies the maximum amount of time in seconds that NeoMutt will
2540 # wait before polling open IMAP connections, to prevent the server from closing
2541 # them before NeoMutt has finished with them. The default is well within the
2542 # RFC-specified minimum amount of time (30 minutes) before a server is allowed to
2543 # do this, but in practice the RFC does get violated every now and then. Reduce
2544 # this number if you find yourself getting disconnected from your IMAP server due
2549 # 3.167. imap_list_subscribed
2554 # This variable configures whether IMAP folder browsing will look for only
2555 # subscribed folders or all folders. This can be toggled in the IMAP browser with
2556 # the <toggle-subscribed> function.
2565 # Your login name on the IMAP server.
2567 # This variable defaults to the value of $imap_user.
2571 # 3.169. imap_oauth_refresh_command
2576 # The command to run to generate an OAUTH refresh token for authorizing your
2577 # connection to your IMAP server. This command will be run on every connection
2578 # attempt that uses the OAUTHBEARER or XOAUTH2 authentication mechanisms. See "
2579 # oauth" for details.
2588 # Specifies the password for your IMAP account. If unset, NeoMutt will prompt you
2589 # for your password when you invoke the <imap-fetch-mail> function or try to open
2592 # Warning: you should only use this option when you are on a fairly secure
2593 # machine, because the superuser can read your neomuttrc even if you are the only
2594 # one who can read the file.
2598 # 3.171. imap_passive
2603 # When set, NeoMutt will not open new IMAP connections to check for new mail.
2604 # NeoMutt will only check for new mail over existing IMAP connections. This is
2605 # useful if you don't want to be prompted for user/password pairs on NeoMutt
2606 # invocation, or if opening the connection is slow.
2615 # When set, NeoMutt will avoid implicitly marking your mail as read whenever you
2616 # fetch a message from the server. This is generally a good thing, but can make
2617 # closing an IMAP folder somewhat slower. This option exists to appease speed
2622 # 3.173. imap_pipeline_depth
2627 # Controls the number of IMAP commands that may be queued up before they are sent
2628 # to the server. A deeper pipeline reduces the amount of time NeoMutt must wait
2629 # for the server, and can make IMAP servers feel much more responsive. But not
2630 # all servers correctly handle pipelined commands, so if you have problems you
2631 # might want to try setting this variable to 0.
2633 # Note: Changes to this variable have no effect on open connections.
2637 # 3.174. imap_poll_timeout
2642 # This variable specifies the maximum amount of time in seconds that NeoMutt will
2643 # wait for a response when polling IMAP connections for new mail, before timing
2644 # out and closing the connection. Set to 0 to disable timing out.
2648 # 3.175. imap_qresync
2653 # When set, NeoMutt will use the QRESYNC extension (RFC7162) if advertised by the
2654 # server. NeoMutt's current implementation is basic, used only for initial
2655 # message fetching and flag updates.
2657 # Note: this feature is currently experimental. If you experience strange
2658 # behavior, such as duplicate or missing messages please file a bug report to let
2663 # 3.176. imap_rfc5161
2668 # When set, NeoMutt will use the IMAP ENABLE extension (RFC5161) to select
2669 # CAPABILITIES. Some servers (notably Coremail System IMap Server) do not
2670 # properly respond to ENABLE commands, which might cause NeoMutt to hang. If your
2671 # connection seems to freeze at login, try unsetting this. See also https://
2672 # github.com/neomutt/neomutt/issues/1689
2676 # 3.177. imap_send_id
2681 # When set, NeoMutt will send an IMAP ID command (RFC2971) to the server when
2682 # logging in if advertised by the server. This command provides information about
2683 # the IMAP client, such as "NeoMutt" and the current version.
2687 # 3.178. imap_server_noise
2692 # When set, NeoMutt will display warning messages from the IMAP server as error
2693 # messages. Since these messages are often harmless, or generated due to
2694 # configuration problems on the server which are out of the users' hands, you may
2695 # wish to suppress them at some point.
2704 # The name of the user whose mail you intend to access on the IMAP server.
2706 # This variable defaults to your user name on the local machine.
2710 # 3.180. implicit_auto_view
2715 # If set to "yes", NeoMutt will look for a mailcap entry with the "copiousoutput"
2716 # flag set for every MIME attachment it doesn't have an internal viewer defined
2717 # for. If such an entry is found, NeoMutt will use the viewer defined in that
2718 # entry to convert the body part to text form.
2727 # Controls whether or not a copy of the message(s) you are replying to is
2728 # included in your reply.
2733 # 3.182. include_encrypted
2738 # Controls whether or not NeoMutt includes separately encrypted attachment
2739 # contents when replying.
2741 # This variable was added to prevent accidental exposure of encrypted contents
2742 # when replying to an attacker. If a previously encrypted message were attached
2743 # by the attacker, they could trick an unwary recipient into decrypting and
2744 # including the message in their reply.
2748 # 3.183. include_only_first
2753 # Controls whether or not NeoMutt includes only the first attachment of the
2754 # message you are replying.
2758 # 3.184. indent_string
2763 # Specifies the string to prepend to each line of text quoted in a message to
2764 # which you are replying. You are strongly encouraged not to change this value,
2765 # as it tends to agitate the more fanatical netizens.
2767 # The value of this option is ignored if $text_flowed is set, because the quoting
2768 # mechanism is strictly defined for format=flowed.
2770 # This option is a format string, please see the description of $index_format for
2771 # supported printf(3)-style sequences.
2775 # 3.185. index_format
2778 # Default: “%4C %Z %{%b %d} %-15.15L (%<l?%4l&%4c>) %s”
2780 # This variable allows you to customize the message index display to your
2783 # "Format strings" are similar to the strings used in the C function printf(3) to
2784 # format output (see the man page for more details). For an explanation of the %
2785 # <...> construct, see the status_format description. The following sequences are
2786 # defined in NeoMutt:
2788 # ┌───────┬─────────────────────────────────────────────────────────────────────┐
2789 # │%a │Address of the author │
2790 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2791 # │%A │Reply-to address (if present; otherwise: address of author) │
2792 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2793 # │%b │Filename of the original message folder (think mailbox) │
2794 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2796 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2797 # │%c │Number of characters (bytes) in the body of the message (see │
2798 # │ │formatstrings-size) │
2799 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2800 # │%C │Current message number │
2801 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2802 # │%cr │Number of characters (bytes) in the raw message, including the header│
2803 # │ │(see formatstrings-size) │
2804 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2805 # │ │Date and time of message using date_format and sender's timezone It │
2806 # │%d │is encouraged to use "%{fmt}" instead, where "fmt" is the value of │
2807 # │ │$date_format. │
2808 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2809 # │ │Date and time of message using date_format and local timezone It is │
2810 # │%D │encouraged to use "%[fmt]" instead, where "fmt" is the value of │
2811 # │ │$date_format. │
2812 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2813 # │%e │Current message number in thread │
2814 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2815 # │%E │Number of messages in current thread │
2816 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2817 # │%f │Sender (address + real name), either From: or Return-Path: │
2818 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2819 # │%F │Author name, or recipient name if the message is from you │
2820 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2821 # │%Fp │Like %F, but plain. No contextual formatting is applied to recipient │
2823 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2824 # │%g │Message tags (e.g. notmuch tags/imap flags) │
2825 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2826 # │%Gx │Individual message tag (e.g. notmuch tags/imap flags) │
2827 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2828 # │%H │Spam attribute(s) of this message │
2829 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2830 # │%i │Message-id of the current message │
2831 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2832 # │%I │Initials of author │
2833 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2834 # │%J │Message tags (if present, tree unfolded, and != parent's tags) │
2835 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2836 # │%K │The list to which the letter was sent (if any; otherwise: empty) │
2837 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2838 # │%l │number of lines in the unprocessed message (may not work with │
2839 # │ │maildir, mh, and IMAP folders) │
2840 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2841 # │ │If an address in the "To:" or "Cc:" header field matches an address │
2842 # │%L │Defined by the user's "subscribe" command, this displays "To │
2843 # │ │<list-name>", otherwise the same as %F │
2844 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2845 # │%m │Total number of message in the mailbox │
2846 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2847 # │%M │Number of hidden messages if the thread is collapsed │
2848 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2849 # │%n │Author's real name (or address if missing) │
2850 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2851 # │%N │Message score │
2852 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2853 # │%O │Original save folder where NeoMutt would formerly have Stashed the │
2854 # │ │message: list name or recipient name If not sent to a list │
2855 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2856 # │%P │Progress indicator for the built-in pager (how much of the file has │
2857 # │ │been displayed) │
2858 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2859 # │%q │Newsgroup name (if compiled with NNTP support) │
2860 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2861 # │%r │Comma separated list of "To:" recipients │
2862 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2863 # │%R │Comma separated list of "Cc:" recipients │
2864 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2865 # │%s │Subject of the message │
2866 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2867 # │%S │Single character status of the message ("N"/"O"/"D"/"d"/"!"/"r"/"*") │
2868 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2869 # │%t │"To:" field (recipients) │
2870 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2871 # │%T │The appropriate character from the $to_chars string │
2872 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2873 # │%u │User (login) name of the author │
2874 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2875 # │%v │First name of the author, or the recipient if the message is from you│
2876 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2877 # │%W │Name of organization of author ("Organization:" field) │
2878 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2879 # │%x │"X-Comment-To:" field (if present and compiled with NNTP support) │
2880 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2881 # │%X │Number of MIME attachments (please see the "attachments" section for │
2882 # │ │possible speed effects) │
2883 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2884 # │%y │"X-Label:" field, if present │
2885 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2886 # │ │"X-Label:" field, if present, and (1) not at part of a thread tree, │
2887 # │%Y │(2) at the top of a thread, or (3) "X-Label:" is different from │
2888 # │ │Preceding message's "X-Label:" │
2889 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2890 # │ │A three character set of message status flags. The first character is│
2891 # │ │new/read/replied flags ("n"/"o"/"r"/"O"/"N"). The second is deleted │
2892 # │%Z │or encryption flags ("D"/"d"/"S"/"P"/"s"/"K"). The third is either │
2893 # │ │tagged/flagged ("*"/"!"), or one of the characters Listed in │
2895 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2896 # │%zc │Message crypto flags │
2897 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2898 # │%zs │Message status flags │
2899 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2900 # │%zt │Message tag flags │
2901 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2902 # │%@name@│insert and evaluate format-string from the matching " │
2903 # │ │index-format-hook" command │
2904 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2905 # │ │the date and time of the message is converted to sender's time zone, │
2906 # │ │and "fmt" is expanded by the library function strftime(3); if the │
2907 # │ │first character inside the braces is a bang ("!"), the date is │
2908 # │%{fmt} │formatted ignoring any locale settings. Note that the sender's time │
2909 # │ │zone might only be available as a numerical offset, so "%Z" behaves │
2910 # │ │like "%z". %{fmt} behaves like %[fmt] on systems where struct tm │
2911 # │ │doesn't have a tm_gmtoff member. │
2912 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2913 # │ │the date and time of the message is converted to the local time zone,│
2914 # │%[fmt] │and "fmt" is expanded by the library function strftime(3); if the │
2915 # │ │first character inside the brackets is a bang ("!"), the date is │
2916 # │ │formatted ignoring any locale settings. │
2917 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2918 # │ │the local date and time when the message was received, and "fmt" is │
2919 # │%(fmt) │expanded by the library function strftime(3); if the first character │
2920 # │ │inside the parentheses is a bang ("!"), the date is formatted │
2921 # │ │ignoring any locale settings. │
2922 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2923 # │%>X │right justify the rest of the string and pad with character "X" │
2924 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2925 # │%|X │pad to the end of the line with character "X" │
2926 # ├───────┼─────────────────────────────────────────────────────────────────────┤
2927 # │%*X │soft-fill with character "X" as pad │
2928 # └───────┴─────────────────────────────────────────────────────────────────────┘
2930 # Date format expressions can be constructed based on relative dates. Using the
2931 # date formatting operators along with nested conditionals, the date format can
2932 # be modified based on how old a message is. See the section on "Conditional
2933 # Dates" for an explanation and examples
2935 # Note that for mbox/mmdf, "%l" applies to the unprocessed message, and for
2936 # maildir/mh, the value comes from the "Lines:" header field when present (the
2937 # meaning is normally the same). Thus the value depends on the encodings used in
2938 # the different parts of the message and has little meaning in practice.
2940 # "Soft-fill" deserves some explanation: Normal right-justification will print
2941 # everything to the left of the "%>", displaying padding and whatever lies to the
2942 # right only if there's room. By contrast, soft-fill gives priority to the
2943 # right-hand side, guaranteeing space to display it and showing padding only if
2944 # there's still room. If necessary, soft-fill will eat text leftwards to make
2945 # room for rightward text.
2947 # Note that these expandos are supported in "save-hook", "fcc-hook" and "
2948 # fcc-save-hook", too.
2957 # If set, specifies the program and arguments used to deliver news posted by
2958 # NeoMutt. Otherwise, NeoMutt posts article using current connection to news
2959 # server. The following printf-style sequence is understood:
2961 # ┌──┬──────────────────┐
2963 # ├──┼──────────────────┤
2965 # ├──┼──────────────────┤
2966 # │%P│port if specified │
2967 # ├──┼──────────────────┤
2968 # │%s│news server name │
2969 # ├──┼──────────────────┤
2971 # ├──┼──────────────────┤
2973 # └──┴──────────────────┘
2977 # set inews="/usr/local/bin/inews -hS"
2986 # How to invoke ispell (GNU's spell-checking software).
2990 # 3.188. keep_flagged
2995 # If set, read messages marked as flagged will not be moved from your spool
2996 # mailbox to your $mbox mailbox or to the "mbox" specified by a mbox-hook
2999 # Note that $keep_flagged only has an effect if $move is set.
3003 # 3.189. local_date_header
3008 # If set, the date in the Date header of emails that you send will be in your
3009 # local timezone. If unset a UTC date will be used instead to avoid leaking
3010 # information about your current location.
3019 # This variable configures how often (in seconds) NeoMutt should look for new
3020 # mail. Also see the $timeout variable.
3024 # 3.191. mail_check_recent
3029 # When set, NeoMutt will only notify you about new mail that has been received
3030 # since the last time you opened the mailbox. When unset, NeoMutt will notify you
3031 # if any new mail exists in the mailbox, regardless of whether you have visited
3036 # 3.192. mail_check_stats
3041 # When set, NeoMutt will periodically calculate message statistics of a mailbox
3042 # while polling for new mail. It will check for unread, flagged, and total
3043 # message counts. (Note: IMAP mailboxes only support unread and total counts).
3045 # Because this operation is more performance intensive, it defaults to unset, and
3046 # has a separate option, $mail_check_stats_interval, to control how often to
3047 # update these counts.
3049 # Message statistics can also be explicitly calculated by invoking the
3050 # <check-stats> function.
3052 set mail_check_stats=yes
3055 # 3.193. mail_check_stats_interval
3060 # When $mail_check_stats is set, this variable configures how often (in seconds)
3061 # NeoMutt will update message counts.
3065 # 3.194. mailbox_folder_format
3068 # Default: “%2C %<n?%6n& > %6m %i”
3070 # This variable allows you to customize the file browser display to your personal
3071 # taste. It's only used to customize network mailboxes (e.g. imap). This string
3072 # is identical in formatting to the one used by "$folder_format".
3076 # 3.195. mailcap_path
3079 # Default: “~/.mailcap:/usr/share/neomutt/mailcap:/etc/mailcap:/etc/mailcap:/usr/
3080 # etc/mailcap:/usr/local/etc/mailcap”
3082 # This variable specifies a list of colon-separated files to consult when
3083 # attempting to display MIME bodies not directly supported by NeoMutt. The
3084 # default value is generated during startup: see the "mailcap" section of the
3087 # $mailcap_path is overridden by the environment variable $MAILCAPS.
3089 # The default search path is from RFC1524.
3091 set mailcap_path="$my_confdir/mailcap.containers:$my_confdir/mailcap.icalendar:$my_confdir/mailcap.backgrounding:$my_confdir/mailcap.htmldump"
3094 # 3.196. mailcap_sanitize
3099 # If set, NeoMutt will restrict possible characters in mailcap % expandos to a
3100 # well-defined set of safe characters. This is the safe setting, but we are not
3101 # sure it doesn't break some more advanced MIME stuff.
3103 # DON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE DOING!
3107 # 3.197. maildir_check_cur
3112 # If set, NeoMutt will poll both the new and cur directories of a maildir folder
3113 # for new messages. This might be useful if other programs interacting with the
3114 # folder (e.g. dovecot) are moving new messages to the cur directory. Note that
3115 # setting this option may slow down polling for new messages in large folders,
3116 # since NeoMutt has to scan all cur messages.
3120 # 3.198. maildir_field_delimiter
3125 # Use the value as maildir field delimiter. This is a single-character used to
3126 # accommodate maildir mailboxes on platforms where `:` is not allowed in a
3127 # filename. The recommended alternative on such platforms is `;`. Neomutt
3128 # supports all non-alphanumeric values except for `-`, `.`, ``, `/`. Note: this
3129 # only applies to maildir-style mailboxes. Setting it will have no effect on
3130 # other mailbox types.
3134 # 3.199. maildir_header_cache_verify
3139 # Check for Maildir unaware programs other than NeoMutt having modified maildir
3140 # files when the header cache is in use. This incurs one stat(2) per message
3141 # every time the folder is opened (which can be very slow for NFS folders).
3143 set maildir_header_cache_verify=no
3146 # 3.200. maildir_trash
3151 # If set, messages marked as deleted will be saved with the maildir trashed flag
3152 # instead of unlinked. Note: this only applies to maildir-style mailboxes.
3153 # Setting it will have no effect on other mailbox types.
3157 # 3.201. mark_macro_prefix
3162 # Prefix for macros created using mark-message. A new macro automatically
3163 # generated with <mark-message>a will be composed from this prefix and the letter
3173 # Controls whether or not NeoMutt marks new unread messages as old if you exit a
3174 # mailbox without reading them. With this option set, the next time you start
3175 # NeoMutt, the messages will show up with an "O" next to them in the index menu,
3176 # indicating that they are old.
3186 # Controls the display of wrapped lines in the internal pager. If set, a "+"
3187 # marker is displayed at the beginning of wrapped lines.
3189 # Also see the $smart_wrap variable.
3196 # Type: regular expression
3197 # Default: “!^.[^.]”
3199 # A regular expression used in the file browser, optionally preceded by the not
3200 # operator "!". Only files whose names match this mask will be shown. The match
3201 # is always case-sensitive.
3210 # This specifies the folder into which read mail in your $spool_file folder will
3213 # Also see the $move variable.
3223 # The default mailbox type used when creating new folders. May be any of "mbox",
3224 # "MMDF", "MH" or "Maildir".
3226 # This can also be set using the -m command-line option.
3228 set mbox_type=Maildir
3236 # If unset, NeoMutt will remove your address (see the "alternates" command) from
3237 # the list of recipients when replying to a message.
3241 # 3.208. menu_context
3246 # This variable controls the number of lines of context that are given when
3247 # scrolling through menus. (Similar to $pager_context.)
3252 # 3.209. menu_move_off
3257 # When unset, the bottom entry of menus will never scroll up past the bottom of
3258 # the screen, unless there are less entries than lines. When set, the bottom
3259 # entry may move off the bottom.
3263 # 3.210. menu_scroll
3268 # When set, menus will be scrolled up or down one line when you attempt to move
3269 # across a screen boundary. If unset, the screen is cleared and the next or
3270 # previous page of the menu is displayed (useful for slow links to avoid many
3276 # 3.211. message_cache_clean
3281 # If set, NeoMutt will clean out obsolete entries from the message cache when the
3282 # mailbox is synchronized. You probably only want to set it every once in a
3283 # while, since it can be a little slow (especially for large folders).
3287 # 3.212. message_cache_dir
3292 # Set this to a directory and NeoMutt will cache copies of messages from your
3293 # IMAP and POP servers here. You are free to remove entries at any time.
3295 # When setting this variable to a directory, NeoMutt needs to fetch every remote
3296 # message only once and can perform regular expression searches as fast as for
3299 # Also see the $message_cache_clean variable.
3303 # 3.213. message_format
3308 # This is the string displayed in the "attachment" menu for attachments of type
3309 # message/rfc822. For a full listing of defined printf(3)-like sequences see the
3310 # section on $index_format.
3319 # If set, forces NeoMutt to interpret keystrokes with the high bit (bit 8) set as
3320 # if the user had pressed the Esc key and whatever key remains after having the
3321 # high bit removed. For example, if the key pressed has an ASCII value of 0xf8,
3322 # then this is treated as if the user had pressed Esc then "x". This is because
3323 # the result of removing the high bit from 0xf8 is 0x78, which is the ASCII
3333 # When unset, NeoMutt will mimic mh's behavior and rename deleted messages to ,
3334 # <old file name> in mh folders instead of really deleting them. This leaves the
3335 # message on disk but makes programs reading the folder ignore it. If the
3336 # variable is set, the message files will simply be deleted.
3338 # This option is similar to $maildir_trash for Maildir folders.
3342 # 3.216. mh_seq_flagged
3345 # Default: “flagged”
3347 # The name of the MH sequence used for flagged messages.
3351 # 3.217. mh_seq_replied
3354 # Default: “replied”
3356 # The name of the MH sequence used to tag replied messages.
3360 # 3.218. mh_seq_unseen
3365 # The name of the MH sequence used for unseen messages.
3369 # 3.219. mime_forward
3374 # When set, the message you are forwarding will be attached as a separate message
3375 # /rfc822 MIME part instead of included in the main body of the message. This is
3376 # useful for forwarding MIME messages so the receiver can properly view the
3377 # message as it was delivered to you. If you like to switch between MIME and not
3378 # MIME from mail to mail, set this variable to "ask-no" or "ask-yes".
3380 # Also see $forward_decode and $mime_forward_decode.
3382 set mime_forward=ask-yes
3385 # 3.220. mime_forward_decode
3390 # Controls the decoding of complex MIME messages into text/plain when forwarding
3391 # a message while $mime_forward is set. Otherwise $forward_decode is used
3396 # 3.221. mime_forward_rest
3401 # When forwarding multiple attachments of a MIME message from the attachment
3402 # menu, attachments which can't be decoded in a reasonable manner will be
3403 # attached to the newly composed message if this option is set.
3407 # 3.222. mime_type_query_command
3412 # This specifies a command to run, to determine the mime type of a new attachment
3413 # when composing a message. Unless $mime_type_query_first is set, this will only
3414 # be run if the attachment's extension is not found in the mime.types file.
3416 # The string may contain a "%s", which will be substituted with the attachment
3417 # filename. NeoMutt will add quotes around the string substituted for "%s"
3418 # automatically according to shell quoting rules, so you should avoid adding your
3419 # own. If no "%s" is found in the string, NeoMutt will append the attachment
3420 # filename to the end of the string.
3422 # The command should output a single line containing the attachment's mime type.
3424 # Suggested values are "xdg-mime query filetype" or "file -bi".
3428 # 3.223. mime_type_query_first
3433 # When set, the $mime_type_query_command will be run before the mime.types
3443 # If this variable is set, then NeoMutt will move read messages from your spool
3444 # mailbox to your $mbox mailbox or to the "mbox" specified by a mbox-hook
3447 # See also $keep_flagged.
3452 # 3.225. narrow_tree
3457 # This variable, when set, makes the thread tree narrower, allowing deeper
3458 # threads to fit on the screen.
3468 # Operations that expect to transfer a large amount of data over the network will
3469 # update their progress every $net_inc kilobytes. If set to 0, no progress
3470 # messages will be displayed.
3472 # See also $read_inc, $write_inc and $net_inc.
3476 # 3.227. new_mail_command
3481 # If set, NeoMutt will call this command after a new message is received. See the
3482 # $status_format documentation for the values that can be formatted into this
3487 # 3.228. news_cache_dir
3490 # Default: “~/.neomutt”
3492 # This variable pointing to directory where NeoMutt will save cached news
3493 # articles and headers in. If unset, articles and headers will not be saved at
3494 # all and will be reloaded from the server each time.
3498 # 3.229. news_server
3503 # This variable specifies domain name or address of NNTP server.
3505 # You can also specify username and an alternative port for each news server,
3506 # e.g. [[s]news://][username[:password]@]server[:port]
3508 # This option can also be set using the command line option "-g", the environment
3509 # variable $NNTPSERVER, or putting the server name in the file "/etc/nntpserver".
3513 # 3.230. newsgroups_charset
3518 # Character set of newsgroups descriptions.
3525 # Default: “~/.newsrc”
3527 # The file, containing info about subscribed newsgroups - names and indexes of
3528 # read articles. The following printf-style sequence is understood:
3530 # ┌───────┬─────────────────┬───────────────────┐
3531 # │Expando│Description │Example │
3532 # ├───────┼─────────────────┼───────────────────┤
3533 # │%a │Account url │news:news.gmane.org│
3534 # ├───────┼─────────────────┼───────────────────┤
3536 # ├───────┼─────────────────┼───────────────────┤
3537 # │%P │Port if specified│10119 │
3538 # ├───────┼─────────────────┼───────────────────┤
3539 # │%s │News server name │news.gmane.org │
3540 # ├───────┼─────────────────┼───────────────────┤
3541 # │%S │Url schema │news │
3542 # ├───────┼─────────────────┼───────────────────┤
3543 # │%u │Username │username │
3544 # └───────┴─────────────────┴───────────────────┘
3548 # 3.232. nm_config_file
3553 # Configuration file for notmuch. Use 'auto' to detect configuration.
3557 # 3.233. nm_config_profile
3562 # Configuration profile for notmuch.
3566 # 3.234. nm_db_limit
3571 # This variable specifies the default limit used in notmuch queries.
3575 # 3.235. nm_default_url
3580 # This variable specifies the default Notmuch database in format notmuch://
3585 # 3.236. nm_exclude_tags
3590 # The messages tagged with these tags are excluded and not loaded from notmuch DB
3591 # to NeoMutt unless specified explicitly.
3595 # 3.237. nm_flagged_tag
3598 # Default: “flagged”
3600 # This variable specifies notmuch tag which is used for flagged messages. The
3601 # variable is used to count flagged messages in DB and set the flagged flag when
3602 # modifying tags. All other NeoMutt commands use standard (e.g. maildir) flags.
3606 # 3.238. nm_open_timeout
3611 # This variable specifies the timeout for database open in seconds.
3615 # 3.239. nm_query_type
3618 # Default: “messages”
3620 # This variable specifies the default query type (threads or messages) used in
3625 # 3.240. nm_query_window_current_position
3630 # This variable contains the position of the current search for window based
3635 # 3.241. nm_query_window_current_search
3640 # This variable contains the currently setup notmuch search for window based
3645 # 3.242. nm_query_window_duration
3650 # This variable sets the time duration of a windowed notmuch query. Accepted
3651 # values all non negative integers. A value of 0 disables the feature.
3655 # 3.243. nm_query_window_enable
3660 # This variable enables windowed notmuch queries even if window duration is 0.
3664 # 3.244. nm_query_window_or_terms
3669 # This variable contains additional notmuch search terms for messages to be shown
3670 # regardless of date.
3674 # Using "notmuch://?query=tag:inbox" as the mailbox and "tag:flagged and
3675 # tag:unread" as the or terms, NeoMutt will produce a query window such as:
3677 # notmuch://?query=tag:inbox and (date:... or (tag:flagged and tag:unread))
3681 # 3.245. nm_query_window_timebase
3686 # This variable sets the time base of a windowed notmuch query. Accepted values
3687 # are 'minute', 'hour', 'day', 'week', 'month', 'year'
3696 # This variable specifies whether, when writing a just-sent message to the
3697 # $record, the message should also be added to the notmuch DB. Replies inherit
3698 # the notmuch tags from the original message. See $nm_record_tags for how to
3699 # modify the set of notmuch tags assigned to sent messages written to the record.
3703 # 3.247. nm_record_tags
3708 # This variable specifies the notmuch tag modifications (addition, removal,
3709 # toggling) applied to messages added to the Neomutt record when $nm_record is
3710 # true. See the description of the <modify-labels> function for the syntax.
3714 # 3.248. nm_replied_tag
3717 # Default: “replied”
3719 # This variable specifies notmuch tag which is used for replied messages. The
3720 # variable is used to set the replied flag when modifying tags. All other NeoMutt
3721 # commands use standard (e.g. maildir) flags.
3725 # 3.249. nm_unread_tag
3730 # This variable specifies notmuch tag which is used for unread messages. The
3731 # variable is used to count unread messages in DB and set the unread flag when
3732 # modifying tags. All other NeoMutt commands use standard (e.g. maildir) flags.
3736 # 3.250. nntp_authenticators
3741 # This is a colon-delimited list of authentication methods NeoMutt may attempt to
3742 # use to log in to a news server, in the order NeoMutt should try them.
3743 # Authentication methods are either "user" or any SASL mechanism, e.g.
3744 # "digest-md5", "gssapi" or "cram-md5". This option is case-insensitive. If it's
3745 # unset (the default) NeoMutt will try all available methods, in order from
3746 # most-secure to least-secure.
3750 # set nntp_authenticators="digest-md5:user"
3752 # Note: NeoMutt will only fall back to other authentication methods if the
3753 # previous methods are unavailable. If a method is available but authentication
3754 # fails, NeoMutt will not connect to the IMAP server.
3758 # 3.251. nntp_context
3760 # Type: number (long)
3763 # This variable defines number of articles which will be in index when newsgroup
3764 # entered. If active newsgroup have more articles than this number, oldest
3765 # articles will be ignored. Also controls how many articles headers will be saved
3766 # in cache when you quit newsgroup.
3770 # 3.252. nntp_listgroup
3775 # This variable controls whether or not existence of each article is checked when
3776 # newsgroup is entered.
3780 # 3.253. nntp_load_description
3785 # This variable controls whether or not descriptions for each newsgroup must be
3786 # loaded when newsgroup is added to list (first time list loading or new
3787 # newsgroup adding).
3796 # Your password for NNTP account.
3805 # The time in seconds until any operations on newsgroup except post new article
3806 # will cause recheck for new news. If set to 0, NeoMutt will recheck newsgroup on
3807 # each operation in index (stepping, read article, etc.).
3816 # Your login name on the NNTP server. If unset and NNTP server requires
3817 # authentication, NeoMutt will prompt you for your account name when you connect
3827 # This variable specifies which pager you would like to use to view messages.
3828 # When empty, NeoMutt will use the built-in pager, otherwise this variable should
3829 # specify the pathname of the external pager you would like to use.
3831 # Using an external pager may have some disadvantages: Additional keystrokes are
3832 # necessary because you can't call NeoMutt functions directly from the pager, and
3833 # screen resizes cause lines longer than the screen width to be badly formatted
3838 # 3.258. pager_context
3843 # This variable controls the number of lines of context that are given when
3844 # displaying the next or previous page in the internal pager. By default, NeoMutt
3845 # will display the line after the last one on the screen at the top of the next
3846 # page (0 lines of context).
3848 # This variable also specifies the amount of context given for search results. If
3849 # positive, this many lines will be given before a match, if 0, the match will be
3855 # 3.259. pager_format
3858 # Default: “-%Z- %C/%m: %-20.20n %s%* -- (%P)”
3860 # This variable controls the format of the one-line message "status" displayed
3861 # before each message in either the internal or an external pager. The valid
3862 # sequences are listed in the $index_format section.
3864 set pager_format="<%a> %* %i (%P)"
3867 # 3.260. pager_index_lines
3872 # Determines the number of lines of a mini-index which is shown when in the
3873 # pager. The current message, unless near the top or bottom of the folder, will
3874 # be roughly one third of the way down this mini-index, giving the reader the
3875 # context of a few messages before and after the message. This is useful, for
3876 # example, to determine how many messages remain to be read in the current
3877 # thread. A value of 0 results in no index being shown.
3879 set pager_index_lines=$menu_context
3882 # 3.261. pager_read_delay
3887 # Determines the number of seconds that must elapse after first opening a new
3888 # message in the pager before that message will be marked as read. A value of 0
3889 # results in the message being marked read unconditionally; for other values,
3890 # navigating to another message or exiting the pager before the timeout will
3891 # leave the message marked unread. This setting is ignored if $pager is set.
3895 # 3.262. pager_skip_quoted_context
3900 # Determines the number of lines of context to show before the unquoted text when
3901 # using the <skip-quoted> function. When set to a positive number at most that
3902 # many lines of the previous quote are displayed. If the previous quote is
3903 # shorter the whole quote is displayed.
3905 # The (now deprecated) skip_quoted_offset is an alias for this variable, and
3906 # should no longer be used.
3915 # When set, the internal-pager will not move to the next message when you are at
3916 # the end of a message and invoke the <next-page> function.
3921 # 3.264. pattern_format
3924 # Default: “%2n %-15e %d”
3926 # This variable describes the format of the "pattern completion" menu. The
3927 # following printf(3)-style sequences are understood:
3929 # ┌───┬───────────────────────────────────────────────────────────────┐
3930 # │%d │pattern description │
3931 # ├───┼───────────────────────────────────────────────────────────────┤
3932 # │%e │pattern expression │
3933 # ├───┼───────────────────────────────────────────────────────────────┤
3934 # │%n │index number │
3935 # ├───┼───────────────────────────────────────────────────────────────┤
3936 # │%>X│right justify the rest of the string and pad with character "X"│
3937 # ├───┼───────────────────────────────────────────────────────────────┤
3938 # │%|X│pad to the end of the line with character "X" │
3939 # ├───┼───────────────────────────────────────────────────────────────┤
3940 # │%*X│soft-fill with character "X" as pad │
3941 # └───┴───────────────────────────────────────────────────────────────┘
3945 # 3.265. pgp_auto_decode
3950 # If set, NeoMutt will automatically attempt to decrypt traditional PGP messages
3951 # whenever the user performs an operation which ordinarily would result in the
3952 # contents of the message being operated on. For example, if the user displays a
3953 # pgp-traditional message which has not been manually checked with the
3954 # <check-traditional-pgp> function, NeoMutt will automatically check the message
3955 # for traditional pgp.
3959 # 3.266. pgp_auto_inline
3964 # This option controls whether NeoMutt generates old-style inline (traditional)
3965 # PGP encrypted or signed messages under certain circumstances. This can be
3966 # overridden by use of the pgp menu, when inline is not required. The GPGME
3967 # backend does not support this option.
3969 # Note that NeoMutt might automatically use PGP/MIME for messages which consist
3970 # of more than a single MIME part. NeoMutt can be configured to ask before
3971 # sending PGP/MIME messages when inline (traditional) would not work.
3973 # Also see the $pgp_mime_auto variable.
3975 # Also note that using the old-style PGP message format is strongly deprecated.
3980 # 3.267. pgp_check_exit
3985 # If set, NeoMutt will check the exit code of the PGP subprocess when signing or
3986 # encrypting. A non-zero exit code means that the subprocess failed. (PGP only)
3990 # 3.268. pgp_check_gpg_decrypt_status_fd
3995 # If set, NeoMutt will check the status file descriptor output of
3996 # $pgp_decrypt_command and $pgp_decode_command for GnuPG status codes indicating
3997 # successful decryption. This will check for the presence of DECRYPTION_OKAY,
3998 # absence of DECRYPTION_FAILED, and that all PLAINTEXT occurs between the
3999 # BEGIN_DECRYPTION and END_DECRYPTION status codes.
4001 # If unset, NeoMutt will instead match the status fd output against
4002 # $pgp_decryption_okay. (PGP only)
4006 # 3.269. pgp_clear_sign_command
4011 # This format is used to create an old-style "clearsigned" PGP message. Note that
4012 # the use of this format is strongly deprecated.
4014 # This is a format string, see the $pgp_decode_command command for possible
4015 # printf(3)-like sequences. Note that in this case, %r expands to the search
4016 # string, which is a list of one or more quoted values such as email address,
4017 # name, or keyid. (PGP only)
4021 # 3.270. pgp_decode_command
4026 # This format strings specifies a command which is used to decode application/pgp
4029 # The PGP command formats have their own set of printf(3)-like sequences:
4031 # ┌──┬──────────────────────────────────────────────────────────────────────────┐
4032 # │%a│The value of $pgp_sign_as if set, otherwise the value of $pgp_default_key.│
4033 # ├──┼──────────────────────────────────────────────────────────────────────────┤
4034 # │%f│Expands to the name of a file containing a message. │
4035 # ├──┼──────────────────────────────────────────────────────────────────────────┤
4036 # │%p│Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty string │
4037 # │ │otherwise. Note: This may be used with a %<...> construct. │
4038 # ├──┼──────────────────────────────────────────────────────────────────────────┤
4039 # │%r│One or more key IDs (or fingerprints if available). │
4040 # ├──┼──────────────────────────────────────────────────────────────────────────┤
4041 # │%s│Expands to the name of a file containing the signature part of a multipart│
4042 # │ │/signed attachment when verifying it. │
4043 # └──┴──────────────────────────────────────────────────────────────────────────┘
4049 # 3.271. pgp_decrypt_command
4054 # This command is used to decrypt a PGP encrypted message.
4056 # This is a format string, see the $pgp_decode_command command for possible
4057 # printf(3)-like sequences. (PGP only)
4059 # Note: When decrypting messages using gpg, a pinentry program needs to be
4060 # invoked unless the password is cached within gpg-agent. Currently, the
4061 # pinentry-tty program (usually distributed with gpg) isn't suitable for being
4062 # invoked by NeoMutt. You are encouraged to use a different pinentry-program when
4063 # running NeoMutt in order to avoid problems.
4065 # See also: https://github.com/neomutt/neomutt/issues/1014
4069 # 3.272. pgp_decryption_okay
4071 # Type: regular expression
4074 # If you assign text to this variable, then an encrypted PGP message is only
4075 # considered successfully decrypted if the output from $pgp_decrypt_command
4076 # contains the text. This is used to protect against a spoofed encrypted message,
4077 # with multipart/encrypted headers but containing a block that is not actually
4078 # encrypted. (e.g. simply signed and ascii armored text).
4080 # Note that if $pgp_check_gpg_decrypt_status_fd is set, this variable is ignored.
4085 # 3.273. pgp_default_key
4090 # This is the default key-pair to use for PGP operations. It will be used for
4091 # encryption (see $postpone_encrypt and $pgp_self_encrypt).
4093 # It will also be used for signing unless $pgp_sign_as is set.
4095 # The (now deprecated) pgp_self_encrypt_as is an alias for this variable, and
4096 # should no longer be used. (PGP only)
4100 # 3.274. pgp_encrypt_only_command
4105 # This command is used to encrypt a body part without signing it.
4107 # This is a format string, see the $pgp_decode_command command for possible
4108 # printf(3)-like sequences. Note that in this case, %r expands to the search
4109 # string, which is a list of one or more quoted values such as email address,
4110 # name, or keyid. (PGP only)
4114 # 3.275. pgp_encrypt_sign_command
4119 # This command is used to both sign and encrypt a body part.
4121 # This is a format string, see the $pgp_decode_command command for possible
4122 # printf(3)-like sequences. (PGP only)
4126 # 3.276. pgp_entry_format
4129 # Default: “%4n %t%f %4l/0x%k %-4a %2c %u”
4131 # This variable allows you to customize the PGP key selection menu to your
4132 # personal taste. If $crypt_use_gpgme is set, then it applies to S/MIME key
4133 # selection menu also. This string is similar to $index_format, but has its own
4134 # set of printf(3)-like sequences:
4136 # ┌──────┬───────────────────────────────────────────────────────────────┐
4138 # ├──────┼───────────────────────────────────────────────────────────────┤
4139 # │%c │Capabilities │
4140 # ├──────┼───────────────────────────────────────────────────────────────┤
4142 # ├──────┼───────────────────────────────────────────────────────────────┤
4143 # │%i │Key fingerprint (or long key id if non-existent) │
4144 # ├──────┼───────────────────────────────────────────────────────────────┤
4146 # ├──────┼───────────────────────────────────────────────────────────────┤
4148 # ├──────┼───────────────────────────────────────────────────────────────┤
4150 # ├──────┼───────────────────────────────────────────────────────────────┤
4152 # ├──────┼───────────────────────────────────────────────────────────────┤
4153 # │%t │Trust/validity of the key-uid association │
4154 # ├──────┼───────────────────────────────────────────────────────────────┤
4156 # ├──────┼───────────────────────────────────────────────────────────────┤
4157 # │%[<s>]│Date of the key where <s> is an strftime(3) expression │
4158 # ├──────┼───────────────────────────────────────────────────────────────┤
4159 # │%>X │Right justify the rest of the string and pad with character "X"│
4160 # ├──────┼───────────────────────────────────────────────────────────────┤
4161 # │%|X │Pad to the end of the line with character "X" │
4162 # ├──────┼───────────────────────────────────────────────────────────────┤
4163 # │%*X │Soft-fill with character "X" as pad │
4164 # └──────┴───────────────────────────────────────────────────────────────┘
4166 # See the section "Sending Cryptographically Signed/Encrypted Messages" of the
4167 # user manual for the meaning of the letters some of these sequences expand to.
4169 # (Crypto only) or (PGP only when GPGME disabled)
4173 # 3.277. pgp_export_command
4178 # This command is used to export a public key from the user's key ring.
4180 # This is a format string, see the $pgp_decode_command command for possible
4181 # printf(3)-like sequences. (PGP only)
4185 # 3.278. pgp_get_keys_command
4190 # This command is invoked whenever NeoMutt needs to fetch the public key
4191 # associated with an email address. Of the sequences supported by
4192 # $pgp_decode_command, %r is the only printf(3)-like sequence used with this
4193 # format. Note that in this case, %r expands to the email address, not the public
4194 # key ID (the key ID is unknown, which is why NeoMutt is invoking this command).
4199 # 3.279. pgp_good_sign
4201 # Type: regular expression
4204 # If you assign a text to this variable, then a PGP signature is only considered
4205 # verified if the output from $pgp_verify_command contains the text. Use this
4206 # variable if the exit code from the command is 0 even for bad signatures. (PGP
4211 # 3.280. pgp_ignore_subkeys
4216 # Setting this variable will cause NeoMutt to ignore OpenPGP subkeys. Instead,
4217 # the principal key will inherit the subkeys' capabilities. Unset this if you
4218 # want to play interesting key selection games. (PGP only)
4222 # 3.281. pgp_import_command
4227 # This command is used to import a key from a message into the user's public key
4230 # This is a format string, see the $pgp_decode_command command for possible
4231 # printf(3)-like sequences. (PGP only)
4235 # 3.282. pgp_list_pubring_command
4240 # This command is used to list the public key ring's contents. The output format
4241 # must be analogous to the one used by
4243 # gpg --list-keys --with-colons --with-fingerprint
4245 # Note: gpg's fixed-list-mode option should not be used. It produces a different
4246 # date format which may result in NeoMutt showing incorrect key generation dates.
4248 # This is a format string, see the $pgp_decode_command command for possible
4249 # printf(3)-like sequences. (PGP only)
4253 # 3.283. pgp_list_secring_command
4258 # This command is used to list the secret key ring's contents. The output format
4259 # must be analogous to the one used by:
4261 # gpg --list-keys --with-colons --with-fingerprint
4263 # Note: gpg's fixed-list-mode option should not be used. It produces a different
4264 # date format which may result in NeoMutt showing incorrect key generation dates.
4266 # This is a format string, see the $pgp_decode_command command for possible
4267 # printf(3)-like sequences. (PGP only)
4271 # 3.284. pgp_key_sort
4276 # Specifies how the entries in the pgp menu are sorted. The following are legal
4279 # ┌───────┬──────────────────────────────┐
4280 # │address│sort alphabetically by user id│
4281 # ├───────┼──────────────────────────────┤
4282 # │keyid │sort alphabetically by key id │
4283 # ├───────┼──────────────────────────────┤
4284 # │date │sort by key creation date │
4285 # ├───────┼──────────────────────────────┤
4286 # │trust │sort by the trust of the key │
4287 # └───────┴──────────────────────────────┘
4289 # If you prefer reverse order of the above values, prefix it with "reverse-".
4294 # 3.285. pgp_long_ids
4299 # If set, use 64 bit PGP key IDs, if unset use the normal 32 bit key IDs. NOTE:
4300 # Internally, NeoMutt has transitioned to using fingerprints (or long key IDs as
4301 # a fallback). This option now only controls the display of key IDs in the key
4302 # selection menu and a few other places. (PGP only)
4306 # 3.286. pgp_mime_auto
4311 # This option controls whether NeoMutt will prompt you for automatically sending
4312 # a (signed/encrypted) message using PGP/MIME when inline (traditional) fails
4315 # Also note that using the old-style PGP message format is strongly deprecated.
4320 # 3.287. pgp_reply_inline
4325 # Setting this variable will cause NeoMutt to always attempt to create an inline
4326 # (traditional) message when replying to a message which is PGP encrypted/signed
4327 # inline. This can be overridden by use of the pgp menu, when inline is not
4328 # required. This option does not automatically detect if the (replied-to) message
4329 # is inline; instead it relies on NeoMutt internals for previously checked/
4332 # Note that NeoMutt might automatically use PGP/MIME for messages which consist
4333 # of more than a single MIME part. NeoMutt can be configured to ask before
4334 # sending PGP/MIME messages when inline (traditional) would not work.
4336 # Also see the $pgp_mime_auto variable.
4338 # Also note that using the old-style PGP message format is strongly deprecated.
4343 # 3.288. pgp_retainable_sigs
4348 # If set, signed and encrypted messages will consist of nested multipart/signed
4349 # and multipart/encrypted body parts.
4351 # This is useful for applications like encrypted and signed mailing lists, where
4352 # the outer layer (multipart/encrypted) can be easily removed, while the inner
4353 # multipart/signed part is retained. (PGP only)
4355 set pgp_retainable_sigs=yes
4358 # 3.289. pgp_self_encrypt
4363 # When set, PGP encrypted messages will also be encrypted using the key in
4364 # $pgp_default_key. (PGP only)
4368 # 3.290. pgp_show_unusable
4373 # If set, NeoMutt will display non-usable keys on the PGP key selection menu.
4374 # This includes keys which have been revoked, have expired, or have been marked
4375 # as "disabled" by the user. (PGP only)
4377 set pgp_show_unusable=no
4380 # 3.291. pgp_sign_as
4385 # If you have a different key pair to use for signing, you should set this to the
4386 # signing key. Most people will only need to set $pgp_default_key. It is
4387 # recommended that you use the keyid form to specify your key (e.g. 0x00112233).
4390 set pgp_sign_as="0x9C9D6979AE941637"
4393 # 3.292. pgp_sign_command
4398 # This command is used to create the detached PGP signature for a multipart/
4399 # signed PGP/MIME body part.
4401 # This is a format string, see the $pgp_decode_command command for possible
4402 # printf(3)-like sequences. (PGP only)
4406 # 3.293. pgp_strict_enc
4411 # If set, NeoMutt will automatically encode PGP/MIME signed messages as
4412 # quoted-printable. Please note that unsetting this variable may lead to problems
4413 # with non-verifyable PGP signatures, so only change this if you know what you
4414 # are doing. (PGP only)
4418 # 3.294. pgp_timeout
4420 # Type: number (long)
4423 # The number of seconds after which a cached passphrase will expire if not used.
4428 # 3.295. pgp_use_gpg_agent
4433 # If set, NeoMutt expects a gpg-agent(1) process will handle private key
4434 # passphrase prompts. If unset, NeoMutt will prompt for the passphrase and pass
4435 # it via stdin to the pgp command.
4437 # Note that as of version 2.1, GnuPG automatically spawns an agent and requires
4438 # the agent be used for passphrase management. Since that version is increasingly
4439 # prevalent, this variable now defaults set.
4441 # NeoMutt works with a GUI or curses pinentry program. A TTY pinentry should not
4444 # If you are using an older version of GnuPG without an agent running, or another
4445 # encryption program without an agent, you will need to unset this variable. (PGP
4448 set pgp_use_gpg_agent=yes
4451 # 3.296. pgp_verify_command
4456 # This command is used to verify PGP signatures.
4458 # This is a format string, see the $pgp_decode_command command for possible
4459 # printf(3)-like sequences. (PGP only)
4463 # 3.297. pgp_verify_key_command
4468 # This command is used to verify key information from the key selection menu.
4470 # This is a format string, see the $pgp_decode_command command for possible
4471 # printf(3)-like sequences. (PGP only)
4475 # 3.298. pipe_decode
4480 # Used in connection with the <pipe-message> function. When unset, NeoMutt will
4481 # pipe the messages without any preprocessing. When set, NeoMutt will attempt to
4482 # decode the messages first.
4484 # Also see $pipe_decode_weed, which controls whether headers will be weeded when
4489 # 3.299. pipe_decode_weed
4494 # For <pipe-message>, when $pipe_decode is set, this further controls whether
4495 # NeoMutt will weed headers.
4504 # The separator to add between messages when piping a list of tagged messages to
4505 # an external Unix command.
4514 # Used in connection with the <pipe-message> function following <tag-prefix>. If
4515 # this variable is unset, when piping a list of tagged messages NeoMutt will
4516 # concatenate the messages and will pipe them all concatenated. When set, NeoMutt
4517 # will pipe the messages one by one. In both cases the messages are piped in the
4518 # current sorted order, and the $pipe_sep separator is added after each message.
4522 # 3.302. pop_auth_try_all
4527 # If set, NeoMutt will try all available authentication methods. When unset,
4528 # NeoMutt will only fall back to other authentication methods if the previous
4529 # methods are unavailable. If a method is available but authentication fails,
4530 # NeoMutt will not connect to the POP server.
4534 # 3.303. pop_authenticators
4539 # This is a colon-separated list of authentication methods NeoMutt may attempt to
4540 # use to log in to an POP server, in the order NeoMutt should try them.
4541 # Authentication methods are either "user", "apop" or any SASL mechanism, e.g.
4542 # "digest-md5", "gssapi" or "cram-md5". This option is case-insensitive. If this
4543 # option is unset (the default) NeoMutt will try all available methods, in order
4544 # from most-secure to least-secure.
4548 # set pop_authenticators="digest-md5:apop:user"
4552 # 3.304. pop_check_interval
4557 # This variable configures how often (in seconds) NeoMutt should look for new
4558 # mail in the currently selected mailbox if it is a POP mailbox.
4567 # If set, NeoMutt will delete successfully downloaded messages from the POP
4568 # server when using the <fetch-mail> function. When unset, NeoMutt will download
4569 # messages but also leave them on the POP server.
4578 # The name of your POP server for the <fetch-mail> function. You can also specify
4579 # an alternative port, username and password, i.e.:
4581 # [pop[s]://][username[:password]@]popserver[:port]
4583 # where "[...]" denotes an optional part.
4592 # If this variable is set, NeoMutt will try to use the "LAST" POP command for
4593 # retrieving only unread messages from the POP server when using the <fetch-mail>
4598 # 3.308. pop_oauth_refresh_command
4603 # The command to run to generate an OAUTH refresh token for authorizing your
4604 # connection to your POP server. This command will be run on every connection
4605 # attempt that uses the OAUTHBEARER authentication mechanism. See "oauth" for
4615 # Specifies the password for your POP account. If unset, NeoMutt will prompt you
4616 # for your password when you open a POP mailbox.
4618 # Warning: you should only use this option when you are on a fairly secure
4619 # machine, because the superuser can read your neomuttrc even if you are the only
4620 # one who can read the file.
4624 # 3.310. pop_reconnect
4629 # Controls whether or not NeoMutt will try to reconnect to the POP server if the
4630 # connection is lost.
4639 # Your login name on the POP server.
4641 # This variable defaults to your user name on the local machine.
4645 # 3.312. post_moderated
4650 # If set to yes, NeoMutt will post article to newsgroup that have not permissions
4651 # to posting (e.g. moderated). Note: if news server does not support posting to
4652 # that newsgroup or totally read-only, that posting will not have an effect.
4661 # Controls whether or not messages are saved in the $postponed mailbox when you
4662 # elect not to send immediately. If set to ask-yes or ask-no, you will be
4663 # prompted with "Save (postpone) draft message?" when quitting from the "compose"
4666 # Also see the $recall variable.
4670 # 3.314. postpone_encrypt
4675 # When set, postponed messages that are marked for encryption will be
4676 # self-encrypted. NeoMutt will first try to encrypt using the value specified in
4677 # $pgp_default_key or $smime_default_key. If those are not set, it will try the
4678 # deprecated $postpone_encrypt_as. (Crypto only)
4682 # 3.315. postpone_encrypt_as
4687 # This is a deprecated fall-back variable for $postpone_encrypt. Please use
4688 # $pgp_default_key or $smime_default_key. (Crypto only)
4695 # Default: “~/postponed”
4697 # NeoMutt allows you to indefinitely "postpone sending a message" which you are
4698 # editing. When you choose to postpone a message, NeoMutt saves it in the mailbox
4699 # specified by this variable.
4701 # Also see the $postpone variable.
4703 set postponed="=drafts"
4711 # If set, a shell command to be executed if NeoMutt fails to establish a
4712 # connection to the server. This is useful for setting up secure connections,
4713 # e.g. with ssh(1). If the command returns a nonzero status, NeoMutt gives up
4714 # opening the server. Example:
4716 # set preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net sleep 20 < /dev/null > /dev/null"
4718 # Mailbox "foo" on "mailhost.net" can now be reached as "{localhost:1234}foo".
4720 # Note: For this example to work, you must be able to log in to the remote
4721 # machine without having to enter a password.
4725 # 3.318. preferred_languages
4730 # This variable specifies a list of comma-separated languages. RFC8255 : user
4731 # preferred languages to be searched in parts and display. Example:
4733 # set preferred_languages="en,fr,de"
4742 # Controls whether or not NeoMutt really prints messages. This is set to "ask-no"
4743 # by default, because some people accidentally hit "p" often.
4747 # 3.320. print_command
4752 # This specifies the command pipe that should be used to print messages.
4754 set print_command="muttprint"
4757 # 3.321. print_decode
4762 # Used in connection with the <print-message> function. If this option is set,
4763 # the message is decoded before it is passed to the external command specified by
4764 # $print_command. If this option is unset, no processing will be applied to the
4765 # message when printing it. The latter setting may be useful if you are using
4766 # some advanced printer filter which is able to properly format e-mail messages
4769 # Also see $print_decode_weed, which controls whether headers will be weeded when
4774 # 3.322. print_decode_weed
4779 # For <print-message>, when $print_decode is set, this further controls whether
4780 # NeoMutt will weed headers.
4784 # 3.323. print_split
4789 # Used in connection with the <print-message> function. If this option is set,
4790 # the command specified by $print_command is executed once for each message which
4791 # is to be printed. If this option is unset, the command specified by
4792 # $print_command is executed only once, and all the messages are concatenated,
4793 # with a form feed as the message separator.
4795 # Those who use the enscript(1) program's mail-printing mode will most likely
4796 # want to set this option.
4801 # 3.324. prompt_after
4806 # If you use an external $pager, setting this variable will cause NeoMutt to
4807 # prompt you for a command when the pager exits rather than returning to the
4808 # index menu. If unset, NeoMutt will return to the index menu when the external
4813 # 3.325. query_command
4818 # This specifies the command NeoMutt will use to make external address queries.
4819 # The string may contain a "%s", which will be substituted with the query string
4820 # the user types. NeoMutt will add quotes around the string substituted for "%s"
4821 # automatically according to shell quoting rules, so you should avoid adding your
4822 # own. If no "%s" is found in the string, NeoMutt will append the user's query to
4823 # the end of the string. See "query" (https://neomutt.org/guide/
4824 # advancedusage.html#query) for more information.
4826 set query_command="lbdbq"
4829 # 3.326. query_format
4832 # Default: “%3i %t %-25N %-25E | %C%> %Y”
4834 # This variable describes the format of the "query" menu. The following printf(3)
4835 # -style sequences are understood:
4837 # ┌───┬─────────────────────────────────────────────────────┐
4838 # │%A │Full Address (Name and Email) │
4839 # ├───┼─────────────────────────────────────────────────────┤
4841 # ├───┼─────────────────────────────────────────────────────┤
4842 # │%E │Email Address │
4843 # ├───┼─────────────────────────────────────────────────────┤
4844 # │%i │Index number │
4845 # ├───┼─────────────────────────────────────────────────────┤
4847 # ├───┼─────────────────────────────────────────────────────┤
4848 # │%t │Alias is tagged (selected) │
4849 # ├───┼─────────────────────────────────────────────────────┤
4850 # │%Y │User-defined tags (labels) │
4851 # ├───┼─────────────────────────────────────────────────────┤
4852 # │%>X│Right justify the rest of the string and pad with "X"│
4853 # ├───┼─────────────────────────────────────────────────────┤
4854 # │%|X│Pad to the end of the line with "X" │
4855 # ├───┼─────────────────────────────────────────────────────┤
4856 # │%*X│Soft-fill with character "X" as pad │
4857 # └───┴─────────────────────────────────────────────────────┘
4859 # For an explanation of "soft-fill", see the $index_format documentation.
4861 # The following sequences are deprecated; they will be removed in the future.
4863 # ┌──┬───────────────┐
4864 # │%a│Use %E instead │
4865 # ├──┼───────────────┤
4866 # │%c│Use %i instead │
4867 # ├──┼───────────────┤
4868 # │%e│Use %C instead │
4869 # ├──┼───────────────┤
4870 # │%n│Use %N instead │
4871 # └──┴───────────────┘
4880 # This variable controls whether "quit" and "exit" actually quit from NeoMutt. If
4881 # this option is set, they do quit, if it is unset, they have no effect, and if
4882 # it is set to ask-yes or ask-no, you are prompted for confirmation when you try
4885 # In order to quit from NeoMutt if this variable is unset, you must send the
4886 # signal SIGINT to NeoMutt. This can usually be achieved by pressing CTRL-C in
4891 # 3.328. quote_regex
4893 # Type: regular expression
4894 # Default: “^([ t]*[|>:}#])+”
4896 # A regular expression used in the internal pager to determine quoted sections of
4897 # text in the body of a message. Quoted text may be filtered out using the
4898 # <toggle-quoted> command, or colored according to the "color quoted" family of
4901 # Higher levels of quoting may be colored differently ("color quoted1", "color
4902 # quoted2", etc.). The quoting level is determined by removing the last character
4903 # from the matched text and recursively reapplying the regular expression until
4904 # it fails to produce a match.
4906 # Match detection may be overridden by the $smileys regular expression.
4915 # If set to a value greater than 0, NeoMutt will display which message it is
4916 # currently on when reading a mailbox or when performing search actions such as
4917 # search and limit. The message is printed after this many messages have been
4918 # read or searched (e.g., if set to 25, NeoMutt will print a message when it is
4919 # at message 25, and then again when it gets to message 50). This variable is
4920 # meant to indicate progress when reading or searching large mailboxes which may
4921 # take some time. When set to 0, only a single message will appear before the
4922 # reading the mailbox.
4924 # Also see the $write_inc, $net_inc and $time_inc variables and the "tuning"
4925 # section of the manual for performance considerations.
4934 # If set, all folders are opened in read-only mode.
4943 # This variable specifies what "real" or "personal" name should be used when
4946 # If not specified, then the user's "real name" will be read from /etc/passwd.
4947 # This option will not be used, if "$from" is set.
4956 # Controls whether or not NeoMutt recalls postponed messages when composing a new
4959 # Setting this variable to yes is not generally useful, and thus not recommended.
4960 # Note that the <recall-message> function can be used to manually recall
4961 # postponed messages.
4963 # Also see $postponed variable.
4973 # This specifies the file into which your outgoing messages should be appended.
4974 # (This is meant as the primary method for saving a copy of your messages, but
4975 # another way to do this is using the "my_hdr" command to create a "Bcc:" field
4976 # with your email address in it.)
4978 # The value of $record is overridden by the $force_name and $save_name variables,
4979 # and the "fcc-hook" command. Also see $copy and $write_bcc.
4984 # 3.334. reflow_space_quotes
4989 # This option controls how quotes from format=flowed messages are displayed in
4990 # the pager and when replying (with $text_flowed unset). When set, this option
4991 # adds spaces after each level of quote marks, turning ">>>foo" into "> > > foo".
4993 # Note: If $reflow_text is unset, this option has no effect. Also, this option
4994 # does not affect replies when $text_flowed is set.
4998 # 3.335. reflow_text
5003 # When set, NeoMutt will reformat paragraphs in text/plain parts marked format=
5004 # flowed. If unset, NeoMutt will display paragraphs unaltered from how they
5005 # appear in the message body. See RFC3676 for details on the format=flowed
5008 # Also see $reflow_wrap, and $wrap.
5012 # 3.336. reflow_wrap
5017 # This variable controls the maximum paragraph width when reformatting text/plain
5018 # parts when $reflow_text is set. When the value is 0, paragraphs will be wrapped
5019 # at the terminal's right margin. A positive value sets the paragraph width
5020 # relative to the left margin. A negative value set the paragraph width relative
5021 # to the right margin.
5023 # Be aware that the reformatted lines of a paragraph are still subject to $wrap.
5024 # This means if $reflow_wrap is 40 and $wrap is 30, then the paragraph gets
5025 # reformatted to 40 characters a line (due to $reflow_wrap) and afterwards each
5026 # 40-character-line is split at 30 characters (due to $wrap), resulting in
5027 # alternating line lengths of 30 and 10 characters.
5034 # 3.337. reply_regex
5036 # Type: regular expression
5037 # Default: “^((re|aw|sv)([[0-9]+])*:[ t]*)*”
5039 # A regular expression used to recognize reply messages when threading and
5040 # replying. The default value corresponds to the standard Latin "Re:" prefix.
5042 # This value may have been localized by the translator for your locale, adding
5043 # other prefixes that are common in the locale. You can add your own prefixes by
5044 # appending inside "^(re)". For example: "^(re|sv)" or "^(re|aw|sv)".
5046 # The second parenthesized expression matches zero or more bracketed numbers
5047 # following the prefix, such as "Re[1]: ". The initial "\[" means a literal
5048 # left-bracket character. Note the backslash must be doubled when used inside a
5049 # double quoted string in the neomuttrc. "[0-9]+" means one or more numbers. "\]
5050 # " means a literal right-bracket. Finally the whole parenthesized expression has
5051 # a "*" suffix, meaning it can occur zero or more times.
5053 # The last part matches a colon followed by an optional space or tab. Note "t"
5054 # is converted to a literal tab inside a double quoted string. If you use a
5055 # single quoted string, you would have to type an actual tab character, and would
5056 # need to convert the double-backslashes to single backslashes.
5058 # Note: the result of this regex match against the subject is stored in the
5059 # header cache. Mutt isn't smart enough to invalidate a header cache entry based
5060 # on changing $reply_regex, so if you aren't seeing correct values in the index,
5061 # try temporarily turning off the header cache. If that fixes the problem, then
5062 # once the variable is set to your liking, remove your stale header cache files
5063 # and turn the header cache back on.
5072 # If unset and you are replying to a message sent by you, NeoMutt will assume
5073 # that you want to reply to the recipients of that message rather than to
5076 # Also see the "alternates" command.
5085 # If set, when replying to a message, NeoMutt will use the address listed in the
5086 # Reply-to: header as the recipient of the reply. If unset, it will use the
5087 # address in the From: header field instead. This option is useful for reading a
5088 # mailing list that sets the Reply-To: header field to the list address and you
5089 # want to send a private message to the author of a message.
5093 # 3.340. reply_with_xorig
5098 # This variable provides a toggle. When active, the From: header will be
5099 # extracted from the current mail's 'X-Original-To:' header. This setting does
5100 # not have precedence over "reverse_real_name".
5102 # Assuming 'fast_reply' is disabled, this option will prompt the user with a
5103 # prefilled From: header.
5112 # When set, the cursor in a list will be automatically advanced to the next
5113 # (possibly undeleted) message/attachment/entry whenever a command that modifies
5114 # the current message/attachment/entry is executed.
5116 # Examples of such commands are tagging a message, deleting an entry, or saving
5121 # 3.342. resume_draft_files
5126 # If set, draft files (specified by -H on the command line) are processed
5127 # similarly to when resuming a postponed message. Recipients are not prompted
5128 # for; send-hooks are not evaluated; no alias expansion takes place; user-defined
5129 # headers and signatures are not added to the message.
5133 # 3.343. resume_edited_draft_files
5138 # If set, draft files previously edited (via -E -H on the command line) will have
5139 # $resume_draft_files automatically set when they are used as a draft file again.
5141 # The first time a draft file is saved, NeoMutt will add a header,
5142 # X-Mutt-Resume-Draft to the saved file. The next time the draft file is read in,
5143 # if NeoMutt sees the header, it will set $resume_draft_files.
5145 # This option is designed to prevent multiple signatures, user-defined headers,
5146 # and other processing effects from being made multiple times to the draft file.
5150 # 3.344. reverse_alias
5155 # This variable controls whether or not NeoMutt will display the "personal" name
5156 # from your aliases in the index menu if it finds an alias that matches the
5157 # message's sender. For example, if you have the following alias:
5159 # alias juser abd30425@somewhere.net (Joe User)
5161 # and then you receive mail which contains the following header:
5163 # From: abd30425@somewhere.net
5165 # It would be displayed in the index menu as "Joe User" instead of
5166 # "abd30425@somewhere.net." This is useful when the person's e-mail address is
5167 # not human friendly.
5171 # 3.345. reverse_name
5176 # It may sometimes arrive that you receive mail to a certain machine, move the
5177 # messages to another machine, and reply to some the messages from there. If this
5178 # variable is set, the default From: line of the reply messages is built using
5179 # the address where you received the messages you are replying to if that address
5180 # matches your "alternates". If the variable is unset, or the address that would
5181 # be used doesn't match your "alternates", the From: line will use your address
5182 # on the current machine.
5184 # Also see the "alternates" command and $reverse_real_name.
5186 set reverse_name=yes
5189 # 3.346. reverse_real_name
5194 # This variable fine-tunes the behavior of the $reverse_name feature.
5196 # When it is unset, NeoMutt will remove the real name part of a matching address.
5197 # This allows the use of the email address without having to also use what the
5198 # sender put in the real name field.
5200 # When it is set, NeoMutt will use the matching address as-is.
5202 # In either case, a missing real name will be filled in afterwards using the
5203 # value of $real_name.
5207 # 3.347. rfc2047_parameters
5212 # When this variable is set, NeoMutt will decode RFC2047-encoded MIME parameters.
5213 # You want to set this variable when NeoMutt suggests you to save attachments to
5216 # =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
5217 # =?utf-8?Q?z=C4=99ta.png?=
5219 # When this variable is set interactively, the change won't be active until you
5222 # Note that this use of RFC2047's encoding is explicitly prohibited by the
5223 # standard, but nevertheless encountered in the wild and produced by, e.g.,
5226 # Also note that setting this parameter will not have the effect that NeoMutt
5227 # generates this kind of encoding. Instead, NeoMutt will unconditionally use the
5228 # encoding specified in RFC2231.
5230 set rfc2047_parameters=yes
5233 # 3.348. save_address
5238 # If set, NeoMutt will take the sender's full address when choosing a default
5239 # folder for saving a mail. If $save_name or $force_name is set too, the
5240 # selection of the Fcc folder will be changed as well.
5249 # When unset, mailboxes which contain no saved messages will be removed when
5250 # closed (the exception is $spool_file which is never removed). If set, mailboxes
5251 # are never removed.
5253 # Note: This only applies to mbox and MMDF folders, NeoMutt does not delete MH
5254 # and Maildir directories.
5258 # 3.350. save_history
5263 # This variable controls the size of the history (per category) saved in the
5264 # $history_file file.
5266 # Setting this to a value greater than $history is possible. However, there will
5267 # never be more than $history entries to select from even if more are recorded in
5270 set save_history=100
5278 # This variable controls how copies of outgoing messages are saved. When set, a
5279 # check is made to see if a mailbox specified by the recipient address exists
5280 # (this is done by searching for a mailbox in the $folder directory with the
5281 # username part of the recipient address). If the mailbox exists, the outgoing
5282 # message will be saved to that mailbox, otherwise the message is saved to the
5285 # Also see the $force_name variable.
5289 # 3.352. save_unsubscribed
5294 # When set, info about unsubscribed newsgroups will be saved into "newsrc" file
5304 # When this variable is unset, scoring is turned off. This can be useful to
5305 # selectively disable scoring for certain folders when the
5306 # $score_threshold_delete variable and related are used.
5310 # 3.354. score_threshold_delete
5315 # Messages which have been assigned a score equal to or lower than the value of
5316 # this variable are automatically marked for deletion by NeoMutt. Since NeoMutt
5317 # scores are always greater than or equal to zero, the default setting of this
5318 # variable will never mark a message for deletion.
5322 # 3.355. score_threshold_flag
5327 # Messages which have been assigned a score greater than or equal to this
5328 # variable's value are automatically marked "flagged".
5332 # 3.356. score_threshold_read
5337 # Messages which have been assigned a score equal to or lower than the value of
5338 # this variable are automatically marked as read by NeoMutt. Since NeoMutt scores
5339 # are always greater than or equal to zero, the default setting of this variable
5340 # will never mark a message read.
5344 # 3.357. search_context
5349 # For the pager, this variable specifies the number of lines shown before search
5350 # results. By default, search results will be top-aligned.
5352 set search_context=5
5355 # 3.358. send_charset
5358 # Default: “us-ascii:iso-8859-1:utf-8”
5360 # A colon-delimited list of character sets for outgoing messages. NeoMutt will
5361 # use the first character set into which the text can be converted exactly. If
5362 # your $charset is not "iso-8859-1" and recipients may not understand "UTF-8", it
5363 # is advisable to include in the list an appropriate widely used standard
5364 # character set (such as "iso-8859-2", "koi8-r" or "iso-2022-jp") either instead
5365 # of or after "iso-8859-1".
5367 # In case the text can't be converted into one of these exactly, NeoMutt uses
5368 # $charset as a fallback.
5370 set send_charset="utf-8"
5376 # Default: “/usr/sbin/sendmail -oem -oi”
5378 # Specifies the program and arguments used to deliver mail sent by NeoMutt.
5379 # NeoMutt expects that the specified program interprets additional arguments as
5380 # recipient addresses. NeoMutt appends all recipients after adding a -- delimiter
5381 # (if not already present). Additional flags, such as for $use_8bit_mime,
5382 # $use_envelope_from, $dsn_notify, or $dsn_return will be added before the
5385 # Note: This command is invoked differently from most other commands in NeoMutt.
5386 # It is tokenized by space, and invoked directly via execvp(3) with an array of
5387 # arguments - so commands or arguments with spaces in them are not supported. The
5388 # shell is not used to run the command, so shell quoting is also not supported.
5390 # See also: $write_bcc.
5392 set sendmail="$my_confdir/sendmail"
5395 # 3.360. sendmail_wait
5400 # Specifies the number of seconds to wait for the $sendmail process to finish
5401 # before giving up and putting delivery in the background.
5403 # NeoMutt interprets the value of this variable as follows:
5405 # ┌──┬──────────────────────────────────────────────────────────────────┐
5406 # │>0│number of seconds to wait for sendmail to finish before continuing│
5407 # ├──┼──────────────────────────────────────────────────────────────────┤
5408 # │0 │wait forever for sendmail to finish │
5409 # ├──┼──────────────────────────────────────────────────────────────────┤
5410 # │<0│always put sendmail in the background without waiting │
5411 # └──┴──────────────────────────────────────────────────────────────────┘
5413 # Note that if you specify a value other than 0, the output of the child process
5414 # will be put in a temporary file. If there is some error, you will be informed
5415 # as to where to find the output.
5422 # Default: “/bin/sh”
5424 # Command to use when spawning a subshell. If not specified, then the user's
5425 # login shell from /etc/passwd is used.
5429 # 3.362. show_multipart_alternative
5434 # When set to info, the multipart/alternative information is shown. When set to
5435 # inline, all of the alternatives are displayed. When not set, the default
5436 # behavior is to show only the chosen alternative.
5440 # 3.363. show_new_news
5445 # If set, news server will be asked for new newsgroups on entering the browser.
5446 # Otherwise, it will be done only once for a news server. Also controls whether
5447 # or not number of new articles of subscribed newsgroups will be then checked.
5451 # 3.364. show_only_unread
5456 # If set, only subscribed newsgroups that contain unread articles will be
5457 # displayed in browser.
5461 # 3.365. sidebar_component_depth
5466 # By default the sidebar will show the mailbox's path, relative to the $folder
5467 # variable. This specifies the number of parent directories to hide from display
5468 # in the sidebar. For example: If a maildir is normally displayed in the sidebar
5469 # as dir1/dir2/dir3/maildir, setting sidebar_component_depth=2 will display it as
5470 # dir3/maildir, having truncated the 2 highest directories.
5472 # See also: $sidebar_short_path
5476 # 3.366. sidebar_delim_chars
5481 # This contains the list of characters which you would like to treat as folder
5482 # separators for displaying paths in the sidebar.
5484 # Local mail is often arranged in directories: 'dir1/dir2/mailbox'.
5486 # set sidebar_delim_chars='/'
5488 # IMAP mailboxes are often named: 'folder1.folder2.mailbox'.
5490 # set sidebar_delim_chars='.'
5492 # See also: $sidebar_short_path, $sidebar_folder_indent, $sidebar_indent_string.
5496 # 3.367. sidebar_divider_char
5501 # The default is a Unicode vertical line.
5503 # This specifies the characters to be drawn between the sidebar (when visible)
5504 # and the other NeoMutt panels. ASCII and Unicode line-drawing characters are
5507 # The divider char can be set to an empty string for some extra space. If empty,
5508 # setting the sidebar_background color may help distinguish the sidebar from
5511 set sidebar_divider_char=" "
5514 # 3.368. sidebar_folder_indent
5519 # Set this to indent mailboxes in the sidebar.
5521 # See also: $sidebar_short_path, $sidebar_indent_string, $sidebar_delim_chars.
5523 set sidebar_folder_indent=yes
5526 # 3.369. sidebar_format
5529 # Default: “%D%* %n”
5531 # This variable allows you to customize the sidebar display. This string is
5532 # similar to $index_format, but has its own set of printf(3)-like sequences:
5534 # ┌───┬──┬──────────────────────────────────────────────────────────────────────┐
5535 # │%a │ │Alert: 1 if user is notified of new mail │
5536 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤
5537 # │%B │ │Name of the mailbox │
5538 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤
5539 # │%d │* │Number of deleted messages in the mailbox │
5541 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤
5542 # │%D │ │Descriptive name of the mailbox │
5543 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤
5544 # │%F │* │Number of flagged messages in the mailbox │
5545 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤
5546 # │%L │* │Number of messages after limiting │
5548 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤
5549 # │%n │ │"N" if mailbox has new mail, " " (space) otherwise │
5550 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤
5551 # │%N │* │Number of unread messages in the mailbox (seen or unseen) │
5552 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤
5553 # │%o │* │Number of old messages in the mailbox (unread, seen) │
5554 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤
5555 # │%p │ │Poll: 1 if Mailbox is checked for new mail │
5556 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤
5557 # │%r │* │Number of read messages in the mailbox (read, seen) │
5558 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤
5559 # │%S │* │Size of mailbox (total number of messages) │
5560 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤
5561 # │%t │* │Number of tagged messages in the mailbox │
5563 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤
5564 # │%Z │* │Number of new messages in the mailbox (unread, unseen) │
5565 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤
5566 # │%! │ │"!" : one flagged message; "!!" : two flagged messages; "n!" : n │
5567 # │ │ │flagged messages (for n > 2). Otherwise prints nothing. │
5568 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤
5569 # │%>X│ │Right justify the rest of the string and pad with "X" │
5570 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤
5571 # │%|X│ │Pad to the end of the line with "X" │
5572 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤
5573 # │%*X│ │Soft-fill with character "X" as pad │
5574 # └───┴──┴──────────────────────────────────────────────────────────────────────┘
5576 # * = Can be optionally printed if nonzero
5578 # @ = Only applicable to the current folder
5580 # In order to use %S, %N, %F, and %!, $mail_check_stats must be set. When thus
5581 # set, a suggested value for this option is "%B%<F? [%F]>%* %<N?%N/>%S".
5583 set sidebar_format="%D%?F? [%F]?%* %?N?%N/?%S"
5586 # 3.370. sidebar_indent_string
5591 # This specifies the string that is used to indent mailboxes in the sidebar. It
5592 # defaults to two spaces.
5594 # See also: $sidebar_short_path, $sidebar_folder_indent, $sidebar_delim_chars.
5596 set sidebar_indent_string=" "
5599 # 3.371. sidebar_new_mail_only
5604 # When set, the sidebar will only display mailboxes containing new, or flagged,
5607 # See also: sidebar_pin, $sidebar_non_empty_mailbox_only.
5611 # 3.372. sidebar_next_new_wrap
5616 # When set, the <sidebar-next-new> command will not stop at the end of the list
5617 # of mailboxes, but wrap around to the beginning. The <sidebar-prev-new> command
5618 # is similarly affected, wrapping around to the end of the list.
5620 set sidebar_next_new_wrap=yes
5623 # 3.373. sidebar_non_empty_mailbox_only
5628 # When set, the sidebar will only display mailboxes that contain one or more
5631 # See also: $sidebar_new_mail_only, sidebar_pin.
5635 # 3.374. sidebar_on_right
5640 # When set, the sidebar will appear on the right-hand side of the screen.
5644 # 3.375. sidebar_short_path
5649 # By default the sidebar will show the mailbox's path, relative to the $folder
5650 # variable. Setting sidebar_shortpath=yes will shorten the names relative to the
5651 # previous name. Here's an example:
5653 # ┌────────────┬─────────────┬───────────────────────────────────────────────┐
5654 # │shortpath=no│shortpath=yes│shortpath=yes, folderindent=yes, indentstr=".."│
5655 # ├────────────┼─────────────┼───────────────────────────────────────────────┤
5656 # │fruit │fruit │fruit │
5657 # ├────────────┼─────────────┼───────────────────────────────────────────────┤
5658 # │fruit.apple │apple │..apple │
5659 # ├────────────┼─────────────┼───────────────────────────────────────────────┤
5660 # │fruit.banana│banana │..banana │
5661 # ├────────────┼─────────────┼───────────────────────────────────────────────┤
5662 # │fruit.cherry│cherry │..cherry │
5663 # └────────────┴─────────────┴───────────────────────────────────────────────┘
5665 # See also: $sidebar_delim_chars, $sidebar_folder_indent, $sidebar_indent_string,
5666 # $sidebar_component_depth.
5668 set sidebar_short_path=no
5671 # 3.376. sidebar_sort
5676 # Specifies how to sort mailbox entries in the sidebar. By default, the entries
5677 # are unsorted. Valid values:
5679 # • count (all message count)
5681 # • desc (mailbox description)
5683 # • flagged (flagged message count)
5685 # • path (alphabetically)
5687 # • unread (unread message count)
5691 # You may optionally use the "reverse-" prefix to specify reverse sorting order
5692 # (example: "set sidebar_sort=reverse-path").
5694 # The alpha and name values are synonyms for path. The new value is a synonym for
5699 # 3.377. sidebar_visible
5704 # This specifies whether or not to show sidebar. The sidebar shows a list of all
5707 # See also: $sidebar_format, $sidebar_width
5709 set sidebar_visible=no
5712 # 3.378. sidebar_width
5717 # This controls the width of the sidebar. It is measured in screen columns. For
5718 # example: sidebar_width=20 could display 20 ASCII characters, or 10 Chinese
5721 set sidebar_width=20
5729 # If set, a line containing "-- " (note the trailing space) will be inserted
5730 # before your $signature. It is strongly recommended that you not unset this
5731 # variable unless your signature contains just your name. The reason for this is
5732 # because many software packages use "-- n" to detect your signature. For
5733 # example, NeoMutt has the ability to highlight the signature in a different
5734 # color in the built-in pager.
5744 # If set, the signature will be included before any quoted or forwarded text. It
5745 # is strongly recommended that you do not set this variable unless you really
5746 # know what you are doing, and are prepared to take some heat from netiquette
5754 # Default: “~/.signature”
5756 # Specifies the filename of your signature, which is appended to all outgoing
5757 # messages. If the filename ends with a pipe ("|"), it is assumed that filename
5758 # is a shell command and input should be read from its standard output.
5762 # 3.382. simple_search
5765 # Default: “~f %s | ~s %s”
5767 # Specifies how NeoMutt should expand a simple search into a real search pattern.
5768 # A simple search is one that does not contain any of the "~" pattern operators.
5769 # See "patterns" for more information on search patterns.
5771 # simple_search applies to several functions, e.g. <delete-pattern>, <limit>,
5772 # searching in the index, and all of the index colors.
5774 # For example, if you simply type "joe" at a search or limit prompt, NeoMutt will
5775 # automatically expand it to the value specified by this variable by replacing
5776 # "%s" with the supplied string. For the default value, "joe" would be expanded
5777 # to: "~f joe | ~s joe".
5779 set simple_search="~L %s | ~s %s"
5782 # 3.383. size_show_bytes
5787 # If set, message sizes will display bytes for values less than 1 kilobyte. See
5788 # formatstrings-size.
5792 # 3.384. size_show_fractions
5797 # If set, message sizes will be displayed with a single decimal value for sizes
5798 # from 0 to 10 kilobytes and 1 to 10 megabytes. See formatstrings-size.
5802 # 3.385. size_show_mb
5807 # If set, message sizes will display megabytes for values greater than or equal
5808 # to 1 megabyte. See formatstrings-size.
5812 # 3.386. size_units_on_left
5817 # If set, message sizes units will be displayed to the left of the number. See
5818 # formatstrings-size.
5827 # Specifies time, in seconds, to pause while displaying certain informational
5828 # messages, while moving from folder to folder and after expunging messages from
5829 # the current folder. The default is to pause one second, so a value of zero for
5830 # this option suppresses the pause.
5839 # Controls the display of lines longer than the screen width in the internal
5840 # pager. If set, long lines are wrapped at a word boundary. If unset, lines are
5841 # simply wrapped at the screen edge. Also see the $markers variable.
5847 # Type: regular expression
5848 # Default: “(>From )|(:[-^]?[][)(><}{|/DP])”
5850 # The pager uses this variable to catch some common false positives of
5851 # $quote_regex, most notably smileys and not consider a line quoted text if it
5852 # also matches $smileys. This mostly happens at the beginning of a line.
5856 # 3.390. smime_ask_cert_label
5861 # This flag controls whether you want to be asked to enter a label for a
5862 # certificate about to be added to the database or not. It is set by default. (S/
5867 # 3.391. smime_ca_location
5872 # This variable contains the name of either a directory, or a file which contains
5873 # trusted certificates for use with OpenSSL. (S/MIME only)
5877 # 3.392. smime_certificates
5882 # Since for S/MIME there is no pubring/secring as with PGP, NeoMutt has to handle
5883 # storage and retrieval of keys by itself. This is very basic right now, and keys
5884 # and certificates are stored in two different directories, both named as the
5885 # hash-value retrieved from OpenSSL. There is an index file which contains
5886 # mailbox-address keyid pairs, and which can be manually edited. This option
5887 # points to the location of the certificates. (S/MIME only)
5889 set smime_certificates="~/.smime/certificates"
5892 # 3.393. smime_decrypt_command
5897 # This format string specifies a command which is used to decrypt application/
5898 # pkcs7-mime attachments.
5900 # The OpenSSL command formats have their own set of printf(3)-like sequences
5903 # ┌──┬──────────────────────────────────────────────────────────────────────────┐
5904 # │%a│The algorithm used for encryption. │
5905 # ├──┼──────────────────────────────────────────────────────────────────────────┤
5906 # │%c│One or more certificate IDs. │
5907 # ├──┼──────────────────────────────────────────────────────────────────────────┤
5908 # │ │CA location: Depending on whether $smime_ca_location points to a directory│
5909 # │%C│or file, this expands to "-CApath $smime_ca_location" or "-CAfile │
5910 # │ │$smime_ca_location". │
5911 # ├──┼──────────────────────────────────────────────────────────────────────────┤
5912 # │%d│The message digest algorithm specified with $smime_sign_digest_alg. │
5913 # ├──┼──────────────────────────────────────────────────────────────────────────┤
5914 # │%f│Expands to the name of a file containing a message. │
5915 # ├──┼──────────────────────────────────────────────────────────────────────────┤
5916 # │%i│Intermediate certificates │
5917 # ├──┼──────────────────────────────────────────────────────────────────────────┤
5918 # │%k│The key-pair specified with $smime_default_key │
5919 # ├──┼──────────────────────────────────────────────────────────────────────────┤
5920 # │%s│Expands to the name of a file containing the signature part of a multipart│
5921 # │ │/signed attachment when verifying it. │
5922 # └──┴──────────────────────────────────────────────────────────────────────────┘
5924 # For examples on how to configure these formats, see the smime.rc in the samples
5925 # / subdirectory which has been installed on your system alongside the
5926 # documentation. (S/MIME only)
5930 # 3.394. smime_decrypt_use_default_key
5935 # If set (default) this tells NeoMutt to use the default key for decryption.
5936 # Otherwise, if managing multiple certificate-key-pairs, NeoMutt will try to use
5937 # the mailbox-address to determine the key to use. It will ask you to supply a
5938 # key, if it can't find one. (S/MIME only)
5942 # 3.395. smime_default_key
5947 # This is the default key-pair to use for S/MIME operations, and must be set to
5948 # the keyid (the hash-value that OpenSSL generates) to work properly.
5950 # It will be used for encryption (see $postpone_encrypt and $smime_self_encrypt).
5951 # If GPGME is enabled, this is the key id displayed by gpgsm.
5953 # It will be used for decryption unless $smime_decrypt_use_default_key is unset.
5955 # It will also be used for signing unless $smime_sign_as is set.
5957 # The (now deprecated) smime_self_encrypt_as is an alias for this variable, and
5958 # should no longer be used. (S/MIME only)
5962 # 3.396. smime_encrypt_command
5967 # This command is used to create encrypted S/MIME messages.
5969 # This is a format string, see the $smime_decrypt_command command for possible
5970 # printf(3)-like sequences. (S/MIME only)
5972 # Encrypt the message to $smime_default_key too. (S/MIME only)
5974 # Note: On Debian systems, this defaults to the first existing file in the
5975 # following list: ~/.smime/ca-certificates.crt ~/.smime/ca-bundle.crt /etc/ssl/
5976 # certs/ca-certificates.crt.
5980 # 3.397. smime_encrypt_with
5985 # This sets the algorithm that should be used for encryption. Valid choices are
5986 # "aes128", "aes192", "aes256", "des", "des3", "rc2-40", "rc2-64", "rc2-128". (S/
5991 # 3.398. smime_get_cert_command
5996 # This command is used to extract X509 certificates from a PKCS7 structure.
5998 # This is a format string, see the $smime_decrypt_command command for possible
5999 # printf(3)-like sequences. (S/MIME only)
6003 # 3.399. smime_get_cert_email_command
6008 # This command is used to extract the mail address(es) used for storing X509
6009 # certificates, and for verification purposes (to check whether the certificate
6010 # was issued for the sender's mailbox).
6012 # This is a format string, see the $smime_decrypt_command command for possible
6013 # printf(3)-like sequences. (S/MIME only)
6017 # 3.400. smime_get_signer_cert_command
6022 # This command is used to extract only the signers X509 certificate from a S/MIME
6023 # signature, so that the certificate's owner may get compared to the email's
6026 # This is a format string, see the $smime_decrypt_command command for possible
6027 # printf(3)-like sequences. (S/MIME only)
6031 # 3.401. smime_import_cert_command
6036 # This command is used to import a certificate via smime_keys.
6038 # This is a format string, see the $smime_decrypt_command command for possible
6039 # printf(3)-like sequences. NOTE: %c and %k will default to $smime_sign_as if
6040 # set, otherwise $smime_default_key. (S/MIME only)
6044 # 3.402. smime_is_default
6049 # The default behavior of NeoMutt is to use PGP on all auto-sign/encryption
6050 # operations. To override and to use OpenSSL instead this must be set. However,
6051 # this has no effect while replying, since NeoMutt will automatically select the
6052 # same application that was used to sign/encrypt the original message. (Note that
6053 # this variable can be overridden by unsetting $crypt_auto_smime.) (S/MIME only)
6062 # Since for S/MIME there is no pubring/secring as with PGP, NeoMutt has to handle
6063 # storage and retrieval of keys/certs by itself. This is very basic right now,
6064 # and stores keys and certificates in two different directories, both named as
6065 # the hash-value retrieved from OpenSSL. There is an index file which contains
6066 # mailbox-address keyid pair, and which can be manually edited. This option
6067 # points to the location of the private keys. (S/MIME only)
6069 set smime_keys="~/.smime/keys"
6072 # 3.404. smime_pk7out_command
6077 # This command is used to extract PKCS7 structures of S/MIME signatures, in order
6078 # to extract the public X509 certificate(s).
6080 # This is a format string, see the $smime_decrypt_command command for possible
6081 # printf(3)-like sequences. (S/MIME only)
6085 # 3.405. smime_self_encrypt
6090 # When set, S/MIME encrypted messages will also be encrypted using the
6091 # certificate in $smime_default_key. (S/MIME only)
6095 # 3.406. smime_sign_as
6100 # If you have a separate key to use for signing, you should set this to the
6101 # signing key. Most people will only need to set $smime_default_key. (S/MIME
6106 # 3.407. smime_sign_command
6111 # This command is used to created S/MIME signatures of type multipart/signed,
6112 # which can be read by all mail clients.
6114 # This is a format string, see the $smime_decrypt_command command for possible
6115 # printf(3)-like sequences. (S/MIME only)
6119 # 3.408. smime_sign_digest_alg
6124 # This sets the algorithm that should be used for the signature message digest.
6125 # Valid choices are "md5", "sha1", "sha224", "sha256", "sha384", "sha512". (S/
6130 # 3.409. smime_timeout
6135 # The number of seconds after which a cached passphrase will expire if not used.
6140 # 3.410. smime_verify_command
6145 # This command is used to verify S/MIME signatures of type multipart/signed.
6147 # This is a format string, see the $smime_decrypt_command command for possible
6148 # printf(3)-like sequences. (S/MIME only)
6152 # 3.411. smime_verify_opaque_command
6157 # This command is used to verify S/MIME signatures of type application/
6160 # This is a format string, see the $smime_decrypt_command command for possible
6161 # printf(3)-like sequences. (S/MIME only)
6165 # 3.412. smtp_authenticators
6170 # This is a colon-separated list of authentication methods NeoMutt may attempt to
6171 # use to log in to an SMTP server, in the order NeoMutt should try them.
6172 # Authentication methods are any SASL mechanism, e.g. "plain", "digest-md5",
6173 # "gssapi" or "cram-md5". This option is case-insensitive. If it is "unset" (the
6174 # default) NeoMutt will try all available methods, in order from most-secure to
6175 # least-secure. Support for the "plain" mechanism is bundled; other mechanisms
6176 # are provided by an external SASL library (look for '+sasl' in the output of
6181 # set smtp_authenticators="digest-md5:cram-md5"
6185 # 3.413. smtp_oauth_refresh_command
6190 # The command to run to generate an OAUTH refresh token for authorizing your
6191 # connection to your SMTP server. This command will be run on every connection
6192 # attempt that uses the OAUTHBEARER or XOAUTH2 authentication mechanisms. See "
6193 # oauth" for details.
6202 # Specifies the password for your SMTP account. If unset, NeoMutt will prompt you
6203 # for your password when you first send mail via SMTP. See $smtp_url to configure
6204 # NeoMutt to send mail via SMTP.
6206 # Warning: you should only use this option when you are on a fairly secure
6207 # machine, because the superuser can read your neomuttrc even if you are the only
6208 # one who can read the file.
6217 # Defines the SMTP smarthost where sent messages should relayed for delivery.
6218 # This should take the form of an SMTP URL, e.g.:
6220 # smtp[s]://[user[:pass]@]host[:port]
6222 # where "[...]" denotes an optional part. Setting this variable overrides the
6223 # value of the $sendmail variable.
6225 # Also see $write_bcc.
6234 # The username for the SMTP server.
6236 # This variable defaults to your user name on the local machine.
6240 # 3.417. socket_timeout
6245 # Causes NeoMutt to timeout any socket connect/read/write operation (for IMAP,
6246 # POP or SMTP) after this many seconds. A negative value causes NeoMutt to wait
6256 # Specifies how to sort messages in the "index" menu. Valid values are:
6280 # You may optionally use the "reverse-" prefix to specify reverse sorting order,
6281 # or the "last-" prefix to sort threads based on the corresponding attribute of
6282 # the last descendant rather than the thread root. If both prefixes are in use,
6283 # "reverse-" must come before "last-". The "last-" prefix has no effect on a flat
6286 # Any ties in the primary sort are broken by $sort_aux. When $use_threads is
6287 # "threads" or "reverse", $sort controls the sorting between threads, and
6288 # $sort_aux controls the sorting within a thread.
6290 # The "date-sent" value is a synonym for "date". The "mailbox-order" value is a
6291 # synonym for "unsorted".
6293 # The values of "threads" and "reverse-threads" are legacy options, which cause
6294 # the value of $sort_aux to also control sorting between threads, and they may
6295 # not be used with the "last-" prefix. The preferred way to enable a threaded
6296 # view is via $use_threads. This variable can also be set via the <sort-mailbox>
6297 # and <sort-reverse> functions.
6299 # Note: When $use_threads is "threads", the last thread sorts to the bottom; when
6300 # it is "reversed", the last thread sorts to the top. The use of "reverse-" in
6301 # $sort swaps which end the last thread will sort to.
6303 # See the "Use Threads Feature" section for further explanation and examples,
6304 # https://neomutt.org/feature/use-threads
6314 # This provides a secondary sort for messages in the "index" menu, used when the
6315 # $sort value is equal for two messages.
6317 # When sorting by threads, this variable controls how subthreads are sorted
6318 # within a single thread (for the order between threads, see $sort). This can be
6319 # set to any value that $sort can, including with the use of "reverse-" and
6320 # "last-" prefixes, except for variations using "threads" (in that case, NeoMutt
6321 # will just use "date"). For instance,
6323 # set sort_aux=last-date-received
6325 # would mean that if a new message is received in a thread, that subthread
6326 # becomes the last one displayed (or the first, if you have "set use_threads=
6327 # reverse".) When using $use_threads, it is more common to use "last-" with $sort
6328 # and not with $sort_aux.
6330 # See the "Use Threads Feature" section for further explanation and examples,
6331 # https://neomutt.org/feature/use-threads
6333 set sort_aux=last-date-received
6341 # This variable is only useful when sorting by threads with $strict_threads unset
6342 # . In that case, it changes the heuristic neomutt uses to thread messages by
6343 # subject. With $sort_re set, neomutt will only attach a message as the child of
6344 # another message by subject if the subject of the child message starts with a
6345 # substring matching the setting of $reply_regex. With $sort_re unset, neomutt
6346 # will attach the message whether or not this is the case, as long as the non-
6347 # $reply_regex parts of both messages are identical.
6351 # 3.421. spam_separator
6356 # This variable controls what happens when multiple spam headers are matched: if
6357 # unset, each successive header will overwrite any previous matches value for the
6358 # spam label. If set, each successive match will append to the previous, using
6359 # this variable's value as a separator.
6368 # If your spool mailbox is in a non-default place where NeoMutt can't find it,
6369 # you can specify its location with this variable. The description from
6370 # "named-mailboxes" or "virtual-mailboxes" may be used for the spool_file.
6372 # If not specified, then the environment variables $MAIL and $MAILDIR will be
6375 set spool_file="=inbox"
6378 # 3.423. ssl_ca_certificates_file
6383 # This variable specifies a file containing trusted CA certificates. Any server
6384 # certificate that is signed with one of these CA certificates is also
6385 # automatically accepted. (GnuTLS only)
6389 # set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
6391 set ssl_ca_certificates_file="/etc/ssl/certs/ca-certificates.crt"
6394 # 3.424. ssl_ciphers
6399 # Contains a colon-separated list of ciphers to use when using SSL. For OpenSSL,
6400 # see ciphers(1) for the syntax of the string.
6402 # For GnuTLS, this option will be used in place of "NORMAL" at the start of the
6403 # priority string. See gnutls_priority_init(3) for the syntax and more details.
6404 # (Note: GnuTLS version 2.1.7 or higher is required.)
6408 # 3.425. ssl_client_cert
6413 # The file containing a client certificate and its associated private key.
6417 # 3.426. ssl_force_tls
6422 # If this variable is set, NeoMutt will require that all connections to remote
6423 # servers be encrypted. Furthermore it will attempt to negotiate TLS even if the
6424 # server does not advertise the capability, since it would otherwise have to
6425 # abort the connection anyway. This option supersedes $ssl_starttls.
6429 # 3.427. ssl_min_dh_prime_bits
6434 # This variable specifies the minimum acceptable prime size (in bits) for use in
6435 # any Diffie-Hellman key exchange. A value of 0 will use the default from the
6436 # GNUTLS library. (GnuTLS only)
6440 # 3.428. ssl_starttls
6445 # If set (the default), NeoMutt will attempt to use STARTTLS on servers
6446 # advertising the capability. When unset, NeoMutt will not attempt to use
6447 # STARTTLS regardless of the server's capabilities.
6449 # Note that STARTTLS is subject to many kinds of attacks, including the ability
6450 # of a machine-in-the-middle to suppress the advertising of support. Setting
6451 # $ssl_force_tls is recommended if you rely on STARTTLS.
6455 # 3.429. ssl_use_sslv2
6460 # If set , NeoMutt will use SSLv2 when communicating with servers that request
6461 # it. N.B. As of 2011, SSLv2 is considered insecure, and using is inadvisable.
6462 # See https://tools.ietf.org/html/rfc6176 (OpenSSL only)
6466 # 3.430. ssl_use_sslv3
6471 # If set , NeoMutt will use SSLv3 when communicating with servers that request
6472 # it. N.B. As of 2015, SSLv3 is considered insecure, and using it is inadvisable.
6473 # See https://tools.ietf.org/html/rfc7525
6477 # 3.431. ssl_use_system_certs
6482 # If set to yes, NeoMutt will use CA certificates in the system-wide certificate
6483 # store when checking if a server certificate is signed by a trusted CA. (OpenSSL
6488 # 3.432. ssl_use_tlsv1
6493 # If set , NeoMutt will use TLSv1.0 when communicating with servers that request
6494 # it. N.B. As of 2015, TLSv1.0 is considered insecure, and using it is
6495 # inadvisable. See https://tools.ietf.org/html/rfc7525
6499 # 3.433. ssl_use_tlsv1_1
6504 # If set , NeoMutt will use TLSv1.1 when communicating with servers that request
6505 # it. N.B. As of 2015, TLSv1.1 is considered insecure, and using it is
6506 # inadvisable. See https://tools.ietf.org/html/rfc7525
6510 # 3.434. ssl_use_tlsv1_2
6515 # If set , NeoMutt will use TLSv1.2 when communicating with servers that request
6520 # 3.435. ssl_use_tlsv1_3
6525 # If set , NeoMutt will use TLSv1.3 when communicating with servers that request
6530 # 3.436. ssl_verify_dates
6535 # If set (the default), NeoMutt will not automatically accept a server
6536 # certificate that is either not yet valid or already expired. You should only
6537 # unset this for particular known hosts, using the <account-hook> function.
6541 # 3.437. ssl_verify_host
6546 # If set (the default), NeoMutt will not automatically accept a server
6547 # certificate whose host name does not match the host used in your folder URL.
6548 # You should only unset this for particular known hosts, using the <account-hook>
6553 # 3.438. ssl_verify_partial_chains
6558 # This option should not be changed from the default unless you understand what
6561 # Setting this variable to yes will permit verifying partial certification
6562 # chains, i. e. a certificate chain where not the root, but an intermediate
6563 # certificate CA, or the host certificate, are marked trusted (in
6564 # $certificate_file), without marking the root signing CA as trusted.
6566 # (OpenSSL 1.0.2b and newer only).
6570 # 3.439. status_chars
6572 # Type: character string
6575 # Controls the characters used by the "%r" indicator in $status_format.
6577 # ┌─────────┬───────┬───────────────────────────────────────────────────────────┐
6578 # │Character│Default│Description │
6579 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤
6580 # │1 │- │Mailbox is unchanged │
6581 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤
6582 # │2 │* │Mailbox has been changed and needs to be resynchronized │
6583 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤
6584 # │ │ │Mailbox is read-only, or will not be written when exiting. │
6585 # │3 │% │(You can toggle whether to write changes to a mailbox with │
6586 # │ │ │the <toggle-write> operation, bound by default to "%") │
6587 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤
6588 # │ │ │Folder opened in attach-message mode. (Certain operations │
6589 # │4 │A │like composing a new mail, replying, forwarding, etc. are │
6590 # │ │ │not permitted in this mode) │
6591 # └─────────┴───────┴───────────────────────────────────────────────────────────┘
6595 # 3.440. status_format
6598 # Default: “-%r-NeoMutt: %D [Msgs:%<M?%M/>%m%<n? New:%n>%<o? Old:%o>%<d? Del:%d>%
6599 # <F? Flag:%F>%<t? Tag:%t>%<p? Post:%p>%<b? Inc:%b>%<l? %l>]---(%<T?%T/>%s/%S)-%>
6602 # Controls the format of the status line displayed in the "index" menu. This
6603 # string is similar to $index_format, but has its own set of printf(3)-like
6606 # ┌───┬─┬───────────────────────────────────────────────────────────────────────┐
6607 # │%b │*│Number of mailboxes with new mail │
6608 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6609 # │%d │*│Number of deleted messages │
6610 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6611 # │%D │ │Description of the mailbox │
6612 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6613 # │%f │ │The full pathname of the current mailbox │
6614 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6615 # │%F │*│Number of flagged messages │
6616 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6617 # │%h │ │Local hostname │
6618 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6619 # │%l │*│Size (in bytes) of the current mailbox (see formatstrings-size) │
6620 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6621 # │%L │*│Size (in bytes) of the messages shown (i.e., which match the current │
6622 # │ │ │limit) (see formatstrings-size) │
6623 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6624 # │%m │*│The number of messages in the mailbox │
6625 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6626 # │%M │*│The number of messages shown (i.e., which match the current limit) │
6627 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6628 # │%n │*│Number of new messages in the mailbox (unread, unseen) │
6629 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6630 # │%o │*│Number of old messages in the mailbox (unread, seen) │
6631 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6632 # │%p │*│Number of postponed messages │
6633 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6634 # │%P │ │Percentage of the way through the index │
6635 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6636 # │%r │ │Modified/read-only/won't-write/attach-message indicator, According to │
6637 # │ │ │$status_chars │
6638 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6639 # │%R │*│Number of read messages in the mailbox (read, seen) │
6640 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6641 # │%s │ │Current sorting mode ($sort) │
6642 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6643 # │%S │ │Current aux sorting method ($sort_aux) │
6644 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6645 # │%t │*│Number of tagged messages in the mailbox │
6646 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6647 # │%T │*│Current threading mode ($use_threads) │
6648 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6649 # │%u │*│Number of unread messages in the mailbox (seen or unseen) │
6650 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6651 # │%v │ │NeoMutt version string │
6652 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6653 # │%V │*│Currently active limit pattern, if any │
6654 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6655 # │%>X│ │Right justify the rest of the string and pad with "X" │
6656 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6657 # │%|X│ │Pad to the end of the line with "X" │
6658 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤
6659 # │%*X│ │Soft-fill with character "X" as pad │
6660 # └───┴─┴───────────────────────────────────────────────────────────────────────┘
6662 # For an explanation of "soft-fill", see the $index_format documentation.
6664 # * = can be optionally printed if nonzero
6666 # Some of the above sequences can be used to optionally print a string if their
6667 # value is nonzero. For example, you may only want to see the number of flagged
6668 # messages if such messages exist, since zero is not particularly meaningful. To
6669 # optionally print a string based upon one of the above sequences, the following
6670 # construct is used:
6672 # %<sequence_char?optional_string>
6674 # where sequence_char is a character from the table above, and optional_string is
6675 # the string you would like printed if sequence_char is nonzero. optional_string
6676 # may contain other sequences as well as normal text.
6678 # Here is an example illustrating how to optionally print the number of new
6679 # messages in a mailbox:
6681 # %<n?%n new messages>
6683 # You can also switch between two strings using the following construct:
6685 # %<sequence_char?if_string&else_string>
6687 # If the value of sequence_char is non-zero, if_string will be expanded,
6688 # otherwise else_string will be expanded.
6690 # As another example, here is how to show either $sort and $sort_aux or
6691 # $use_threads and $sort, based on whether threads are enabled with $use_threads:
6695 # You can force the result of any printf(3)-like sequence to be lowercase by
6696 # prefixing the sequence character with an underscore ("_") sign. For example, if
6697 # you want to display the local hostname in lowercase, you would use: "%_h".
6699 # If you prefix the sequence character with a colon (":") character, NeoMutt will
6700 # replace any dots in the expansion by underscores. This might be helpful with
6701 # IMAP folders that don't like dots in folder names.
6703 set status_format=" %r %f [m:%?M?%M/?%m%?n? n:%n?%?o? o:%o?%?d? d:%d?%?F? f:%F?%?t? t:%t?%?p? p:%p?%?b? i:%b?%?l? %l?] %?V?%V ?(%s/%S) %> (%P) "
6706 # 3.441. status_on_top
6711 # Setting this variable causes the "status bar" to be displayed on the first line
6712 # of the screen rather than near the bottom. If $help is set too, it'll be placed
6717 # 3.442. strict_threads
6722 # If set, threading will only make use of the "In-Reply-To" and "References:"
6723 # fields when you $sort by message threads. By default, messages with the same
6724 # subject are grouped together in "pseudo threads.". This may not always be
6725 # desirable, such as in a personal mailbox where you might have several unrelated
6726 # messages with the subjects like "hi" which will get grouped together. See also
6727 # $sort_re for a less drastic way of controlling this behavior.
6729 set strict_threads=yes
6737 # When unset, NeoMutt won't stop when the user presses the terminal's susp key,
6738 # usually "^Z". This is useful if you run NeoMutt inside an xterm using a command
6739 # like "xterm -e neomutt".
6741 # On startup NeoMutt tries to detect if it is the process session leader. If so,
6742 # the default of suspend is "no" otherwise "yes". This default covers the above
6743 # mentioned use case of "xterm -e neomutt".
6747 # 3.444. text_flowed
6752 # When set, NeoMutt will generate "format=flowed" bodies with a content type of
6753 # "text/plain; format=flowed". This format is easier to handle for some mailing
6754 # software, and generally just looks like ordinary text. To actually make use of
6755 # this format's features, you'll need support in your editor.
6757 # The option only controls newly composed messages. Postponed messages, resent
6758 # messages, and draft messages (via -H on the command line) will use the
6759 # content-type of the source message.
6761 # Note that $indent_string is ignored when this option is set.
6766 # 3.445. thorough_search
6771 # Affects the ~b, ~B, and ~h search operations described in section "patterns".
6772 # If set, the headers and body/attachments of messages to be searched are decoded
6773 # before searching. If unset, messages are searched as they appear in the folder.
6775 # Users searching attachments or for non-ASCII characters should set this value
6776 # because decoding also includes MIME parsing/decoding and possible character set
6777 # conversions. Otherwise NeoMutt will attempt to match against the raw message
6778 # received (for example quoted-printable encoded or with encoded headers) which
6779 # may lead to incorrect search results.
6781 set thorough_search=yes
6784 # 3.446. thread_received
6789 # If $strict_threads is unset, then messages may also be grouped by subject.
6790 # Unlike threading by "In-Reply-To:" and "References:" header, grouping by
6791 # subject does not imply a parent-child relation between two messages.
6793 # To determine the ancestry between messages grouped by subject, Neomutt uses
6794 # their date: only newer messages can be descendants of older ones.
6796 # When $thread_received is set, NeoMutt uses the date received rather than the
6797 # date sent when comparing messages for the date.
6799 # See also $strict_threads, and $sort_re.
6801 set thread_received=yes
6809 # When set, the internal-pager will pad blank lines to the bottom of the screen
6810 # with a tilde ("~").
6820 # Along with $read_inc, $write_inc, and $net_inc, this variable controls the
6821 # frequency with which progress updates are displayed. It suppresses updates less
6822 # than $time_inc milliseconds apart. This can improve throughput on systems with
6823 # slow terminals, or when running NeoMutt on a remote system.
6825 # Also see the "tuning" section of the manual for performance considerations.
6835 # When NeoMutt is waiting for user input either idling in menus or in an
6836 # interactive prompt, NeoMutt would block until input is present. Depending on
6837 # the context, this would prevent certain operations from working, like checking
6838 # for new mail or keeping an IMAP connection alive.
6840 # This variable controls how many seconds NeoMutt will at most wait until it
6841 # aborts waiting for input, performs these operations and continues to wait for
6844 # A value of zero or less will cause NeoMutt to never time out.
6853 # This variable allows you to specify where NeoMutt will place its temporary
6854 # files needed for displaying and composing messages.
6856 # If this variable is not set, the environment variable $TMPDIR is used. Failing
6857 # that, then "/tmp" is used.
6863 # Type: character string
6864 # Default: “ +TCFLR”
6866 # Controls the character used to indicate mail addressed to you.
6868 # ┌─────────┬───────┬───────────────────────────────────────────────────────────┐
6869 # │Character│Default│Description │
6870 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤
6871 # │1 │<space>│The mail is not addressed to your address. │
6872 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤
6873 # │2 │+ │You are the only recipient of the message. │
6874 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤
6875 # │3 │T │Your address appears in the "To:" header field, but you are│
6876 # │ │ │not the only recipient of the message. │
6877 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤
6878 # │4 │C │Your address is specified in the "Cc:" header field, but │
6879 # │ │ │you are not the only recipient. │
6880 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤
6881 # │5 │F │Indicates the mail that was sent by you. │
6882 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤
6883 # │6 │L │Indicates the mail was sent to a mailing-list you subscribe│
6885 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤
6886 # │7 │R │Your address appears in the "Reply-To:" header field but │
6887 # │ │ │none of the above applies. │
6888 # └─────────┴───────┴───────────────────────────────────────────────────────────┘
6892 # 3.452. toggle_quoted_show_levels
6897 # Quoted text may be filtered out using the <toggle-quoted> command. If set to a
6898 # number greater than 0, then the <toggle-quoted> command will only filter out
6899 # quote levels above this number.
6908 # If set, this variable specifies the path of the trash folder where the mails
6909 # marked for deletion will be moved, instead of being irremediably purged.
6911 # NOTE: When you delete a message in the trash folder, it is really deleted, so
6912 # that you have a way to clean the trash.
6921 # Controls whether NeoMutt tries to set the terminal status line and icon name.
6922 # Most terminal emulators emulate the status line in the window title.
6927 # 3.455. ts_icon_format
6930 # Default: “M%<n?AIL&ail>”
6932 # Controls the format of the icon title, as long as "$ts_enabled" is set. This
6933 # string is identical in formatting to the one used by "$status_format".
6937 # 3.456. ts_status_format
6940 # Default: “NeoMutt with %<m?%m messages&no messages>%<n? [%n NEW]>”
6942 # Controls the format of the terminal status line (or window title), provided
6943 # that "$ts_enabled" has been set. This string is identical in formatting to the
6944 # one used by "$status_format".
6946 set ts_status_format="[`tty|sed -re 's,.+pts/,,'`]mutt@%h%r %f%?V?[%V]&?"
6954 # Setting this variable will cause NeoMutt to open a pipe to a command instead of
6955 # a raw socket. You may be able to use this to set up preauthenticated
6956 # connections to your IMAP/POP3/SMTP server. Example:
6958 # set tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
6960 # Note: For this example to work you must be able to log in to the remote machine
6961 # without having to enter a password.
6963 # When set, NeoMutt uses the tunnel for all remote connections. Please see "
6964 # account-hook" in the manual for how to use different tunnel commands per
6969 # 3.458. tunnel_is_secure
6974 # When set, NeoMutt will assume the $tunnel connection does not need STARTTLS to
6975 # be enabled. It will also allow IMAP PREAUTH server responses inside a tunnel to
6976 # proceed. This is appropriate if $tunnel uses ssh or directly invokes the server
6979 # When unset, NeoMutt will negotiate STARTTLS according to the ssl_starttls and
6980 # ssl_force_tls variables. If ssl_force_tls is set, NeoMutt will abort connecting
6981 # if an IMAP server responds with PREAUTH. This setting is appropriate if $tunnel
6982 # does not provide security and could be tampered with by attackers.
6986 # 3.459. uncollapse_jump
6991 # When set, NeoMutt will jump to the next unread message, if any, when the
6992 # current thread is uncollapsed.
6996 # 3.460. uncollapse_new
7001 # When set, NeoMutt will automatically uncollapse any collapsed thread that
7002 # receives a newly delivered message. When unset, collapsed threads will remain
7003 # collapsed. The presence of the newly delivered message will still affect index
7008 # 3.461. use_8bit_mime
7013 # Warning: do not set this variable unless you are using a version of sendmail
7014 # which supports the -B8BITMIME flag (such as sendmail 8.8.x) or you may not be
7015 # able to send mail.
7017 # When set, NeoMutt will invoke $sendmail with the -B8BITMIME flag when sending
7018 # 8-bit messages to enable ESMTP negotiation.
7027 # When set, NeoMutt will qualify all local addresses (ones without the "@host"
7028 # portion) with the value of $hostname. If unset, no addresses will be qualified.
7032 # 3.463. use_envelope_from
7037 # When set, NeoMutt will set the envelope sender of the message. If
7038 # $envelope_from_address is set, it will be used as the sender address. If unset,
7039 # NeoMutt will attempt to derive the sender from the "From:" header.
7041 # Note that this information is passed to sendmail command using the -f command
7042 # line switch. Therefore setting this option is not useful if the $sendmail
7043 # variable already contains -f or if the executable pointed to by $sendmail
7044 # doesn't support the -f switch.
7046 set use_envelope_from=yes
7054 # When set, NeoMutt will generate the "From:" header field when sending messages.
7055 # If unset, no "From:" header field will be generated unless the user explicitly
7056 # sets one using the "my_hdr" command.
7065 # When set, NeoMutt will look for IPv6 addresses of hosts it tries to contact. If
7066 # this option is unset, NeoMutt will restrict itself to IPv4 addresses. Normally,
7067 # the default should work.
7071 # 3.466. use_threads
7076 # The style of threading used in the index. May be one of "flat" (no threading),
7077 # "threads" (threaded, with subthreads below root message) or "reverse"
7078 # (threaded, with subthreads above root message). For convenience, the value
7079 # "yes" is a synonym for "threads", and "no" is a synonym for "flat".
7081 # If this variable is never set, then $sort controls whether threading is used,
7082 # $sort_aux controls both the sorting of threads and subthreads, and using
7083 # <sort-mailbox> to select threads affects only $sort. Once this variable is set,
7084 # attempting to set $sort to a value using "threads" will warn, the value of
7085 # $sort controls the sorting between threads while $sort_aux controls sorting
7086 # within a thread, and <sort-mailbox> toggles $use_threads.
7090 # set use_threads=yes
7092 # See the "Use Threads Feature" section for further explanation and examples.
7094 # Note: On Debian systems, this option is set by default to “threads” in /etc/
7104 # When set, NeoMutt will add a "User-Agent:" header to outgoing messages,
7105 # indicating which version of NeoMutt was used for composing them.
7109 # 3.468. virtual_spool_file
7114 # This command is now unnecessary. $spool_file has been extended to support
7115 # mailbox descriptions as a value.
7117 # When set, NeoMutt will use the first defined virtual mailbox (see
7118 # virtual-mailboxes) as a spool file.
7127 # Controls whether NeoMutt will ask you to press a key after an external command
7128 # has been invoked by these functions: <shell-escape>, <pipe-message>,
7129 # <pipe-entry>, <print-message>, and <print-entry> commands.
7131 # It is also used when viewing attachments with "auto_view", provided that the
7132 # corresponding mailcap entry has a needsterminal flag, and the external program
7135 # When set, NeoMutt will always ask for a key. When unset, NeoMutt will wait for
7136 # a key only if the external command returned a non-zero status.
7146 # When set, NeoMutt will weed headers when displaying, forwarding, or replying to
7149 # Also see $copy_decode_weed, $pipe_decode_weed, $print_decode_weed.
7158 # When set to a positive value, NeoMutt will wrap text at $wrap characters. When
7159 # set to a negative value, NeoMutt will wrap text so that there are $wrap
7160 # characters of empty space on the right side of the terminal. Setting it to zero
7161 # makes NeoMutt wrap at the terminal width.
7163 # Also see $reflow_wrap.
7165 set wrap=$reflow_wrap
7168 # 3.472. wrap_headers
7173 # This option specifies the number of characters to use for wrapping an outgoing
7174 # message's headers. Allowed values are between 78 and 998 inclusive.
7176 # Note: This option usually shouldn't be changed. RFC5233 recommends a line
7177 # length of 78 (the default), so please only change this setting when you know
7178 # what you're doing.
7182 # 3.473. wrap_search
7187 # Controls whether searches wrap around the end.
7189 # When set, searches will wrap around the first (or last) item. When unset,
7190 # incremental searches will not wrap.
7199 # Controls whether NeoMutt writes out the "Bcc:" header when preparing messages
7200 # to be sent. Some MTAs, such as Exim and Courier, do not strip the "Bcc:"
7201 # header; so it is advisable to leave this unset unless you have a particular
7202 # need for the header to be in the sent message.
7204 # If NeoMutt is set to deliver directly via SMTP(see $smtp_url), this option does
7205 # nothing: NeoMutt will never write out the "Bcc:" header in this case.
7207 # Note this option only affects the sending of messages. Fcc'ed copies of a
7208 # message will always contain the "Bcc:" header if one exists.
7210 # Note: On Debian systems, exim4 and postfix strip BCC headers by default. The
7211 # above warning applies to exim3 users, see /etc/neomuttrc.
7220 # When writing a mailbox, a message will be printed every $write_inc messages to
7221 # indicate progress. If set to 0, only a single message will be displayed before
7222 # writing a mailbox.
7224 # Also see the $read_inc, $net_inc and $time_inc variables and the "tuning"
7225 # section of the manual for performance considerations.
7229 # 3.476. x_comment_to
7234 # If set, NeoMutt will add "X-Comment-To:" field (that contains full name of
7235 # original article author) to article that followuped to newsgroup.
7238 # vim:sw=12:noet:sts=12:ts=12:ft=muttrc