]> git.madduck.net Git - etc/neomutt.git/blob - .config/neomutt/confvars

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

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.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

import of config from mutt
[etc/neomutt.git] / .config / neomutt / confvars
1 # Auto-generated using mkconf from manual.txt
2 # on 2023-08-11 16:33:16
3 #
4 # Invoked as: ./mkconf
5 #
6
7 # 3.1. abort_backspace
8
9 # Type: boolean
10 # Default: yes
11
12 # If set, hitting backspace against an empty prompt aborts the prompt.
13
14
15
16 # 3.2. abort_key
17
18 # Type: string
19 # Default: “007”
20
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.
25
26 # Example: 
27
28 # set abort_key = "<Esc>"
29
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.
35
36
37
38 # 3.3. abort_noattach
39
40 # Type: quadoption
41 # Default: no
42
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
46 # aborted. 
47
48 # Example: 
49
50 # set abort_noattach_regex = "\<attach(|ed|ments?)\>"
51
52 set abort_noattach=ask-yes
53
54
55 # 3.4. abort_noattach_regex
56
57 # Type: regular expression
58 # Default: “<(attach|attached|attachments?)>”
59
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
63 # be aborted.
64
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
67 # otherwise. 
68
69
70
71 # 3.5. abort_nosubject
72
73 # Type: quadoption
74 # Default: ask-yes
75
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.
79
80
81
82 # 3.6. abort_unmodified
83
84 # Type: quadoption
85 # Default: yes
86
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.
90
91
92
93 # 3.7. alias_file
94
95 # Type: path
96 # Default: “~/.neomuttrc”
97
98 # The default file in which to save aliases created by the <create-alias>
99 # function. Entries added to this file are encoded in the character set specified
100 # by $config_charset if it is set or the current character set otherwise.
101
102 # Note: NeoMutt will not automatically source this file; you must explicitly use
103 # the "source" command for it to be executed in case this option points to a
104 # dedicated alias file.
105
106 # The default for this option is the currently used neomuttrc file, or "~
107 # /.neomuttrc" if no user neomuttrc was found.
108
109 set alias_file="$my_confdir/aliases"
110
111
112 # 3.8. alias_format
113
114 # Type: string
115 # Default: “%3n %f%t %-15a %-56r | %c”
116
117 # Specifies the format of the data displayed for the "alias" menu. The following
118 # printf(3)-style sequences are available:
119
120 # ┌───┬───────────────────────────────────────────────────────────────┐ 
121 # │%a │Alias name                                                     │
122 # ├───┼───────────────────────────────────────────────────────────────┤ 
123 # │%c │Comment                                                        │
124 # ├───┼───────────────────────────────────────────────────────────────┤ 
125 # │%f │Flags - currently, a "d" for an alias marked for deletion      │
126 # ├───┼───────────────────────────────────────────────────────────────┤ 
127 # │%n │Index number                                                   │
128 # ├───┼───────────────────────────────────────────────────────────────┤ 
129 # │%r │Address which alias expands to                                 │
130 # ├───┼───────────────────────────────────────────────────────────────┤ 
131 # │%t │Character which indicates if the alias is tagged for inclusion │
132 # ├───┼───────────────────────────────────────────────────────────────┤ 
133 # │%>X│right justify the rest of the string and pad with character "X"│
134 # ├───┼───────────────────────────────────────────────────────────────┤ 
135 # │%|X│pad to the end of the line with character "X"                  │
136 # ├───┼───────────────────────────────────────────────────────────────┤ 
137 # │%*X│soft-fill with character "X" as pad                            │
138 # └───┴───────────────────────────────────────────────────────────────┘ 
139
140
141
142 # 3.9. allow_8bit
143
144 # Type: boolean
145 # Default: yes
146
147 # Controls whether 8-bit data is converted to 7-bit using either Quoted-
148 # Printable or Base64 encoding when sending mail.
149
150
151
152 # 3.10. allow_ansi
153
154 # Type: boolean
155 # Default: no
156
157 # Controls whether ANSI color codes in messages (and color tags in rich text
158 # messages) are to be interpreted. Messages containing these codes are rare, but
159 # if this option is set, their text will be colored accordingly. Note that this
160 # may override your color choices, and even present a security problem, since a
161 # message could include a line like
162
163 # [-- PGP output follows ...
164
165 # and give it the same color as your attachment color (see also $crypt_timestamp
166 # ). 
167
168
169
170 # 3.11. arrow_cursor
171
172 # Type: boolean
173 # Default: no
174
175 # When set, an arrow ("->") will be used to indicate the current entry in menus
176 # instead of highlighting the whole line. On slow network or modem links this
177 # will make response faster because there is less that has to be redrawn on the
178 # screen when moving to the next or previous entries in the menu.
179
180
181
182 # 3.12. arrow_string
183
184 # Type: string
185 # Default: “->”
186
187 # Specifies the string of arrow_cursor when arrow_cursor enabled.
188
189
190
191 # 3.13. ascii_chars
192
193 # Type: boolean
194 # Default: no
195
196 # If set, NeoMutt will use plain ASCII characters when displaying thread and
197 # attachment trees, instead of the default ACS characters.
198
199
200
201 # 3.14. ask_bcc
202
203 # Type: boolean
204 # Default: no
205
206 # If set, NeoMutt will prompt you for blind-carbon-copy (Bcc) recipients before
207 # editing an outgoing message.
208
209
210
211 # 3.15. ask_cc
212
213 # Type: boolean
214 # Default: no
215
216 # If set, NeoMutt will prompt you for carbon-copy (Cc) recipients before editing
217 # the body of an outgoing message.
218
219
220
221 # 3.16. ask_follow_up
222
223 # Type: boolean
224 # Default: no
225
226 # If set, NeoMutt will prompt you for follow-up groups before editing the body of
227 # an outgoing message.
228
229
230
231 # 3.17. ask_x_comment_to
232
233 # Type: boolean
234 # Default: no
235
236 # If set, NeoMutt will prompt you for x-comment-to field before editing the body
237 # of an outgoing message.
238
239
240
241 # 3.18. assumed_charset
242
243 # Type: string
244 # Default: (empty)
245
246 # This variable is a colon-separated list of character encoding schemes for
247 # messages without character encoding indication. Header field values and message
248 # body content without character encoding indication would be assumed that they
249 # are written in one of this list. By default, all the header fields and message
250 # body without any charset indication are assumed to be in "us-ascii".
251
252 # For example, Japanese users might prefer this:
253
254 # set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
255
256 # However, only the first content is valid for the message body.
257
258
259
260 # 3.19. attach_charset
261
262 # Type: string
263 # Default: (empty)
264
265 # This variable is a colon-separated list of character encoding schemes for text
266 # file attachments. NeoMutt uses this setting to guess which encoding files being
267 # attached are encoded in to convert them to a proper character set given in
268 # $send_charset. 
269
270 # If unset, the value of $charset will be used instead. For example, the
271 # following configuration would work for Japanese text handling:
272
273 # set attach_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
274
275 # Note: for Japanese users, "iso-2022-*" must be put at the head of the value as
276 # shown above if included.
277
278
279
280 # 3.20. attach_format
281
282 # Type: string
283 # Default: “%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] ”
284
285 # This variable describes the format of the "attachment" menu. The following
286 # printf(3)-style sequences are understood:
287
288 # ┌───┬─────────────────────────────────────────────────────────────────────────┐ 
289 # │%C │Charset                                                                  │
290 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
291 # │%c │Requires charset conversion ("n" or "c")                                 │
292 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
293 # │%D │Deleted flag                                                             │
294 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
295 # │%d │Description (if none, falls back to %F)                                  │
296 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
297 # │%e │MIME content-transfer-encoding                                           │
298 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
299 # │%f │Filename                                                                 │
300 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
301 # │%F │Filename in content-disposition header (if none, falls back to %f)       │
302 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
303 # │%I │Disposition ("I" for inline, "A" for attachment)                         │
304 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
305 # │%m │Major MIME type                                                          │
306 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
307 # │%M │MIME subtype                                                             │
308 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
309 # │%n │Attachment number                                                        │
310 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
311 # │%Q │"Q", if MIME part qualifies for attachment counting                      │
312 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
313 # │%s │Size (see formatstrings-size)                                            │
314 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
315 # │%T │Graphic tree characters                                                  │
316 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
317 # │%t │Tagged flag                                                              │
318 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
319 # │%u │Unlink (=to delete) flag                                                 │
320 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
321 # │%X │Number of qualifying MIME parts in this part and its children (please see│
322 # │ │the "attachments" section for possible speed effects)                    │
323 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
324 # │%>X│Right justify the rest of the string and pad with character "X"          │
325 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
326 # │%|X│Pad to the end of the line with character "X"                            │
327 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
328 # │%*X│Soft-fill with character "X" as pad                                      │
329 # └───┴─────────────────────────────────────────────────────────────────────────┘ 
330
331 # For an explanation of "soft-fill", see the $index_format documentation.
332
333
334
335 # 3.21. attach_save_dir
336
337 # Type: path
338 # Default: “./”
339
340 # The directory where attachments are saved.
341
342 set attach_save_dir=$tmpdir
343
344
345 # 3.22. attach_save_without_prompting
346
347 # Type: boolean
348 # Default: no
349
350 # This variable, when set to true, will cause attachments to be saved to the
351 # 'attach_save_dir' location without prompting the user for the filename.
352
353
354
355 # 3.23. attach_sep
356
357 # Type: string
358 # Default: “n”
359
360 # The separator to add between attachments when operating (saving, printing,
361 # piping, etc) on a list of tagged attachments.
362
363
364
365 # 3.24. attach_split
366
367 # Type: boolean
368 # Default: yes
369
370 # If this variable is unset, when operating (saving, printing, piping, etc) on a
371 # list of tagged attachments, NeoMutt will concatenate the attachments and will
372 # operate on them as a single attachment. The $attach_sep separator is added
373 # after each attachment. When set, NeoMutt will operate on the attachments one by
374 # one. 
375
376
377
378 # 3.25. attribution
379
380 # Type: string
381 # Default: “On %d, %n wrote:”
382
383 # This is the string that will precede a message which has been included in a
384 # reply. For a full listing of defined printf(3)-like sequences see the section
385 # on $index_format.
386
387 set attribution="$my_attribution_en"
388
389
390 # 3.26. attribution_locale
391
392 # Type: string
393 # Default: (empty)
394
395 # The locale used by strftime(3) to format dates in the attribution string. Legal
396 # values are the strings your system accepts for the locale environment variable
397 # $LC_TIME. 
398
399 # This variable is to allow the attribution date format to be customized by
400 # recipient or folder using hooks. By default, NeoMutt will use your locale
401 # environment, so there is no need to set this except to override that default.
402
403
404
405 # 3.27. auto_edit
406
407 # Type: boolean
408 # Default: no
409
410 # When set along with $edit_headers, NeoMutt will skip the initial send-menu
411 # (prompting for subject and recipients) and allow you to immediately begin
412 # editing the body of your message. The send-menu may still be accessed once you
413 # have finished editing the body of your message.
414
415 # Note: when this option is set, you can't use send-hooks that depend on the
416 # recipients when composing a new (non-reply) message, as the initial list of
417 # recipients is empty.
418
419 # Also see $fast_reply.
420
421 set auto_edit=yes
422
423
424 # 3.28. auto_subscribe
425
426 # Type: boolean
427 # Default: no
428
429 # When set, NeoMutt assumes the presence of a List-Post header means the
430 # recipient is subscribed to the list. Unless the mailing list is in the
431 # "unsubscribe" or "unlist" lists, it will be added to the "subscribe" list.
432 # Parsing and checking these things slows header reading down, so this option is
433 # disabled by default.
434
435
436
437 # 3.29. auto_tag
438
439 # Type: boolean
440 # Default: no
441
442 # When set, functions in the index menu which affect a message will be applied to
443 # all tagged messages (if there are any). When unset, you must first use the
444 # <tag-prefix> function (bound to ";" by default) to make the next function apply
445 # to all tagged messages.
446
447
448
449 # 3.30. autocrypt
450
451 # Type: boolean
452 # Default: no
453
454 # When set, enables autocrypt, which provides passive encryption protection with
455 # keys exchanged via headers. See "autocryptdoc" for more details. (Autocrypt
456 # only) 
457
458
459
460 # 3.31. autocrypt_acct_format
461
462 # Type: string
463 # Default: “%4n %-30a %20p %10s”
464
465 # This variable describes the format of the "autocrypt account" menu. The
466 # following printf(3)-style sequences are understood
467
468 # ┌──┬─────────────────────────────┐ 
469 # │%a│email address                │
470 # ├──┼─────────────────────────────┤ 
471 # │%k│gpg keyid                    │
472 # ├──┼─────────────────────────────┤ 
473 # │%n│current entry number         │
474 # ├──┼─────────────────────────────┤ 
475 # │%p│prefer-encrypt flag          │
476 # ├──┼─────────────────────────────┤ 
477 # │%s│status flag (active/inactive)│
478 # └──┴─────────────────────────────┘ 
479
480 # (Autocrypt only)
481
482
483
484 # 3.32. autocrypt_dir
485
486 # Type: path
487 # Default: “~/.mutt/autocrypt”
488
489 # This variable sets where autocrypt files are stored, including the GPG keyring
490 # and SQLite database. See "autocryptdoc" for more details. (Autocrypt only)
491
492
493
494 # 3.33. autocrypt_reply
495
496 # Type: boolean
497 # Default: yes
498
499 # When set, replying to an autocrypt email automatically enables autocrypt in the
500 # reply. You may want to unset this if you're using the same key for autocrypt as
501 # normal web-of-trust, so that autocrypt isn't forced on for all encrypted
502 # replies. (Autocrypt only)
503
504
505
506 # 3.34. beep
507
508 # Type: boolean
509 # Default: yes
510
511 # When this variable is set, NeoMutt will beep when an error occurs.
512
513 set beep=no
514
515
516 # 3.35. beep_new
517
518 # Type: boolean
519 # Default: no
520
521 # When this variable is set, NeoMutt will beep whenever it prints a message
522 # notifying you of new mail. This is independent of the setting of the $beep
523 # variable. 
524
525
526
527 # 3.36. bounce
528
529 # Type: quadoption
530 # Default: ask-yes
531
532 # Controls whether you will be asked to confirm bouncing messages. If set to yes
533 # you don't get asked if you want to bounce a message. Setting this variable to
534 # no is not generally useful, and thus not recommended, because you are unable to
535 # bounce messages.
536
537
538
539 # 3.37. bounce_delivered
540
541 # Type: boolean
542 # Default: yes
543
544 # When this variable is set, NeoMutt will include Delivered-To headers when
545 # bouncing messages. Postfix users may wish to unset this variable.
546
547 # Note: On Debian systems, this option is unset by default in /etc/Muttrc.
548
549 set bounce_delivered=no
550
551
552 # 3.38. braille_friendly
553
554 # Type: boolean
555 # Default: no
556
557 # When this variable is set, NeoMutt will place the cursor at the beginning of
558 # the current line in menus, even when the $arrow_cursor variable is unset,
559 # making it easier for blind persons using Braille displays to follow these
560 # menus. The option is unset by default because many visual terminals don't
561 # permit making the cursor invisible.
562
563
564
565 # 3.39. browser_abbreviate_mailboxes
566
567 # Type: boolean
568 # Default: yes
569
570 # When this variable is set, NeoMutt will abbreviate mailbox names in the browser
571 # mailbox list, using '~' and '=' shortcuts.
572
573 # The default "alpha" setting of $sort_browser uses locale-based sorting (using
574 # strcoll(3)), which ignores some punctuation. This can lead to some situations
575 # where the order doesn't make intuitive sense. In those cases, it may be
576 # desirable to unset this variable.
577
578
579
580 # 3.40. catchup_newsgroup
581
582 # Type: quadoption
583 # Default: ask-yes
584
585 # If this variable is set, NeoMutt will mark all articles in newsgroup as read
586 # when you quit the newsgroup (catchup newsgroup).
587
588
589
590 # 3.41. certificate_file
591
592 # Type: path
593 # Default: “~/.mutt_certificates”
594
595 # This variable specifies the file where the certificates you trust are saved.
596 # When an unknown certificate is encountered, you are asked if you accept it or
597 # not. If you accept it, the certificate can also be saved in this file and
598 # further connections are automatically accepted.
599
600 # You can also manually add CA certificates in this file. Any server certificate
601 # that is signed with one of these CA certificates is also automatically
602 # accepted. 
603
604 # Example: 
605
606 # set certificate_file=~/.neomutt/certificates
607
608
609
610 # 3.42. change_folder_next
611
612 # Type: boolean
613 # Default: no
614
615 # When this variable is set, the <change-folder> function mailbox suggestion will
616 # start at the next folder in your "mailboxes" list, instead of starting at the
617 # first folder in the list.
618
619
620
621 # 3.43. charset
622
623 # Type: string
624 # Default: (empty)
625
626 # Character set your terminal uses to display and enter textual data. It is also
627 # the fallback for $send_charset.
628
629 # Upon startup NeoMutt tries to derive this value from environment variables such
630 # as $LC_CTYPE or $LANG.
631
632 # Note: It should only be set in case NeoMutt isn't able to determine the
633 # character set used correctly.
634
635
636
637 # 3.44. check_mbox_size
638
639 # Type: boolean
640 # Default: no
641
642 # When this variable is set, NeoMutt will use file size attribute instead of
643 # access time when checking for new mail in mbox and mmdf folders.
644
645 # This variable is unset by default and should only be enabled when new mail
646 # detection for these folder types is unreliable or doesn't work.
647
648 # Note that enabling this variable should happen before any "mailboxes"
649 # directives occur in configuration files regarding mbox or mmdf folders because
650 # NeoMutt needs to determine the initial new mail status of such a mailbox by
651 # performing a fast mailbox scan when it is defined. Afterwards the new mail
652 # status is tracked by file size changes.
653
654
655
656 # 3.45. check_new
657
658 # Type: boolean
659 # Default: yes
660
661 # Note: this option only affects maildir and MH style mailboxes.
662
663 # When set, NeoMutt will check for new mail delivered while the mailbox is open.
664 # Especially with MH mailboxes, this operation can take quite some time since it
665 # involves scanning the directory and checking each file to see if it has already
666 # been looked at. If this variable is unset, no check for new mail is performed
667 # while the mailbox is open.
668
669
670
671 # 3.46. collapse_all
672
673 # Type: boolean
674 # Default: no
675
676 # When set, NeoMutt will collapse all threads when entering a folder.
677
678
679
680 # 3.47. collapse_flagged
681
682 # Type: boolean
683 # Default: yes
684
685 # When unset, NeoMutt will not collapse a thread if it contains any flagged
686 # messages. 
687
688
689
690 # 3.48. collapse_unread
691
692 # Type: boolean
693 # Default: yes
694
695 # When unset, NeoMutt will not collapse a thread if it contains any unread
696 # messages. 
697
698
699
700 # 3.49. compose_format
701
702 # Type: string
703 # Default: “-- NeoMutt: Compose  [Approx. msg size: %l   Atts: %a]%>-”
704
705 # Controls the format of the status line displayed in the "compose" menu. This
706 # string is similar to $status_format, but has its own set of printf(3)-like
707 # sequences: 
708
709 # ┌───┬─────────────────────────────────────────────────────────────────────────┐ 
710 # │%a │Total number of attachments                                              │
711 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
712 # │%h │Local hostname                                                           │
713 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
714 # │%l │Approximate size (in bytes) of the current message (see                  │
715 # │ │formatstrings-size)                                                      │
716 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
717 # │%v │NeoMutt version string                                                   │
718 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
719 # │%>X│right justify the rest of the string and pad with character "X"          │
720 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
721 # │%|X│pad to the end of the line with character "X"                            │
722 # ├───┼─────────────────────────────────────────────────────────────────────────┤ 
723 # │%*X│soft-fill with character "X" as pad                                      │
724 # └───┴─────────────────────────────────────────────────────────────────────────┘ 
725
726 # See the text describing the $status_format option for more information on how
727 # to set $compose_format.
728
729
730
731 # 3.50. compose_show_user_headers
732
733 # Type: boolean
734 # Default: yes
735
736 # When set, Neomutt will display user-defined headers (set via my_hdr or from
737 # editing with edit-headers).
738
739 set compose_show_user_headers=no
740
741 # 3.51. config_charset
742
743 # Type: string
744 # Default: (empty)
745
746 # When defined, NeoMutt will recode commands in rc files from this encoding to
747 # the current character set as specified by $charset and aliases written to
748 # $alias_file from the current character set.
749
750 # Please note that if setting $charset it must be done before setting
751 # $config_charset. 
752
753 # Recoding should be avoided as it may render unconvertable characters as
754 # question marks which can lead to undesired side effects (for example in regular
755 # expressions). 
756
757
758
759 # 3.52. confirm_append
760
761 # Type: boolean
762 # Default: yes
763
764 # When set, NeoMutt will prompt for confirmation when appending messages to an
765 # existing mailbox.
766
767 set confirm_append=no
768
769
770 # 3.53. confirm_create
771
772 # Type: boolean
773 # Default: yes
774
775 # When set, NeoMutt will prompt for confirmation when saving messages to a
776 # mailbox which does not yet exist before creating it.
777
778
779
780 # 3.54. connect_timeout
781
782 # Type: number
783 # Default: 30
784
785 # Causes NeoMutt to timeout a network connection (for IMAP, POP or SMTP) after
786 # this many seconds if the connection is not able to be established. A negative
787 # value causes NeoMutt to wait indefinitely for the connection attempt to
788 # succeed. 
789
790
791
792 # 3.55. content_type
793
794 # Type: string
795 # Default: “text/plain”
796
797 # Sets the default Content-Type for the body of newly composed messages.
798
799 set content_type="text/plain; markup=markdown"
800
801
802 # 3.56. copy
803
804 # Type: quadoption
805 # Default: yes
806
807 # This variable controls whether or not copies of your outgoing messages will be
808 # saved for later references. Also see $record, $save_name, $force_name and "
809 # fcc-hook". 
810
811 set copy=yes
812
813
814 # 3.57. copy_decode_weed
815
816 # Type: boolean
817 # Default: no
818
819 # Controls whether NeoMutt will weed headers when invoking the <decode-copy> or
820 # <decode-save> functions.
821
822
823
824 # 3.58. count_alternatives
825
826 # Type: boolean
827 # Default: no
828
829 # When set, NeoMutt will recurse inside multipart/alternatives while performing
830 # attachment searching and counting(see attachments).
831
832 # Traditionally, multipart/alternative parts have simply represented different
833 # encodings of the main content of the email. Unfortunately, some mail clients
834 # have started to place email attachments inside one of alternatives. Setting
835 # this will allow NeoMutt to find and count matching attachments hidden there,
836 # and include them in the index via %X or through ~X pattern matching.
837
838
839
840 # 3.59. crypt_auto_encrypt
841
842 # Type: boolean
843 # Default: no
844
845 # Setting this variable will cause NeoMutt to always attempt to PGP encrypt
846 # outgoing messages. This is probably only useful in connection to the "send-hook
847 # " command. It can be overridden by use of the pgp menu, when encryption is not
848 # required or signing is requested as well. If $smime_is_default is set, then
849 # OpenSSL is used instead to create S/MIME messages and settings can be
850 # overridden by use of the smime menu instead. (Crypto only)
851
852
853
854 # 3.60. crypt_auto_pgp
855
856 # Type: boolean
857 # Default: yes
858
859 # This variable controls whether or not NeoMutt may automatically enable PGP
860 # encryption/signing for messages. See also $crypt_auto_encrypt,
861 # $crypt_reply_encrypt, $crypt_auto_sign, $crypt_reply_sign and $smime_is_default
862 # . 
863
864
865
866 # 3.61. crypt_auto_sign
867
868 # Type: boolean
869 # Default: no
870
871 # Setting this variable will cause NeoMutt to always attempt to cryptographically
872 # sign outgoing messages. This can be overridden by use of the pgp menu, when
873 # signing is not required or encryption is requested as well. If
874 # $smime_is_default is set, then OpenSSL is used instead to create S/MIME
875 # messages and settings can be overridden by use of the smime menu instead of the
876 # pgp menu. (Crypto only)
877
878
879
880 # 3.62. crypt_auto_smime
881
882 # Type: boolean
883 # Default: yes
884
885 # This variable controls whether or not NeoMutt may automatically enable S/MIME
886 # encryption/signing for messages. See also $crypt_auto_encrypt,
887 # $crypt_reply_encrypt, $crypt_auto_sign, $crypt_reply_sign and $smime_is_default
888 # . 
889
890
891
892 # 3.63. crypt_chars
893
894 # Type: character string
895 # Default: “SPsK ”
896
897 # Controls the characters used in cryptography flags.
898
899 # ┌─────────┬───────┬───────────────────────────────────────────────────────────┐ 
900 # │Character│Default│Description │
901 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤ 
902 # │1 │S      │The mail is signed, and the signature is successfully      │
903 # │ │       │verified.                                                  │
904 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤ 
905 # │2 │P      │The mail is PGP encrypted.                                 │
906 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤ 
907 # │3 │s      │The mail is signed.                                        │
908 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤ 
909 # │4 │K      │The mail contains a PGP public key.                        │
910 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤ 
911 # │5 │<space>│The mail has no crypto info.                               │
912 # └─────────┴───────┴───────────────────────────────────────────────────────────┘ 
913
914
915
916 # 3.64. crypt_confirm_hook
917
918 # Type: boolean
919 # Default: yes
920
921 # If set, then you will be prompted for confirmation of keys when using the
922 # crypt-hook command. If unset, no such confirmation prompt will be presented.
923 # This is generally considered unsafe, especially where typos are concerned.
924
925
926
927 # 3.65. crypt_opportunistic_encrypt
928
929 # Type: boolean
930 # Default: no
931
932 # Setting this variable will cause NeoMutt to automatically enable and disable
933 # encryption, based on whether all message recipient keys can be located by
934 # NeoMutt. 
935
936 # When this option is enabled, NeoMutt will enable/disable encryption each time
937 # the TO, CC, and BCC lists are edited. If $edit_headers is set, NeoMutt will
938 # also do so each time the message is edited.
939
940 # While this is set, encryption can't be manually enabled/disabled. The pgp or
941 # smime menus provide a selection to temporarily disable this option for the
942 # current message.
943
944 # If $crypt_auto_encrypt or $crypt_reply_encrypt enable encryption for a message,
945 # this option will be disabled for that message. It can be manually re-enabled in
946 # the pgp or smime menus. (Crypto only)
947
948 set crypt_opportunistic_encrypt=no
949
950
951 # 3.66. crypt_opportunistic_encrypt_strong_keys
952
953 # Type: boolean
954 # Default: no
955
956 # When set, this modifies the behavior of $crypt_opportunistic_encrypt to only
957 # search for "strong keys", that is, keys with full validity according to the
958 # web-of-trust algorithm. A key with marginal or no validity will not enable
959 # opportunistic encryption.
960
961 # For S/MIME, the behavior depends on the backend. Classic S/MIME will filter for
962 # certificates with the 't'(trusted) flag in the .index file. The GPGME backend
963 # will use the same filters as with OpenPGP, and depends on GPGME's logic for
964 # assigning the GPGME_VALIDITY_FULL and GPGME_VALIDITY_ULTIMATE validity flag.
965
966
967
968 # 3.67. crypt_protected_headers_read
969
970 # Type: boolean
971 # Default: yes
972
973 # When set, NeoMutt will display protected headers ("Memory Hole") in the pager,
974 # When set, NeoMutt will display protected headers in the pager, and will update
975 # the index and header cache with revised headers.
976
977 # Protected headers are stored inside the encrypted or signed part of an an
978 # email, to prevent disclosure or tampering. For more information see https://
979 # github.com/autocrypt/protected-headers Currently NeoMutt only supports the
980 # Subject header.
981
982 # Encrypted messages using protected headers often substitute the exposed Subject
983 # header with a dummy value (see $crypt_protected_headers_subject). NeoMutt will
984 # update its concept of the correct subject after the message is opened, i.e. via
985 # the <display-message> function. If you reply to a message before opening it,
986 # NeoMutt will end up using the dummy Subject header, so be sure to open such a
987 # message first. (Crypto only)
988
989
990
991 # 3.68. crypt_protected_headers_save
992
993 # Type: boolean
994 # Default: no
995
996 # When $crypt_protected_headers_read is set, and a message with a protected
997 # Subject is opened, NeoMutt will save the updated Subject into the header cache
998 # by default. This allows searching/limiting based on the protected Subject
999 # header if the mailbox is re-opened, without having to re-open the message each
1000 # time. However, for mbox/mh mailbox types, or if header caching is not set up,
1001 # you would need to re-open the message each time the mailbox was reopened before
1002 # you could see or search/limit on the protected subject again.
1003
1004 # When this variable is set, NeoMutt additionally saves the protected Subject
1005 # back in the clear-text message headers. This provides better usability, but
1006 # with the tradeoff of reduced security. The protected Subject header, which may
1007 # have previously been encrypted, is now stored in clear-text in the message
1008 # headers. Copying the message elsewhere, via NeoMutt or external tools, could
1009 # expose this previously encrypted data. Please make sure you understand the
1010 # consequences of this before you enable this variable. (Crypto only)
1011
1012
1013
1014 # 3.69. crypt_protected_headers_subject
1015
1016 # Type: string
1017 # Default: “...”
1018
1019 # When $crypt_protected_headers_write is set, and the message is marked for
1020 # encryption, this will be substituted into the Subject field in the message
1021 # headers. 
1022
1023 # To prevent a subject from being substituted, unset this variable, or set it to
1024 # the empty string. (Crypto only)
1025
1026
1027
1028 # 3.70. crypt_protected_headers_write
1029
1030 # Type: boolean
1031 # Default: no
1032
1033 # When set, NeoMutt will generate protected headers for signed and encrypted
1034 # emails. 
1035
1036 # Protected headers are stored inside the encrypted or signed part of an an
1037 # email, to prevent disclosure or tampering. For more information see https://
1038 # github.com/autocrypt/protected-headers 
1039
1040 # Currently NeoMutt only supports the Subject header. (Crypto only)
1041
1042
1043
1044 # 3.71. crypt_reply_encrypt
1045
1046 # Type: boolean
1047 # Default: yes
1048
1049 # If set, automatically PGP or OpenSSL encrypt replies to messages which are
1050 # encrypted. (Crypto only)
1051
1052
1053
1054 # 3.72. crypt_reply_sign
1055
1056 # Type: boolean
1057 # Default: no
1058
1059 # If set, automatically PGP or OpenSSL sign replies to messages which are signed.
1060
1061 # Note: this does not work on messages that are encrypted and signed! (Crypto
1062 # only) 
1063
1064
1065
1066 # 3.73. crypt_reply_sign_encrypted
1067
1068 # Type: boolean
1069 # Default: no
1070
1071 # If set, automatically PGP or OpenSSL sign replies to messages which are
1072 # encrypted. This makes sense in combination with $crypt_reply_encrypt, because
1073 # it allows you to sign all messages which are automatically encrypted. This
1074 # works around the problem noted in $crypt_reply_sign, that NeoMutt is not able
1075 # to find out whether an encrypted message is also signed. (Crypto only)
1076
1077
1078
1079 # 3.74. crypt_timestamp
1080
1081 # Type: boolean
1082 # Default: yes
1083
1084 # If set, NeoMutt will include a time stamp in the lines surrounding PGP or S/
1085 # MIME output, so spoofing such lines is more difficult. If you are using colors
1086 # to mark these lines, and rely on these, you may unset this setting. (Crypto
1087 # only) 
1088
1089
1090
1091 # 3.75. crypt_use_gpgme
1092
1093 # Type: boolean
1094 # Default: yes
1095
1096 # This variable controls the use of the GPGME-enabled crypto backends. If it is
1097 # set and NeoMutt was built with GPGME support, the gpgme code for S/MIME and PGP
1098 # will be used instead of the classic code. Note that you need to set this option
1099 # in .neomuttrc; it won't have any effect when used interactively.
1100
1101 # Note that the GPGME backend does not support creating old-style inline
1102 # (traditional) PGP encrypted or signed messages (see $pgp_auto_inline).
1103
1104
1105
1106 # 3.76. crypt_use_pka
1107
1108 # Type: boolean
1109 # Default: no
1110
1111 # Controls whether NeoMutt uses PKA (see http://www.g10code.de/docs/
1112 # pka-intro.de.pdf) during signature verification (only supported by the GPGME
1113 # backend). 
1114
1115 set crypt_use_pka=yes
1116
1117
1118 # 3.77. crypt_verify_sig
1119
1120 # Type: quadoption
1121 # Default: yes
1122
1123 # If "yes", always attempt to verify PGP or S/MIME signatures. If "ask-*", ask
1124 # whether or not to verify the signature. If "no", never attempt to verify
1125 # cryptographic signatures. (Crypto only)
1126
1127
1128
1129 # 3.78. date_format
1130
1131 # Type: string
1132 # Default: “!%a, %b %d, %Y at %I:%M:%S%p %Z”
1133
1134 # This variable controls the format of the date printed by the "%d" sequence in
1135 # $index_format. This is passed to the strftime(3) function to process the date,
1136 # see the man page for the proper syntax.
1137
1138 # Unless the first character in the string is a bang ("!"), the month and week
1139 # day names are expanded according to the locale. If the first character in the
1140 # string is a bang, the bang is discarded, and the month and week day names in
1141 # the rest of the string are expanded in the C locale (that is in US English).
1142
1143 set date_format="%F"
1144
1145
1146 # 3.79. debug_file
1147
1148 # Type: path
1149 # Default: “~/.neomuttdebug”
1150
1151 # Debug logging is controlled by the variables $debug_file and $debug_level.
1152 # $debug_file specifies the root of the filename. NeoMutt will add "0" to the
1153 # end. Each time NeoMutt is run with logging enabled, the log files are rotated.
1154 # A maximum of five log files are kept, numbered 0 (most recent) to 4 (oldest).
1155
1156 # This option can be enabled on the command line, "neomutt -l mylog"
1157
1158 # See also: $debug_level
1159
1160
1161
1162 # 3.80. debug_level
1163
1164 # Type: number
1165 # Default: 0
1166
1167 # Debug logging is controlled by the variables $debug_file and $debug_level.
1168
1169 # The debug level controls how much information is saved to the log file. If you
1170 # have a problem with NeoMutt, then enabling logging may help find the cause.
1171 # Levels 1-3 will usually provide enough information for writing a bug report.
1172 # Levels 4,5 will be extremely verbose.
1173
1174 # Warning: Logging at high levels may save private information to the file.
1175
1176 # This option can be enabled on the command line, "neomutt -d 2"
1177
1178 # See also: $debug_file
1179
1180
1181
1182 # 3.81. default_hook
1183
1184 # Type: string
1185 # Default: “~f %s !~P | (~P ~C %s)”
1186
1187 # This variable controls how "message-hook", "reply-hook", "send-hook", "
1188 # send2-hook", "save-hook", and "fcc-hook" will be interpreted if they are
1189 # specified with only a simple regex, instead of a matching pattern. The hooks
1190 # are expanded when they are declared, so a hook will be interpreted according to
1191 # the value of this variable at the time the hook is declared.
1192
1193 # The default value matches if the message is either from a user matching the
1194 # regular expression given, or if it is from you (if the from address matches "
1195 # alternates") and is to or cc'ed to a user matching the given regular
1196 # expression. 
1197
1198
1199
1200 # 3.82. delete
1201
1202 # Type: quadoption
1203 # Default: ask-yes
1204
1205 # Controls whether or not messages are really deleted when closing or
1206 # synchronizing a mailbox. If set to yes, messages marked for deleting will
1207 # automatically be purged without prompting. If set to no, messages marked for
1208 # deletion will be kept in the mailbox.
1209
1210 set delete=yes
1211
1212
1213 # 3.83. delete_untag
1214
1215 # Type: boolean
1216 # Default: yes
1217
1218 # If this option is set, NeoMutt will untag messages when marking them for
1219 # deletion. This applies when you either explicitly delete a message, or when you
1220 # save it to another folder.
1221
1222
1223
1224 # 3.84. digest_collapse
1225
1226 # Type: boolean
1227 # Default: yes
1228
1229 # If this option is set, NeoMutt's received-attachments menu will not show the
1230 # subparts of individual messages in a multipart/digest. To see these subparts,
1231 # press "v" on that menu.
1232
1233
1234
1235 # 3.85. display_filter
1236
1237 # Type: command
1238 # Default: (empty)
1239
1240 # When set, specifies a command used to filter messages. When a message is viewed
1241 # it is passed as standard input to $display_filter, and the filtered message is
1242 # read from the standard output.
1243
1244 # When preparing the message, NeoMutt inserts some escape sequences into the
1245 # text. They are of the form: <esc>]9;XXX<bel> where "XXX" is a random 64-bit
1246 # number. 
1247
1248 # If these escape sequences interfere with your filter, they can be removed using
1249 # a tool like ansifilter or sed 's/^x1b]9;[0-9]+x7//'
1250
1251 # If they are removed, then PGP and MIME headers will no longer be coloured. This
1252 # can be fixed by adding this to your config: color body magenta default '^[--
1253 # .* --]$'.
1254
1255
1256
1257 # 3.86. dsn_notify
1258
1259 # Type: string
1260 # Default: (empty)
1261
1262 # This variable sets the request for when notification is returned. The string
1263 # consists of a comma separated list (no spaces!) of one or more of the
1264 # following: never, to never request notification, failure, to request
1265 # notification on transmission failure, delay, to be notified of message delays,
1266 # success, to be notified of successful transmission.
1267
1268 # Example: 
1269
1270 # set dsn_notify="failure,delay"
1271
1272 # Note: when using $sendmail for delivery, you should not enable this unless you
1273 # are either using Sendmail 8.8.x or greater or a MTA providing a sendmail(1)
1274 # -compatible interface supporting the -N option for DSN. For SMTP delivery, DSN
1275 # support is auto-detected so that it depends on the server whether DSN will be
1276 # used or not.
1277
1278
1279
1280 # 3.87. dsn_return
1281
1282 # Type: string
1283 # Default: (empty)
1284
1285 # This variable controls how much of your message is returned in DSN messages. It
1286 # may be set to either hdrs to return just the message header, or full to return
1287 # the full message.
1288
1289 # Example: 
1290
1291 # set dsn_return=hdrs
1292
1293 # Note: when using $sendmail for delivery, you should not enable this unless you
1294 # are either using Sendmail 8.8.x or greater or a MTA providing a sendmail(1)
1295 # -compatible interface supporting the -R option for DSN. For SMTP delivery, DSN
1296 # support is auto-detected so that it depends on the server whether DSN will be
1297 # used or not.
1298
1299
1300
1301 # 3.88. duplicate_threads
1302
1303 # Type: boolean
1304 # Default: yes
1305
1306 # This variable controls whether NeoMutt, when $sort is set to threads, threads
1307 # messages with the same Message-Id together. If it is set, it will indicate that
1308 # it thinks they are duplicates of each other with an equals sign in the thread
1309 # tree. 
1310
1311
1312
1313 # 3.89. edit_headers
1314
1315 # Type: boolean
1316 # Default: no
1317
1318 # This option allows you to edit the header of your outgoing messages along with
1319 # the body of your message.
1320
1321 # Although the compose menu may have localized header labels, the labels passed
1322 # to your editor will be standard RFC2822 headers, (e.g. To:, Cc:, Subject:).
1323 # Headers added in your editor must also be RFC2822 headers, or one of the pseudo
1324 # headers listed in "edit-header". NeoMutt will not understand localized header
1325 # labels, just as it would not when parsing an actual email.
1326
1327 # Note that changes made to the References: and Date: headers are ignored for
1328 # interoperability reasons.
1329
1330 set edit_headers=yes
1331
1332
1333 # 3.90. editor
1334
1335 # Type: command
1336 # Default: (empty)
1337
1338 # This variable specifies which editor is used by NeoMutt. It defaults to the
1339 # value of the $VISUAL, or $EDITOR, environment variable, or to the string "/usr/
1340 # bin/editor" if neither of those are set.
1341
1342 # The $editor string may contain a %s escape, which will be replaced by the name
1343 # of the file to be edited. If the %s escape does not appear in $editor, a space
1344 # and the name to be edited are appended.
1345
1346 # The resulting string is then executed by running
1347
1348 # sh -c 'string'
1349
1350 # where string is the expansion of $editor described above.
1351
1352 set editor="mailplate --edit --auto --keep-unknown"
1353
1354
1355 # 3.91. empty_subject
1356
1357 # Type: string
1358 # Default: “Re: your mail”
1359
1360 # This variable specifies the subject to be used when replying to an email with
1361 # an empty subject. It defaults to "Re: your mail".
1362
1363
1364
1365 # 3.92. encode_from
1366
1367 # Type: boolean
1368 # Default: no
1369
1370 # When set, NeoMutt will quoted-printable encode messages when they contain the
1371 # string "From " (note the trailing space) in the beginning of a line. This is
1372 # useful to avoid the tampering certain mail delivery and transport agents tend
1373 # to do with messages (in order to prevent tools from misinterpreting the line as
1374 # a mbox message separator).
1375
1376
1377
1378 # 3.93. envelope_from_address
1379
1380 # Type: e-mail address
1381 # Default: (empty)
1382
1383 # Manually sets the envelope sender for outgoing messages. This value is ignored
1384 # if $use_envelope_from is unset.
1385
1386
1387
1388 # 3.94. external_search_command
1389
1390 # Type: command
1391 # Default: (empty)
1392
1393 # If set, contains the name of the external program used by "~I" patterns. This
1394 # will usually be a wrapper script around mairix, mu, or similar indexers other
1395 # than notmuch (for which there is optional special support).
1396
1397 # Here is an example how it works. Let's assume $external_search_command is set
1398 # to "mairix_filter", and mairix_filter is a script which runs the old but well
1399 # loved mairix indexer with the arguments given to mairix_filter, in the "raw"
1400 # mode of mairix, producing on the standard output a list of Message-IDs, one per
1401 # line. 
1402
1403 # If possible, it also filters down the results coming from mairix such that only
1404 # messages in the current folder remain. It can do this because it gets a hidden
1405 # first argument which is the path to the folder. (This can be the type of clean
1406 # and simple script called a one-liner.)
1407
1408 # Now if NeoMutt gets a limit or tag command followed by the pattern "~I '-t
1409 # s:bleeping='", mairix_filter runs mairix with the arguments from inside the
1410 # quotes (the quotes are needed because of the space after "-t"), mairix finds
1411 # all messages with "bleeping" in the Subject plus all messages sharing threads
1412 # with these and outputs their file names, and mairix_filter translates the file
1413 # names into Message-IDs. Finally, NeoMutt reads the Message-IDs and targets the
1414 # matching messages with the command given to it.
1415
1416 # You, the user, still have to rewrite the mairix_filter script to match the
1417 # behavior of your indexer, but this should help users of indexers other than
1418 # notmuch to integrate them cleanly with NeoMutt.
1419
1420
1421
1422 # 3.95. fast_reply
1423
1424 # Type: boolean
1425 # Default: no
1426
1427 # When set, the initial prompt for recipients (to, cc, bcc) and subject are
1428 # skipped when the relevant information is already provided. These cases include
1429 # replying to messages and passing the relevant command line arguments. The
1430 # initial prompt for recipients is also skipped when composing a new message to
1431 # the current message sender, while the initial prompt for subject is also
1432 # skipped when forwarding messages.
1433
1434 # Note: this variable has no effect when the $auto_edit variable is set.
1435
1436 # See also: $auto_edit, $edit_headers, $ask_cc, $ask_bcc
1437
1438
1439
1440 # 3.96. fcc_attach
1441
1442 # Type: quadoption
1443 # Default: yes
1444
1445 # This variable controls whether or not attachments on outgoing messages are
1446 # saved along with the main body of your message.
1447
1448 # Note: $fcc_before_send forces the default (set) behavior of this option.
1449
1450
1451
1452 # 3.97. fcc_before_send
1453
1454 # Type: boolean
1455 # Default: no
1456
1457 # When this variable is set, FCCs will occur before sending the message. Before
1458 # sending, the message cannot be manipulated, so it will be stored the exact same
1459 # as sent: $fcc_attach and $fcc_clear will be ignored (using their default
1460 # values). 
1461
1462 # When unset, the default, FCCs will occur after sending. Variables $fcc_attach
1463 # and $fcc_clear will be respected, allowing it to be stored without attachments
1464 # or encryption/signing if desired.
1465
1466
1467
1468 # 3.98. fcc_clear
1469
1470 # Type: boolean
1471 # Default: no
1472
1473 # When this variable is set, FCCs will be stored unencrypted and unsigned, even
1474 # when the actual message is encrypted and/or signed.
1475
1476 # Note: $fcc_before_send forces the default (unset) behavior of this option. (PGP
1477 # only) 
1478
1479 # See also $pgp_self_encrypt, $smime_self_encrypt
1480
1481
1482
1483 # 3.99. flag_chars
1484
1485 # Type: character string
1486 # Default: “*!DdrONon- ”
1487
1488 # Controls the characters used in several flags.
1489
1490 # ┌─────────┬───────┬─────────────────────────────────────────────┐ 
1491 # │Character│Default│Description │
1492 # ├─────────┼───────┼─────────────────────────────────────────────┤ 
1493 # │1 │*      │The mail is tagged.                          │
1494 # ├─────────┼───────┼─────────────────────────────────────────────┤ 
1495 # │2 │!      │The mail is flagged as important.            │
1496 # ├─────────┼───────┼─────────────────────────────────────────────┤ 
1497 # │3 │D      │The mail is marked for deletion.             │
1498 # ├─────────┼───────┼─────────────────────────────────────────────┤ 
1499 # │4 │d      │The mail has attachments marked for deletion.│
1500 # ├─────────┼───────┼─────────────────────────────────────────────┤ 
1501 # │5 │r      │The mail has been replied to.                │
1502 # ├─────────┼───────┼─────────────────────────────────────────────┤ 
1503 # │6 │O      │The mail is Old (Unread but seen).           │
1504 # ├─────────┼───────┼─────────────────────────────────────────────┤ 
1505 # │7 │N      │The mail is New (Unread but not seen).       │
1506 # ├─────────┼───────┼─────────────────────────────────────────────┤ 
1507 # │8 │o      │The mail thread is Old (Unread but seen).    │
1508 # ├─────────┼───────┼─────────────────────────────────────────────┤ 
1509 # │9 │n      │The mail thread is New (Unread but not seen).│
1510 # ├─────────┼───────┼─────────────────────────────────────────────┤ 
1511 # │10 │-      │The mail is read - %S expando.               │
1512 # ├─────────┼───────┼─────────────────────────────────────────────┤ 
1513 # │11 │<space>│The mail is read - %Z expando.               │
1514 # └─────────┴───────┴─────────────────────────────────────────────┘ 
1515
1516
1517
1518 # 3.100. flag_safe
1519
1520 # Type: boolean
1521 # Default: no
1522
1523 # If set, flagged messages can't be deleted.
1524
1525
1526
1527 # 3.101. folder
1528
1529 # Type: mailbox
1530 # Default: “~/Mail”
1531
1532 # Specifies the default location of your mailboxes. A "+" or "=" at the beginning
1533 # of a pathname will be expanded to the value of this variable. Note that if you
1534 # change this variable (from the default) value you need to make sure that the
1535 # assignment occurs before you use "+" or "=" for any other variables since
1536 # expansion takes place when handling the "mailboxes" command.
1537
1538 set folder="~/mail"
1539
1540
1541 # 3.102. folder_format
1542
1543 # Type: string
1544 # Default: “%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %i”
1545
1546 # This variable allows you to customize the file browser display to your personal
1547 # taste. This string is similar to $index_format, but has its own set of printf
1548 # (3)-like sequences:
1549
1550 # ┌───┬─┬───────────────────────────────────────────────────────────────────────┐ 
1551 # │%C │ │Current file number                                                    │
1552 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
1553 # │%d │ │Date/time folder was last modified                                     │
1554 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
1555 # │%D │ │Date/time folder was last modified using $date_format.                 │
1556 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
1557 # │%f │ │Filename ("/" is appended to directory names, "@" to symbolic links and│
1558 # │ │ │"*" to executable files)                                               │
1559 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
1560 # │%F │ │File permissions                                                       │
1561 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
1562 # │%g │ │Group name (or numeric gid, if missing)                                │
1563 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
1564 # │%i │ │Description of the folder                                              │
1565 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
1566 # │%l │ │Number of hard links                                                   │
1567 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
1568 # │%m │*│Number of messages in the mailbox                                      │
1569 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
1570 # │%n │*│Number of unread messages in the mailbox                               │
1571 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
1572 # │%N │ │"N" if mailbox has new mail, blank otherwise                           │
1573 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
1574 # │%s │ │Size in bytes (see formatstrings-size)                                 │
1575 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
1576 # │%t │ │"*" if the file is tagged, blank otherwise                             │
1577 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
1578 # │%u │ │Owner name (or numeric uid, if missing)                                │
1579 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
1580 # │%>X│ │Right justify the rest of the string and pad with character "X"        │
1581 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
1582 # │%|X│ │Pad to the end of the line with character "X"                          │
1583 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
1584 # │%*X│ │Soft-fill with character "X" as pad                                    │
1585 # └───┴─┴───────────────────────────────────────────────────────────────────────┘ 
1586
1587 # For an explanation of "soft-fill", see the $index_format documentation.
1588
1589 # * = can be optionally printed if nonzero
1590
1591 # %m, %n, and %N only work for monitored mailboxes. %m requires $mail_check_stats
1592 # to be set. %n requires $mail_check_stats to be set (except for IMAP mailboxes).
1593
1594 set folder_format='%t%N%2C  %D  %4s  %f'
1595
1596
1597 # 3.103. followup_to
1598
1599 # Type: boolean
1600 # Default: yes
1601
1602 # Controls whether or not the "Mail-Followup-To:" header field is generated when
1603 # sending mail. When set, NeoMutt will generate this field when you are replying
1604 # to a known mailing list, specified with the "subscribe" or "lists" commands.
1605
1606 # This field has two purposes. First, preventing you from receiving duplicate
1607 # copies of replies to messages which you send to mailing lists, and second,
1608 # ensuring that you do get a reply separately for any messages sent to known
1609 # lists to which you are not subscribed.
1610
1611 # The header will contain only the list's address for subscribed lists, and both
1612 # the list address and your own email address for unsubscribed lists. Without
1613 # this header, a group reply to your message sent to a subscribed list will be
1614 # sent to both the list and your address, resulting in two copies of the same
1615 # email for you.
1616
1617
1618
1619 # 3.104. followup_to_poster
1620
1621 # Type: quadoption
1622 # Default: ask-yes
1623
1624 # If this variable is set and the keyword "poster" is present in Followup-To
1625 # header, follow-up to newsgroup function is not permitted. The message will be
1626 # mailed to the submitter of the message via mail.
1627
1628
1629
1630 # 3.105. force_name
1631
1632 # Type: boolean
1633 # Default: no
1634
1635 # This variable is similar to $save_name, except that NeoMutt will store a copy
1636 # of your outgoing message by the username of the address you are sending to even
1637 # if that mailbox does not exist.
1638
1639 # Also see the $record variable.
1640
1641
1642
1643 # 3.106. forward_attachments
1644
1645 # Type: quadoption
1646 # Default: ask-yes
1647
1648 # When forwarding inline (i.e. $mime_forward unset or answered with "no" and
1649 # $forward_decode set), attachments which cannot be decoded in a reasonable
1650 # manner will be attached to the newly composed message if this quadoption is set
1651 # or answered with "yes".
1652
1653
1654
1655 # 3.107. forward_attribution_intro
1656
1657 # Type: string
1658 # Default: “----- Forwarded message from %f -----”
1659
1660 # This is the string that will precede a message which has been forwarded in the
1661 # main body of a message (when $mime_forward is unset). For a full listing of
1662 # defined printf(3)-like sequences see the section on $index_format. See also
1663 # $attribution_locale. 
1664
1665
1666
1667 # 3.108. forward_attribution_trailer
1668
1669 # Type: string
1670 # Default: “----- End forwarded message -----”
1671
1672 # This is the string that will follow a message which has been forwarded in the
1673 # main body of a message (when $mime_forward is unset). For a full listing of
1674 # defined printf(3)-like sequences see the section on $index_format. See also
1675 # $attribution_locale. 
1676
1677
1678
1679 # 3.109. forward_decode
1680
1681 # Type: boolean
1682 # Default: yes
1683
1684 # Controls the decoding of complex MIME messages into text/plain when forwarding
1685 # a message. The message header is also RFC2047 decoded. This variable is only
1686 # used, if $mime_forward is unset, otherwise $mime_forward_decode is used
1687 # instead. 
1688
1689
1690
1691 # 3.110. forward_decrypt
1692
1693 # Type: boolean
1694 # Default: yes
1695
1696 # Controls the handling of encrypted messages when forwarding a message. When set
1697 # , the outer layer of encryption is stripped off. This variable is only used if
1698 # $mime_forward is set and $mime_forward_decode is unset. (PGP only)
1699
1700
1701
1702 # 3.111. forward_edit
1703
1704 # Type: quadoption
1705 # Default: yes
1706
1707 # This quadoption controls whether or not the user is automatically placed in the
1708 # editor when forwarding messages. For those who always want to forward with no
1709 # modification, use a setting of "no".
1710
1711
1712
1713 # 3.112. forward_format
1714
1715 # Type: string
1716 # Default: “[%a: %s]”
1717
1718 # This variable controls the default subject when forwarding a message. It uses
1719 # the same format sequences as the $index_format variable.
1720
1721 set forward_format="(fwd) %s"
1722
1723
1724 # 3.113. forward_quote
1725
1726 # Type: boolean
1727 # Default: no
1728
1729 # When set, forwarded messages included in the main body of the message (when
1730 # $mime_forward is unset) will be quoted using $indent_string.
1731
1732
1733
1734 # 3.114. forward_references
1735
1736 # Type: boolean
1737 # Default: no
1738
1739 # When set, forwarded messages set the "In-Reply-To:" and "References:" headers
1740 # in the same way as normal replies would. Hence the forwarded message becomes
1741 # part of the original thread instead of starting a new one.
1742
1743
1744
1745 # 3.115. from
1746
1747 # Type: e-mail address
1748 # Default: (empty)
1749
1750 # When set, this variable contains a default "from" address. It can be overridden
1751 # using "my_hdr" (including from a "send-hook") and $reverse_name. This variable
1752 # is ignored if $use_from is unset.
1753
1754 # If not specified, then it may be read from the environment variable $EMAIL.
1755
1756 set from='martin f krafft <madduck@madduck.net>'
1757
1758
1759 # 3.116. from_chars
1760
1761 # Type: character string
1762 # Default: (empty)
1763
1764 # Controls the character used to prefix the %F and %L fields in the index.
1765
1766 # ┌─────────┬───────────────────────────────────────────────────────────────────┐ 
1767 # │Character│Description │
1768 # ├─────────┼───────────────────────────────────────────────────────────────────┤ 
1769 # │1 │Mail is written by you and has a To address, or has a known mailing│
1770 # │ │list in the To address.                                            │
1771 # ├─────────┼───────────────────────────────────────────────────────────────────┤ 
1772 # │2 │Mail is written by you and has a Cc address, or has a known mailing│
1773 # │ │list in the Cc address.                                            │
1774 # ├─────────┼───────────────────────────────────────────────────────────────────┤ 
1775 # │3 │Mail is written by you and has a Bcc address.                      │
1776 # ├─────────┼───────────────────────────────────────────────────────────────────┤ 
1777 # │4 │All remaining cases.                                               │
1778 # └─────────┴───────────────────────────────────────────────────────────────────┘ 
1779
1780 # If this is empty or unset (default), the traditional long "To ", "Cc " and "Bcc
1781 # " prefixes are used. If set but too short to include a character for a
1782 # particular case, a single space will be prepended to the field. To prevent any
1783 # prefix at all from being added in a particular case, use the special value CR
1784 # (aka ^M) for the corresponding character.
1785
1786 # This slightly odd interface is necessitated by NeoMutt's handling of string
1787 # variables; one can't tell a variable that is unset from one that is set to the
1788 # empty string.
1789
1790
1791
1792 # 3.117. gecos_mask
1793
1794 # Type: regular expression
1795 # Default: “^[^,]*”
1796
1797 # A regular expression used by NeoMutt to parse the GECOS field of a password
1798 # entry when expanding the alias. The default value will return the string up to
1799 # the first "," encountered. If the GECOS field contains a string like "lastname,
1800 # firstname" then you should set it to ".*".
1801
1802 # This can be useful if you see the following behavior: you address an e-mail to
1803 # user ID "stevef" whose full name is "Steve Franklin". If NeoMutt expands
1804 # "stevef" to '"Franklin" stevef@foo.bar' then you should set the $gecos_mask to
1805 # a regular expression that will match the whole name so NeoMutt will expand
1806 # "Franklin" to "Franklin, Steve".
1807
1808
1809
1810 # 3.118. greeting
1811
1812 # Type: string
1813 # Default: (empty)
1814
1815 # When set, this is the string that will precede every message as a greeting
1816 # phrase to the recipients.
1817
1818 # "Format strings" are similar to the strings used in the "C" function printf to
1819 # format output (see the man page for more detail). The following sequences are
1820 # defined in NeoMutt:
1821
1822 # ┌──┬──────────────────────────────┐ 
1823 # │%n│Recipient's real name         │
1824 # ├──┼──────────────────────────────┤ 
1825 # │%u│User (login) name of recipient│
1826 # ├──┼──────────────────────────────┤ 
1827 # │%v│First name of recipient       │
1828 # └──┴──────────────────────────────┘ 
1829
1830
1831
1832 # 3.119. group_index_format
1833
1834 # Type: string
1835 # Default: “%4C %M%N %5s  %-45.45f %d”
1836
1837 # This variable allows you to customize the newsgroup browser display to your
1838 # personal taste. This string is similar to "index_format", but has its own set
1839 # of printf()-like sequences:
1840
1841 # ┌───┬──────────────────────────────────────────────────────────────────┐ 
1842 # │%C │Current newsgroup number                                          │
1843 # ├───┼──────────────────────────────────────────────────────────────────┤ 
1844 # │%d │Description of newsgroup (becomes from server)                    │
1845 # ├───┼──────────────────────────────────────────────────────────────────┤ 
1846 # │%f │Newsgroup name                                                    │
1847 # ├───┼──────────────────────────────────────────────────────────────────┤ 
1848 # │%M │- if newsgroup not allowed for direct post (moderated for example)│
1849 # ├───┼──────────────────────────────────────────────────────────────────┤ 
1850 # │%N │N if newsgroup is new, u if unsubscribed, blank otherwise         │
1851 # ├───┼──────────────────────────────────────────────────────────────────┤ 
1852 # │%n │Number of new articles in newsgroup                               │
1853 # ├───┼──────────────────────────────────────────────────────────────────┤ 
1854 # │%s │Number of unread articles in newsgroup                            │
1855 # ├───┼──────────────────────────────────────────────────────────────────┤ 
1856 # │%>X│Right justify the rest of the string and pad with character "X"   │
1857 # ├───┼──────────────────────────────────────────────────────────────────┤ 
1858 # │%|X│Pad to the end of the line with character "X"                     │
1859 # └───┴──────────────────────────────────────────────────────────────────┘ 
1860
1861
1862
1863 # 3.120. hdrs
1864
1865 # Type: boolean
1866 # Default: yes
1867
1868 # When unset, the header fields normally added by the "my_hdr" command are not
1869 # created. This variable must be unset before composing a new message or replying
1870 # in order to take effect. If set, the user defined header fields are added to
1871 # every new message.
1872
1873
1874
1875 # 3.121. header
1876
1877 # Type: boolean
1878 # Default: no
1879
1880 # When set, this variable causes NeoMutt to include the header of the message you
1881 # are replying to into the edit buffer. The $weed setting applies.
1882
1883
1884
1885 # 3.122. header_cache
1886
1887 # Type: path
1888 # Default: (empty)
1889
1890 # This variable points to the header cache database. If the path points to an
1891 # existing directory, NeoMutt will create a dedicated header cache database per
1892 # folder. Otherwise, the path points to a regular file, which will be created as
1893 # needed and used as a shared global header cache for all folders. By default it
1894 # is unset so no header caching will be used.
1895
1896 # Header caching can greatly improve speed when opening POP, IMAP MH or Maildir
1897 # folders, see "caching" for details.
1898
1899 set header_cache="~/.var/neomutt/header_cache"
1900
1901
1902 # 3.123. header_cache_backend
1903
1904 # Type: string
1905 # Default: (empty)
1906
1907 # This variable specifies the header cache backend. If no backend is specified,
1908 # the first available backend will be used in the following order: tokyocabinet,
1909 # kyotocabinet, qdbm, rocksdb, gdbm, bdb, tdb, lmdb.
1910
1911
1912
1913 # 3.124. header_color_partial
1914
1915 # Type: boolean
1916 # Default: no
1917
1918 # When set, color header regexes behave like color body regexes: color is applied
1919 # to the exact text matched by the regex. When unset, color is applied to the
1920 # entire header.
1921
1922 # One use of this option might be to apply color to just the header labels.
1923
1924 # See "color" for more details.
1925
1926
1927
1928 # 3.125. help
1929
1930 # Type: boolean
1931 # Default: yes
1932
1933 # When set, help lines describing the bindings for the major functions provided
1934 # by each menu are displayed on the first line of the screen.
1935
1936 # Note: The binding will not be displayed correctly if the function is bound to a
1937 # sequence rather than a single keystroke. Also, the help line may not be updated
1938 # if a binding is changed while NeoMutt is running. Since this variable is
1939 # primarily aimed at new users, neither of these should present a major problem.
1940
1941
1942
1943 # 3.126. hidden_host
1944
1945 # Type: boolean
1946 # Default: no
1947
1948 # When set, NeoMutt will skip the host name part of $hostname variable when
1949 # adding the domain part to addresses. This variable does not affect the
1950 # generation of Message-IDs, and it will not lead to the cut-off of first-level
1951 # domains. 
1952
1953
1954
1955 # 3.127. hidden_tags
1956
1957 # Type: string list
1958 # Default: “unread,draft,flagged,passed,replied,attachment,signed,encrypted”
1959
1960 # This variable specifies a list of comma-separated private notmuch/imap tags
1961 # which should not be printed on screen.
1962
1963
1964
1965 # 3.128. hide_limited
1966
1967 # Type: boolean
1968 # Default: no
1969
1970 # When set, NeoMutt will not show the presence of messages that are hidden by
1971 # limiting, in the thread tree.
1972
1973
1974
1975 # 3.129. hide_missing
1976
1977 # Type: boolean
1978 # Default: yes
1979
1980 # When set, NeoMutt will not show the presence of missing messages in the thread
1981 # tree. 
1982
1983
1984
1985 # 3.130. hide_thread_subject
1986
1987 # Type: boolean
1988 # Default: yes
1989
1990 # When set, NeoMutt will not show the subject of messages in the thread tree that
1991 # have the same subject as their parent or closest previously displayed sibling.
1992
1993
1994
1995 # 3.131. hide_top_limited
1996
1997 # Type: boolean
1998 # Default: no
1999
2000 # When set, NeoMutt will not show the presence of messages that are hidden by
2001 # limiting, at the top of threads in the thread tree. Note that when
2002 # $hide_limited is set, this option will have no effect.
2003
2004
2005
2006 # 3.132. hide_top_missing
2007
2008 # Type: boolean
2009 # Default: yes
2010
2011 # When set, NeoMutt will not show the presence of missing messages at the top of
2012 # threads in the thread tree. Note that when $hide_missing is set, this option
2013 # will have no effect.
2014
2015
2016
2017 # 3.133. history
2018
2019 # Type: number
2020 # Default: 10
2021
2022 # This variable controls the size (in number of strings remembered) of the string
2023 # history buffer per category. The buffer is cleared each time the variable is
2024 # set. 
2025
2026
2027
2028 # 3.134. history_file
2029
2030 # Type: path
2031 # Default: “~/.mutthistory”
2032
2033 # The file in which NeoMutt will save its history.
2034
2035 # Also see $save_history.
2036
2037 set history_file="~/.var/neomutt/history"
2038
2039
2040 # 3.135. history_remove_dups
2041
2042 # Type: boolean
2043 # Default: no
2044
2045 # When set, all of the string history will be scanned for duplicates when a new
2046 # entry is added. Duplicate entries in the $history_file will also be removed
2047 # when it is periodically compacted.
2048
2049
2050
2051 # 3.136. honor_disposition
2052
2053 # Type: boolean
2054 # Default: no
2055
2056 # When set, NeoMutt will not display attachments with a disposition of
2057 # "attachment" inline even if it could render the part to plain text. These MIME
2058 # parts can only be viewed from the attachment menu.
2059
2060 # If unset, NeoMutt will render all MIME parts it can properly transform to plain
2061 # text. 
2062
2063
2064
2065 # 3.137. honor_followup_to
2066
2067 # Type: quadoption
2068 # Default: yes
2069
2070 # This variable controls whether or not a Mail-Followup-To header is honored when
2071 # group-replying to a message.
2072
2073
2074
2075 # 3.138. hostname
2076
2077 # Type: string
2078 # Default: (empty)
2079
2080 # Specifies the fully-qualified hostname of the system NeoMutt is running on
2081 # containing the host's name and the DNS domain it belongs to. It is used as the
2082 # domain part (after "@") for local email addresses as well as Message-Id
2083 # headers. 
2084
2085 # If not specified in a config file, then NeoMutt will try to determine the
2086 # hostname itself.
2087
2088 # Optionally, NeoMutt can be compiled with a fixed domain name.
2089
2090 # Also see $use_domain and $hidden_host.
2091
2092 # Note: On Debian systems, the default for this variable is obtained from /etc/
2093 # mailname when Mutt starts.
2094
2095
2096
2097 # 3.139. idn_decode
2098
2099 # Type: boolean
2100 # Default: yes
2101
2102 # When set, NeoMutt will show you international domain names decoded. Note: You
2103 # can use IDNs for addresses even if this is unset. This variable only affects
2104 # decoding. (IDN only)
2105
2106
2107
2108 # 3.140. idn_encode
2109
2110 # Type: boolean
2111 # Default: yes
2112
2113 # When set, NeoMutt will encode international domain names using IDN. Unset this
2114 # if your SMTP server can handle newer (RFC6531) UTF-8 encoded domains. (IDN
2115 # only) 
2116
2117
2118
2119 # 3.141. ignore_list_reply_to
2120
2121 # Type: boolean
2122 # Default: no
2123
2124 # Affects the behavior of the <reply> function when replying to messages from
2125 # mailing lists (as defined by the "subscribe" or "lists" commands). When set, if
2126 # the "Reply-To:" field is set to the same value as the "To:" field, NeoMutt
2127 # assumes that the "Reply-To:" field was set by the mailing list to automate
2128 # responses to the list, and will ignore this field. To direct a response to the
2129 # mailing list when this option is set, use the <list-reply> function;
2130 # <group-reply> will reply to both the sender and the list.
2131
2132 set ignore_list_reply_to=yes
2133
2134
2135 # 3.142. imap_authenticators
2136
2137 # Type: string list
2138 # Default: (empty)
2139
2140 # This is a colon-separated list of authentication methods NeoMutt may attempt to
2141 # use to log in to an IMAP server, in the order NeoMutt should try them.
2142 # Authentication methods are either "login" or the right side of an IMAP "AUTH=
2143 # xxx" capability string, e.g. "digest-md5", "gssapi" or "cram-md5". This option
2144 # is case-insensitive. If it's unset (the default) NeoMutt will try all available
2145 # methods, in order from most-secure to least-secure.
2146
2147 # Example: 
2148
2149 # set imap_authenticators="gssapi:cram-md5:login"
2150
2151 # Note: NeoMutt will only fall back to other authentication methods if the
2152 # previous methods are unavailable. If a method is available but authentication
2153 # fails, NeoMutt will not connect to the IMAP server.
2154
2155
2156
2157 # 3.143. imap_check_subscribed
2158
2159 # Type: boolean
2160 # Default: no
2161
2162 # When set, NeoMutt will fetch the set of subscribed folders from your server
2163 # whenever a mailbox is selected, and add them to the set of mailboxes it polls
2164 # for new mail just as if you had issued individual "mailboxes" commands.
2165
2166
2167
2168 # 3.144. imap_condstore
2169
2170 # Type: boolean
2171 # Default: no
2172
2173 # When set, NeoMutt will use the CONDSTORE extension (RFC7162) if advertised by
2174 # the server. NeoMutt's current implementation is basic, used only for initial
2175 # message fetching and flag updates.
2176
2177 # For some IMAP servers, enabling this will slightly speed up downloading initial
2178 # messages. Unfortunately, Gmail is not one those, and displays worse performance
2179 # when enabled. Your mileage may vary.
2180
2181
2182
2183 # 3.145. imap_delim_chars
2184
2185 # Type: string
2186 # Default: “/.”
2187
2188 # This contains the list of characters that NeoMutt will use as folder separators
2189 # for IMAP paths, when no separator is provided on the IMAP connection.
2190
2191
2192
2193 # 3.146. imap_fetch_chunk_size
2194
2195 # Type: number (long)
2196 # Default: 0
2197
2198 # When set to a value greater than 0, new headers will be downloaded in groups of
2199 # this many headers per request. If you have a very large mailbox, this might
2200 # prevent a timeout and disconnect when opening the mailbox, by sending a FETCH
2201 # per set of this many headers, instead of a single FETCH for all new headers.
2202
2203
2204
2205 # 3.147. imap_headers
2206
2207 # Type: string
2208 # Default: (empty)
2209
2210 # NeoMutt requests these header fields in addition to the default headers
2211 # ("Date:", "From:", "Sender:", "Subject:", "To:", "Cc:", "Message-Id:",
2212 # "References:", "Content-Type:", "Content-Description:", "In-Reply-To:",
2213 # "Reply-To:", "Lines:", "List-Post:", "X-Label:") from IMAP servers before
2214 # displaying the index menu. You may want to add more headers for spam detection.
2215
2216 # Note: This is a space separated list, items should be uppercase and not contain
2217 # the colon, e.g. "X-BOGOSITY X-SPAM-STATUS" for the "X-Bogosity:" and
2218 # "X-Spam-Status:" header fields.
2219
2220
2221
2222 # 3.148. imap_idle
2223
2224 # Type: boolean
2225 # Default: no
2226
2227 # When set, NeoMutt will attempt to use the IMAP IDLE extension to check for new
2228 # mail in the current mailbox. Some servers (dovecot was the inspiration for this
2229 # option) react badly to NeoMutt's implementation. If your connection seems to
2230 # freeze up periodically, try unsetting this.
2231
2232
2233
2234 # 3.149. imap_keepalive
2235
2236 # Type: number
2237 # Default: 300
2238
2239 # This variable specifies the maximum amount of time in seconds that NeoMutt will
2240 # wait before polling open IMAP connections, to prevent the server from closing
2241 # them before NeoMutt has finished with them. The default is well within the
2242 # RFC-specified minimum amount of time (30 minutes) before a server is allowed to
2243 # do this, but in practice the RFC does get violated every now and then. Reduce
2244 # this number if you find yourself getting disconnected from your IMAP server due
2245 # to inactivity.
2246
2247
2248
2249 # 3.150. imap_list_subscribed
2250
2251 # Type: boolean
2252 # Default: no
2253
2254 # This variable configures whether IMAP folder browsing will look for only
2255 # subscribed folders or all folders. This can be toggled in the IMAP browser with
2256 # the <toggle-subscribed> function.
2257
2258
2259
2260 # 3.151. imap_login
2261
2262 # Type: string
2263 # Default: (empty)
2264
2265 # Your login name on the IMAP server.
2266
2267 # This variable defaults to the value of $imap_user.
2268
2269
2270
2271 # 3.152. imap_oauth_refresh_command
2272
2273 # Type: command
2274 # Default: (empty)
2275
2276 # The command to run to generate an OAUTH refresh token for authorizing your
2277 # connection to your IMAP server. This command will be run on every connection
2278 # attempt that uses the OAUTHBEARER or XOAUTH2 authentication mechanisms. See "
2279 # oauth" for details.
2280
2281
2282
2283 # 3.153. imap_pass
2284
2285 # Type: string
2286 # Default: (empty)
2287
2288 # Specifies the password for your IMAP account. If unset, NeoMutt will prompt you
2289 # for your password when you invoke the <imap-fetch-mail> function or try to open
2290 # an IMAP folder.
2291
2292 # Warning: you should only use this option when you are on a fairly secure
2293 # machine, because the superuser can read your neomuttrc even if you are the only
2294 # one who can read the file.
2295
2296
2297
2298 # 3.154. imap_passive
2299
2300 # Type: boolean
2301 # Default: yes
2302
2303 # When set, NeoMutt will not open new IMAP connections to check for new mail.
2304 # NeoMutt will only check for new mail over existing IMAP connections. This is
2305 # useful if you don't want to be prompted for user/password pairs on NeoMutt
2306 # invocation, or if opening the connection is slow.
2307
2308
2309
2310 # 3.155. imap_peek
2311
2312 # Type: boolean
2313 # Default: yes
2314
2315 # When set, NeoMutt will avoid implicitly marking your mail as read whenever you
2316 # fetch a message from the server. This is generally a good thing, but can make
2317 # closing an IMAP folder somewhat slower. This option exists to appease speed
2318 # freaks. 
2319
2320
2321
2322 # 3.156. imap_pipeline_depth
2323
2324 # Type: number
2325 # Default: 15
2326
2327 # Controls the number of IMAP commands that may be queued up before they are sent
2328 # to the server. A deeper pipeline reduces the amount of time NeoMutt must wait
2329 # for the server, and can make IMAP servers feel much more responsive. But not
2330 # all servers correctly handle pipelined commands, so if you have problems you
2331 # might want to try setting this variable to 0.
2332
2333 # Note: Changes to this variable have no effect on open connections.
2334
2335
2336
2337 # 3.157. imap_poll_timeout
2338
2339 # Type: number
2340 # Default: 15
2341
2342 # This variable specifies the maximum amount of time in seconds that NeoMutt will
2343 # wait for a response when polling IMAP connections for new mail, before timing
2344 # out and closing the connection. Set to 0 to disable timing out.
2345
2346
2347
2348 # 3.158. imap_qresync
2349
2350 # Type: boolean
2351 # Default: no
2352
2353 # When set, NeoMutt will use the QRESYNC extension (RFC7162) if advertised by the
2354 # server. NeoMutt's current implementation is basic, used only for initial
2355 # message fetching and flag updates.
2356
2357 # Note: this feature is currently experimental. If you experience strange
2358 # behavior, such as duplicate or missing messages please file a bug report to let
2359 # us know.
2360
2361
2362
2363 # 3.159. imap_rfc5161
2364
2365 # Type: boolean
2366 # Default: yes
2367
2368 # When set, NeoMutt will use the IMAP ENABLE extension (RFC5161) to select
2369 # CAPABILITIES. Some servers (notably Coremail System IMap Server) do not
2370 # properly respond to ENABLE commands, which might cause NeoMutt to hang. If your
2371 # connection seems to freeze at login, try unsetting this. See also https://
2372 # github.com/neomutt/neomutt/issues/1689 
2373
2374
2375
2376 # 3.160. imap_server_noise
2377
2378 # Type: boolean
2379 # Default: yes
2380
2381 # When set, NeoMutt will display warning messages from the IMAP server as error
2382 # messages. Since these messages are often harmless, or generated due to
2383 # configuration problems on the server which are out of the users' hands, you may
2384 # wish to suppress them at some point.
2385
2386
2387
2388 # 3.161. imap_user
2389
2390 # Type: string
2391 # Default: (empty)
2392
2393 # The name of the user whose mail you intend to access on the IMAP server.
2394
2395 # This variable defaults to your user name on the local machine.
2396
2397
2398
2399 # 3.162. implicit_autoview
2400
2401 # Type: boolean
2402 # Default: no
2403
2404 # If set to "yes", NeoMutt will look for a mailcap entry with the "copiousoutput"
2405 # flag set for every MIME attachment it doesn't have an internal viewer defined
2406 # for. If such an entry is found, NeoMutt will use the viewer defined in that
2407 # entry to convert the body part to text form.
2408
2409 set implicit_autoview=no
2410
2411
2412 # 3.163. include
2413
2414 # Type: quadoption
2415 # Default: ask-yes
2416
2417 # Controls whether or not a copy of the message(s) you are replying to is
2418 # included in your reply.
2419
2420 set include=yes
2421
2422
2423 # 3.164. include_encrypted
2424
2425 # Type: boolean
2426 # Default: no
2427
2428 # Controls whether or not NeoMutt includes separately encrypted attachment
2429 # contents when replying.
2430
2431 # This variable was added to prevent accidental exposure of encrypted contents
2432 # when replying to an attacker. If a previously encrypted message were attached
2433 # by the attacker, they could trick an unwary recipient into decrypting and
2434 # including the message in their reply.
2435
2436
2437
2438 # 3.165. include_only_first
2439
2440 # Type: boolean
2441 # Default: no
2442
2443 # Controls whether or not NeoMutt includes only the first attachment of the
2444 # message you are replying.
2445
2446
2447
2448 # 3.166. indent_string
2449
2450 # Type: string
2451 # Default: “> ”
2452
2453 # Specifies the string to prepend to each line of text quoted in a message to
2454 # which you are replying. You are strongly encouraged not to change this value,
2455 # as it tends to agitate the more fanatical netizens.
2456
2457 # The value of this option is ignored if $text_flowed is set, because the quoting
2458 # mechanism is strictly defined for format=flowed.
2459
2460 # This option is a format string, please see the description of $index_format for
2461 # supported printf(3)-style sequences.
2462
2463
2464
2465 # 3.167. index_format
2466
2467 # Type: string
2468 # Default: “%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s”
2469
2470 # This variable allows you to customize the message index display to your
2471 # personal taste.
2472
2473 # "Format strings" are similar to the strings used in the C function printf(3) to
2474 # format output (see the man page for more details). For an explanation of the %?
2475 # construct, see the status_format description. The following sequences are
2476 # defined in NeoMutt:
2477
2478 # ┌───────┬─────────────────────────────────────────────────────────────────────┐ 
2479 # │%a │Address of the author                                                │
2480 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2481 # │%A │Reply-to address (if present; otherwise: address of author)          │
2482 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2483 # │%b │Filename of the original message folder (think mailbox)              │
2484 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2485 # │%B │Same as %K                                                           │
2486 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2487 # │%C │Current message number                                               │
2488 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2489 # │%c │Number of characters (bytes) in the body of the message (see         │
2490 # │ │formatstrings-size)                                                  │
2491 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2492 # │%cr │Number of characters (bytes) in the raw message, including the header│
2493 # │ │(see formatstrings-size)                                             │
2494 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2495 # │%D │Date and time of message using date_format and local timezone        │
2496 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2497 # │%d │Date and time of message using date_format and sender's timezone     │
2498 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2499 # │%e │Current message number in thread                                     │
2500 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2501 # │%E │Number of messages in current thread                                 │
2502 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2503 # │%F │Author name, or recipient name if the message is from you            │
2504 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2505 # │%Fp │Like %F, but plain. No contextual formatting is applied to recipient │
2506 # │ │name                                                                 │
2507 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2508 # │%f │Sender (address + real name), either From: or Return-Path:           │
2509 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2510 # │%g │Newsgroup name (if compiled with NNTP support)                       │
2511 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2512 # │%g │Message tags (e.g. notmuch tags/imap flags)                          │
2513 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2514 # │%Gx │Individual message tag (e.g. notmuch tags/imap flags)                │
2515 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2516 # │%H │Spam attribute(s) of this message                                    │
2517 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2518 # │%I │Initials of author                                                   │
2519 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2520 # │%i │Message-id of the current message                                    │
2521 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2522 # │%J │Message tags (if present, tree unfolded, and != parent's tags)       │
2523 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2524 # │%K │The list to which the letter was sent (if any; otherwise: empty)     │
2525 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2526 # │ │If an address in the "To:" or "Cc:" header field matches an address  │
2527 # │%L │Defined by the user's "subscribe" command, this displays "To         │
2528 # │ │<list-name>", otherwise the same as %F                               │
2529 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2530 # │%l │number of lines in the unprocessed message (may not work with        │
2531 # │ │maildir, mh, and IMAP folders)                                       │
2532 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2533 # │%M │Number of hidden messages if the thread is collapsed                 │
2534 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2535 # │%m │Total number of message in the mailbox                               │
2536 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2537 # │%N │Message score                                                        │
2538 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2539 # │%n │Author's real name (or address if missing)                           │
2540 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2541 # │%O │Original save folder where NeoMutt would formerly have Stashed the   │
2542 # │ │message: list name or recipient name If not sent to a list           │
2543 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2544 # │%P │Progress indicator for the built-in pager (how much of the file has  │
2545 # │ │been displayed)                                                      │
2546 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2547 # │%q │Newsgroup name (if compiled with NNTP support)                       │
2548 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2549 # │%R │Comma separated list of "Cc:" recipients                             │
2550 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2551 # │%r │Comma separated list of "To:" recipients                             │
2552 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2553 # │%S │Single character status of the message ("N"/"O"/"D"/"d"/"!"/"r"/"*") │
2554 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2555 # │%s │Subject of the message                                               │
2556 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2557 # │%T │The appropriate character from the $to_chars string                  │
2558 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2559 # │%t │"To:" field (recipients)                                             │
2560 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2561 # │%u │User (login) name of the author                                      │
2562 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2563 # │%v │First name of the author, or the recipient if the message is from you│
2564 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2565 # │%W │Name of organization of author ("Organization:" field)               │
2566 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2567 # │%x │"X-Comment-To:" field (if present and compiled with NNTP support)    │
2568 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2569 # │%X │Number of MIME attachments (please see the "attachments" section for │
2570 # │ │possible speed effects)                                              │
2571 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2572 # │ │"X-Label:" field, if present, and (1) not at part of a thread tree,  │
2573 # │%Y │(2) at the top of a thread, or (3) "X-Label:" is different from      │
2574 # │ │Preceding message's "X-Label:"                                       │
2575 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2576 # │%y │"X-Label:" field, if present                                         │
2577 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2578 # │ │A three character set of message status flags. The first character is│
2579 # │ │new/read/replied flags ("n"/"o"/"r"/"O"/"N"). The second is deleted  │
2580 # │%Z │or encryption flags ("D"/"d"/"S"/"P"/"s"/"K"). The third is either   │
2581 # │ │tagged/flagged ("*"/"!"), or one of the characters Listed in         │
2582 # │ │$to_chars.                                                           │
2583 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2584 # │%zc │Message crypto flags                                                 │
2585 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2586 # │%zs │Message status flags                                                 │
2587 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2588 # │%zt │Message tag flags                                                    │
2589 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2590 # │%@name@│insert and evaluate format-string from the matching "                │
2591 # │ │index-format-hook" command                                           │
2592 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2593 # │ │the date and time of the message is converted to sender's time zone, │
2594 # │ │and "fmt" is expanded by the library function strftime(3); if the    │
2595 # │%{fmt} │first character inside the braces is a bang ("!"), the date is       │
2596 # │ │formatted ignoring any locale settings. Note that the sender's time  │
2597 # │ │zone might only be available as a numerical offset, so "%Z" behaves  │
2598 # │ │like "%z".                                                           │
2599 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2600 # │ │the date and time of the message is converted to the local time zone,│
2601 # │%[fmt] │and "fmt" is expanded by the library function strftime(3); if the    │
2602 # │ │first character inside the brackets is a bang ("!"), the date is     │
2603 # │ │formatted ignoring any locale settings.                              │
2604 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2605 # │ │the local date and time when the message was received, and "fmt" is  │
2606 # │%(fmt) │expanded by the library function strftime(3); if the first character │
2607 # │ │inside the parentheses is a bang ("!"), the date is formatted        │
2608 # │ │ignoring any locale settings.                                        │
2609 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2610 # │%>X │right justify the rest of the string and pad with character "X"      │
2611 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2612 # │%|X │pad to the end of the line with character "X"                        │
2613 # ├───────┼─────────────────────────────────────────────────────────────────────┤ 
2614 # │%*X │soft-fill with character "X" as pad                                  │
2615 # └───────┴─────────────────────────────────────────────────────────────────────┘ 
2616
2617 # Date format expressions can be constructed based on relative dates. Using the
2618 # date formatting operators along with nested conditionals, the date format can
2619 # be modified based on how old a message is. See the section on "Conditional
2620 # Dates" for an explanation and examples
2621
2622 # Note that for mbox/mmdf, "%l" applies to the unprocessed message, and for
2623 # maildir/mh, the value comes from the "Lines:" header field when present (the
2624 # meaning is normally the same). Thus the value depends on the encodings used in
2625 # the different parts of the message and has little meaning in practice.
2626
2627 # "Soft-fill" deserves some explanation: Normal right-justification will print
2628 # everything to the left of the "%>", displaying padding and whatever lies to the
2629 # right only if there's room. By contrast, soft-fill gives priority to the
2630 # right-hand side, guaranteeing space to display it and showing padding only if
2631 # there's still room. If necessary, soft-fill will eat text leftwards to make
2632 # room for rightward text.
2633
2634 # Note that these expandos are supported in "save-hook", "fcc-hook" and "
2635 # fcc-save-hook", too.
2636
2637
2638
2639 # 3.168. inews
2640
2641 # Type: command
2642 # Default: (empty)
2643
2644 # If set, specifies the program and arguments used to deliver news posted by
2645 # NeoMutt. Otherwise, NeoMutt posts article using current connection to news
2646 # server. The following printf-style sequence is understood:
2647
2648 # ┌──┬──────────────────┐ 
2649 # │%a│account url       │
2650 # ├──┼──────────────────┤ 
2651 # │%p│port │
2652 # ├──┼──────────────────┤ 
2653 # │%P│port if specified │
2654 # ├──┼──────────────────┤ 
2655 # │%s│news server name  │
2656 # ├──┼──────────────────┤ 
2657 # │%S│url schema        │
2658 # ├──┼──────────────────┤ 
2659 # │%u│username │
2660 # └──┴──────────────────┘ 
2661
2662 # Example: 
2663
2664 # set inews="/usr/local/bin/inews -hS"
2665
2666
2667
2668 # 3.169. ispell
2669
2670 # Type: command
2671 # Default: “ispell”
2672
2673 # How to invoke ispell (GNU's spell-checking software).
2674
2675
2676
2677 # 3.170. keep_flagged
2678
2679 # Type: boolean
2680 # Default: no
2681
2682 # If set, read messages marked as flagged will not be moved from your spool
2683 # mailbox to your $mbox mailbox, or as a result of a "mbox-hook" command.
2684
2685
2686
2687 # 3.171. local_date_header
2688
2689 # Type: boolean
2690 # Default: yes
2691
2692 # If set, the date in the Date header of emails that you send will be in your
2693 # local timezone. If unset a UTC date will be used instead to avoid leaking
2694 # information about your current location.
2695
2696
2697
2698 # 3.172. mail_check
2699
2700 # Type: number
2701 # Default: 5
2702
2703 # This variable configures how often (in seconds) NeoMutt should look for new
2704 # mail. Also see the $timeout variable.
2705
2706
2707
2708 # 3.173. mail_check_recent
2709
2710 # Type: boolean
2711 # Default: yes
2712
2713 # When set, NeoMutt will only notify you about new mail that has been received
2714 # since the last time you opened the mailbox. When unset, NeoMutt will notify you
2715 # if any new mail exists in the mailbox, regardless of whether you have visited
2716 # it recently.
2717
2718 # When $mark_old is set, NeoMutt does not consider the mailbox to contain new
2719 # mail if only old messages exist.
2720
2721
2722
2723 # 3.174. mail_check_stats
2724
2725 # Type: boolean
2726 # Default: no
2727
2728 # When set, NeoMutt will periodically calculate message statistics of a mailbox
2729 # while polling for new mail. It will check for unread, flagged, and total
2730 # message counts. Because this operation is more performance intensive, it
2731 # defaults to unset, and has a separate option, $mail_check_stats_interval, to
2732 # control how often to update these counts.
2733
2734 # Message statistics can also be explicitly calculated by invoking the
2735 # <check-stats> function.
2736
2737 set mail_check_stats=yes
2738
2739
2740 # 3.175. mail_check_stats_interval
2741
2742 # Type: number
2743 # Default: 60
2744
2745 # When $mail_check_stats is set, this variable configures how often (in seconds)
2746 # NeoMutt will update message counts.
2747
2748
2749
2750 # 3.176. mailcap_path
2751
2752 # Type: string list
2753 # Default: “~/.mailcap:/usr/share/neomutt/mailcap:/etc/mailcap:/etc/mailcap:/usr/
2754 # etc/mailcap:/usr/local/etc/mailcap” 
2755
2756 # This variable specifies a list of colon-separated files to consult when
2757 # attempting to display MIME bodies not directly supported by NeoMutt. The
2758 # default value is generated during startup: see the "mailcap" section of the
2759 # manual. 
2760
2761 # $mailcap_path is overridden by the environment variable $MAILCAPS.
2762
2763 # The default search path is from RFC1524.
2764
2765 set mailcap_path="$my_confdir/mailcap.containers:$my_confdir/mailcap.icalendar:$my_confdir/mailcap.backgrounding:$my_confdir/mailcap.htmldump"
2766
2767
2768 # 3.177. mailcap_sanitize
2769
2770 # Type: boolean
2771 # Default: yes
2772
2773 # If set, NeoMutt will restrict possible characters in mailcap % expandos to a
2774 # well-defined set of safe characters. This is the safe setting, but we are not
2775 # sure it doesn't break some more advanced MIME stuff.
2776
2777 # DON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE DOING!
2778
2779
2780
2781 # 3.178. maildir_check_cur
2782
2783 # Type: boolean
2784 # Default: no
2785
2786 # If set, NeoMutt will poll both the new and cur directories of a maildir folder
2787 # for new messages. This might be useful if other programs interacting with the
2788 # folder (e.g. dovecot) are moving new messages to the cur directory. Note that
2789 # setting this option may slow down polling for new messages in large folders,
2790 # since NeoMutt has to scan all cur messages.
2791
2792
2793
2794 # 3.179. maildir_header_cache_verify
2795
2796 # Type: boolean
2797 # Default: yes
2798
2799 # Check for Maildir unaware programs other than NeoMutt having modified maildir
2800 # files when the header cache is in use. This incurs one stat(2) per message
2801 # every time the folder is opened (which can be very slow for NFS folders).
2802
2803 set maildir_header_cache_verify=no
2804
2805
2806 # 3.180. maildir_trash
2807
2808 # Type: boolean
2809 # Default: no
2810
2811 # If set, messages marked as deleted will be saved with the maildir trashed flag
2812 # instead of unlinked. Note: this only applies to maildir-style mailboxes.
2813 # Setting it will have no effect on other mailbox types.
2814
2815
2816
2817 # 3.181. mark_macro_prefix
2818
2819 # Type: string
2820 # Default: “'”
2821
2822 # Prefix for macros created using mark-message. A new macro automatically
2823 # generated with <mark-message>a will be composed from this prefix and the letter
2824 # a. 
2825
2826
2827
2828 # 3.182. mark_old
2829
2830 # Type: boolean
2831 # Default: yes
2832
2833 # Controls whether or not NeoMutt marks new unread messages as old if you exit a
2834 # mailbox without reading them. With this option set, the next time you start
2835 # NeoMutt, the messages will show up with an "O" next to them in the index menu,
2836 # indicating that they are old.
2837
2838 set mark_old=no
2839
2840
2841 # 3.183. markers
2842
2843 # Type: boolean
2844 # Default: yes
2845
2846 # Controls the display of wrapped lines in the internal pager. If set, a "+"
2847 # marker is displayed at the beginning of wrapped lines.
2848
2849 # Also see the $smart_wrap variable.
2850
2851 set markers=no
2852
2853
2854 # 3.184. mask
2855
2856 # Type: regular expression
2857 # Default: “!^.[^.]”
2858
2859 # A regular expression used in the file browser, optionally preceded by the not
2860 # operator "!". Only files whose names match this mask will be shown. The match
2861 # is always case-sensitive.
2862
2863
2864
2865 # 3.185. mbox
2866
2867 # Type: mailbox
2868 # Default: “~/mbox”
2869
2870 # This specifies the folder into which read mail in your $spool_file folder will
2871 # be appended.
2872
2873 # Also see the $move variable.
2874
2875 set mbox="=spool"
2876
2877
2878 # 3.186. mbox_type
2879
2880 # Type: enumeration
2881 # Default: mbox
2882
2883 # The default mailbox type used when creating new folders. May be any of "mbox",
2884 # "MMDF", "MH" or "Maildir".
2885
2886 # This can also be set using the -m command-line option.
2887
2888 set mbox_type=Maildir
2889
2890
2891 # 3.187. me_too
2892
2893 # Type: boolean
2894 # Default: no
2895
2896 # If unset, NeoMutt will remove your address (see the "alternates" command) from
2897 # the list of recipients when replying to a message.
2898
2899
2900
2901 # 3.188. menu_context
2902
2903 # Type: number
2904 # Default: 0
2905
2906 # This variable controls the number of lines of context that are given when
2907 # scrolling through menus. (Similar to $pager_context.)
2908
2909 set menu_context=5
2910
2911
2912 # 3.189. menu_move_off
2913
2914 # Type: boolean
2915 # Default: yes
2916
2917 # When unset, the bottom entry of menus will never scroll up past the bottom of
2918 # the screen, unless there are less entries than lines. When set, the bottom
2919 # entry may move off the bottom.
2920
2921
2922
2923 # 3.190. menu_scroll
2924
2925 # Type: boolean
2926 # Default: no
2927
2928 # When set, menus will be scrolled up or down one line when you attempt to move
2929 # across a screen boundary. If unset, the screen is cleared and the next or
2930 # previous page of the menu is displayed (useful for slow links to avoid many
2931 # redraws). 
2932
2933 set menu_scroll=yes
2934
2935
2936 # 3.191. message_cache_clean
2937
2938 # Type: boolean
2939 # Default: no
2940
2941 # If set, NeoMutt will clean out obsolete entries from the message cache when the
2942 # mailbox is synchronized. You probably only want to set it every once in a
2943 # while, since it can be a little slow (especially for large folders).
2944
2945
2946
2947 # 3.192. message_cachedir
2948
2949 # Type: path
2950 # Default: (empty)
2951
2952 # Set this to a directory and NeoMutt will cache copies of messages from your
2953 # IMAP and POP servers here. You are free to remove entries at any time.
2954
2955 # When setting this variable to a directory, NeoMutt needs to fetch every remote
2956 # message only once and can perform regular expression searches as fast as for
2957 # local folders.
2958
2959 # Also see the $message_cache_clean variable.
2960
2961
2962
2963 # 3.193. message_format
2964
2965 # Type: string
2966 # Default: “%s”
2967
2968 # This is the string displayed in the "attachment" menu for attachments of type
2969 # message/rfc822. For a full listing of defined printf(3)-like sequences see the
2970 # section on $index_format.
2971
2972
2973
2974 # 3.194. meta_key
2975
2976 # Type: boolean
2977 # Default: no
2978
2979 # If set, forces NeoMutt to interpret keystrokes with the high bit (bit 8) set as
2980 # if the user had pressed the Esc key and whatever key remains after having the
2981 # high bit removed. For example, if the key pressed has an ASCII value of 0xf8,
2982 # then this is treated as if the user had pressed Esc then "x". This is because
2983 # the result of removing the high bit from 0xf8 is 0x78, which is the ASCII
2984 # character "x".
2985
2986
2987
2988 # 3.195. mh_purge
2989
2990 # Type: boolean
2991 # Default: no
2992
2993 # When unset, NeoMutt will mimic mh's behavior and rename deleted messages to ,
2994 # <old file name> in mh folders instead of really deleting them. This leaves the
2995 # message on disk but makes programs reading the folder ignore it. If the
2996 # variable is set, the message files will simply be deleted.
2997
2998 # This option is similar to $maildir_trash for Maildir folders.
2999
3000
3001
3002 # 3.196. mh_seq_flagged
3003
3004 # Type: string
3005 # Default: “flagged”
3006
3007 # The name of the MH sequence used for flagged messages.
3008
3009
3010
3011 # 3.197. mh_seq_replied
3012
3013 # Type: string
3014 # Default: “replied”
3015
3016 # The name of the MH sequence used to tag replied messages.
3017
3018
3019
3020 # 3.198. mh_seq_unseen
3021
3022 # Type: string
3023 # Default: “unseen”
3024
3025 # The name of the MH sequence used for unseen messages.
3026
3027
3028
3029 # 3.199. mime_forward
3030
3031 # Type: quadoption
3032 # Default: no
3033
3034 # When set, the message you are forwarding will be attached as a separate message
3035 # /rfc822 MIME part instead of included in the main body of the message. This is
3036 # useful for forwarding MIME messages so the receiver can properly view the
3037 # message as it was delivered to you. If you like to switch between MIME and not
3038 # MIME from mail to mail, set this variable to "ask-no" or "ask-yes".
3039
3040 # Also see $forward_decode and $mime_forward_decode.
3041
3042 set mime_forward=ask-yes
3043
3044
3045 # 3.200. mime_forward_decode
3046
3047 # Type: boolean
3048 # Default: no
3049
3050 # Controls the decoding of complex MIME messages into text/plain when forwarding
3051 # a message while $mime_forward is set. Otherwise $forward_decode is used
3052 # instead. 
3053
3054
3055
3056 # 3.201. mime_forward_rest
3057
3058 # Type: quadoption
3059 # Default: yes
3060
3061 # When forwarding multiple attachments of a MIME message from the attachment
3062 # menu, attachments which can't be decoded in a reasonable manner will be
3063 # attached to the newly composed message if this option is set.
3064
3065
3066
3067 # 3.202. mime_type_query_command
3068
3069 # Type: command
3070 # Default: (empty)
3071
3072 # This specifies a command to run, to determine the mime type of a new attachment
3073 # when composing a message. Unless $mime_type_query_first is set, this will only
3074 # be run if the attachment's extension is not found in the mime.types file.
3075
3076 # The string may contain a "%s", which will be substituted with the attachment
3077 # filename. NeoMutt will add quotes around the string substituted for "%s"
3078 # automatically according to shell quoting rules, so you should avoid adding your
3079 # own. If no "%s" is found in the string, NeoMutt will append the attachment
3080 # filename to the end of the string.
3081
3082 # The command should output a single line containing the attachment's mime type.
3083
3084 # Suggested values are "xdg-mime query filetype" or "file -bi".
3085
3086
3087
3088 # 3.203. mime_type_query_first
3089
3090 # Type: boolean
3091 # Default: no
3092
3093 # When set, the $mime_type_query_command will be run before the mime.types
3094 # lookup. 
3095
3096
3097
3098 # 3.204. mix_entry_format
3099
3100 # Type: string
3101 # Default: “%4n %c %-16s %a”
3102
3103 # This variable describes the format of a remailer line on the mixmaster chain
3104 # selection screen. The following printf(3)-like sequences are supported:
3105
3106 # ┌───┬───────────────────────────────────────────────────────────────┐ 
3107 # │%a │The remailer's e-mail address                                  │
3108 # ├───┼───────────────────────────────────────────────────────────────┤ 
3109 # │%c │Remailer capabilities                                          │
3110 # ├───┼───────────────────────────────────────────────────────────────┤ 
3111 # │%n │The running number on the menu                                 │
3112 # ├───┼───────────────────────────────────────────────────────────────┤ 
3113 # │%s │The remailer's short name                                      │
3114 # ├───┼───────────────────────────────────────────────────────────────┤ 
3115 # │%>X│right justify the rest of the string and pad with character "X"│
3116 # ├───┼───────────────────────────────────────────────────────────────┤ 
3117 # │%|X│pad to the end of the line with character "X"                  │
3118 # ├───┼───────────────────────────────────────────────────────────────┤ 
3119 # │%*X│soft-fill with character "X" as pad                            │
3120 # └───┴───────────────────────────────────────────────────────────────┘ 
3121
3122
3123
3124 # 3.205. mixmaster
3125
3126 # Type: command
3127 # Default: “mixmaster”
3128
3129 # This variable contains the path to the Mixmaster binary on your system. It is
3130 # used with various sets of parameters to gather the list of known remailers, and
3131 # to finally send a message through the mixmaster chain.
3132
3133 # Note: On Debian systems, this option is set by default to “mixmaster-filter” in
3134 # /etc/Muttrc. 
3135
3136 set mixmaster="mixmaster-filter"
3137
3138
3139 # 3.206. move
3140
3141 # Type: quadoption
3142 # Default: no
3143
3144 # Controls whether or not NeoMutt will move read messages from your spool mailbox
3145 # to your $mbox mailbox, or as a result of a "mbox-hook" command.
3146
3147 set move=no
3148
3149
3150 # 3.207. narrow_tree
3151
3152 # Type: boolean
3153 # Default: no
3154
3155 # This variable, when set, makes the thread tree narrower, allowing deeper
3156 # threads to fit on the screen.
3157
3158 set narrow_tree=yes
3159
3160
3161 # 3.208. net_inc
3162
3163 # Type: number
3164 # Default: 10
3165
3166 # Operations that expect to transfer a large amount of data over the network will
3167 # update their progress every $net_inc kilobytes. If set to 0, no progress
3168 # messages will be displayed.
3169
3170 # See also $read_inc, $write_inc and $net_inc.
3171
3172
3173
3174 # 3.209. new_mail_command
3175
3176 # Type: command
3177 # Default: (empty)
3178
3179 # If set, NeoMutt will call this command after a new message is received. See the
3180 # $status_format documentation for the values that can be formatted into this
3181 # command. 
3182
3183
3184
3185 # 3.210. news_cache_dir
3186
3187 # Type: path
3188 # Default: “~/.neomutt”
3189
3190 # This variable pointing to directory where NeoMutt will save cached news
3191 # articles and headers in. If unset, articles and headers will not be saved at
3192 # all and will be reloaded from the server each time.
3193
3194
3195
3196 # 3.211. news_server
3197
3198 # Type: string
3199 # Default: (empty)
3200
3201 # This variable specifies domain name or address of NNTP server.
3202
3203 # You can also specify username and an alternative port for each news server,
3204 # e.g. [[s]news://][username[:password]@]server[:port]
3205
3206 # This option can also be set using the command line option "-g", the environment
3207 # variable $NNTPSERVER, or putting the server name in the file "/etc/nntpserver".
3208
3209
3210
3211 # 3.212. newsgroups_charset
3212
3213 # Type: string
3214 # Default: “utf-8”
3215
3216 # Character set of newsgroups descriptions.
3217
3218
3219
3220 # 3.213. newsrc
3221
3222 # Type: path
3223 # Default: “~/.newsrc”
3224
3225 # The file, containing info about subscribed newsgroups - names and indexes of
3226 # read articles. The following printf-style sequence is understood:
3227
3228 # ┌───────┬─────────────────┬───────────────────┐ 
3229 # │Expando│Description │Example            │
3230 # ├───────┼─────────────────┼───────────────────┤ 
3231 # │%a │Account url      │news:news.gmane.org│
3232 # ├───────┼─────────────────┼───────────────────┤ 
3233 # │%p │Port             │119                │
3234 # ├───────┼─────────────────┼───────────────────┤ 
3235 # │%P │Port if specified│10119              │
3236 # ├───────┼─────────────────┼───────────────────┤ 
3237 # │%s │News server name │news.gmane.org     │
3238 # ├───────┼─────────────────┼───────────────────┤ 
3239 # │%S │Url schema       │news               │
3240 # ├───────┼─────────────────┼───────────────────┤ 
3241 # │%u │Username         │username           │
3242 # └───────┴─────────────────┴───────────────────┘ 
3243
3244
3245
3246 # 3.214. nm_db_limit
3247
3248 # Type: number
3249 # Default: 0
3250
3251 # This variable specifies the default limit used in notmuch queries.
3252
3253
3254
3255 # 3.215. nm_default_url
3256
3257 # Type: string
3258 # Default: (empty)
3259
3260 # This variable specifies the default Notmuch database in format notmuch://
3261 # <absolute path>.
3262
3263 #set nm_default_url="notmuch://$HOME/nmmail"
3264
3265
3266 # 3.216. nm_exclude_tags
3267
3268 # Type: string
3269 # Default: (empty)
3270
3271 # The messages tagged with these tags are excluded and not loaded from notmuch DB
3272 # to NeoMutt unless specified explicitly.
3273
3274
3275
3276 # 3.217. nm_flagged_tag
3277
3278 # Type: string
3279 # Default: “flagged”
3280
3281 # This variable specifies notmuch tag which is used for flagged messages. The
3282 # variable is used to count flagged messages in DB and set the flagged flag when
3283 # modifying tags. All other NeoMutt commands use standard (e.g. maildir) flags.
3284
3285
3286
3287 # 3.218. nm_open_timeout
3288
3289 # Type: number
3290 # Default: 5
3291
3292 # This variable specifies the timeout for database open in seconds.
3293
3294
3295
3296 # 3.219. nm_query_type
3297
3298 # Type: string
3299 # Default: “messages”
3300
3301 # This variable specifies the default query type (threads or messages) used in
3302 # notmuch queries.
3303
3304 #set nm_query_type="threads"
3305
3306
3307 # 3.220. nm_query_window_current_position
3308
3309 # Type: number
3310 # Default: 0
3311
3312 # This variable contains the position of the current search for window based
3313 # vfolder. 
3314
3315
3316
3317 # 3.221. nm_query_window_current_search
3318
3319 # Type: string
3320 # Default: (empty)
3321
3322 # This variable contains the currently setup notmuch search for window based
3323 # vfolder. 
3324
3325
3326
3327 # 3.222. nm_query_window_duration
3328
3329 # Type: number
3330 # Default: 0
3331
3332 # This variable sets the time duration of a windowed notmuch query. Accepted
3333 # values all non negative integers. A value of 0 disables the feature.
3334
3335 #set nm_query_window_duration=2
3336
3337
3338 # 3.223. nm_query_window_enable
3339
3340 # Type: boolean
3341 # Default: no
3342
3343 # This variable enables windowed notmuch queries even if window duration is 0.
3344
3345 #set nm_query_window_enable=yes
3346
3347
3348 # 3.224. nm_query_window_or_terms
3349
3350 # Type: string
3351 # Default: (empty)
3352
3353 # This variable contains additional notmuch search terms for messages to be shown
3354 # regardless of date.
3355
3356 # Example: 
3357
3358 # Using "notmuch://?query=tag:inbox" as the mailbox and "tag:flagged and
3359 # tag:unread" as the or terms, NeoMutt will produce a query window such as:
3360
3361 # notmuch://?query=tag:inbox and (date:... or (tag:flagged and tag:unread))
3362
3363 #set nm_query_window_or_terms="tag:unread and tag:flagged"
3364
3365
3366 # 3.225. nm_query_window_timebase
3367
3368 # Type: string
3369 # Default: “week”
3370
3371 # This variable sets the time base of a windowed notmuch query. Accepted values
3372 # are 'minute', 'hour', 'day', 'week', 'month', 'year'
3373
3374
3375
3376 # 3.226. nm_record
3377
3378 # Type: boolean
3379 # Default: no
3380
3381 # This variable specifies whether, when writing a just-sent message to the
3382 # $record, the message should also be added to the notmuch DB. Replies inherit
3383 # the notmuch tags from the original message. See $nm_record_tags for how to
3384 # modify the set of notmuch tags assigned to sent messages written to the record.
3385
3386 #set nm_record=yes
3387
3388
3389 # 3.227. nm_record_tags
3390
3391 # Type: string
3392 # Default: (empty)
3393
3394 # This variable specifies the notmuch tag modifications (addition, removal,
3395 # toggling) applied to messages added to the Neomutt record when $nm_record is
3396 # true. See the description of the <modify-labels> function for the syntax.
3397
3398 #set nm_record_tags="-unread,reply,archive"
3399
3400
3401 # 3.228. nm_replied_tag
3402
3403 # Type: string
3404 # Default: “replied”
3405
3406 # This variable specifies notmuch tag which is used for replied messages. The
3407 # variable is used to set the replied flag when modifying tags. All other NeoMutt
3408 # commands use standard (e.g. maildir) flags.
3409
3410
3411
3412 # 3.229. nm_unread_tag
3413
3414 # Type: string
3415 # Default: “unread”
3416
3417 # This variable specifies notmuch tag which is used for unread messages. The
3418 # variable is used to count unread messages in DB and set the unread flag when
3419 # modifiying tags. All other NeoMutt commands use standard (e.g. maildir) flags.
3420
3421
3422
3423 # 3.230. nntp_authenticators
3424
3425 # Type: string
3426 # Default: (empty)
3427
3428 # This is a colon-delimited list of authentication methods NeoMutt may attempt to
3429 # use to log in to a news server, in the order NeoMutt should try them.
3430 # Authentication methods are either "user" or any SASL mechanism, e.g.
3431 # "digest-md5", "gssapi" or "cram-md5". This option is case-insensitive. If it's
3432 # unset (the default) NeoMutt will try all available methods, in order from
3433 # most-secure to least-secure.
3434
3435 # Example: 
3436
3437 # set nntp_authenticators="digest-md5:user"
3438
3439 # Note: NeoMutt will only fall back to other authentication methods if the
3440 # previous methods are unavailable. If a method is available but authentication
3441 # fails, NeoMutt will not connect to the IMAP server.
3442
3443
3444
3445 # 3.231. nntp_context
3446
3447 # Type: number
3448 # Default: 1000
3449
3450 # This variable defines number of articles which will be in index when newsgroup
3451 # entered. If active newsgroup have more articles than this number, oldest
3452 # articles will be ignored. Also controls how many articles headers will be saved
3453 # in cache when you quit newsgroup.
3454
3455
3456
3457 # 3.232. nntp_listgroup
3458
3459 # Type: boolean
3460 # Default: yes
3461
3462 # This variable controls whether or not existence of each article is checked when
3463 # newsgroup is entered.
3464
3465
3466
3467 # 3.233. nntp_load_description
3468
3469 # Type: boolean
3470 # Default: yes
3471
3472 # This variable controls whether or not descriptions for each newsgroup must be
3473 # loaded when newsgroup is added to list (first time list loading or new
3474 # newsgroup adding).
3475
3476
3477
3478 # 3.234. nntp_pass
3479
3480 # Type: string
3481 # Default: (empty)
3482
3483 # Your password for NNTP account.
3484
3485
3486
3487 # 3.235. nntp_poll
3488
3489 # Type: number
3490 # Default: 60
3491
3492 # The time in seconds until any operations on newsgroup except post new article
3493 # will cause recheck for new news. If set to 0, NeoMutt will recheck newsgroup on
3494 # each operation in index (stepping, read article, etc.).
3495
3496
3497
3498 # 3.236. nntp_user
3499
3500 # Type: string
3501 # Default: (empty)
3502
3503 # Your login name on the NNTP server. If unset and NNTP server requires
3504 # authentication, NeoMutt will prompt you for your account name when you connect
3505 # to news server.
3506
3507
3508
3509 # 3.237. pager
3510
3511 # Type: command
3512 # Default: “builtin”
3513
3514 # This variable specifies which pager you would like to use to view messages. The
3515 # value "builtin" means to use the built-in pager, otherwise this variable should
3516 # specify the pathname of the external pager you would like to use.
3517
3518 # Using an external pager may have some disadvantages: Additional keystrokes are
3519 # necessary because you can't call NeoMutt functions directly from the pager, and
3520 # screen resizes cause lines longer than the screen width to be badly formatted
3521 # in the help menu.
3522
3523
3524
3525 # 3.238. pager_context
3526
3527 # Type: number
3528 # Default: 0
3529
3530 # This variable controls the number of lines of context that are given when
3531 # displaying the next or previous page in the internal pager. By default, NeoMutt
3532 # will display the line after the last one on the screen at the top of the next
3533 # page (0 lines of context).
3534
3535 # This variable also specifies the amount of context given for search results. If
3536 # positive, this many lines will be given before a match, if 0, the match will be
3537 # top-aligned. 
3538
3539 set pager_context=2
3540
3541
3542 # 3.239. pager_format
3543
3544 # Type: string
3545 # Default: “-%Z- %C/%m: %-20.20n   %s%*  -- (%P)”
3546
3547 # This variable controls the format of the one-line message "status" displayed
3548 # before each message in either the internal or an external pager. The valid
3549 # sequences are listed in the $index_format section.
3550
3551 set pager_format="<%a> %*  %i (%P)"
3552
3553
3554 # 3.240. pager_index_lines
3555
3556 # Type: number
3557 # Default: 0
3558
3559 # Determines the number of lines of a mini-index which is shown when in the
3560 # pager. The current message, unless near the top or bottom of the folder, will
3561 # be roughly one third of the way down this mini-index, giving the reader the
3562 # context of a few messages before and after the message. This is useful, for
3563 # example, to determine how many messages remain to be read in the current
3564 # thread. A value of 0 results in no index being shown. If the number of messages
3565 # in the current folder is less than $pager_index_lines, then the index will only
3566 # use as many lines as it needs.
3567
3568 set pager_index_lines=$menu_context
3569
3570
3571 # 3.241. pager_read_delay
3572
3573 # Type: number
3574 # Default: 0
3575
3576 # Determines the number of seconds that must elapse after first opening a new
3577 # message in the pager before that message will be marked as read. A value of 0
3578 # results in the message being marked read unconditionally; for other values,
3579 # navigating to another message or exiting the pager before the timeout will
3580 # leave the message marked unread. This setting is ignored if $pager is not
3581 # builtin. 
3582
3583
3584
3585 # 3.242. pager_skip_quoted_context
3586
3587 # Type: number
3588 # Default: 0
3589
3590 # Determines the number of lines of context to show before the unquoted text when
3591 # using the <skip-quoted> function. When set to a positive number at most that
3592 # many lines of the previous quote are displayed. If the previous quote is
3593 # shorter the whole quote is displayed.
3594
3595 # The (now deprecated) skip_quoted_offset is an alias for this variable, and
3596 # should no longer be used.
3597
3598
3599
3600 # 3.243. pager_stop
3601
3602 # Type: boolean
3603 # Default: no
3604
3605 # When set, the internal-pager will not move to the next message when you are at
3606 # the end of a message and invoke the <next-page> function.
3607
3608 set pager_stop=yes
3609
3610
3611 # 3.244. pattern_format
3612
3613 # Type: string
3614 # Default: “%2n %-15e  %d”
3615
3616 # This variable describes the format of the "pattern completion" menu. The
3617 # following printf(3)-style sequences are understood:
3618
3619 # ┌──┬────────────────────┐ 
3620 # │%d│pattern description │
3621 # ├──┼────────────────────┤ 
3622 # │%e│pattern expression  │
3623 # ├──┼────────────────────┤ 
3624 # │%n│index number        │
3625 # └──┴────────────────────┘ 
3626
3627
3628
3629 # 3.245. pgp_auto_decode
3630
3631 # Type: boolean
3632 # Default: no
3633
3634 # If set, NeoMutt will automatically attempt to decrypt traditional PGP messages
3635 # whenever the user performs an operation which ordinarily would result in the
3636 # contents of the message being operated on. For example, if the user displays a
3637 # pgp-traditional message which has not been manually checked with the
3638 # <check-traditional-pgp> function, NeoMutt will automatically check the message
3639 # for traditional pgp.
3640
3641
3642
3643 # 3.246. pgp_auto_inline
3644
3645 # Type: boolean
3646 # Default: no
3647
3648 # This option controls whether NeoMutt generates old-style inline (traditional)
3649 # PGP encrypted or signed messages under certain circumstances. This can be
3650 # overridden by use of the pgp menu, when inline is not required. The GPGME
3651 # backend does not support this option.
3652
3653 # Note that NeoMutt might automatically use PGP/MIME for messages which consist
3654 # of more than a single MIME part. NeoMutt can be configured to ask before
3655 # sending PGP/MIME messages when inline (traditional) would not work.
3656
3657 # Also see the $pgp_mime_auto variable.
3658
3659 # Also note that using the old-style PGP message format is strongly deprecated.
3660 # (PGP only)
3661
3662
3663
3664 # 3.247. pgp_check_exit
3665
3666 # Type: boolean
3667 # Default: yes
3668
3669 # If set, NeoMutt will check the exit code of the PGP subprocess when signing or
3670 # encrypting. A non-zero exit code means that the subprocess failed. (PGP only)
3671
3672
3673
3674 # 3.248. pgp_check_gpg_decrypt_status_fd
3675
3676 # Type: boolean
3677 # Default: yes
3678
3679 # If set, NeoMutt will check the status file descriptor output of
3680 # $pgp_decrypt_command and $pgp_decode_command for GnuPG status codes indicating
3681 # successful decryption. This will check for the presence of DECRYPTION_OKAY,
3682 # absence of DECRYPTION_FAILED, and that all PLAINTEXT occurs between the
3683 # BEGIN_DECRYPTION and END_DECRYPTION status codes.
3684
3685 # If unset, NeoMutt will instead match the status fd output against
3686 # $pgp_decryption_okay. (PGP only)
3687
3688
3689
3690 # 3.249. pgp_clear_sign_command
3691
3692 # Type: command
3693 # Default: (empty)
3694
3695 # This format is used to create an old-style "clearsigned" PGP message. Note that
3696 # the use of this format is strongly deprecated.
3697
3698 # This is a format string, see the $pgp_decode_command command for possible
3699 # printf(3)-like sequences. Note that in this case, %r expands to the search
3700 # string, which is a list of one or more quoted values such as email address,
3701 # name, or keyid. (PGP only)
3702
3703
3704
3705 # 3.250. pgp_decode_command
3706
3707 # Type: command
3708 # Default: (empty)
3709
3710 # This format strings specifies a command which is used to decode application/pgp
3711 # attachments. 
3712
3713 # The PGP command formats have their own set of printf(3)-like sequences:
3714
3715 # ┌──┬──────────────────────────────────────────────────────────────────────────┐ 
3716 # │%a│The value of $pgp_sign_as if set, otherwise the value of $pgp_default_key.│
3717 # ├──┼──────────────────────────────────────────────────────────────────────────┤ 
3718 # │%f│Expands to the name of a file containing a message.                       │
3719 # ├──┼──────────────────────────────────────────────────────────────────────────┤ 
3720 # │%p│Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty string   │
3721 # │ │otherwise. Note: This may be used with a %? construct.                    │
3722 # ├──┼──────────────────────────────────────────────────────────────────────────┤ 
3723 # │%r│One or more key IDs (or fingerprints if available).                       │
3724 # ├──┼──────────────────────────────────────────────────────────────────────────┤ 
3725 # │%s│Expands to the name of a file containing the signature part of a multipart│
3726 # │ │/signed attachment when verifying it.                                     │
3727 # └──┴──────────────────────────────────────────────────────────────────────────┘ 
3728
3729 # For examples on how to configure these formats for the various versions of PGP
3730 # which are floating around, see the pgp and gpg sample configuration files in
3731 # the samples/ subdirectory which has been installed on your system alongside the
3732 # documentation. (PGP only)
3733
3734
3735
3736 # 3.251. pgp_decrypt_command
3737
3738 # Type: command
3739 # Default: (empty)
3740
3741 # This command is used to decrypt a PGP encrypted message.
3742
3743 # This is a format string, see the $pgp_decode_command command for possible
3744 # printf(3)-like sequences. (PGP only)
3745
3746 # Note: When decrypting messages using gpg, a pinentry program needs to be
3747 # invoked unless the password is cached within gpg-agent. Currently, the
3748 # pinentry-tty program (usually distributed with gpg) isn't suitable for being
3749 # invoked by NeoMutt. You are encouraged to use a different pinentry-program when
3750 # running NeoMutt in order to avoid problems.
3751
3752 # See also: https://github.com/neomutt/neomutt/issues/1014
3753
3754
3755
3756 # 3.252. pgp_decryption_okay
3757
3758 # Type: regular expression
3759 # Default: (empty)
3760
3761 # If you assign text to this variable, then an encrypted PGP message is only
3762 # considered successfully decrypted if the output from $pgp_decrypt_command
3763 # contains the text. This is used to protect against a spoofed encrypted message,
3764 # with multipart/encrypted headers but containing a block that is not actually
3765 # encrypted. (e.g. simply signed and ascii armored text).
3766
3767 # Note that if $pgp_check_gpg_decrypt_status_fd is set, this variable is ignored.
3768 # (PGP only)
3769
3770
3771
3772 # 3.253. pgp_default_key
3773
3774 # Type: string
3775 # Default: (empty)
3776
3777 # This is the default key-pair to use for PGP operations. It will be used for
3778 # encryption (see $postpone_encrypt and $pgp_self_encrypt).
3779
3780 # It will also be used for signing unless $pgp_sign_as is set.
3781
3782 # The (now deprecated) pgp_self_encrypt_as is an alias for this variable, and
3783 # should no longer be used. (PGP only)
3784
3785
3786
3787 # 3.254. pgp_encrypt_only_command
3788
3789 # Type: command
3790 # Default: (empty)
3791
3792 # This command is used to encrypt a body part without signing it.
3793
3794 # This is a format string, see the $pgp_decode_command command for possible
3795 # printf(3)-like sequences. Note that in this case, %r expands to the search
3796 # string, which is a list of one or more quoted values such as email address,
3797 # name, or keyid. (PGP only)
3798
3799
3800
3801 # 3.255. pgp_encrypt_sign_command
3802
3803 # Type: command
3804 # Default: (empty)
3805
3806 # This command is used to both sign and encrypt a body part.
3807
3808 # This is a format string, see the $pgp_decode_command command for possible
3809 # printf(3)-like sequences. (PGP only)
3810
3811
3812
3813 # 3.256. pgp_entry_format
3814
3815 # Type: string
3816 # Default: “%4n %t%f %4l/0x%k %-4a %2c %u”
3817
3818 # This variable allows you to customize the PGP key selection menu to your
3819 # personal taste. If $crypt_use_gpgme is set, then it applies to S/MIME key
3820 # selection menu also. This string is similar to $index_format, but has its own
3821 # set of printf(3)-like sequences:
3822
3823 # ┌──────┬──────────────────────────────────────────────────────┐ 
3824 # │%a │Algorithm                                             │
3825 # ├──────┼──────────────────────────────────────────────────────┤ 
3826 # │%c │Capabilities                                          │
3827 # ├──────┼──────────────────────────────────────────────────────┤ 
3828 # │%f │Flags                                                 │
3829 # ├──────┼──────────────────────────────────────────────────────┤ 
3830 # │%k │Key id                                                │
3831 # ├──────┼──────────────────────────────────────────────────────┤ 
3832 # │%l │Key length                                            │
3833 # ├──────┼──────────────────────────────────────────────────────┤ 
3834 # │%n │Number                                                │
3835 # ├──────┼──────────────────────────────────────────────────────┤ 
3836 # │%p │Protocol                                              │
3837 # ├──────┼──────────────────────────────────────────────────────┤ 
3838 # │%t │Trust/validity of the key-uid association             │
3839 # ├──────┼──────────────────────────────────────────────────────┤ 
3840 # │%u │User id                                               │
3841 # ├──────┼──────────────────────────────────────────────────────┤ 
3842 # │%[<s>]│Date of the key where <s> is an strftime(3) expression│
3843 # └──────┴──────────────────────────────────────────────────────┘ 
3844
3845 # (Crypto only) or (PGP only when GPGME disabled)
3846
3847
3848
3849 # 3.257. pgp_export_command
3850
3851 # Type: command
3852 # Default: (empty)
3853
3854 # This command is used to export a public key from the user's key ring.
3855
3856 # This is a format string, see the $pgp_decode_command command for possible
3857 # printf(3)-like sequences. (PGP only)
3858
3859
3860
3861 # 3.258. pgp_get_keys_command
3862
3863 # Type: command
3864 # Default: (empty)
3865
3866 # This command is invoked whenever NeoMutt needs to fetch the public key
3867 # associated with an email address. Of the sequences supported by
3868 # $pgp_decode_command, %r is the only printf(3)-like sequence used with this
3869 # format. Note that in this case, %r expands to the email address, not the public
3870 # key ID (the key ID is unknown, which is why NeoMutt is invoking this command).
3871 # (PGP only)
3872
3873
3874
3875 # 3.259. pgp_good_sign
3876
3877 # Type: regular expression
3878 # Default: (empty)
3879
3880 # If you assign a text to this variable, then a PGP signature is only considered
3881 # verified if the output from $pgp_verify_command contains the text. Use this
3882 # variable if the exit code from the command is 0 even for bad signatures. (PGP
3883 # only) 
3884
3885
3886
3887 # 3.260. pgp_ignore_subkeys
3888
3889 # Type: boolean
3890 # Default: yes
3891
3892 # Setting this variable will cause NeoMutt to ignore OpenPGP subkeys. Instead,
3893 # the principal key will inherit the subkeys' capabilities. Unset this if you
3894 # want to play interesting key selection games. (PGP only)
3895
3896
3897
3898 # 3.261. pgp_import_command
3899
3900 # Type: command
3901 # Default: (empty)
3902
3903 # This command is used to import a key from a message into the user's public key
3904 # ring. 
3905
3906 # This is a format string, see the $pgp_decode_command command for possible
3907 # printf(3)-like sequences. (PGP only)
3908
3909
3910
3911 # 3.262. pgp_list_pubring_command
3912
3913 # Type: command
3914 # Default: (empty)
3915
3916 # This command is used to list the public key ring's contents. The output format
3917 # must be analogous to the one used by
3918
3919 # gpg --list-keys --with-colons --with-fingerprint
3920
3921 # Note: gpg's fixed-list-mode option should not be used. It produces a different
3922 # date format which may result in NeoMutt showing incorrect key generation dates.
3923
3924 # This is a format string, see the $pgp_decode_command command for possible
3925 # printf(3)-like sequences. (PGP only)
3926
3927
3928
3929 # 3.263. pgp_list_secring_command
3930
3931 # Type: command
3932 # Default: (empty)
3933
3934 # This command is used to list the secret key ring's contents. The output format
3935 # must be analogous to the one used by:
3936
3937 # gpg --list-keys --with-colons --with-fingerprint
3938
3939 # Note: gpg's fixed-list-mode option should not be used. It produces a different
3940 # date format which may result in NeoMutt showing incorrect key generation dates.
3941
3942 # This is a format string, see the $pgp_decode_command command for possible
3943 # printf(3)-like sequences. (PGP only)
3944
3945
3946
3947 # 3.264. pgp_long_ids
3948
3949 # Type: boolean
3950 # Default: yes
3951
3952 # If set, use 64 bit PGP key IDs, if unset use the normal 32 bit key IDs. NOTE:
3953 # Internally, NeoMutt has transitioned to using fingerprints (or long key IDs as
3954 # a fallback). This option now only controls the display of key IDs in the key
3955 # selection menu and a few other places. (PGP only)
3956
3957
3958
3959 # 3.265. pgp_mime_auto
3960
3961 # Type: quadoption
3962 # Default: ask-yes
3963
3964 # This option controls whether NeoMutt will prompt you for automatically sending
3965 # a (signed/encrypted) message using PGP/MIME when inline (traditional) fails
3966 # (for any reason).
3967
3968 # Also note that using the old-style PGP message format is strongly deprecated.
3969 # (PGP only)
3970
3971
3972
3973 # 3.266. pgp_reply_inline
3974
3975 # Type: boolean
3976 # Default: no
3977
3978 # Setting this variable will cause NeoMutt to always attempt to create an inline
3979 # (traditional) message when replying to a message which is PGP encrypted/signed
3980 # inline. This can be overridden by use of the pgp menu, when inline is not
3981 # required. This option does not automatically detect if the (replied-to) message
3982 # is inline; instead it relies on NeoMutt internals for previously checked/
3983 # flagged messages.
3984
3985 # Note that NeoMutt might automatically use PGP/MIME for messages which consist
3986 # of more than a single MIME part. NeoMutt can be configured to ask before
3987 # sending PGP/MIME messages when inline (traditional) would not work.
3988
3989 # Also see the $pgp_mime_auto variable.
3990
3991 # Also note that using the old-style PGP message format is strongly deprecated.
3992 # (PGP only)
3993
3994
3995
3996 # 3.267. pgp_retainable_sigs
3997
3998 # Type: boolean
3999 # Default: no
4000
4001 # If set, signed and encrypted messages will consist of nested multipart/signed
4002 # and multipart/encrypted body parts.
4003
4004 # This is useful for applications like encrypted and signed mailing lists, where
4005 # the outer layer (multipart/encrypted) can be easily removed, while the inner
4006 # multipart/signed part is retained. (PGP only)
4007
4008 set pgp_retainable_sigs=yes
4009
4010
4011 # 3.268. pgp_self_encrypt
4012
4013 # Type: boolean
4014 # Default: yes
4015
4016 # When set, PGP encrypted messages will also be encrypted using the key in
4017 # $pgp_default_key. (PGP only)
4018
4019
4020
4021 # 3.269. pgp_show_unusable
4022
4023 # Type: boolean
4024 # Default: yes
4025
4026 # If set, NeoMutt will display non-usable keys on the PGP key selection menu.
4027 # This includes keys which have been revoked, have expired, or have been marked
4028 # as "disabled" by the user. (PGP only)
4029
4030 set pgp_show_unusable=no
4031
4032
4033 # 3.270. pgp_sign_as
4034
4035 # Type: string
4036 # Default: (empty)
4037
4038 # If you have a different key pair to use for signing, you should set this to the
4039 # signing key. Most people will only need to set $pgp_default_key. It is
4040 # recommended that you use the keyid form to specify your key (e.g. 0x00112233).
4041 # (PGP only)
4042
4043 set pgp_sign_as="0x9C9D6979AE941637"
4044
4045
4046 # 3.271. pgp_sign_command
4047
4048 # Type: command
4049 # Default: (empty)
4050
4051 # This command is used to create the detached PGP signature for a multipart/
4052 # signed PGP/MIME body part.
4053
4054 # This is a format string, see the $pgp_decode_command command for possible
4055 # printf(3)-like sequences. (PGP only)
4056
4057
4058
4059 # 3.272. pgp_sort_keys
4060
4061 # Type: sort order
4062 # Default: address
4063
4064 # Specifies how the entries in the pgp menu are sorted. The following are legal
4065 # values: 
4066
4067 # ┌───────┬──────────────────────────────┐ 
4068 # │address│sort alphabetically by user id│
4069 # ├───────┼──────────────────────────────┤ 
4070 # │keyid │sort alphabetically by key id │
4071 # ├───────┼──────────────────────────────┤ 
4072 # │date │sort by key creation date     │
4073 # ├───────┼──────────────────────────────┤ 
4074 # │trust │sort by the trust of the key  │
4075 # └───────┴──────────────────────────────┘ 
4076
4077 # If you prefer reverse order of the above values, prefix it with "reverse-".
4078 # (PGP only)
4079
4080
4081
4082 # 3.273. pgp_strict_enc
4083
4084 # Type: boolean
4085 # Default: yes
4086
4087 # If set, NeoMutt will automatically encode PGP/MIME signed messages as
4088 # quoted-printable. Please note that unsetting this variable may lead to problems
4089 # with non-verifyable PGP signatures, so only change this if you know what you
4090 # are doing. (PGP only)
4091
4092
4093
4094 # 3.274. pgp_timeout
4095
4096 # Type: number (long)
4097 # Default: 300
4098
4099 # The number of seconds after which a cached passphrase will expire if not used.
4100 # (PGP only)
4101
4102
4103
4104 # 3.275. pgp_use_gpg_agent
4105
4106 # Type: boolean
4107 # Default: yes
4108
4109 # If set, NeoMutt expects a gpg-agent(1) process will handle private key
4110 # passphrase prompts. If unset, NeoMutt will prompt for the passphrase and pass
4111 # it via stdin to the pgp command.
4112
4113 # Note that as of version 2.1, GnuPG automatically spawns an agent and requires
4114 # the agent be used for passphrase management. Since that version is increasingly
4115 # prevalent, this variable now defaults set.
4116
4117 # NeoMutt works with a GUI or curses pinentry program. A TTY pinentry should not
4118 # be used.
4119
4120 # If you are using an older version of GnuPG without an agent running, or another
4121 # encryption program without an agent, you will need to unset this variable. (PGP
4122 # only) 
4123
4124 set pgp_use_gpg_agent=yes
4125
4126
4127 # 3.276. pgp_verify_command
4128
4129 # Type: command
4130 # Default: (empty)
4131
4132 # This command is used to verify PGP signatures.
4133
4134 # This is a format string, see the $pgp_decode_command command for possible
4135 # printf(3)-like sequences. (PGP only)
4136
4137
4138
4139 # 3.277. pgp_verify_key_command
4140
4141 # Type: command
4142 # Default: (empty)
4143
4144 # This command is used to verify key information from the key selection menu.
4145
4146 # This is a format string, see the $pgp_decode_command command for possible
4147 # printf(3)-like sequences. (PGP only)
4148
4149
4150
4151 # 3.278. pipe_decode
4152
4153 # Type: boolean
4154 # Default: no
4155
4156 # Used in connection with the <pipe-message> function. When unset, NeoMutt will
4157 # pipe the messages without any preprocessing. When set, NeoMutt will attempt to
4158 # decode the messages first.
4159
4160 # Also see $pipe_decode_weed, which controls whether headers will be weeded when
4161 # this is set.
4162
4163
4164
4165 # 3.279. pipe_decode_weed
4166
4167 # Type: boolean
4168 # Default: yes
4169
4170 # For <pipe-message>, when $pipe_decode is set, this further controls whether
4171 # NeoMutt will weed headers.
4172
4173
4174
4175 # 3.280. pipe_sep
4176
4177 # Type: string
4178 # Default: “n”
4179
4180 # The separator to add between messages when piping a list of tagged messages to
4181 # an external Unix command.
4182
4183
4184
4185 # 3.281. pipe_split
4186
4187 # Type: boolean
4188 # Default: no
4189
4190 # Used in connection with the <pipe-message> function following <tag-prefix>. If
4191 # this variable is unset, when piping a list of tagged messages NeoMutt will
4192 # concatenate the messages and will pipe them all concatenated. When set, NeoMutt
4193 # will pipe the messages one by one. In both cases the messages are piped in the
4194 # current sorted order, and the $pipe_sep separator is added after each message.
4195
4196
4197
4198 # 3.282. pop_auth_try_all
4199
4200 # Type: boolean
4201 # Default: yes
4202
4203 # If set, NeoMutt will try all available authentication methods. When unset,
4204 # NeoMutt will only fall back to other authentication methods if the previous
4205 # methods are unavailable. If a method is available but authentication fails,
4206 # NeoMutt will not connect to the POP server.
4207
4208
4209
4210 # 3.283. pop_authenticators
4211
4212 # Type: string list
4213 # Default: (empty)
4214
4215 # This is a colon-separated list of authentication methods NeoMutt may attempt to
4216 # use to log in to an POP server, in the order NeoMutt should try them.
4217 # Authentication methods are either "user", "apop" or any SASL mechanism, e.g.
4218 # "digest-md5", "gssapi" or "cram-md5". This option is case-insensitive. If this
4219 # option is unset (the default) NeoMutt will try all available methods, in order
4220 # from most-secure to least-secure.
4221
4222 # Example: 
4223
4224 # set pop_authenticators="digest-md5:apop:user"
4225
4226
4227
4228 # 3.284. pop_check_interval
4229
4230 # Type: number
4231 # Default: 60
4232
4233 # This variable configures how often (in seconds) NeoMutt should look for new
4234 # mail in the currently selected mailbox if it is a POP mailbox.
4235
4236
4237
4238 # 3.285. pop_delete
4239
4240 # Type: quadoption
4241 # Default: ask-no
4242
4243 # If set, NeoMutt will delete successfully downloaded messages from the POP
4244 # server when using the <fetch-mail> function. When unset, NeoMutt will download
4245 # messages but also leave them on the POP server.
4246
4247
4248
4249 # 3.286. pop_host
4250
4251 # Type: string
4252 # Default: (empty)
4253
4254 # The name of your POP server for the <fetch-mail> function. You can also specify
4255 # an alternative port, username and password, i.e.:
4256
4257 # [pop[s]://][username[:password]@]popserver[:port] 
4258
4259 # where "[...]" denotes an optional part.
4260
4261
4262
4263 # 3.287. pop_last
4264
4265 # Type: boolean
4266 # Default: no
4267
4268 # If this variable is set, NeoMutt will try to use the "LAST" POP command for
4269 # retrieving only unread messages from the POP server when using the <fetch-mail>
4270 # function. 
4271
4272
4273
4274 # 3.288. pop_oauth_refresh_command
4275
4276 # Type: command
4277 # Default: (empty)
4278
4279 # The command to run to generate an OAUTH refresh token for authorizing your
4280 # connection to your POP server. This command will be run on every connection
4281 # attempt that uses the OAUTHBEARER authentication mechanism. See "oauth" for
4282 # details. 
4283
4284
4285
4286 # 3.289. pop_pass
4287
4288 # Type: string
4289 # Default: (empty)
4290
4291 # Specifies the password for your POP account. If unset, NeoMutt will prompt you
4292 # for your password when you open a POP mailbox.
4293
4294 # Warning: you should only use this option when you are on a fairly secure
4295 # machine, because the superuser can read your neomuttrc even if you are the only
4296 # one who can read the file.
4297
4298
4299
4300 # 3.290. pop_reconnect
4301
4302 # Type: quadoption
4303 # Default: ask-yes
4304
4305 # Controls whether or not NeoMutt will try to reconnect to the POP server if the
4306 # connection is lost.
4307
4308
4309
4310 # 3.291. pop_user
4311
4312 # Type: string
4313 # Default: (empty)
4314
4315 # Your login name on the POP server.
4316
4317 # This variable defaults to your user name on the local machine.
4318
4319
4320
4321 # 3.292. post_indent_string
4322
4323 # Type: string
4324 # Default: (empty)
4325
4326 # Similar to the $attribution variable, NeoMutt will append this string after the
4327 # inclusion of a message which is being replied to.
4328
4329
4330
4331 # 3.293. post_moderated
4332
4333 # Type: quadoption
4334 # Default: ask-yes
4335
4336 # If set to yes, NeoMutt will post article to newsgroup that have not permissions
4337 # to posting (e.g. moderated). Note: if news server does not support posting to
4338 # that newsgroup or totally read-only, that posting will not have an effect.
4339
4340
4341
4342 # 3.294. postpone
4343
4344 # Type: quadoption
4345 # Default: ask-yes
4346
4347 # Controls whether or not messages are saved in the $postponed mailbox when you
4348 # elect not to send immediately. If set to ask-yes or ask-no, you will be
4349 # prompted with "Save (postpone) draft message?" when quitting from the "compose"
4350 # screen. 
4351
4352 # Also see the $recall variable.
4353
4354
4355
4356 # 3.295. postpone_encrypt
4357
4358 # Type: boolean
4359 # Default: no
4360
4361 # When set, postponed messages that are marked for encryption will be
4362 # self-encrypted. NeoMutt will first try to encrypt using the value specified in
4363 # $pgp_default_key or $smime_default_key. If those are not set, it will try the
4364 # deprecated $postpone_encrypt_as. (Crypto only)
4365
4366
4367
4368 # 3.296. postpone_encrypt_as
4369
4370 # Type: string
4371 # Default: (empty)
4372
4373 # This is a deprecated fall-back variable for $postpone_encrypt. Please use
4374 # $pgp_default_key or $smime_default_key. (Crypto only)
4375
4376
4377
4378 # 3.297. postponed
4379
4380 # Type: mailbox
4381 # Default: “~/postponed”
4382
4383 # NeoMutt allows you to indefinitely "postpone sending a message" which you are
4384 # editing. When you choose to postpone a message, NeoMutt saves it in the mailbox
4385 # specified by this variable.
4386
4387 # Also see the $postpone variable.
4388
4389 set postponed="=drafts"
4390
4391
4392 # 3.298. preconnect
4393
4394 # Type: string
4395 # Default: (empty)
4396
4397 # If set, a shell command to be executed if NeoMutt fails to establish a
4398 # connection to the server. This is useful for setting up secure connections,
4399 # e.g. with ssh(1). If the command returns a nonzero status, NeoMutt gives up
4400 # opening the server. Example:
4401
4402 # set preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net sleep 20 < /dev/null > /dev/null"
4403
4404 # Mailbox "foo" on "mailhost.net" can now be reached as "{localhost:1234}foo".
4405
4406 # Note: For this example to work, you must be able to log in to the remote
4407 # machine without having to enter a password.
4408
4409
4410
4411 # 3.299. preferred_languages
4412
4413 # Type: string list
4414 # Default: (empty)
4415
4416 # This variable specifies a list of comma-separated languages. RFC8255 : user
4417 # preferred languages to be searched in parts and display. Example:
4418
4419 # set preferred_languages="en,fr,de"
4420
4421
4422
4423 # 3.300. print
4424
4425 # Type: quadoption
4426 # Default: ask-no
4427
4428 # Controls whether or not NeoMutt really prints messages. This is set to "ask-no"
4429 # by default, because some people accidentally hit "p" often.
4430
4431
4432
4433 # 3.301. print_command
4434
4435 # Type: command
4436 # Default: “lpr”
4437
4438 # This specifies the command pipe that should be used to print messages.
4439
4440 set print_command="muttprint"
4441
4442
4443 # 3.302. print_decode
4444
4445 # Type: boolean
4446 # Default: yes
4447
4448 # Used in connection with the <print-message> function. If this option is set,
4449 # the message is decoded before it is passed to the external command specified by
4450 # $print_command. If this option is unset, no processing will be applied to the
4451 # message when printing it. The latter setting may be useful if you are using
4452 # some advanced printer filter which is able to properly format e-mail messages
4453 # for printing.
4454
4455 # Also see $print_decode_weed, which controls whether headers will be weeded when
4456 # this is set.
4457
4458
4459
4460 # 3.303. print_decode_weed
4461
4462 # Type: boolean
4463 # Default: yes
4464
4465 # For <print-message>, when $print_decode is set, this further controls whether
4466 # NeoMutt will weed headers.
4467
4468
4469
4470 # 3.304. print_split
4471
4472 # Type: boolean
4473 # Default: no
4474
4475 # Used in connection with the <print-message> function. If this option is set,
4476 # the command specified by $print_command is executed once for each message which
4477 # is to be printed. If this option is unset, the command specified by
4478 # $print_command is executed only once, and all the messages are concatenated,
4479 # with a form feed as the message separator.
4480
4481 # Those who use the enscript(1) program's mail-printing mode will most likely
4482 # want to set this option.
4483
4484 set print_split=yes
4485
4486
4487 # 3.305. prompt_after
4488
4489 # Type: boolean
4490 # Default: yes
4491
4492 # If you use an external $pager, setting this variable will cause NeoMutt to
4493 # prompt you for a command when the pager exits rather than returning to the
4494 # index menu. If unset, NeoMutt will return to the index menu when the external
4495 # pager exits.
4496
4497
4498
4499 # 3.306. query_command
4500
4501 # Type: command
4502 # Default: (empty)
4503
4504 # This specifies the command NeoMutt will use to make external address queries.
4505 # The string may contain a "%s", which will be substituted with the query string
4506 # the user types. NeoMutt will add quotes around the string substituted for "%s"
4507 # automatically according to shell quoting rules, so you should avoid adding your
4508 # own. If no "%s" is found in the string, NeoMutt will append the user's query to
4509 # the end of the string. See "query" (https://neomutt.org/guide/
4510 # advancedusage.html#query) for more information.
4511
4512 set query_command="lbdbq"
4513
4514
4515 # 3.307. query_format
4516
4517 # Type: string
4518 # Default: “%3c %t %-25.25n %-25.25a | %e”
4519
4520 # This variable describes the format of the "query" menu. The following printf(3)
4521 # -style sequences are understood:
4522
4523 # ┌───┬─┬─────────────────────────────────────────────────────┐ 
4524 # │%a │ │Destination address                                  │
4525 # ├───┼─┼─────────────────────────────────────────────────────┤ 
4526 # │%c │ │Current entry number                                 │
4527 # ├───┼─┼─────────────────────────────────────────────────────┤ 
4528 # │%e │*│Extra information                                    │
4529 # ├───┼─┼─────────────────────────────────────────────────────┤ 
4530 # │%n │ │Destination name                                     │
4531 # ├───┼─┼─────────────────────────────────────────────────────┤ 
4532 # │%t │ │"*" if current entry is tagged, a space otherwise    │
4533 # ├───┼─┼─────────────────────────────────────────────────────┤ 
4534 # │%>X│ │Right justify the rest of the string and pad with "X"│
4535 # ├───┼─┼─────────────────────────────────────────────────────┤ 
4536 # │%|X│ │Pad to the end of the line with "X"                  │
4537 # ├───┼─┼─────────────────────────────────────────────────────┤ 
4538 # │%*X│ │Soft-fill with character "X" as pad                  │
4539 # └───┴─┴─────────────────────────────────────────────────────┘ 
4540
4541 # For an explanation of "soft-fill", see the $index_format documentation.
4542
4543 # * = can be optionally printed if nonzero, see the $status_format documentation.
4544
4545
4546
4547 # 3.308. quit
4548
4549 # Type: quadoption
4550 # Default: yes
4551
4552 # This variable controls whether "quit" and "exit" actually quit from NeoMutt. If
4553 # this option is set, they do quit, if it is unset, they have no effect, and if
4554 # it is set to ask-yes or ask-no, you are prompted for confirmation when you try
4555 # to quit.
4556
4557
4558
4559 # 3.309. quote_regex
4560
4561 # Type: regular expression
4562 # Default: “^([ t]*[|>:}#])+”
4563
4564 # A regular expression used in the internal pager to determine quoted sections of
4565 # text in the body of a message. Quoted text may be filtered out using the
4566 # <toggle-quoted> command, or colored according to the "color quoted" family of
4567 # directives. 
4568
4569 # Higher levels of quoting may be colored differently ("color quoted1", "color
4570 # quoted2", etc.). The quoting level is determined by removing the last character
4571 # from the matched text and recursively reapplying the regular expression until
4572 # it fails to produce a match.
4573
4574 # Match detection may be overridden by the $smileys regular expression.
4575
4576
4577
4578 # 3.310. read_inc
4579
4580 # Type: number
4581 # Default: 10
4582
4583 # If set to a value greater than 0, NeoMutt will display which message it is
4584 # currently on when reading a mailbox or when performing search actions such as
4585 # search and limit. The message is printed after this many messages have been
4586 # read or searched (e.g., if set to 25, NeoMutt will print a message when it is
4587 # at message 25, and then again when it gets to message 50). This variable is
4588 # meant to indicate progress when reading or searching large mailboxes which may
4589 # take some time. When set to 0, only a single message will appear before the
4590 # reading the mailbox.
4591
4592 # Also see the $write_inc, $net_inc and $time_inc variables and the "tuning"
4593 # section of the manual for performance considerations.
4594
4595
4596
4597 # 3.311. read_only
4598
4599 # Type: boolean
4600 # Default: no
4601
4602 # If set, all folders are opened in read-only mode.
4603
4604
4605
4606 # 3.312. real_name
4607
4608 # Type: string
4609 # Default: (empty)
4610
4611 # This variable specifies what "real" or "personal" name should be used when
4612 # sending messages.
4613
4614 # If not specified, then the user's "real name" will be read from /etc/passwd.
4615 # This option will not be used, if "$from" is set.
4616
4617
4618
4619 # 3.313. recall
4620
4621 # Type: quadoption
4622 # Default: ask-yes
4623
4624 # Controls whether or not NeoMutt recalls postponed messages when composing a new
4625 # message. 
4626
4627 # Setting this variable to yes is not generally useful, and thus not recommended.
4628 # Note that the <recall-message> function can be used to manually recall
4629 # postponed messages.
4630
4631 # Also see $postponed variable.
4632
4633 set recall=no
4634
4635
4636 # 3.314. record
4637
4638 # Type: mailbox
4639 # Default: “~/sent”
4640
4641 # This specifies the file into which your outgoing messages should be appended.
4642 # (This is meant as the primary method for saving a copy of your messages, but
4643 # another way to do this is using the "my_hdr" command to create a "Bcc:" field
4644 # with your email address in it.)
4645
4646 # The value of $record is overridden by the $force_name and $save_name variables,
4647 # and the "fcc-hook" command. Also see $copy and $write_bcc.
4648
4649 set record="=store"
4650
4651
4652 # 3.315. reflow_space_quotes
4653
4654 # Type: boolean
4655 # Default: yes
4656
4657 # This option controls how quotes from format=flowed messages are displayed in
4658 # the pager and when replying (with $text_flowed unset). When set, this option
4659 # adds spaces after each level of quote marks, turning ">>>foo" into "> > > foo".
4660
4661 # Note: If $reflow_text is unset, this option has no effect. Also, this option
4662 # does not affect replies when $text_flowed is set.
4663
4664
4665
4666 # 3.316. reflow_text
4667
4668 # Type: boolean
4669 # Default: yes
4670
4671 # When set, NeoMutt will reformat paragraphs in text/plain parts marked format=
4672 # flowed. If unset, NeoMutt will display paragraphs unaltered from how they
4673 # appear in the message body. See RFC3676 for details on the format=flowed
4674 # format. 
4675
4676 # Also see $reflow_wrap, and $wrap.
4677
4678
4679
4680 # 3.317. reflow_wrap
4681
4682 # Type: number
4683 # Default: 78
4684
4685 # This variable controls the maximum paragraph width when reformatting text/plain
4686 # parts when $reflow_text is set. When the value is 0, paragraphs will be wrapped
4687 # at the terminal's right margin. A positive value sets the paragraph width
4688 # relative to the left margin. A negative value set the paragraph width relative
4689 # to the right margin.
4690
4691 # Also see $wrap.
4692
4693 set reflow_wrap=-10
4694
4695
4696 # 3.318. reply_regex
4697
4698 # Type: regular expression
4699 # Default: “^((re|aw|sv)([[0-9]+])*:[ t]*)*”
4700
4701 # A regular expression used to recognize reply messages when threading and
4702 # replying. The default value corresponds to the English "Re:", the German "Aw:"
4703 # and the Swedish "Sv:".
4704
4705
4706
4707 # 3.319. reply_self
4708
4709 # Type: boolean
4710 # Default: no
4711
4712 # If unset and you are replying to a message sent by you, NeoMutt will assume
4713 # that you want to reply to the recipients of that message rather than to
4714 # yourself. 
4715
4716 # Also see the "alternates" command.
4717
4718
4719
4720 # 3.320. reply_to
4721
4722 # Type: quadoption
4723 # Default: ask-yes
4724
4725 # If set, when replying to a message, NeoMutt will use the address listed in the
4726 # Reply-to: header as the recipient of the reply. If unset, it will use the
4727 # address in the From: header field instead. This option is useful for reading a
4728 # mailing list that sets the Reply-To: header field to the list address and you
4729 # want to send a private message to the author of a message.
4730
4731
4732
4733 # 3.321. reply_with_xorig
4734
4735 # Type: boolean
4736 # Default: no
4737
4738 # This variable provides a toggle. When active, the From: header will be
4739 # extracted from the current mail's 'X-Original-To:' header. This setting does
4740 # not have precedence over "reverse_real_name".
4741
4742 # Assuming 'fast_reply' is disabled, this option will prompt the user with a
4743 # prefilled From: header.
4744
4745
4746
4747 # 3.322. resolve
4748
4749 # Type: boolean
4750 # Default: yes
4751
4752 # When set, the cursor will be automatically advanced to the next (possibly
4753 # undeleted) message whenever a command that modifies the current message is
4754 # executed. 
4755
4756
4757
4758 # 3.323. resume_draft_files
4759
4760 # Type: boolean
4761 # Default: no
4762
4763 # If set, draft files (specified by -H on the command line) are processed
4764 # similarly to when resuming a postponed message. Recipients are not prompted
4765 # for; send-hooks are not evaluated; no alias expansion takes place; user-defined
4766 # headers and signatures are not added to the message.
4767
4768
4769
4770 # 3.324. resume_edited_draft_files
4771
4772 # Type: boolean
4773 # Default: yes
4774
4775 # If set, draft files previously edited (via -E -H on the command line) will have
4776 # $resume_draft_files automatically set when they are used as a draft file again.
4777
4778 # The first time a draft file is saved, NeoMutt will add a header,
4779 # X-Mutt-Resume-Draft to the saved file. The next time the draft file is read in,
4780 # if NeoMutt sees the header, it will set $resume_draft_files.
4781
4782 # This option is designed to prevent multiple signatures, user-defined headers,
4783 # and other processing effects from being made multiple times to the draft file.
4784
4785
4786
4787 # 3.325. reverse_alias
4788
4789 # Type: boolean
4790 # Default: no
4791
4792 # This variable controls whether or not NeoMutt will display the "personal" name
4793 # from your aliases in the index menu if it finds an alias that matches the
4794 # message's sender. For example, if you have the following alias:
4795
4796 # alias juser abd30425@somewhere.net (Joe User)
4797
4798 # and then you receive mail which contains the following header:
4799
4800 # From: abd30425@somewhere.net
4801
4802 # It would be displayed in the index menu as "Joe User" instead of
4803 # "abd30425@somewhere.net." This is useful when the person's e-mail address is
4804 # not human friendly.
4805
4806
4807
4808 # 3.326. reverse_name
4809
4810 # Type: boolean
4811 # Default: no
4812
4813 # It may sometimes arrive that you receive mail to a certain machine, move the
4814 # messages to another machine, and reply to some the messages from there. If this
4815 # variable is set, the default From: line of the reply messages is built using
4816 # the address where you received the messages you are replying to if that address
4817 # matches your "alternates". If the variable is unset, or the address that would
4818 # be used doesn't match your "alternates", the From: line will use your address
4819 # on the current machine.
4820
4821 # Also see the "alternates" command and $reverse_real_name.
4822
4823 set reverse_name=yes
4824
4825
4826 # 3.327. reverse_real_name
4827
4828 # Type: boolean
4829 # Default: yes
4830
4831 # This variable fine-tunes the behavior of the $reverse_name feature.
4832
4833 # When it is unset, NeoMutt will remove the real name part of a matching address.
4834 # This allows the use of the email address without having to also use what the
4835 # sender put in the real name field.
4836
4837 # When it is set, NeoMutt will use the matching address as-is.
4838
4839 # In either case, a missing real name will be filled in afterwards using the
4840 # value of $real_name.
4841
4842
4843
4844 # 3.328. rfc2047_parameters
4845
4846 # Type: boolean
4847 # Default: no
4848
4849 # When this variable is set, NeoMutt will decode RFC2047-encoded MIME parameters.
4850 # You want to set this variable when NeoMutt suggests you to save attachments to
4851 # files named like:
4852
4853 # =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?= 
4854 # =?utf-8?Q?z=C4=99ta.png?= 
4855
4856 # When this variable is set interactively, the change won't be active until you
4857 # change folders.
4858
4859 # Note that this use of RFC2047's encoding is explicitly prohibited by the
4860 # standard, but nevertheless encountered in the wild and produced by, e.g.,
4861 # Outlook. 
4862
4863 # Also note that setting this parameter will not have the effect that NeoMutt
4864 # generates this kind of encoding. Instead, NeoMutt will unconditionally use the
4865 # encoding specified in RFC2231.
4866
4867 set rfc2047_parameters=yes
4868
4869
4870 # 3.329. save_address
4871
4872 # Type: boolean
4873 # Default: no
4874
4875 # If set, NeoMutt will take the sender's full address when choosing a default
4876 # folder for saving a mail. If $save_name or $force_name is set too, the
4877 # selection of the Fcc folder will be changed as well.
4878
4879
4880
4881 # 3.330. save_empty
4882
4883 # Type: boolean
4884 # Default: yes
4885
4886 # When unset, mailboxes which contain no saved messages will be removed when
4887 # closed (the exception is $spool_file which is never removed). If set, mailboxes
4888 # are never removed.
4889
4890 # Note: This only applies to mbox and MMDF folders, NeoMutt does not delete MH
4891 # and Maildir directories.
4892
4893
4894
4895 # 3.331. save_history
4896
4897 # Type: number
4898 # Default: 0
4899
4900 # This variable controls the size of the history (per category) saved in the
4901 # $history_file file.
4902
4903 set save_history=100
4904
4905
4906 # 3.332. save_name
4907
4908 # Type: boolean
4909 # Default: no
4910
4911 # This variable controls how copies of outgoing messages are saved. When set, a
4912 # check is made to see if a mailbox specified by the recipient address exists
4913 # (this is done by searching for a mailbox in the $folder directory with the
4914 # username part of the recipient address). If the mailbox exists, the outgoing
4915 # message will be saved to that mailbox, otherwise the message is saved to the
4916 # $record mailbox.
4917
4918 # Also see the $force_name variable.
4919
4920
4921
4922 # 3.333. save_unsubscribed
4923
4924 # Type: boolean
4925 # Default: no
4926
4927 # When set, info about unsubscribed newsgroups will be saved into "newsrc" file
4928 # and into cache.
4929
4930
4931
4932 # 3.334. score
4933
4934 # Type: boolean
4935 # Default: yes
4936
4937 # When this variable is unset, scoring is turned off. This can be useful to
4938 # selectively disable scoring for certain folders when the
4939 # $score_threshold_delete variable and related are used.
4940
4941
4942
4943 # 3.335. score_threshold_delete
4944
4945 # Type: number
4946 # Default: -1
4947
4948 # Messages which have been assigned a score equal to or lower than the value of
4949 # this variable are automatically marked for deletion by NeoMutt. Since NeoMutt
4950 # scores are always greater than or equal to zero, the default setting of this
4951 # variable will never mark a message for deletion.
4952
4953
4954
4955 # 3.336. score_threshold_flag
4956
4957 # Type: number
4958 # Default: 9999
4959
4960 # Messages which have been assigned a score greater than or equal to this
4961 # variable's value are automatically marked "flagged".
4962
4963
4964
4965 # 3.337. score_threshold_read
4966
4967 # Type: number
4968 # Default: -1
4969
4970 # Messages which have been assigned a score equal to or lower than the value of
4971 # this variable are automatically marked as read by NeoMutt. Since NeoMutt scores
4972 # are always greater than or equal to zero, the default setting of this variable
4973 # will never mark a message read.
4974
4975
4976
4977 # 3.338. search_context
4978
4979 # Type: number
4980 # Default: 0
4981
4982 # For the pager, this variable specifies the number of lines shown before search
4983 # results. By default, search results will be top-aligned.
4984
4985 set search_context=5
4986
4987
4988 # 3.339. send_charset
4989
4990 # Type: string
4991 # Default: “us-ascii:iso-8859-1:utf-8”
4992
4993 # A colon-delimited list of character sets for outgoing messages. NeoMutt will
4994 # use the first character set into which the text can be converted exactly. If
4995 # your $charset is not "iso-8859-1" and recipients may not understand "UTF-8", it
4996 # is advisable to include in the list an appropriate widely used standard
4997 # character set (such as "iso-8859-2", "koi8-r" or "iso-2022-jp") either instead
4998 # of or after "iso-8859-1".
4999
5000 # In case the text can't be converted into one of these exactly, NeoMutt uses
5001 # $charset as a fallback.
5002
5003 set send_charset="utf-8"
5004
5005
5006 # 3.340. sendmail
5007
5008 # Type: command
5009 # Default: “/usr/sbin/sendmail -oem -oi”
5010
5011 # Specifies the program and arguments used to deliver mail sent by NeoMutt.
5012 # NeoMutt expects that the specified program interprets additional arguments as
5013 # recipient addresses. NeoMutt appends all recipients after adding a -- delimiter
5014 # (if not already present). Additional flags, such as for $use_8bit_mime,
5015 # $use_envelope_from, $dsn_notify, or $dsn_return will be added before the
5016 # delimiter. 
5017
5018 # See also: $write_bcc.
5019
5020 set sendmail="$my_confdir/sendmail"
5021
5022
5023 # 3.341. sendmail_wait
5024
5025 # Type: number
5026 # Default: 0
5027
5028 # Specifies the number of seconds to wait for the $sendmail process to finish
5029 # before giving up and putting delivery in the background.
5030
5031 # NeoMutt interprets the value of this variable as follows:
5032
5033 # ┌──┬──────────────────────────────────────────────────────────────────┐ 
5034 # │>0│number of seconds to wait for sendmail to finish before continuing│
5035 # ├──┼──────────────────────────────────────────────────────────────────┤ 
5036 # │0 │wait forever for sendmail to finish                               │
5037 # ├──┼──────────────────────────────────────────────────────────────────┤ 
5038 # │<0│always put sendmail in the background without waiting             │
5039 # └──┴──────────────────────────────────────────────────────────────────┘ 
5040
5041 # Note that if you specify a value other than 0, the output of the child process
5042 # will be put in a temporary file. If there is some error, you will be informed
5043 # as to where to find the output.
5044
5045
5046
5047 # 3.342. shell
5048
5049 # Type: command
5050 # Default: “/bin/sh”
5051
5052 # Command to use when spawning a subshell. If not specified, then the user's
5053 # login shell from /etc/passwd is used.
5054
5055
5056
5057 # 3.343. show_multipart_alternative
5058
5059 # Type: string
5060 # Default: (empty)
5061
5062 # When set to info, the multipart/alternative information is shown. When set to
5063 # inline, all of the alternatives are displayed. When not set, the default
5064 # behavior is to show only the chosen alternative.
5065
5066
5067
5068 # 3.344. show_new_news
5069
5070 # Type: boolean
5071 # Default: yes
5072
5073 # If set, news server will be asked for new newsgroups on entering the browser.
5074 # Otherwise, it will be done only once for a news server. Also controls whether
5075 # or not number of new articles of subscribed newsgroups will be then checked.
5076
5077
5078
5079 # 3.345. show_only_unread
5080
5081 # Type: boolean
5082 # Default: no
5083
5084 # If set, only subscribed newsgroups that contain unread articles will be
5085 # displayed in browser.
5086
5087
5088
5089 # 3.346. sidebar_component_depth
5090
5091 # Type: number
5092 # Default: 0
5093
5094 # By default the sidebar will show the mailbox's path, relative to the $folder
5095 # variable. This specifies the number of parent directories to hide from display
5096 # in the sidebar. For example: If a maildir is normally displayed in the sidebar
5097 # as dir1/dir2/dir3/maildir, setting sidebar_component_depth=2 will display it as
5098 # dir3/maildir, having truncated the 2 highest directories.
5099
5100 # See also: $sidebar_short_path
5101
5102
5103
5104 # 3.347. sidebar_delim_chars
5105
5106 # Type: string
5107 # Default: “/.”
5108
5109 # This contains the list of characters which you would like to treat as folder
5110 # separators for displaying paths in the sidebar.
5111
5112 # Local mail is often arranged in directories: 'dir1/dir2/mailbox'.
5113
5114 # set sidebar_delim_chars='/'
5115
5116 # IMAP mailboxes are often named: 'folder1.folder2.mailbox'.
5117
5118 # set sidebar_delim_chars='.'
5119
5120 # See also: $sidebar_short_path, $sidebar_folder_indent, $sidebar_indent_string.
5121
5122
5123
5124 # 3.348. sidebar_divider_char
5125
5126 # Type: string
5127 # Default: (empty)
5128
5129 # This specifies the characters to be drawn between the sidebar (when visible)
5130 # and the other NeoMutt panels. ASCII and Unicode line-drawing characters are
5131 # supported. 
5132
5133 set sidebar_divider_char=" "
5134
5135
5136 # 3.349. sidebar_folder_indent
5137
5138 # Type: boolean
5139 # Default: no
5140
5141 # Set this to indent mailboxes in the sidebar.
5142
5143 # See also: $sidebar_short_path, $sidebar_indent_string, $sidebar_delim_chars.
5144
5145 set sidebar_folder_indent=yes
5146
5147
5148 # 3.350. sidebar_format
5149
5150 # Type: string
5151 # Default: “%D%*  %n”
5152
5153 # This variable allows you to customize the sidebar display. This string is
5154 # similar to $index_format, but has its own set of printf(3)-like sequences:
5155
5156 # ┌───┬──┬──────────────────────────────────────────────────────────────────────┐ 
5157 # │%B │  │Name of the mailbox                                                   │
5158 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤ 
5159 # │%d │* │Number of deleted messages in the mailbox                             │
5160 # │ │@ │                                                                      │
5161 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤ 
5162 # │%D │  │Descriptive name of the mailbox                                       │
5163 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤ 
5164 # │%F │* │Number of flagged messages in the mailbox                             │
5165 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤ 
5166 # │%L │* │Number of messages after limiting                                     │
5167 # │ │@ │                                                                      │
5168 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤ 
5169 # │%n │  │"N" if mailbox has new mail, ' ' (space) otherwise                    │
5170 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤ 
5171 # │%N │* │Number of unread messages in the mailbox (seen or unseen)             │
5172 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤ 
5173 # │%o │* │Number of old messages in the mailbox (unread, seen)                  │
5174 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤ 
5175 # │%r │* │Number of read messages in the mailbox (read, seen)                   │
5176 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤ 
5177 # │%S │* │Size of mailbox (total number of messages)                            │
5178 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤ 
5179 # │%t │* │Number of tagged messages in the mailbox                              │
5180 # │ │@ │                                                                      │
5181 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤ 
5182 # │%Z │* │Number of new messages in the mailbox (unread, unseen)                │
5183 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤ 
5184 # │%! │  │"!" : one flagged message; "!!" : two flagged messages; "n!" : n      │
5185 # │ │  │flagged messages (for n > 2). Otherwise prints nothing.               │
5186 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤ 
5187 # │%>X│ │Right justify the rest of the string and pad with "X"                 │
5188 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤ 
5189 # │%|X│ │Pad to the end of the line with "X"                                   │
5190 # ├───┼──┼──────────────────────────────────────────────────────────────────────┤ 
5191 # │%*X│ │Soft-fill with character "X" as pad                                   │
5192 # └───┴──┴──────────────────────────────────────────────────────────────────────┘ 
5193
5194 # * = Can be optionally printed if nonzero
5195
5196 # @ = Only applicable to the current folder
5197
5198 # In order to use %S, %N, %F, and %!, $mail_check_stats must be set. When thus
5199 # set, a suggested value for this option is "%B%?F? [%F]?%* %?N?%N/?%S".
5200
5201 set sidebar_format="%D%?F? [%F]?%*  %?N?%N/?%S"
5202
5203
5204 # 3.351. sidebar_indent_string
5205
5206 # Type: string
5207 # Default: “  ”
5208
5209 # This specifies the string that is used to indent mailboxes in the sidebar. It
5210 # defaults to two spaces.
5211
5212 # See also: $sidebar_short_path, $sidebar_folder_indent, $sidebar_delim_chars.
5213
5214 set sidebar_indent_string=" "
5215
5216
5217 # 3.352. sidebar_new_mail_only
5218
5219 # Type: boolean
5220 # Default: no
5221
5222 # When set, the sidebar will only display mailboxes containing new, or flagged,
5223 # mail. 
5224
5225 # See also: $sidebar_whitelist, $sidebar_non_empty_mailbox_only.
5226
5227
5228
5229 # 3.353. sidebar_next_new_wrap
5230
5231 # Type: boolean
5232 # Default: no
5233
5234 # When set, the <sidebar-next-new> command will not stop and the end of the list
5235 # of mailboxes, but wrap around to the beginning. The <sidebar-prev-new> command
5236 # is similarly affected, wrapping around to the end of the list.
5237
5238 set sidebar_next_new_wrap=yes
5239
5240
5241 # 3.354. sidebar_non_empty_mailbox_only
5242
5243 # Type: boolean
5244 # Default: no
5245
5246 # When set, the sidebar will only display mailboxes that contain one or more
5247 # mails. 
5248
5249 # See also: $sidebar_new_mail_only, $sidebar_whitelist.
5250
5251
5252
5253 # 3.355. sidebar_on_right
5254
5255 # Type: boolean
5256 # Default: no
5257
5258 # When set, the sidebar will appear on the right-hand side of the screen.
5259
5260
5261
5262 # 3.356. sidebar_short_path
5263
5264 # Type: boolean
5265 # Default: no
5266
5267 # By default the sidebar will show the mailbox's path, relative to the $folder
5268 # variable. Setting sidebar_shortpath=yes will shorten the names relative to the
5269 # previous name. Here's an example:
5270
5271 # ┌────────────┬─────────────┬───────────────────────────────────────────────┐ 
5272 # │shortpath=no│shortpath=yes│shortpath=yes, folderindent=yes, indentstr=".."│
5273 # ├────────────┼─────────────┼───────────────────────────────────────────────┤ 
5274 # │fruit │fruit        │fruit                                          │
5275 # ├────────────┼─────────────┼───────────────────────────────────────────────┤ 
5276 # │fruit.apple │apple        │..apple                                        │
5277 # ├────────────┼─────────────┼───────────────────────────────────────────────┤ 
5278 # │fruit.banana│banana │..banana                                       │
5279 # ├────────────┼─────────────┼───────────────────────────────────────────────┤ 
5280 # │fruit.cherry│cherry │..cherry                                       │
5281 # └────────────┴─────────────┴───────────────────────────────────────────────┘ 
5282
5283 # See also: $sidebar_delim_chars, $sidebar_folder_indent, $sidebar_indent_string,
5284 # $sidebar_component_depth. 
5285
5286 set sidebar_short_path=no
5287
5288
5289 # 3.357. sidebar_sort_method
5290
5291 # Type: sort order
5292 # Default: order
5293
5294 # Specifies how to sort mailbox entries in the sidebar. By default, the entries
5295 # are sorted alphabetically. Valid values:
5296
5297 # • path (alphabetically)
5298
5299 # • count (all message count)
5300
5301 # • flagged (flagged message count)
5302
5303 # • new (unread message count)
5304
5305 # • unread (unread message count)
5306
5307 # • unsorted
5308
5309 # You may optionally use the "reverse-" prefix to specify reverse sorting order
5310 # (example: "set sidebar_sort_method=reverse-alpha").
5311
5312 # The "alpha" and "name" values are synonyms for "path".
5313
5314 set sidebar_sort_method=path
5315
5316
5317 # 3.358. sidebar_visible
5318
5319 # Type: boolean
5320 # Default: no
5321
5322 # This specifies whether or not to show sidebar. The sidebar shows a list of all
5323 # your mailboxes.
5324
5325 # See also: $sidebar_format, $sidebar_width
5326
5327 set sidebar_visible=no
5328
5329
5330 # 3.359. sidebar_width
5331
5332 # Type: number
5333 # Default: 30
5334
5335 # This controls the width of the sidebar. It is measured in screen columns. For
5336 # example: sidebar_width=20 could display 20 ASCII characters, or 10 Chinese
5337 # characters. 
5338
5339 set sidebar_width=20
5340
5341
5342 # 3.360. sig_dashes
5343
5344 # Type: boolean
5345 # Default: yes
5346
5347 # If set, a line containing "-- " (note the trailing space) will be inserted
5348 # before your $signature. It is strongly recommended that you not unset this
5349 # variable unless your signature contains just your name. The reason for this is
5350 # because many software packages use "-- n" to detect your signature. For
5351 # example, NeoMutt has the ability to highlight the signature in a different
5352 # color in the built-in pager.
5353
5354 set sig_dashes=no
5355
5356
5357 # 3.361. sig_on_top
5358
5359 # Type: boolean
5360 # Default: no
5361
5362 # If set, the signature will be included before any quoted or forwarded text. It
5363 # is strongly recommended that you do not set this variable unless you really
5364 # know what you are doing, and are prepared to take some heat from netiquette
5365 # guardians. 
5366
5367
5368
5369 # 3.362. signature
5370
5371 # Type: path
5372 # Default: “~/.signature”
5373
5374 # Specifies the filename of your signature, which is appended to all outgoing
5375 # messages. If the filename ends with a pipe ("|"), it is assumed that filename
5376 # is a shell command and input should be read from its standard output.
5377
5378
5379
5380 # 3.363. simple_search
5381
5382 # Type: string
5383 # Default: “~f %s | ~s %s”
5384
5385 # Specifies how NeoMutt should expand a simple search into a real search pattern.
5386 # A simple search is one that does not contain any of the "~" pattern operators.
5387 # See "patterns" for more information on search patterns.
5388
5389 # For example, if you simply type "joe" at a search or limit prompt, NeoMutt will
5390 # automatically expand it to the value specified by this variable by replacing
5391 # "%s" with the supplied string. For the default value, "joe" would be expanded
5392 # to: "~f joe | ~s joe".
5393
5394 set simple_search="~L %s | ~s %s"
5395
5396
5397 # 3.364. size_show_bytes
5398
5399 # Type: boolean
5400 # Default: no
5401
5402 # If set, message sizes will display bytes for values less than 1 kilobyte. See
5403 # formatstrings-size. 
5404
5405
5406
5407 # 3.365. size_show_fractions
5408
5409 # Type: boolean
5410 # Default: yes
5411
5412 # If set, message sizes will be displayed with a single decimal value for sizes
5413 # from 0 to 10 kilobytes and 1 to 10 megabytes. See formatstrings-size.
5414
5415
5416
5417 # 3.366. size_show_mb
5418
5419 # Type: boolean
5420 # Default: yes
5421
5422 # If set, message sizes will display megabytes for values greater than or equal
5423 # to 1 megabyte. See formatstrings-size.
5424
5425
5426
5427 # 3.367. size_units_on_left
5428
5429 # Type: boolean
5430 # Default: no
5431
5432 # If set, message sizes units will be displayed to the left of the number. See
5433 # formatstrings-size. 
5434
5435
5436
5437 # 3.368. sleep_time
5438
5439 # Type: number
5440 # Default: 1
5441
5442 # Specifies time, in seconds, to pause while displaying certain informational
5443 # messages, while moving from folder to folder and after expunging messages from
5444 # the current folder. The default is to pause one second, so a value of zero for
5445 # this option suppresses the pause.
5446
5447
5448
5449 # 3.369. smart_wrap
5450
5451 # Type: boolean
5452 # Default: yes
5453
5454 # Controls the display of lines longer than the screen width in the internal
5455 # pager. If set, long lines are wrapped at a word boundary. If unset, lines are
5456 # simply wrapped at the screen edge. Also see the $markers variable.
5457
5458
5459
5460 # 3.370. smileys
5461
5462 # Type: regular expression
5463 # Default: “(>From )|(:[-^]?[][)(><}{|/DP])”
5464
5465 # The pager uses this variable to catch some common false positives of
5466 # $quote_regex, most notably smileys and not consider a line quoted text if it
5467 # also matches $smileys. This mostly happens at the beginning of a line.
5468
5469
5470
5471 # 3.371. smime_ask_cert_label
5472
5473 # Type: boolean
5474 # Default: yes
5475
5476 # This flag controls whether you want to be asked to enter a label for a
5477 # certificate about to be added to the database or not. It is set by default. (S/
5478 # MIME only)
5479
5480
5481
5482 # 3.372. smime_ca_location
5483
5484 # Type: path
5485 # Default: (empty)
5486
5487 # This variable contains the name of either a directory, or a file which contains
5488 # trusted certificates for use with OpenSSL. (S/MIME only)
5489
5490
5491
5492 # 3.373. smime_certificates
5493
5494 # Type: path
5495 # Default: (empty)
5496
5497 # Since for S/MIME there is no pubring/secring as with PGP, NeoMutt has to handle
5498 # storage and retrieval of keys by itself. This is very basic right now, and keys
5499 # and certificates are stored in two different directories, both named as the
5500 # hash-value retrieved from OpenSSL. There is an index file which contains
5501 # mailbox-address keyid pairs, and which can be manually edited. This option
5502 # points to the location of the certificates. (S/MIME only)
5503
5504 set smime_certificates="~/.smime/certificates"
5505
5506
5507 # 3.374. smime_decrypt_command
5508
5509 # Type: command
5510 # Default: (empty)
5511
5512 # This format string specifies a command which is used to decrypt application/
5513 # x-pkcs7-mime attachments.
5514
5515 # The OpenSSL command formats have their own set of printf(3)-like sequences
5516 # similar to PGP's:
5517
5518 # ┌──┬──────────────────────────────────────────────────────────────────────────┐ 
5519 # │%f│Expands to the name of a file containing a message.                       │
5520 # ├──┼──────────────────────────────────────────────────────────────────────────┤ 
5521 # │%s│Expands to the name of a file containing the signature part of a multipart│
5522 # │ │/signed attachment when verifying it.                                     │
5523 # ├──┼──────────────────────────────────────────────────────────────────────────┤ 
5524 # │%k│The key-pair specified with $smime_default_key                            │
5525 # ├──┼──────────────────────────────────────────────────────────────────────────┤ 
5526 # │%i│Intermediate certificates                                                 │
5527 # ├──┼──────────────────────────────────────────────────────────────────────────┤ 
5528 # │%c│One or more certificate IDs.                                              │
5529 # ├──┼──────────────────────────────────────────────────────────────────────────┤ 
5530 # │%a│The algorithm used for encryption.                                        │
5531 # ├──┼──────────────────────────────────────────────────────────────────────────┤ 
5532 # │%d│The message digest algorithm specified with $smime_sign_digest_alg.       │
5533 # ├──┼──────────────────────────────────────────────────────────────────────────┤ 
5534 # │ │CA location: Depending on whether $smime_ca_location points to a directory│
5535 # │%C│or file, this expands to "-CApath $smime_ca_location" or "-CAfile         │
5536 # │ │$smime_ca_location".                                                      │
5537 # └──┴──────────────────────────────────────────────────────────────────────────┘ 
5538
5539 # For examples on how to configure these formats, see the smime.rc in the samples
5540 # / subdirectory which has been installed on your system alongside the
5541 # documentation. (S/MIME only)
5542
5543
5544
5545 # 3.375. smime_decrypt_use_default_key
5546
5547 # Type: boolean
5548 # Default: yes
5549
5550 # If set (default) this tells NeoMutt to use the default key for decryption.
5551 # Otherwise, if managing multiple certificate-key-pairs, NeoMutt will try to use
5552 # the mailbox-address to determine the key to use. It will ask you to supply a
5553 # key, if it can't find one. (S/MIME only)
5554
5555
5556
5557 # 3.376. smime_default_key
5558
5559 # Type: string
5560 # Default: (empty)
5561
5562 # This is the default key-pair to use for S/MIME operations, and must be set to
5563 # the keyid (the hash-value that OpenSSL generates) to work properly.
5564
5565 # It will be used for encryption (see $postpone_encrypt and $smime_self_encrypt).
5566
5567 # It will be used for decryption unless $smime_decrypt_use_default_key is unset.
5568
5569 # It will also be used for signing unless $smime_sign_as is set.
5570
5571 # The (now deprecated) smime_self_encrypt_as is an alias for this variable, and
5572 # should no longer be used. (S/MIME only)
5573
5574
5575
5576 # 3.377. smime_encrypt_command
5577
5578 # Type: command
5579 # Default: (empty)
5580
5581 # This command is used to create encrypted S/MIME messages.
5582
5583 # This is a format string, see the $smime_decrypt_command command for possible
5584 # printf(3)-like sequences. (S/MIME only)
5585
5586 # Encrypt the message to $smime_default_key too. (S/MIME only) Note: On Debian
5587 # systems, this defaults to the first existing file in the following list: ~
5588 # /.smime/ca-certificates.crt ~/.smime/ca-bundle.crt /etc/ssl/certs/
5589 # ca-certificates.crt. 
5590
5591
5592
5593 # 3.378. smime_encrypt_with
5594
5595 # Type: string
5596 # Default: “aes256”
5597
5598 # This sets the algorithm that should be used for encryption. Valid choices are
5599 # "aes128", "aes192", "aes256", "des", "des3", "rc2-40", "rc2-64", "rc2-128". (S/
5600 # MIME only)
5601
5602
5603
5604 # 3.379. smime_get_cert_command
5605
5606 # Type: command
5607 # Default: (empty)
5608
5609 # This command is used to extract X509 certificates from a PKCS7 structure.
5610
5611 # This is a format string, see the $smime_decrypt_command command for possible
5612 # printf(3)-like sequences. (S/MIME only)
5613
5614
5615
5616 # 3.380. smime_get_cert_email_command
5617
5618 # Type: command
5619 # Default: (empty)
5620
5621 # This command is used to extract the mail address(es) used for storing X509
5622 # certificates, and for verification purposes (to check whether the certificate
5623 # was issued for the sender's mailbox).
5624
5625 # This is a format string, see the $smime_decrypt_command command for possible
5626 # printf(3)-like sequences. (S/MIME only)
5627
5628
5629
5630 # 3.381. smime_get_signer_cert_command
5631
5632 # Type: command
5633 # Default: (empty)
5634
5635 # This command is used to extract only the signers X509 certificate from a S/MIME
5636 # signature, so that the certificate's owner may get compared to the email's
5637 # "From:" field.
5638
5639 # This is a format string, see the $smime_decrypt_command command for possible
5640 # printf(3)-like sequences. (S/MIME only)
5641
5642
5643
5644 # 3.382. smime_import_cert_command
5645
5646 # Type: command
5647 # Default: (empty)
5648
5649 # This command is used to import a certificate via smime_keys.
5650
5651 # This is a format string, see the $smime_decrypt_command command for possible
5652 # printf(3)-like sequences. NOTE: %c and %k will default to $smime_sign_as if
5653 # set, otherwise $smime_default_key. (S/MIME only)
5654
5655
5656
5657 # 3.383. smime_is_default
5658
5659 # Type: boolean
5660 # Default: no
5661
5662 # The default behavior of NeoMutt is to use PGP on all auto-sign/encryption
5663 # operations. To override and to use OpenSSL instead this must be set. However,
5664 # this has no effect while replying, since NeoMutt will automatically select the
5665 # same application that was used to sign/encrypt the original message. (Note that
5666 # this variable can be overridden by unsetting $crypt_auto_smime.) (S/MIME only)
5667
5668
5669
5670 # 3.384. smime_keys
5671
5672 # Type: path
5673 # Default: (empty)
5674
5675 # Since for S/MIME there is no pubring/secring as with PGP, NeoMutt has to handle
5676 # storage and retrieval of keys/certs by itself. This is very basic right now,
5677 # and stores keys and certificates in two different directories, both named as
5678 # the hash-value retrieved from OpenSSL. There is an index file which contains
5679 # mailbox-address keyid pair, and which can be manually edited. This option
5680 # points to the location of the private keys. (S/MIME only)
5681
5682 set smime_keys="~/.smime/keys"
5683
5684
5685 # 3.385. smime_pk7out_command
5686
5687 # Type: command
5688 # Default: (empty)
5689
5690 # This command is used to extract PKCS7 structures of S/MIME signatures, in order
5691 # to extract the public X509 certificate(s).
5692
5693 # This is a format string, see the $smime_decrypt_command command for possible
5694 # printf(3)-like sequences. (S/MIME only)
5695
5696
5697
5698 # 3.386. smime_self_encrypt
5699
5700 # Type: boolean
5701 # Default: yes
5702
5703 # When set, S/MIME encrypted messages will also be encrypted using the
5704 # certificate in $smime_default_key. (S/MIME only)
5705
5706
5707
5708 # 3.387. smime_sign_as
5709
5710 # Type: string
5711 # Default: (empty)
5712
5713 # If you have a separate key to use for signing, you should set this to the
5714 # signing key. Most people will only need to set $smime_default_key. (S/MIME
5715 # only) 
5716
5717
5718
5719 # 3.388. smime_sign_command
5720
5721 # Type: command
5722 # Default: (empty)
5723
5724 # This command is used to created S/MIME signatures of type multipart/signed,
5725 # which can be read by all mail clients.
5726
5727 # This is a format string, see the $smime_decrypt_command command for possible
5728 # printf(3)-like sequences. (S/MIME only)
5729
5730
5731
5732 # 3.389. smime_sign_digest_alg
5733
5734 # Type: string
5735 # Default: “sha256”
5736
5737 # This sets the algorithm that should be used for the signature message digest.
5738 # Valid choices are "md5", "sha1", "sha224", "sha256", "sha384", "sha512". (S/
5739 # MIME only)
5740
5741
5742
5743 # 3.390. smime_timeout
5744
5745 # Type: number
5746 # Default: 300
5747
5748 # The number of seconds after which a cached passphrase will expire if not used.
5749 # (S/MIME only)
5750
5751
5752
5753 # 3.391. smime_verify_command
5754
5755 # Type: command
5756 # Default: (empty)
5757
5758 # This command is used to verify S/MIME signatures of type multipart/signed.
5759
5760 # This is a format string, see the $smime_decrypt_command command for possible
5761 # printf(3)-like sequences. (S/MIME only)
5762
5763
5764
5765 # 3.392. smime_verify_opaque_command
5766
5767 # Type: command
5768 # Default: (empty)
5769
5770 # This command is used to verify S/MIME signatures of type application/
5771 # x-pkcs7-mime. 
5772
5773 # This is a format string, see the $smime_decrypt_command command for possible
5774 # printf(3)-like sequences. (S/MIME only)
5775
5776
5777
5778 # 3.393. smtp_authenticators
5779
5780 # Type: string list
5781 # Default: (empty)
5782
5783 # This is a colon-separated list of authentication methods NeoMutt may attempt to
5784 # use to log in to an SMTP server, in the order NeoMutt should try them.
5785 # Authentication methods are any SASL mechanism, e.g. "plain", "digest-md5",
5786 # "gssapi" or "cram-md5". This option is case-insensitive. If it is "unset" (the
5787 # default) NeoMutt will try all available methods, in order from most-secure to
5788 # least-secure. Support for the "plain" mechanism is bundled; other mechanisms
5789 # are provided by an external SASL library (look for '+sasl' in the output of
5790 # neomutt -v).
5791
5792 # Example: 
5793
5794 # set smtp_authenticators="digest-md5:cram-md5"
5795
5796
5797
5798 # 3.394. smtp_oauth_refresh_command
5799
5800 # Type: command
5801 # Default: (empty)
5802
5803 # The command to run to generate an OAUTH refresh token for authorizing your
5804 # connection to your SMTP server. This command will be run on every connection
5805 # attempt that uses the OAUTHBEARER or XOAUTH2 authentication mechanisms. See "
5806 # oauth" for details.
5807
5808
5809
5810 # 3.395. smtp_pass
5811
5812 # Type: string
5813 # Default: (empty)
5814
5815 # Specifies the password for your SMTP account. If unset, NeoMutt will prompt you
5816 # for your password when you first send mail via SMTP. See $smtp_url to configure
5817 # NeoMutt to send mail via SMTP.
5818
5819 # Warning: you should only use this option when you are on a fairly secure
5820 # machine, because the superuser can read your neomuttrc even if you are the only
5821 # one who can read the file.
5822
5823
5824
5825 # 3.396. smtp_url
5826
5827 # Type: string
5828 # Default: (empty)
5829
5830 # Defines the SMTP smarthost where sent messages should relayed for delivery.
5831 # This should take the form of an SMTP URL, e.g.:
5832
5833 # smtp[s]://[user[:pass]@]host[:port] 
5834
5835 # where "[...]" denotes an optional part. Setting this variable overrides the
5836 # value of the $sendmail variable.
5837
5838 # Also see $write_bcc.
5839
5840
5841
5842 # 3.397. smtp_user
5843
5844 # Type: string
5845 # Default: (empty)
5846
5847 # The username for the SMTP server.
5848
5849 # This variable defaults to your user name on the local machine.
5850
5851
5852
5853 # 3.398. sort
5854
5855 # Type: sort order
5856 # Default: date
5857
5858 # Specifies how to sort messages in the "index" menu. Valid values are:
5859
5860 # • date
5861
5862 # • date-received
5863
5864 # • from
5865
5866 # • score
5867
5868 # • size
5869
5870 # • spam
5871
5872 # • subject
5873
5874 # • threads
5875
5876 # • to
5877
5878 # • unsorted
5879
5880 # You may optionally use the "reverse-" prefix to specify reverse sorting order,
5881 # or the "last-" prefix to sort threads based on the corresponding attribute of
5882 # the last descendant rather than the thread root. If both prefixes are in use,
5883 # "reverse-" must come before "last-". The "last-" prefix has no effect on a flat
5884 # view. 
5885
5886 # Any ties in the primary sort are broken by $sort_aux. When $use_threads is
5887 # "threads" or "reverse", $sort controls the sorting between threads, and
5888 # $sort_aux controls the sorting within a thread.
5889
5890 # The "date-sent" value is a synonym for "date". The "mailbox-order" value is a
5891 # synonym for "unsorted".
5892
5893 # The values of "threads" and "reverse-threads" are legacy options, which cause
5894 # the value of $sort_aux to also contol sorting between threads, and they may not
5895 # be used with the "last-" prefix. The preferred way to enable a threaded view is
5896 # via $use_threads. This variable can also be set via the <sort-mailbox> and
5897 # <sort-reverse> functions.
5898
5899 # Note: When $use_threads is "threads", the last thread sorts to the bottom; when
5900 # it is "reversed", the last thread sorts to the top. The use of "reverse-" in
5901 # $sort swaps which end the last thread will sort to.
5902
5903 # See the "Use Threads Feature" section for further explanation and examples,
5904 # https://neomutt.org/feature/use-threads. 
5905
5906 set sort=threads
5907
5908
5909 # 3.399. sort_alias
5910
5911 # Type: sort order
5912 # Default: alias
5913
5914 # Specifies how the entries in the "alias" menu are sorted. The following are
5915 # legal values:
5916
5917 # • address (sort alphabetically by email address)
5918
5919 # • alias (sort alphabetically by alias name)
5920
5921 # • unsorted (leave in order specified in .neomuttrc)
5922
5923 # Note: This also affects the entries of the address query menu, thus potentially
5924 # overruling the order of entries as generated by $query_command.
5925
5926
5927
5928 # 3.400. sort_aux
5929
5930 # Type: sort order
5931 # Default: date
5932
5933 # This provides a secondary sort for messages in the "index" menu, used when the
5934 # $sort value is equal for two messages.
5935
5936 # When sorting by threads, this variable controls how subthreads are sorted
5937 # within a single thread (for the order between threads, see $sort). This can be
5938 # set to any value that $sort can, including with the use of "reverse-" and
5939 # "last-" prefixes, except for variations using "threads" (in that case, NeoMutt
5940 # will just use "date"). For instance,
5941
5942 # set sort_aux=last-date-received
5943
5944 # would mean that if a new message is received in a thread, that subthread
5945 # becomes the last one displayed (or the first, if you have "set use_threads=
5946 # reverse".) When using $use_threads, it is more common to use "last-" with $sort
5947 # and not with $sort_aux.
5948
5949 # See the "Use Threads Feature" section for further explanation and examples,
5950 # https://neomutt.org/feature/use-threads. 
5951
5952 set sort_aux=last-date-received
5953
5954
5955 # 3.401. sort_browser
5956
5957 # Type: sort order
5958 # Default: alpha
5959
5960 # Specifies how to sort entries in the file browser. By default, the entries are
5961 # sorted alphabetically. Valid values:
5962
5963 # • alpha (alphabetically)
5964
5965 # • count (all message count)
5966
5967 # • date
5968
5969 # • desc (description)
5970
5971 # • new (new message count)
5972
5973 # • size
5974
5975 # • unsorted
5976
5977 # You may optionally use the "reverse-" prefix to specify reverse sorting order
5978 # (example: "set sort_browser=reverse-date").
5979
5980 # The "unread" value is a synonym for "new".
5981
5982
5983
5984 # 3.402. sort_re
5985
5986 # Type: boolean
5987 # Default: yes
5988
5989 # This variable is only useful when sorting by threads with $strict_threads unset
5990 # . In that case, it changes the heuristic mutt uses to thread messages by
5991 # subject. With $sort_re set, mutt will only attach a message as the child of
5992 # another message by subject if the subject of the child message starts with a
5993 # substring matching the setting of $reply_regex. With $sort_re unset, mutt will
5994 # attach the message whether or not this is the case, as long as the non-
5995 # $reply_regex parts of both messages are identical.
5996
5997
5998
5999 # 3.403. spam_separator
6000
6001 # Type: string
6002 # Default: “,”
6003
6004 # This variable controls what happens when multiple spam headers are matched: if
6005 # unset, each successive header will overwrite any previous matches value for the
6006 # spam label. If set, each successive match will append to the previous, using
6007 # this variable's value as a separator.
6008
6009
6010
6011 # 3.404. spool_file
6012
6013 # Type: mailbox
6014 # Default: (empty)
6015
6016 # If your spool mailbox is in a non-default place where NeoMutt can't find it,
6017 # you can specify its location with this variable. The description from
6018 # "named-mailboxes" or "virtual-mailboxes" may be used for the spool_file.
6019
6020 # If not specified, then the environment variables $MAIL and $MAILDIR will be
6021 # checked. 
6022
6023 set spool_file="=inbox"
6024
6025
6026 # 3.405. ssl_ca_certificates_file
6027
6028 # Type: path
6029 # Default: (empty)
6030
6031 # This variable specifies a file containing trusted CA certificates. Any server
6032 # certificate that is signed with one of these CA certificates is also
6033 # automatically accepted. (GnuTLS only)
6034
6035 # Example: 
6036
6037 # set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
6038
6039 # Note: On Debian systems, this option is set by default to “threads” in /etc/
6040 # Muttrc. 
6041
6042 set ssl_ca_certificates_file="/etc/ssl/certs/ca-certificates.crt"
6043
6044
6045 # 3.406. ssl_ciphers
6046
6047 # Type: string
6048 # Default: (empty)
6049
6050 # Contains a colon-separated list of ciphers to use when using SSL. For OpenSSL,
6051 # see ciphers(1) for the syntax of the string.
6052
6053 # For GnuTLS, this option will be used in place of "NORMAL" at the start of the
6054 # priority string. See gnutls_priority_init(3) for the syntax and more details.
6055 # (Note: GnuTLS version 2.1.7 or higher is required.)
6056
6057
6058
6059 # 3.407. ssl_client_cert
6060
6061 # Type: path
6062 # Default: (empty)
6063
6064 # The file containing a client certificate and its associated private key.
6065
6066
6067
6068 # 3.408. ssl_force_tls
6069
6070 # Type: boolean
6071 # Default: yes
6072
6073 # If this variable is set, NeoMutt will require that all connections to remote
6074 # servers be encrypted. Furthermore it will attempt to negotiate TLS even if the
6075 # server does not advertise the capability, since it would otherwise have to
6076 # abort the connection anyway. This option supersedes $ssl_starttls.
6077
6078
6079
6080 # 3.409. ssl_min_dh_prime_bits
6081
6082 # Type: number
6083 # Default: 0
6084
6085 # This variable specifies the minimum acceptable prime size (in bits) for use in
6086 # any Diffie-Hellman key exchange. A value of 0 will use the default from the
6087 # GNUTLS library. (GnuTLS only)
6088
6089
6090
6091 # 3.410. ssl_starttls
6092
6093 # Type: quadoption
6094 # Default: yes
6095
6096 # If set (the default), NeoMutt will attempt to use STARTTLS on servers
6097 # advertising the capability. When unset, NeoMutt will not attempt to use
6098 # STARTTLS regardless of the server's capabilities.
6099
6100 # Note that STARTTLS is subject to many kinds of attacks, including the ability
6101 # of a machine-in-the-middle to suppress the advertising of support. Setting
6102 # $ssl_force_tls is recommended if you rely on STARTTLS.
6103
6104
6105
6106 # 3.411. ssl_use_sslv3
6107
6108 # Type: boolean
6109 # Default: no
6110
6111 # If set , NeoMutt will use SSLv3 when communicating with servers that request
6112 # it. N.B. As of 2015, SSLv3 is considered insecure, and using it is inadvisable.
6113 # See https://tools.ietf.org/html/rfc7525 .
6114
6115
6116
6117 # 3.412. ssl_use_tlsv1
6118
6119 # Type: boolean
6120 # Default: no
6121
6122 # If set , NeoMutt will use TLSv1.0 when communicating with servers that request
6123 # it. N.B. As of 2015, TLSv1.0 is considered insecure, and using it is
6124 # inadvisable. See https://tools.ietf.org/html/rfc7525 .
6125
6126
6127
6128 # 3.413. ssl_use_tlsv1_1
6129
6130 # Type: boolean
6131 # Default: no
6132
6133 # If set , NeoMutt will use TLSv1.1 when communicating with servers that request
6134 # it. N.B. As of 2015, TLSv1.1 is considered insecure, and using it is
6135 # inadvisable. See https://tools.ietf.org/html/rfc7525 .
6136
6137
6138
6139 # 3.414. ssl_use_tlsv1_2
6140
6141 # Type: boolean
6142 # Default: yes
6143
6144 # If set , NeoMutt will use TLSv1.2 when communicating with servers that request
6145 # it. 
6146
6147
6148
6149 # 3.415. ssl_use_tlsv1_3
6150
6151 # Type: boolean
6152 # Default: yes
6153
6154 # If set , NeoMutt will use TLSv1.3 when communicating with servers that request
6155 # it. 
6156
6157
6158
6159 # 3.416. ssl_verify_dates
6160
6161 # Type: boolean
6162 # Default: yes
6163
6164 # If set (the default), NeoMutt will not automatically accept a server
6165 # certificate that is either not yet valid or already expired. You should only
6166 # unset this for particular known hosts, using the <account-hook> function.
6167
6168
6169
6170 # 3.417. ssl_verify_host
6171
6172 # Type: boolean
6173 # Default: yes
6174
6175 # If set (the default), NeoMutt will not automatically accept a server
6176 # certificate whose host name does not match the host used in your folder URL.
6177 # You should only unset this for particular known hosts, using the <account-hook>
6178 # function. 
6179
6180
6181
6182 # 3.418. status_chars
6183
6184 # Type: character string
6185 # Default: “-*%A”
6186
6187 # Controls the characters used by the "%r" indicator in $status_format.
6188
6189 # ┌─────────┬───────┬───────────────────────────────────────────────────────────┐ 
6190 # │Character│Default│Description │
6191 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤ 
6192 # │1 │-      │Mailbox is unchanged                                       │
6193 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤ 
6194 # │2 │*      │Mailbox has been changed and needs to be resynchronized    │
6195 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤ 
6196 # │ │       │Mailbox is read-only, or will not be written when exiting. │
6197 # │3 │%      │(You can toggle whether to write changes to a mailbox with │
6198 # │ │       │the <toggle-write> operation, bound by default to "%")     │
6199 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤ 
6200 # │ │       │Folder opened in attach-message mode. (Certain operations  │
6201 # │4 │A      │like composing a new mail, replying, forwarding, etc. are  │
6202 # │ │       │not permitted in this mode)                                │
6203 # └─────────┴───────┴───────────────────────────────────────────────────────────┘ 
6204
6205
6206
6207 # 3.419. status_format
6208
6209 # Type: string
6210 # Default: “-%r-NeoMutt: %D [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d? Del:%d?
6211 # %?F? Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l? %l?]---(%?T?%T/?%s/%S)
6212 # -%>-(%P)---” 
6213
6214 # Controls the format of the status line displayed in the "index" menu. This
6215 # string is similar to $index_format, but has its own set of printf(3)-like
6216 # sequences: 
6217
6218 # ┌───┬─┬───────────────────────────────────────────────────────────────────────┐ 
6219 # │%b │*│Number of mailboxes with new mail                                      │
6220 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6221 # │%d │*│Number of deleted messages                                             │
6222 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6223 # │%D │ │Description of the mailbox                                             │
6224 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6225 # │%f │ │The full pathname of the current mailbox                               │
6226 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6227 # │%F │*│Number of flagged messages                                             │
6228 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6229 # │%h │ │Local hostname                                                         │
6230 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6231 # │%l │*│Size (in bytes) of the current mailbox (see formatstrings-size)        │
6232 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6233 # │%L │*│Size (in bytes) of the messages shown (i.e., which match the current   │
6234 # │ │ │limit) (see formatstrings-size)                                        │
6235 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6236 # │%m │*│The number of messages in the mailbox                                  │
6237 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6238 # │%M │*│The number of messages shown (i.e., which match the current limit)     │
6239 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6240 # │%n │*│Number of new messages in the mailbox (unread, unseen)                 │
6241 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6242 # │%o │*│Number of old messages in the mailbox (unread, seen)                   │
6243 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6244 # │%p │*│Number of postponed messages                                           │
6245 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6246 # │%P │ │Percentage of the way through the index                                │
6247 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6248 # │%r │ │Modified/read-only/won't-write/attach-message indicator, According to  │
6249 # │ │ │$status_chars                                                          │
6250 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6251 # │%R │*│Number of read messages in the mailbox (read, seen)                    │
6252 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6253 # │%s │ │Current sorting mode ($sort)                                           │
6254 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6255 # │%S │ │Current aux sorting method ($sort_aux)                                 │
6256 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6257 # │%t │*│Number of tagged messages in the mailbox                               │
6258 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6259 # │%T │*│Current threading mode ($use_threads)                                  │
6260 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6261 # │%u │*│Number of unread messages in the mailbox (seen or unseen)              │
6262 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6263 # │%v │ │NeoMutt version string                                                 │
6264 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6265 # │%V │*│Currently active limit pattern, if any                                 │
6266 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6267 # │%>X│ │Right justify the rest of the string and pad with "X"                  │
6268 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6269 # │%|X│ │Pad to the end of the line with "X"                                    │
6270 # ├───┼─┼───────────────────────────────────────────────────────────────────────┤ 
6271 # │%*X│ │Soft-fill with character "X" as pad                                    │
6272 # └───┴─┴───────────────────────────────────────────────────────────────────────┘ 
6273
6274 # For an explanation of "soft-fill", see the $index_format documentation.
6275
6276 # * = can be optionally printed if nonzero
6277
6278 # Some of the above sequences can be used to optionally print a string if their
6279 # value is nonzero. For example, you may only want to see the number of flagged
6280 # messages if such messages exist, since zero is not particularly meaningful. To
6281 # optionally print a string based upon one of the above sequences, the following
6282 # construct is used:
6283
6284 # %?<sequence_char>?<optional_string>? 
6285
6286 # where sequence_char is a character from the table above, and optional_string is
6287 # the string you would like printed if sequence_char is nonzero. optional_string
6288 # may contain other sequences as well as normal text, but you may not nest
6289 # optional strings.
6290
6291 # Here is an example illustrating how to optionally print the number of new
6292 # messages in a mailbox:
6293
6294 # %?n?%n new messages.?
6295
6296 # You can also switch between two strings using the following construct:
6297
6298 # %?<sequence_char>?<if_string>&<else_string>? 
6299
6300 # If the value of sequence_char is non-zero, if_string will be expanded,
6301 # otherwise else_string will be expanded.
6302
6303 # As another example, here is how to show either $sort and $sort_aux or
6304 # $use_threads and $sort, based on whether threads are enabled with $use_threads:
6305
6306 # %?T?%s/%S&%T/%s? 
6307
6308 # You can force the result of any printf(3)-like sequence to be lowercase by
6309 # prefixing the sequence character with an underscore ("_") sign. For example, if
6310 # you want to display the local hostname in lowercase, you would use: "%_h".
6311
6312 # If you prefix the sequence character with a colon (":") character, NeoMutt will
6313 # replace any dots in the expansion by underscores. This might be helpful with
6314 # IMAP folders that don't like dots in folder names.
6315
6316 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) "
6317
6318
6319 # 3.420. status_on_top
6320
6321 # Type: boolean
6322 # Default: no
6323
6324 # Setting this variable causes the "status bar" to be displayed on the first line
6325 # of the screen rather than near the bottom. If $help is set too, it'll be placed
6326 # at the bottom.
6327
6328
6329
6330 # 3.421. strict_threads
6331
6332 # Type: boolean
6333 # Default: no
6334
6335 # If set, threading will only make use of the "In-Reply-To" and "References:"
6336 # fields when you $sort by message threads. By default, messages with the same
6337 # subject are grouped together in "pseudo threads.". This may not always be
6338 # desirable, such as in a personal mailbox where you might have several unrelated
6339 # messages with the subjects like "hi" which will get grouped together. See also
6340 # $sort_re for a less drastic way of controlling this behavior.
6341
6342 set strict_threads=yes
6343
6344
6345 # 3.422. suspend
6346
6347 # Type: boolean
6348 # Default: yes
6349
6350 # When unset, NeoMutt won't stop when the user presses the terminal's susp key,
6351 # usually "^Z". This is useful if you run NeoMutt inside an xterm using a command
6352 # like "xterm -e neomutt".
6353
6354
6355
6356 # 3.423. text_flowed
6357
6358 # Type: boolean
6359 # Default: no
6360
6361 # When set, NeoMutt will generate "format=flowed" bodies with a content type of
6362 # "text/plain; format=flowed". This format is easier to handle for some mailing
6363 # software, and generally just looks like ordinary text. To actually make use of
6364 # this format's features, you'll need support in your editor.
6365
6366 # The option only controls newly composed messages. Postponed messages, resent
6367 # messages, and draft messages (via -H on the command line) will use the
6368 # content-type of the source message.
6369
6370 # Note that $indent_string is ignored when this option is set.
6371
6372 set text_flowed=yes
6373
6374
6375 # 3.424. thorough_search
6376
6377 # Type: boolean
6378 # Default: yes
6379
6380 # Affects the ~b, ~B, and ~h search operations described in section "patterns".
6381 # If set, the headers and body/attachments of messages to be searched are decoded
6382 # before searching. If unset, messages are searched as they appear in the folder.
6383
6384 # Users searching attachments or for non-ASCII characters should set this value
6385 # because decoding also includes MIME parsing/decoding and possible character set
6386 # conversions. Otherwise NeoMutt will attempt to match against the raw message
6387 # received (for example quoted-printable encoded or with encoded headers) which
6388 # may lead to incorrect search results.
6389
6390 set thorough_search=yes
6391
6392
6393 # 3.425. thread_received
6394
6395 # Type: boolean
6396 # Default: no
6397
6398 # When set, NeoMutt uses the date received rather than the date sent to thread
6399 # messages by subject.
6400
6401 set thread_received=yes
6402
6403
6404 # 3.426. tilde
6405
6406 # Type: boolean
6407 # Default: no
6408
6409 # When set, the internal-pager will pad blank lines to the bottom of the screen
6410 # with a tilde ("~").
6411
6412 set tilde=yes
6413
6414
6415 # 3.427. time_inc
6416
6417 # Type: number
6418 # Default: 0
6419
6420 # Along with $read_inc, $write_inc, and $net_inc, this variable controls the
6421 # frequency with which progress updates are displayed. It suppresses updates less
6422 # than $time_inc milliseconds apart. This can improve throughput on systems with
6423 # slow terminals, or when running NeoMutt on a remote system.
6424
6425 # Also see the "tuning" section of the manual for performance considerations.
6426
6427 set time_inc=250
6428
6429
6430 # 3.428. timeout
6431
6432 # Type: number
6433 # Default: 600
6434
6435 # When NeoMutt is waiting for user input either idling in menus or in an
6436 # interactive prompt, NeoMutt would block until input is present. Depending on
6437 # the context, this would prevent certain operations from working, like checking
6438 # for new mail or keeping an IMAP connection alive.
6439
6440 # This variable controls how many seconds NeoMutt will at most wait until it
6441 # aborts waiting for input, performs these operations and continues to wait for
6442 # input. 
6443
6444 # A value of zero or less will cause NeoMutt to never time out.
6445
6446
6447
6448 # 3.429. tmpdir
6449
6450 # Type: path
6451 # Default: “/tmp”
6452
6453 # This variable allows you to specify where NeoMutt will place its temporary
6454 # files needed for displaying and composing messages.
6455
6456 # If this variable is not set, the environment variable $TMPDIR is used. Failing
6457 # that, then "/tmp" is used.
6458
6459 set tmpdir=`mktemp -d`
6460
6461
6462 # 3.430. to_chars
6463
6464 # Type: character string
6465 # Default: “ +TCFLR”
6466
6467 # Controls the character used to indicate mail addressed to you.
6468
6469 # ┌─────────┬───────┬───────────────────────────────────────────────────────────┐ 
6470 # │Character│Default│Description │
6471 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤ 
6472 # │1 │<space>│The mail is not addressed to your address.                 │
6473 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤ 
6474 # │2 │+      │You are the only recipient of the message.                 │
6475 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤ 
6476 # │3 │T      │Your address appears in the "To:" header field, but you are│
6477 # │ │       │not the only recipient of the message.                     │
6478 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤ 
6479 # │4 │C      │Your address is specified in the "Cc:" header field, but   │
6480 # │ │       │you are not the only recipient.                            │
6481 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤ 
6482 # │5 │F      │Indicates the mail that was sent by you.                   │
6483 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤ 
6484 # │6 │L      │Indicates the mail was sent to a mailing-list you subscribe│
6485 # │ │       │to.                                                        │
6486 # ├─────────┼───────┼───────────────────────────────────────────────────────────┤ 
6487 # │7 │R      │Your address appears in the "Reply-To:" header field but   │
6488 # │ │       │none of the above applies.                                 │
6489 # └─────────┴───────┴───────────────────────────────────────────────────────────┘ 
6490
6491
6492
6493 # 3.431. toggle_quoted_show_levels
6494
6495 # Type: number
6496 # Default: 0
6497
6498 # Quoted text may be filtered out using the <toggle-quoted> command. If set to a
6499 # number greater than 0, then the <toggle-quoted> command will only filter out
6500 # quote levels above this number.
6501
6502
6503
6504 # 3.432. trash
6505
6506 # Type: mailbox
6507 # Default: (empty)
6508
6509 # If set, this variable specifies the path of the trash folder where the mails
6510 # marked for deletion will be moved, instead of being irremediably purged.
6511
6512 # NOTE: When you delete a message in the trash folder, it is really deleted, so
6513 # that you have a way to clean the trash.
6514
6515
6516
6517 # 3.433. ts_enabled
6518
6519 # Type: boolean
6520 # Default: no
6521
6522 # Controls whether NeoMutt tries to set the terminal status line and icon name.
6523 # Most terminal emulators emulate the status line in the window title.
6524
6525 set ts_enabled=yes
6526
6527
6528 # 3.434. ts_icon_format
6529
6530 # Type: string
6531 # Default: “M%?n?AIL&ail?”
6532
6533 # Controls the format of the icon title, as long as "$ts_enabled" is set. This
6534 # string is identical in formatting to the one used by "$status_format".
6535
6536
6537
6538 # 3.435. ts_status_format
6539
6540 # Type: string
6541 # Default: “NeoMutt with %?m?%m messages&no messages?%?n? [%n NEW]?”
6542
6543 # Controls the format of the terminal status line (or window title), provided
6544 # that "$ts_enabled" has been set. This string is identical in formatting to the
6545 # one used by "$status_format".
6546
6547 set ts_status_format="[`tty|sed -re 's,.+pts/,,'`]mutt@%h%r %f%?V?[%V]&?"
6548
6549
6550 # 3.436. tunnel
6551
6552 # Type: command
6553 # Default: (empty)
6554
6555 # Setting this variable will cause NeoMutt to open a pipe to a command instead of
6556 # a raw socket. You may be able to use this to set up preauthenticated
6557 # connections to your IMAP/POP3/SMTP server. Example:
6558
6559 # set tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
6560
6561 # Note: For this example to work you must be able to log in to the remote machine
6562 # without having to enter a password.
6563
6564 # When set, NeoMutt uses the tunnel for all remote connections. Please see "
6565 # account-hook" in the manual for how to use different tunnel commands per
6566 # connection. 
6567
6568
6569
6570 # 3.437. tunnel_is_secure
6571
6572 # Type: boolean
6573 # Default: yes
6574
6575 # When set, NeoMutt will assume the $tunnel connection does not need STARTTLS to
6576 # be enabled. It will also allow IMAP PREAUTH server responses inside a tunnel to
6577 # proceed. This is appropriate if $tunnel uses ssh or directly invokes the server
6578 # locally. 
6579
6580 # When unset, NeoMutt will negotiate STARTTLS according to the ssl_starttls and
6581 # ssl_force_tls variables. If ssl_force_tls is set, NeoMutt will abort connecting
6582 # if an IMAP server responds with PREAUTH. This setting is appropriate if $tunnel
6583 # does not provide security and could be tampered with by attackers.
6584
6585
6586
6587 # 3.438. uncollapse_jump
6588
6589 # Type: boolean
6590 # Default: no
6591
6592 # When set, NeoMutt will jump to the next unread message, if any, when the
6593 # current thread is uncollapsed.
6594
6595
6596
6597 # 3.439. uncollapse_new
6598
6599 # Type: boolean
6600 # Default: yes
6601
6602 # When set, NeoMutt will automatically uncollapse any collapsed thread that
6603 # receives a new message. When unset, collapsed threads will remain collapsed.
6604 # the presence of the new message will still affect index sorting, though.
6605
6606
6607
6608 # 3.440. use_8bit_mime
6609
6610 # Type: boolean
6611 # Default: no
6612
6613 # Warning: do not set this variable unless you are using a version of sendmail
6614 # which supports the -B8BITMIME flag (such as sendmail 8.8.x) or you may not be
6615 # able to send mail.
6616
6617 # When set, NeoMutt will invoke $sendmail with the -B8BITMIME flag when sending
6618 # 8-bit messages to enable ESMTP negotiation.
6619
6620
6621
6622 # 3.441. use_domain
6623
6624 # Type: boolean
6625 # Default: yes
6626
6627 # When set, NeoMutt will qualify all local addresses (ones without the "@host"
6628 # portion) with the value of $hostname. If unset, no addresses will be qualified.
6629
6630
6631
6632 # 3.442. use_envelope_from
6633
6634 # Type: boolean
6635 # Default: no
6636
6637 # When set, NeoMutt will set the envelope sender of the message. If
6638 # $envelope_from_address is set, it will be used as the sender address. If unset,
6639 # NeoMutt will attempt to derive the sender from the "From:" header.
6640
6641 # Note that this information is passed to sendmail command using the -f command
6642 # line switch. Therefore setting this option is not useful if the $sendmail
6643 # variable already contains -f or if the executable pointed to by $sendmail
6644 # doesn't support the -f switch.
6645
6646 set use_envelope_from=yes
6647
6648
6649 # 3.443. use_from
6650
6651 # Type: boolean
6652 # Default: yes
6653
6654 # When set, NeoMutt will generate the "From:" header field when sending messages.
6655 # If unset, no "From:" header field will be generated unless the user explicitly
6656 # sets one using the "my_hdr" command.
6657
6658
6659
6660 # 3.444. use_ipv6
6661
6662 # Type: boolean
6663 # Default: yes
6664
6665 # When set, NeoMutt will look for IPv6 addresses of hosts it tries to contact. If
6666 # this option is unset, NeoMutt will restrict itself to IPv4 addresses. Normally,
6667 # the default should work.
6668
6669
6670
6671 # 3.445. use_threads
6672
6673 # Type: enumeration
6674 # Default: unset
6675
6676 # The style of threading used in the index. May be one of "flat" (no threading),
6677 # "threads" (threaded, with subthreads below root message) or "reverse"
6678 # (threaded, with subthreads above root message). For convenience, the value
6679 # "yes" is a synonym for "threads", and "no" is a synonym for "flat".
6680
6681 # If this variable is never set, then $sort controls whether threading is used,
6682 # $sort_aux controls both the sorting of threads and subthreads, and using
6683 # <sort-mailbox> to select threads affects only $sort. Once this variable is set,
6684 # attempting to set $sort to a value using "threads" will warn, the value of
6685 # $sort controls the sorting between threads while $sort_aux controls sorting
6686 # within a thread, and <sort-mailbox> toggles $use_threads.
6687
6688 # Example: 
6689
6690 # set use_threads=yes
6691
6692 # See the "Use Threads Feature" section for further explanation and examples.
6693
6694
6695
6696 # 3.446. user_agent
6697
6698 # Type: boolean
6699 # Default: no
6700
6701 # When set, NeoMutt will add a "User-Agent:" header to outgoing messages,
6702 # indicating which version of NeoMutt was used for composing them.
6703
6704
6705
6706 # 3.447. vfolder_format
6707
6708 # Type: string
6709 # Default: “%2C %?n?%4n/&     ?%4m %f”
6710
6711 # This variable allows you to customize the file browser display for virtual
6712 # folders to your personal taste. This string uses many of the same expandos as
6713 # $folder_format. 
6714
6715
6716
6717 # 3.448. virtual_spool_file
6718
6719 # Type: boolean
6720 # Default: no
6721
6722 # When set, NeoMutt will use the first defined virtual mailbox (see
6723 # virtual-mailboxes) as a spool file.
6724
6725 # This command is now unnecessary. $spool_file has been extended to support
6726 # mailbox descriptions as a value.
6727
6728
6729
6730 # 3.449. wait_key
6731
6732 # Type: boolean
6733 # Default: yes
6734
6735 # Controls whether NeoMutt will ask you to press a key after an external command
6736 # has been invoked by these functions: <shell-escape>, <pipe-message>,
6737 # <pipe-entry>, <print-message>, and <print-entry> commands.
6738
6739 # It is also used when viewing attachments with "auto_view", provided that the
6740 # corresponding mailcap entry has a needsterminal flag, and the external program
6741 # is interactive.
6742
6743 # When set, NeoMutt will always ask for a key. When unset, NeoMutt will wait for
6744 # a key only if the external command returned a non-zero status.
6745
6746 set wait_key=no
6747
6748
6749 # 3.450. weed
6750
6751 # Type: boolean
6752 # Default: yes
6753
6754 # When set, NeoMutt will weed headers when displaying, forwarding, or replying to
6755 # messages. 
6756
6757 # Also see $copy_decode_weed, $pipe_decode_weed, $print_decode_weed.
6758
6759
6760
6761 # 3.451. wrap
6762
6763 # Type: number
6764 # Default: 0
6765
6766 # When set to a positive value, NeoMutt will wrap text at $wrap characters. When
6767 # set to a negative value, NeoMutt will wrap text so that there are $wrap
6768 # characters of empty space on the right side of the terminal. Setting it to zero
6769 # makes NeoMutt wrap at the terminal width.
6770
6771 # Also see $reflow_wrap.
6772
6773 set wrap=$reflow_wrap
6774
6775
6776 # 3.452. wrap_headers
6777
6778 # Type: number
6779 # Default: 78
6780
6781 # This option specifies the number of characters to use for wrapping an outgoing
6782 # message's headers. Allowed values are between 78 and 998 inclusive.
6783
6784 # Note: This option usually shouldn't be changed. RFC5233 recommends a line
6785 # length of 78 (the default), so please only change this setting when you know
6786 # what you're doing.
6787
6788
6789
6790 # 3.453. wrap_search
6791
6792 # Type: boolean
6793 # Default: yes
6794
6795 # Controls whether searches wrap around the end.
6796
6797 # When set, searches will wrap around the first (or last) item. When unset,
6798 # incremental searches will not wrap.
6799
6800
6801
6802 # 3.454. write_bcc
6803
6804 # Type: boolean
6805 # Default: no
6806
6807 # Controls whether NeoMutt writes out the "Bcc:" header when preparing messages
6808 # to be sent. Some MTAs, such as Exim and Courier, do not strip the "Bcc:"
6809 # header; so it is advisable to leave this unset unless you have a particular
6810 # need for the header to be in the sent message.
6811
6812 # If NeoMutt is set to deliver directly via SMTP(see $smtp_url), this option does
6813 # nothing: NeoMutt will never write out the "Bcc:" header in this case.
6814
6815 # Note this option only affects the sending of messages. Fcc'ed copies of a
6816 # message will always contain the "Bcc:" header if one exists.
6817
6818 # Note: On Debian systems, exim4 and postfix strip BCC headers by default. The
6819 # above warning applies to exim3 users, see /etc/Muttrc.
6820
6821
6822
6823 # 3.455. write_inc
6824
6825 # Type: number
6826 # Default: 10
6827
6828 # When writing a mailbox, a message will be printed every $write_inc messages to
6829 # indicate progress. If set to 0, only a single message will be displayed before
6830 # writing a mailbox.
6831
6832 # Also see the $read_inc, $net_inc and $time_inc variables and the "tuning"
6833 # section of the manual for performance considerations.
6834
6835
6836
6837 # 3.456. x_comment_to
6838
6839 # Type: boolean
6840 # Default: no
6841
6842 # If set, NeoMutt will add "X-Comment-To:" field (that contains full name of
6843 # original article author) to article that followuped to newsgroup.
6844
6845
6846 # vim:sw=12:noet:sts=12:ts=12:ft=muttrc