NeoMutt assumes that an empty file is not compressed. In this situation, unset - $save_empty, so that the compressed file will be removed if you delete all of the messages.
+ $save_empty, so that the compressed file will be removed if you delete all of the messages.Encrypted files are decrypted into temporary files which are stored in the - $tmp_dir directory. This could be a security risk.
+ $tmp_dir directory. This could be a security risk.- $mbox_type + $mbox_type
The “Conditional Dates” feature allows you to construct - $index_format expressions based on the age of the email.
+ $index_format expressions based on the age of the email.NeoMutt's default
$index_format displays email dates in the form: abbreviated-month day-of-month –
“Jan 14”.
Once you encrypt an email to someone you cannot read it. This is good for security, but bad for record-keeping. If you wanted to keep a copy of an encrypted email you could set - $fcc_clear.
+ $fcc_clear.A better option is to enable - $smime_self_encrypt, then set - $smime_default_key to your personal S/MIME key id.
+ $smime_self_encrypt, then set + $smime_default_key to your personal S/MIME key id.set smime_self_encrypt = yes set smime_default_key = bb345e23.0
Or, if you use PGP, - $pgp_self_encrypt, then set - $pgp_default_key to your personal PGP key id.
+ $pgp_self_encrypt, then set + $pgp_default_key to your personal PGP key id.set pgp_self_encrypt = yes set pgp_default_key = A4AF18C5582473BD35A1E9CE78BB3D480042198E
If you have different key for signing, then you can set - $pgp_sign_as or - $smime_sign_as respectively.
+ $pgp_sign_as or + $smime_sign_as respectively.The “fmemopen” feature speeds up some searches.
This feature changes a few places where NeoMutt creates temporary files. It replaces them with in-memory buffers. This should improve the performance when searching the header or body using the - $thorough_search option.
+ $thorough_search option.There are no user-configurable parts.
This feature depends on
open_memstream() and
diff --git a/_feature/forgotten-attachment.html b/_feature/forgotten-attachment.html
index 855cd11..1018976 100644
--- a/_feature/forgotten-attachment.html
+++ b/_feature/forgotten-attachment.html
@@ -48,7 +48,7 @@
The “forgotten-attachment” feature provides a new setting for NeoMutt that alerts the user if the message body contains a certain keyword but there are no attachments added. This is meant to ensure that the user does not forget to attach a file after promising to do so in the mail. The attachment keyword will not be scanned in text matched by - $quote_regex.
+ $quote_regex.The “initials” feature adds an expando (%I) for an author's initials.
The index panel displays a list of emails. Its layout is controlled by the - $index_format variable. Using this expando saves space in the index panel. This can be useful if you are regularly working with a small set of people.
+ $index_format variable. Using this expando saves space in the index panel. This can be useful if you are regularly working with a small set of people.This feature has no config of its own. It adds an expando which can be used in the - $index_format variable.
+ $index_format variable.This feature enables the new_mail_command setting, which can be used to execute a custom script (e.g. a notification handler) upon receiving a new mail.
The command string can contain expandos, such as
%n for the number of new messages. For a complete list, see:
- $status_format.
When the notification is sent, the folder of the new mail is no longer known. This is a limitation of NeoMutt. The `%f` expando will show the open folder.
diff --git a/_feature/nntp.html b/_feature/nntp.html index d76cd73..3a76c91 100644 --- a/_feature/nntp.html +++ b/_feature/nntp.html @@ -51,17 +51,17 @@The default news server can be obtained from the
$NNTPSERVER environment variable or from the
/etc/nntpserver file. Like in other news readers, information about the subscribed newsgroups is saved in the file specified by the
- $newsrc variable. You can open a newsgroup with the function
+ $newsrc variable. You can open a newsgroup with the function
<change-newsgroup>
When browsing the list of newsgroups on the server the function
<subscribe> can be used to tell NeoMutt the groups of interest to you. This list is stored in the
- $newsrc file, so NeoMutt remembers it across invocations (see also
- $save_unsubscribed). With the
+ $newsrc file, so NeoMutt remembers it across invocations (see also
+ $save_unsubscribed). With the
<unsubscribe> function a group can be deleted from that list. You can also specify the list of interesting groups with the
mailboxes command in your config file.
When checking for new messages, NeoMutt only polls the subscribed newsgroups.
The variable - $news_cache_dir can be used to point to a directory. NeoMutt will create a hierarchy of subdirectories named like the account and newsgroup the cache is for. The hierarchy is also used to store header cache if NeoMutt was compiled with + $news_cache_dir can be used to point to a directory. NeoMutt will create a hierarchy of subdirectories named like the account and newsgroup the cache is for. The hierarchy is also used to store header cache if NeoMutt was compiled with header cache support.
no
The “Pager Read Delay” feature adds one new config variable, - $pager_read_delay, which is an integer for how many seconds the pager must remain on a given message before marking it as read. The variable defaults to 0 for the original behavior of marking a message as read the moment the pager visits it.
+ $pager_read_delay, which is an integer for how many seconds the pager must remain on a given message before marking it as read. The variable defaults to 0 for the original behavior of marking a message as read the moment the pager visits it.When - $pager_index_lines is non-zero, the + $pager_index_lines is non-zero, the “N” status indicator from the “%Z” expando of - $index_format does not actively reflect the current new/read status of the message.
+ $index_format does not actively reflect the current new/read status of the message.This command specifies mailboxes that will always be displayed in the sidebar, even if - $sidebar_new_mail_only is set and the mailbox does not contain new mail.
+ $sidebar_new_mail_only is set and the mailbox does not contain new mail.The “sidebar_unpin” command is used to remove a mailbox from the list of always displayed mailboxes. Use “sidebar_unpin *” to remove all mailboxes.
diff --git a/_feature/trash.html b/_feature/trash.html index 3966b62..fcef994 100644 --- a/_feature/trash.html +++ b/_feature/trash.html @@ -65,7 +65,7 @@The
$trash path can be either a full directory, or be relative to the
- $folder variable, like the
+ $folder variable, like the
mailboxes command.
The
“Use Threads” feature adds one new config variable,
- $use_threads, which is an enumeration of possible thread views. The variable defaults to unset for the original behavior of overloading
- $sort=threads to enable sorting. It can be set to
+ $use_threads, which is an enumeration of possible thread views. The variable defaults to unset for the original behavior of overloading
+ $sort=threads to enable sorting. It can be set to
flat (or
no ) for an unthreaded view based on
$sort, to
@@ -85,7 +85,7 @@
yes ) for a threaded view where roots appear above children, or to
reverse for a threaded view where children appear above roots.
When sorting by threads, the value of
- $sort determines which thread floats to the top. If
+ $sort determines which thread floats to the top. If
$sort does not contain
reverse-, the latest thread goes to the bottom for
use_threads=threads and to the top for
@@ -97,12 +97,12 @@
last- prefix is ignored when
use_threads=flat.
Within a single thread, the value of
- $sort_aux determines how siblings are sorted. The same prefixes apply as for
+ $sort_aux determines how siblings are sorted. The same prefixes apply as for
$sort, although it is less common to use the
last- prefix.
The
“Use Threads” feature also modifies the existing config variable
- $status_format, adding the
+ $status_format, adding the
%T expando which shows the current threading method.
Table 41.1. Use Threads
diff --git a/guide/advancedusage.html b/guide/advancedusage.html index 31c3e69..3e36ad8 100644 --- a/guide/advancedusage.html +++ b/guide/advancedusage.html @@ -652,7 +652,7 @@The first type is by checking whether the query string equals a keyword case-insensitively from
Table 4.9, “Simple search keywords”: If that is the case, NeoMutt will use the shown pattern modifier instead. If a keyword would conflict with your search keyword, you need to turn it into a regular expression to avoid matching the keyword table. For example, if you want to find all messages matching
“flag”(using
- $simple_search) but don't want to match flagged messages, simply search for
+ $simple_search) but don't want to match flagged messages, simply search for
“
[f]lag
”.
The second type of simple search is to build a complex search pattern using - $simple_search as a template. NeoMutt will insert your query properly quoted and search for the composed complex query.
+ $simple_search as a template. NeoMutt will insert your query properly quoted and search for the composed complex query.%[...] format, these are
not
@@ -1844,7 +1844,7 @@ (Message marking is really just a shortcut for defining a macro that returns you to the current message by searching for its Message-ID. You can choose a different prefix by setting the - $mark_macro_prefix variable.)
+ $mark_macro_prefix variable.)In
Example 4.7, “Specifying a
“default” hook”, by default the value of
- $from and
- $real_name is not overridden. When sending messages either To: or Cc: to
+ $from and
+ $real_name is not overridden. When sending messages either To: or Cc: to
<b@b.b>, the From: header is changed to
<c@c.c>.
NeoMutt supports connecting to external directory databases such as LDAP, ph/qi, bbdb, or NIS through a wrapper script which connects to NeoMutt using a simple interface. Using the - $query_command variable, you specify the wrapper command to use. For example:
+ $query_command variable, you specify the wrapper command to use. For example:set query_command = "mutt_ldap_query.pl %s"@@ -2261,8 +2261,8 @@
The query menu is affected by - $sort_alias, thus overruling the order of entries as generated by - $query_command.
+ $sort_alias, thus overruling the order of entries as generated by + $query_command.NeoMutt supports reading and writing of four different local mailbox formats: mbox, MMDF, MH and Maildir. The mailbox type is auto detected, so there is no need to use a flag for different mailbox types. When creating new mailboxes, NeoMutt uses the default specified with the - $mbox_type variable. A short description of the formats follows.
+ $mbox_type variable. A short description of the formats follows.
mbox
@@ -2357,21 +2357,21 @@
!
your
- $spool_file(incoming) mailbox
+ $spool_file(incoming) mailbox
>
<
= or
+folder-hook . 'set record=^'@@ -2426,7 +2426,7 @@
^
”, has no value in some cases. No mailbox is opened when NeoMutt is invoked to send an email from the command-line. In interactive mode, NeoMutt reads the muttrc before opening the mailbox, so immediate expansion won't work as expected either. This can be an issue when trying to directly assign to
- $record, but also affects the
+ $record, but also affects the
fcc-hook mailbox, which is expanded immediately too. The folder-hook example above works because the command is executed later, when the folder-hook fires.
Mail-Followup-To, see below).
NeoMutt also supports the
Mail-Followup-To header. When you send a message to a list of recipients which includes one or several known mailing lists, and if the
- $followup_to option is set, NeoMutt will generate a Mail-Followup-To header. If any of the recipients are subscribed mailing lists, this header will contain all the recipients to whom you send this message, but not your address. This indicates that group-replies or list-replies (also known as
+ $followup_to option is set, NeoMutt will generate a Mail-Followup-To header. If any of the recipients are subscribed mailing lists, this header will contain all the recipients to whom you send this message, but not your address. This indicates that group-replies or list-replies (also known as
“followups”) to this message should only be sent to the original recipients of the message, and not separately to you - you'll receive your copy through one of the mailing lists you are subscribed to. If none of the recipients are subscribed mailing lists, the header will also contain your address, ensuring you receive a copy of replies.
Conversely, when group-replying or list-replying to a message which has a
Mail-Followup-To header, NeoMutt will respect this header if the
- $honor_followup_to configuration variable is set. Using
+ $honor_followup_to configuration variable is set. Using
list-reply will in this case also make sure that the reply goes to the mailing list, even if it's not specified in the list of recipients in the
Mail-Followup-To.
The other method some mailing list admins use is to generate a “Reply-To” field which points back to the mailing list address rather than the author of the message. This can create problems when trying to reply directly to the author in private, since most mail clients will automatically reply to the address given in the “Reply-To” field. NeoMutt uses the - $reply_to variable to help decide which address to use. If set to + $reply_to variable to help decide which address to use. If set to ask-yes or @@ -2510,7 +2510,7 @@
Lastly, NeoMutt has the ability to - sort the mailbox into + sort the mailbox into threads. A thread is a group of messages which all relate to the same subject. This is usually organized into a tree-like structure where a message and all of its replies are represented graphically. If you've ever used a threaded news client, this is the same concept. It makes dealing with large volume mailing lists easier because you can easily delete uninteresting threads and quickly find topics of value.
New mail for Maildir is assumed if there is one message in the
new/ subdirectory which is not marked deleted (see
- $maildir_trash). For MH folders, a mailbox is considered having new mail if there's at least one message in the
+ $maildir_trash). For MH folders, a mailbox is considered having new mail if there's at least one message in the
“unseen” sequence as specified by
- $mh_seq_unseen. Optionally,
- $new_mail_command can be configured to execute an external program every time new mail is detected in the current inbox.
NeoMutt does not poll POP3 folders for new mail, it only periodically checks the currently opened folder (if it's a POP3 folder).
For IMAP, by default NeoMutt uses recent message counts provided by the server to detect new mail. If the - $imap_idle option is set, it'll use the IMAP IDLE extension if advertised by the server.
+ $imap_idle option is set, it'll use the IMAP IDLE extension if advertised by the server.The - $mail_check_recent option changes whether NeoMutt will notify you of new mail in an already visited mailbox. When set (the default) it will only notify you of new mail received since the last time you opened the mailbox. When unset, NeoMutt will notify you of any new mail in the mailbox.
+ $mail_check_recent option changes whether NeoMutt will notify you of new mail in an already visited mailbox. When set (the default) it will only notify you of new mail received since the last time you opened the mailbox. When unset, NeoMutt will notify you of any new mail in the mailbox.When in the index menu and being idle (also see
- $timeout), NeoMutt periodically checks for new mail in all folders which have been configured via the
+ $timeout), NeoMutt periodically checks for new mail in all folders which have been configured via the
mailboxes
command (excepting those specified with the
-nopoll flag). The interval depends on the folder type: for local/IMAP folders it consults
- $mail_check and
- $pop_check_interval for POP folders.
Outside the index menu the directory browser supports checking for new mail using the
<check-new> function which is unbound by default. Pressing TAB will bring up a menu showing the files specified by the
@@ -2644,7 +2644,7 @@
<mailbox-list> function (bound to
“.” by default) which will print a list of folders with new mail in the command line at the bottom of the screen.
For the index, by default NeoMutt displays the number of mailboxes with new mail in the status bar, please refer to the - $status_format variable for details.
+ $status_format variable for details.When changing folders, NeoMutt fills the prompt with the first folder from the mailboxes list containing new mail (if any), pressing
<Space> will cycle through folders with new mail. The (by default unbound) function
<next-unread-mailbox> in the index can be used to immediately open the next folder with unread mail (if any).
If - $mail_check_stats is set, NeoMutt will periodically calculate the unread, flagged, and total message counts for each mailbox watched by the + $mail_check_stats is set, NeoMutt will periodically calculate the unread, flagged, and total message counts for each mailbox watched by the mailboxes command. (Note: IMAP mailboxes only support unread and total counts). This calculation takes place at the same time as new mail polling, but is controlled by a separate timer: - $mail_check_stats_interval.
+ $mail_check_stats_interval.The sidebar can display these message counts. See - $sidebar_format.
+ $sidebar_format.RFC1894 defines a set of MIME content types for relaying information about the status of electronic mail messages. These can be thought of as “return receipts.”
To support DSN, there are two variables. - $dsn_notify is used to request receipts for different results (such as failed message, message delivered, etc.). - $dsn_return requests how much of your message should be returned with the receipt (headers or full message).
+ $dsn_notify is used to request receipts for different results (such as failed message, message delivered, etc.). + $dsn_return requests how much of your message should be returned with the receipt (headers or full message).When using - $sendmail for mail delivery, you need to use either Berkeley sendmail 8.8.x (or greater) a MTA supporting DSN command line options compatible to Sendmail: The -N and -R options can be used by the mail client to make requests as to what type of status messages should be returned. Please consider your MTA documentation whether DSN is supported.
+ $sendmail for mail delivery, you need to use either Berkeley sendmail 8.8.x (or greater) a MTA supporting DSN command line options compatible to Sendmail: The -N and -R options can be used by the mail client to make requests as to what type of status messages should be returned. Please consider your MTA documentation whether DSN is supported.For SMTP delivery using - $smtp_url, it depends on the capabilities announced by the server whether NeoMutt will attempt to request DSN or not.
+ $smtp_url, it depends on the capabilities announced by the server whether NeoMutt will attempt to request DSN or not.You can print messages to the message window using the "echo" command. This might be useful after a macro finishes executing. After printing the message, echo will pause for the number of seconds specified by - $sleep_time.
+ $sleep_time.echo "Sourcing muttrc file" unset confirm_append @@ -2823,7 +2823,7 @@
Reply envelope settings. - $reverse_name processing. To, Cc, Subject, References header defaults.
+ $reverse_name processing. To, Cc, Subject, References header defaults.@@ -2833,7 +2833,7 @@
Prompts for To, Cc, Bcc, Subject headers. See $ask_cc, $ask_bcc, - $fast_reply.
+ $fast_reply.From header setting. Note: this is so @@ -2866,11 +2866,11 @@
- $real_name part of From header setting.
+ $real_name part of From header setting.- $editor invocation for the message.
+ $editor invocation for the message.@@ -2894,14 +2894,14 @@
Fcc saving if - $fcc_before_send is set. (Note the variable documentation for caveats of Fcc'ing before sending.)
+ $fcc_before_send is set. (Note the variable documentation for caveats of Fcc'ing before sending.)Message sending.
Fcc saving if - $fcc_before_send is unset (the default). The Fcc used to be saved before sending the message. It is now by default saved afterwards, but if the saving fails, the user is prompted.
+ $fcc_before_send is unset (the default). The Fcc used to be saved before sending the message. It is now by default saved afterwards, but if the saving fails, the user is prompted.
The folder NeoMutt opens at startup is determined as follows: the folder specified in the
$MAIL environment variable if present. Otherwise, the value of
$MAILDIR is taken into account. If that isn't present either, NeoMutt takes the user's mailbox in the mailspool as determined at compile-time (which may also reside in the home directory). The
- $spool_file setting overrides this selection. Highest priority has the mailbox given with the
+ $spool_file setting overrides this selection. Highest priority has the mailbox given with the
-f command line option.
It is highly recommended that NeoMutt be configured with
--idn2 (enabled by default) so that Autocrypt can properly deal with international domain names.
While NeoMutt uses GPGME for Autocrypt, normal keyring operations can still be performed via classic mode (i.e. with
- $crypt_use_gpgme unset). However, to avoid unnecessary prompts, it is recommended gpg not be configured in
+ $crypt_use_gpgme unset). However, to avoid unnecessary prompts, it is recommended gpg not be configured in
loopback pinentry mode, and that
- $pgp_use_gpg_agent remain set (the default).
After optionally creating an account, NeoMutt will prompt you to scan mailboxes for Autocrypt headers. This step occurs because header cached messages are not re-scanned for Autocrypt headers. Scanning during this step will temporarily disable the header cache while opening each mailbox. If you wish to do this manually later, you can simulate the same thing by unsetting - $header_cache and opening a mailbox.
+ $header_cache and opening a mailbox.A final technical note: the first run process takes place between reading the muttrc and opening the initial mailbox. Some muttrc files will push macros to be run after opening the mailbox. To prevent this from interfering with the first run prompts, NeoMutt disables all macros during the first run.
When postponing a message, autocrypt will respect - $postpone_encrypt, but will use the autocrypt account key to encrypt the message. Be sure to set - $postpone_encrypt to ensure postponed messages marked for autocrypt encryption are encrypted.
+ $postpone_encrypt, but will use the autocrypt account key to encrypt the message. Be sure to set + $postpone_encrypt to ensure postponed messages marked for autocrypt encryption are encrypted.The Autocrypt Account Menu is available from the index via
<autocrypt-acct-menu>, by default bound to
A. See
- Autocrypt Account Menu for the list of functions and their default keybindings.
In this menu, you can create new accounts, delete accounts, toggle an account active/inactive, and toggle the “prefer encryption” flag for an account.
Deleting an account only removes the account from the database. The GPG key is kept, to ensure you still have the ability to read past encrypted emails.
diff --git a/guide/configuration.html b/guide/configuration.html index 3424876..c00724e 100644 --- a/guide/configuration.html +++ b/guide/configuration.html @@ -199,13 +199,13 @@~/.neomuttrc
The last file that gets read will overwrite any settings from previous config files. This means that an administrator can set some defaults which the user can override.
Additionally, there are a handful of config items which can be set using an environment variable. They have a lower priority than the NeoMutt config files: - $editor, - $from, - $mailcap_path, - $news_server, - shell, - $spool_file, - $tmp_dir,
+ $editor, + $from, + $mailcap_path, + $news_server, + shell, + $spool_file, + $tmp_dir,Finally, it's possible to
set some variables directly on the command-line using the
-e option.
$HOSTNAME is set to
“kremvax.”(See
- $record for details.)
+ $record for details.)
If NeoMutt can't find a matching
config
@@ -695,7 +695,7 @@ Note
Cc:
prompt. You can also enter aliases in your editor at the appropriate headers if you have the
- $edit_headers variable set.
In addition, at the various address prompts, you can use the tab character to expand a partial alias to the full alias. If there are multiple matches, NeoMutt will bring up a menu with the matching aliases. In order to be presented with the full list of aliases, you must hit tab without a partial alias, such as at the beginning of the prompt or after a comma denoting multiple addresses.
In the alias menu, you can select as many aliases as you want with the
tag-entry key (default: <Space> or t), and use the
@@ -864,7 +864,7 @@
The query menu is the browser for results returned by - $query_command.
+ $query_command.<exit>
<help>
+ <exit>
+ If you use the “!” shortcut for - $spool_file at the beginning of + $spool_file at the beginning of regex , you must place it inside of double or single quotes in order to distinguish it from the logical @@ -1582,7 +1596,7 @@
The following example will set the
- sort variable to
+ sort variable to
date-sent for all folders but to
threads for all folders containing
“work” in their name.
The quoted objects refer to quoted lines in an email reply. They are defined using the
-
+
$reply_regex
config variable.
The quoted email colours don't use pattern. The first colour, @@ -2316,7 +2330,7 @@
When
- $header_color_partial is unset (the default), a
+ $header_color_partial is unset (the default), a
When displaying a message in the pager, NeoMutt folds long header lines at
- $wrap columns. Though there're precise rules about where to break and how, NeoMutt always folds headers using a tab for readability. (Note that the sending side is not affected by this, NeoMutt tries to implement standards compliant folding.)header matched by
regex
@@ -2643,7 +2657,7 @@
Despite not being a real header, NeoMutt will also display an mbox "From_" line in the pager along with other headers. This line can be manipulated with
ignore/unignore
@@ -2799,7 +2813,7 @@
... }
With various functions, NeoMutt will treat messages differently, depending on whether you sent them or whether you received them from someone else. For instance, when replying to a message that you sent to a different party, NeoMutt will automatically suggest to send the response to the original message's recipients – responding to yourself won't make much sense in many cases. (See - $reply_to.)
+ $reply_to.)Many users receive e-mail under a number of different addresses. To fully use NeoMutt's features here, the program must be able to recognize what e-mail addresses you receive mail under. That's the purpose of the
alternates
@@ -2929,11 +2943,11 @@
<list-reply>
function will work for all known lists. Additionally, when you send a message to a known list and
- $followup_to is set, NeoMutt will add a Mail-Followup-To header. For unsubscribed lists, this will include your personal address, ensuring you receive a copy of replies. For subscribed mailing lists, the header will not, telling other users' mail user agents not to send copies of replies to your personal address.
The Mail-Followup-To header is a non-standard extension which is not supported by all mail user agents. Adding it is not bullet-proof against receiving personal CCs of list messages. Also note that the generation of the Mail-Followup-To header is controlled by the - $followup_to configuration variable since it's common practice on some mailing lists to send Cc upon replies (which is more a group- than a list-reply).
+ $followup_to configuration variable since it's common practice on some mailing lists to send Cc upon replies (which is more a group- than a list-reply).More precisely, NeoMutt maintains lists of regular expressions for the addresses of known and subscribed mailing lists. Every subscribed mailing list is known. To mark a mailing list as known, use the
@@ -3015,7 +3029,7 @@
mailbox shortcut expansion performed on the first character. See
Mailbox Matching in Hooks for more details.
Note that execution of mbox-hooks is dependent on the - $move configuration variable. If set to + $move configuration variable. If set to “no”(the default), mbox-hooks will not be executed.
Unlike some of the other
@@ -3096,7 +3110,7 @@ NeoMutt provides a number of advanced features for handling (possibly many) folders and new mail within them, please refer to
Chapter 27,
New Mail Featurefor details (including in what situations and how often NeoMutt checks for new mail). Additionally,
- $new_mail_command can be used to run a command when new mail is detected.
The “unmailboxes” command is used to remove a token from the list of folders which receive mail. “unmailboxes” can be used on the mailbox path, @@ -3111,8 +3125,8 @@
For example, if you would like to add an “Organization:” header field to all of your outgoing messages, you can put the command something like shown in Example 3.12, “Defining custom headers” in your @@ -3173,7 +3187,7 @@
If you would like to add a header field to a single message, you should either set the
- $edit_headers variable, or use the
+ $edit_headers variable, or use the
<edit-headers> function (default:
“E”) in the compose menu so that you can edit the header of your message along with the body.
To remove user defined header fields, use the @@ -3244,14 +3258,14 @@
If the pattern is a plain string, or a regex, it will be expanded to a pattern using - $default_hook.
+ $default_hook.fcc-hook is used to save outgoing mail in a mailbox other than - $record. NeoMutt searches the initial list of message recipients for the first matching + $record. NeoMutt searches the initial list of message recipients for the first matching pattern and uses @@ -3259,7 +3273,7 @@
fcc-hook [@.]aol\\.com$ +spammers@@ -3300,7 +3314,7 @@
To provide more flexibility and good defaults, NeoMutt applies the expandos of - $index_format to + $index_format to mailbox after it was expanded. See @@ -3360,7 +3374,7 @@
If the pattern is a plain string, or a regex, it will be expanded to a pattern using - $default_hook.
+ $default_hook.
reply-hook
@@ -3420,7 +3434,7 @@ Note
send-hook
, and can, e.g., be used to set parameters such as the
- $sendmail variable depending on the message's sender address.
For each type of
send-hook
@@ -3440,7 +3454,7 @@ Another typical use for this command is to change the values of the
$attribution_intro,
$attribution_locale, and
- $signature variables in order to change the language of the attributions and signatures based upon the recipients.Note
@@ -3491,7 +3505,7 @@
.neomuttrc.
If the pattern is a plain string, or a regex, it will be expanded to a pattern using - $default_hook.
+ $default_hook.See
Message Matching in Hooks for information on the exact format of
@@ -3559,11 +3573,11 @@
This command is used to inject format strings dynamically into - $index_format based on pattern matching against the current message.
+ $index_format based on pattern matching against the current message.If the pattern is a plain string, or a regex, it will be expanded to a pattern using - $default_hook.
+ $default_hook.The - $index_format expando + $index_format expando %@name@ specifies a placeholder for the injection. Index-format-hooks with the same @@ -3808,7 +3822,7 @@
%H selector in the
- $index_format variable. (Tip: try
+ $index_format variable. (Tip: try
%<H?[%H] > to display spam tags only when they are defined for a given message.)
Note: the value displayed by
%H and searched by
@@ -3841,16 +3855,16 @@
%1 is replaced with the first back-reference in the regex,
%2 with the second, etc.
To match spam tags, NeoMutt needs the corresponding header information which is always the case for local and POP folders but not for IMAP in the default configuration. Depending on the spam header to be analyzed, - $imap_headers may need to be adjusted.
+ $imap_headers may need to be adjusted.If you're using multiple spam filters, a message can have more than one spam-related header. You can define spam rules for each filter you use. If a message matches two or more of these regular expressions, and the - $spam_separator variable is set to a string, then the message's spam tag will consist of all the + $spam_separator variable is set to a string, then the message's spam tag will consist of all the format strings joined together, with the value of - $spam_separator separating them.
+ $spam_separator separating them.For example, suppose one uses DCC, SpamAssassin, and PureMessage, then the configuration might look like in Example 3.15, “Configuring spam detection”.
If the - $spam_separator variable is unset, then each spam rule match supersedes the previous one. Instead of getting joined + $spam_separator variable is unset, then each spam rule match supersedes the previous one. Instead of getting joined format strings, you'll get only the last one to match.
The spam tag is what will be displayed in the index when you use
%H in the
- $index_format variable. It's also the string that the
+ $index_format variable. It's also the string that the
~H pattern-matching expression matches against for
<search> and
<limit> functions. And it's what sorting by spam attribute will use as a sort key.
A custom variable can also be used in macros to backup the current value of another variable. In the following example, the value of the
- $delete is changed temporarily while its original value is saved as
+ $delete is changed temporarily while its original value is saved as
my_delete. After the macro has executed all commands, the original value of
- $delete is restored.
@@ -4357,8 +4371,8 @@
Since NeoMutt expands such values already when parsing the configuration file(s), the value of
$my_delete in the last example would be the value of
- $delete exactly as it was at that point during parsing the configuration file. If another statement would change the value for
- $delete later in the same or another file, it would have no effect on
+ $delete exactly as it was at that point during parsing the configuration file. If another statement would change the value for
+ $delete later in the same or another file, it would have no effect on
$my_delete. However, the expansion can be deferred to runtime, as shown in the next example, when escaping the dollar sign.
Format strings are a general concept you'll find in several locations through the NeoMutt configuration, especially in the - $index_format, - $pager_format, - $status_format, and other related variables. These can be very straightforward, and it's quite possible you already know how to use them.
+ $index_format, + $pager_format, + $status_format, and other related variables. These can be very straightforward, and it's quite possible you already know how to use them.The most basic format string element is a percent symbol followed by another character. For example,
%s represents a message's Subject: header in the
- $index_format variable. The
+ $index_format variable. The
“expandos” available are documented with each format variable, but there are general modifiers available with all formatting expandos, too. Those are our concern here.
Some of the modifiers are borrowed right out of C (though you might know them from Perl, Python, shell, or another language). These are the
[-]m.n modifiers, as in
@@ -4593,7 +4607,7 @@
Here is an example illustrating how to optionally print the number of new messages (
%n ) in a mailbox in
- $status_format:
%<n?%n new messages>@@ -4651,7 +4665,7 @@
A practical example is the
mutt_xtitle script installed in the
samples subdirectory of the NeoMutt documentation: it can be used as filter for
- $status_format to set the current terminal's title, if supported.
%l in
$compose_format,
%s in
- $folder_format,
+ $folder_format,
%c and
%cr in
- $index_format, and %l and %L in
- $status_format. There are four configuration variables that can be used to customize how the numbers are displayed.
+ $index_format, and %l and %L in
+ $status_format. There are four configuration variables that can be used to customize how the numbers are displayed.
- $size_show_bytes will display the number of bytes when the size is < 1 kilobyte. When unset, kilobytes will be displayed instead.
+ $size_show_bytes will display the number of bytes when the size is < 1 kilobyte. When unset, kilobytes will be displayed instead.- $size_show_mb will display the number of megabytes when the size is >= 1 megabyte. When unset, kilobytes will be displayed instead (which could be a large number).
+ $size_show_mb will display the number of megabytes when the size is >= 1 megabyte. When unset, kilobytes will be displayed instead (which could be a large number).- $size_show_fractions, will display numbers with a single decimal place for values from 0 to 10 kilobytes, and 1 to 10 megabytes.
+ $size_show_fractions, will display numbers with a single decimal place for values from 0 to 10 kilobytes, and 1 to 10 megabytes.- $size_units_on_left will display the unit ( + $size_units_on_left will display the unit ( “K” or “M”) to the left of the number, instead of the right if unset.
These variables also affect size display in a few other places, such as progress indicators and attachment delimiters in the pager.
diff --git a/guide/gettingstarted.html b/guide/gettingstarted.html index 644f2d8..c8b5245 100644 --- a/guide/gettingstarted.html +++ b/guide/gettingstarted.html @@ -344,7 +344,7 @@
$sidebar_format allows you to customize the Sidebar display. For an introduction, read
- format strings including the section about
+ format strings including the section about
conditionals.
The default value is:
%D%* %n
NeoMutt maintains a history for the built-in editor. The number of items is controlled by the
- $history variable and can be made persistent using an external file specified using
- $history_file and
- $save_history. You may cycle through them at an editor prompt by using the
+ $history variable and can be made persistent using an external file specified using
+ $history_file and
+ $save_history. You may cycle through them at an editor prompt by using the
<history-up> and/or
<history-down> commands. NeoMutt will remember the currently entered text as you cycle through history, and will wrap around to the initial entry line.
NeoMutt maintains several distinct history lists, one for each of the following categories:
@@ -1365,7 +1365,7 @@NeoMutt automatically filters out consecutively repeated items from the history. If - $history_remove_dups is set, all repeated items are removed from the history. It also mimics the behavior of some shells by ignoring items starting with a space. The latter feature can be useful in macros to not clobber the history's valuable entries with unwanted entries.
+ $history_remove_dups is set, all repeated items are removed from the history. It also mimics the behavior of some shells by ignoring items starting with a space. The latter feature can be useful in macros to not clobber the history's valuable entries with unwanted entries.Common keys used to navigate through and manage messages in the index are shown in Table 2.7, “Most common message index keys”. How messages are presented in the index menu can be customized using the - $index_format variable.
+ $index_format variable.@@ -1541,7 +1541,7 @@
Furthermore, the flags in Table 2.9, “Message recipient flags” reflect who the message is addressed to. They can be customized with the - $to_chars variable.
+ $to_chars variable.By default, NeoMutt uses its built-in pager to display the contents of messages (an external pager such as
less(1) can be configured, see
- $pager variable). The pager is very similar to the Unix program
+ $pager variable). The pager is very similar to the Unix program
less(1) though not nearly as featureful.
<delete-message> or
<copy-message> (this is one advantage over using an external pager to view messages).
Also, the internal pager supports a couple other advanced features. For one, you can set - $pager_read_delay to operate in a preview mode, where new messages are not marked read unless you remain on the message for a certain length of time. Additionally, it will accept and translate the + $pager_read_delay to operate in a preview mode, where new messages are not marked read unless you remain on the message for a certain length of time. Additionally, it will accept and translate the “standard” nroff sequences for bold and underline. These sequences are a series of either the letter, backspace ( “^H”), the letter again for bold or the letter, backspace, “_” for denoting underline. NeoMutt will attempt to display these in bold and underline respectively if your terminal supports them. If not, you can use the bold and underline @@ -1916,7 +1916,7 @@
So-called “threads” provide a hierarchy of messages where replies are linked to their parent message(s). This organizational form is extremely useful in mailing lists where different parts of the discussion diverge. NeoMutt displays threads as a tree structure.
In NeoMutt, when a mailbox is - sorted by + sorted by threads , there are a few additional functions available in the @@ -2054,7 +2054,7 @@
Collapsing a thread displays only the first message in the thread and hides the others. This is useful when threads contain so many messages that you can only see a handful of threads on the screen. See %M in
- $index_format. For example, you could use
+ $index_format. For example, you could use
%<M?(#%03M)&(%4l)> in
- $index_format to optionally display the number of hidden messages if the thread is collapsed. The
+ $index_format to optionally display the number of hidden messages if the thread is collapsed. The
%<char?if-part&else-part> syntax is explained in detail in
format string conditionals.
Technically, every reply should contain a list of its parent messages in the thread tree, but not all do. In these cases, NeoMutt groups them by subject which can be controlled using the - $strict_threads variable.
+ $strict_threads variable.Mail-Followup-To header(s) if the
- $honor_followup_to configuration variable is set. In addition, the
+ $honor_followup_to configuration variable is set. In addition, the
List-Post header field is examined for
mailto: URLs specifying a mailing list address. Using this when replying to messages posted to mailing lists helps avoid duplicate copies being sent to the author of the message you are replying to.
@@ -2315,11 +2315,11 @@ Asks for an external Unix command and pipes the current or tagged message(s) to it. The variables - $pipe_decode, - $pipe_decode_weed, - $pipe_split, - $pipe_sep and - $wait_key control the exact behavior of this function.
+ $pipe_decode, + $pipe_decode_weed, + $pipe_split, + $pipe_sep and + $wait_key control the exact behavior of this function.NeoMutt takes the current message as a template for a new message. This function is best described as "recall from arbitrary folders". It can conveniently be used to forward MIME messages while preserving the original mail structure. Note that the amount of headers included here depends on the value of the - $weed variable.
+ $weed variable.This function is also available from the attachment menu. You can use this to easily resend a message which was included with a bounce message as a
message/rfc822 body part.
Asks for an external Unix command and executes it. The - $wait_key can be used to control whether NeoMutt will wait for a key to be pressed when the command returns (presumably to let the user read the output of the command), based on the return status of the named command. If no command is given, an interactive shell is executed.
+ $wait_key can be used to control whether NeoMutt will wait for a key to be pressed when the command returns (presumably to let the user read the output of the command), based on the return status of the named command. If no command is given, an interactive shell is executed.This function will make the internal pager go forward to the next segment of non-quoted body text (whether the first line of the body after headers, or following a line of quoted text), or print a message if no further unquoted text can be found.
The variable - $pager_skip_quoted_context can be used to show some quoted context prior to the selected line.
+ $pager_skip_quoted_context can be used to show some quoted context prior to the selected line.The pager uses the - $quote_regex variable to detect quoted text when displaying the body of the message. This function toggles the display of the quoted material in the message. It is particularly useful when being interested in just the response and there is a large amount of quoted text in the way.
+ $quote_regex variable to detect quoted text when displaying the body of the message. This function toggles the display of the quoted material in the message. It is particularly useful when being interested in just the response and there is a large amount of quoted text in the way.The variable - $toggle_quoted_show_levels can be used to show some context by continuing to show that number of levels rather than hiding all quoted levels.
+ $toggle_quoted_show_levels can be used to show some context by continuing to show that number of levels rather than hiding all quoted levels.When replying, NeoMutt fills these fields with proper values depending on the reply type. The types of replying supported are:
After getting recipients for new messages, forwards or replies, NeoMutt will then automatically start your - $editor on the message body. If the - $edit_headers variable is set, the headers will be at the top of the message in your editor; the message body should start on a new line after the existing blank line at the end of headers. Any messages you are replying to will be added in sort order to the message, with appropriate + $editor on the message body. If the + $edit_headers variable is set, the headers will be at the top of the message in your editor; the message body should start on a new line after the existing blank line at the end of headers. Any messages you are replying to will be added in sort order to the message, with appropriate $attribution_intro, - $indent_string and + $indent_string and $attribution_trailer. When forwarding a message, if the - $mime_forward variable is unset, a copy of the forwarded message will be included. If you have specified a - $signature, it will be appended to the message.
+ $mime_forward variable is unset, a copy of the forwarded message will be included. If you have specified a + $signature, it will be appended to the message.Once you have finished editing the body of your mail message, you are returned to the
compose
@@ -2761,14 +2761,14 @@ Note that certain operations like composing a new mail, replying, forwarding, etc. are not permitted when you are in that folder. The %r in
- $status_format will change to a
+ $status_format will change to a
“A” to indicate that you are in attach-message mode. After exiting the compose menu via
-
Note
<send-message>, the message will be sent. If configured and enabled, this can happen via
+ <send-message>, the message will be sent. This happens via
$smtp_url. Otherwise
- $sendmail will be invoked. Prior to version 2019-11-29, NeoMutt enabled
- $write_bcc by default, assuming the MTA would automatically remove a
+ $sendmail will be invoked. Prior to version 2019-11-29, NeoMutt enabled
+ $write_bcc by default, assuming the MTA would automatically remove a
Bcc: header as part of delivery. Starting with 2019-11-29, the option is unset by default, but no longer affects the fcc copy of the message.
When editing the header because of - $edit_headers being set, there are a several pseudo headers available which will not be included in sent messages but trigger special NeoMutt behavior.
+ $edit_headers being set, there are a several pseudo headers available which will not be included in sent messages but trigger special NeoMutt behavior.^G. When you do so, NeoMutt will return to the compose screen.
Once you have successfully finished the key selection, the message will be encrypted using the selected public keys when sent out.
To ensure you can view encrypted messages you have sent, you may wish to set - $pgp_self_encrypt and - $pgp_default_key for PGP, or - $smime_self_encrypt and - $smime_default_key for S/MIME.
+ $pgp_self_encrypt and + $pgp_default_key for PGP, or + $smime_self_encrypt and + $smime_default_key for S/MIME.Most fields of the entries in the key selection menu (see also - $pgp_entry_format) have obvious meanings. But some explanations on the capabilities, flags, and validity fields are in order.
+ $pgp_entry_format) have obvious meanings. But some explanations on the capabilities, flags, and validity fields are in order.The flags sequence ( “%f”) will expand to one of the flags in Table 2.17, “PGP key menu flags”.
@@ -3108,7 +3108,7 @@NeoMutt only supports setting the required
format=flowed MIME parameter on outgoing messages if the
- $text_flowed variable is set, specifically it does not add the trailing spaces.
After editing, NeoMutt properly space-stuffs the message.
Space-stuffing
@@ -3172,22 +3172,22 @@
NeoMutt has some support for reformatting when viewing and replying to
format=flowed messages. In order to take advantage of these,
- $reflow_text must be set.
Paragraphs are automatically reflowed and wrapped at a width specified by - $reflow_wrap.
+ $reflow_wrap.In its original format, the quoting style of
format=flowed messages can be difficult to read, and doesn't intermix well with non-flowed replies. Setting
- $reflow_space_quotes adds spaces after each level of quoting when in the pager and replying in a non-flowed format (i.e. with
- $text_flowed unset).
If - $reflow_space_quotes is unset, NeoMutt will still add one trailing space after all the quotes in the pager (but not when replying).
+ $reflow_space_quotes is unset, NeoMutt will still add one trailing space after all the quotes in the pager (but not when replying).Forwarding can be done by including the original message in the new message's body (surrounded by indicating lines: see - $forward_attribution_intro and - $forward_attribution_trailer) or including it as a MIME attachment, depending on the value of the - $mime_forward variable. Decoding of attachments, like in the pager, can be controlled by the - $forward_decode and - $mime_forward_decode variables, respectively. The desired forwarding format may depend on the content, therefore - $mime_forward is a quadoption which, for example, can be set to + $forward_attribution_intro and + $forward_attribution_trailer) or including it as a MIME attachment, depending on the value of the + $mime_forward variable. Decoding of attachments, like in the pager, can be controlled by the + $forward_decode and + $mime_forward_decode variables, respectively. The desired forwarding format may depend on the content, therefore + $mime_forward is a quadoption which, for example, can be set to “ask-no”.
NeoMutt's default ( - $mime_forward= + $mime_forward= “no” and - $forward_decode= + $forward_decode= “yes”) is to use standard inline forwarding. In that mode all text-decodable parts are included in the new message body. Other attachments from the original email can also be attached to the new message, based on the quadoption - $forward_attachments.
+ $forward_attachments.The inclusion of headers is controlled by the current setting of the - $weed variable, unless - $mime_forward is set. The subject of the email is controlled by - $forward_format.
+ $weed variable, unless + $mime_forward is set. The subject of the email is controlled by + $forward_format.By default a forwarded message does not reference the messages it contains. When - $forward_references is set, a forwarded message includes the + $forward_references is set, a forwarded message includes the “In-Reply-To:” and “References:” headers, just like a reply would. Hence the forwarded message becomes part of the original thread instead of starting a new one.
Editing the message to forward follows the same procedure as sending or replying to a message does, but can be disabled via the quadoption - $forward_edit.
+ $forward_edit.Once a message is postponed, there are several ways to resume it. From the command line you can use the
“-p” option, or if you compose a new message from the
@@ -3264,7 +3264,7 @@ If you postpone a reply to a message, the reply setting of the message is only updated when you actually finish the message and send it. Also, you must be in the same folder with the message you replied to for the status of the message to be updated.Note
See also the - $postpone quad-option.
+ $postpone quad-option.The two most important settings are - $pgp_default_key and - $pgp_sign_as. To perform encryption, you must set the first variable. If you have a separate signing key, or only have a signing key, then set the second. Most people will only need to set - $pgp_default_key.
+ $pgp_default_key and + $pgp_sign_as. To perform encryption, you must set the first variable. If you have a separate signing key, or only have a signing key, then set the second. Most people will only need to set + $pgp_default_key.Starting with version 2.1.0, GnuPG automatically uses an
agent to prompt for your passphrase. If you are using a version older than that, you'll need to ensure an agent is running (alternatively, you can unset
- $pgp_use_gpg_agent and NeoMutt will prompt you for your passphrase). The agent in turn uses a
+ $pgp_use_gpg_agent and NeoMutt will prompt you for your passphrase). The agent in turn uses a
pinentry program to display the prompt. There are many different kinds of pinentry programs that can be used: qt, gtk2, gnome3, fltk, and curses. However, NeoMutt does
not
@@ -3375,9 +3375,9 @@
As with OpenPGP, the two most important settings are - $smime_default_key and - $smime_sign_as. To perform encryption and decryption, you must set the first variable. If you have a separate signing key, or only have a signing key, then set the second. Most people will only need to set - $smime_default_key.
+ $smime_default_key and + $smime_sign_as. To perform encryption and decryption, you must set the first variable. If you have a separate signing key, or only have a signing key, then set the second. Most people will only need to set + $smime_default_key.When using GPGME as S/MIME backend, keys and certificates are managed by GnuPG. You can add your key (or certificates) to GnuPG with the command
“
A sample
If NeoMutt can not determine the MIME type by the extension of the file you attach, it will run the command specified in
- $mime_type_query_command. If that command is not specified, NeoMutt will look at the file. If the file is free of binary information, NeoMutt will assume that the file is plain text, and mark it as
+ $mime_type_query_command. If that command is not specified, NeoMutt will look at the file. If the file is free of binary information, NeoMutt will assume that the file is plain text, and mark it as
The interpretation of shell meta-characters embedded in MIME parameters can lead to security problems in general. NeoMutt tries to quote parameters in expansion of
gpgsm --import mykey.p12
@@ -3389,8 +3389,8 @@
smime_keys program that comes with NeoMutt. By default they are stored under
~/.smime/. (This is set by the
smime.rc file with
- $smime_certificates and
- $smime_keys.) To initialize this directory, use the command
+ $smime_certificates and
+ $smime_keys.) To initialize this directory, use the command
“
smime_keys init
” from a shell prompt. The program can be then be used to import and list certificates. You may also want to periodically run
diff --git a/guide/mimesupport.html b/guide/mimesupport.html
index 0332b7c..83b362b 100644
--- a/guide/mimesupport.html
+++ b/guide/mimesupport.html
@@ -259,7 +259,7 @@
mime.types file comes with the NeoMutt distribution, and should contain most of the MIME types you are likely to use.text/plain. If the file contains binary information, then NeoMutt will mark it as
application/octet-stream. You can change the MIME type that NeoMutt assigns to an attachment by using the
<edit-type> command from the compose menu (default: ^T), see
@@ -490,7 +490,7 @@
%s syntaxes properly, and avoids risky characters by substituting them, see the
- $mailcap_sanitize variable.
Although NeoMutt's procedures to invoke programs with mailcap seem to be safe, there are other applications parsing mailcap, maybe taking less care of it. Therefore you should pay attention to the following rules:
@@ -558,11 +558,11 @@
auto_view
, in order to decide whether it should honor the setting of the
- $wait_key variable or not. When an attachment is viewed using an interactive program, and the corresponding mailcap entry has a
+ $wait_key variable or not. When an attachment is viewed using an interactive program, and the corresponding mailcap entry has a
needsterminal
flag, NeoMutt will use
- $wait_key and the exit status of the program to decide if it will ask you to press a key after the external program has exited. In all other situations it will not prompt you for a key.
This flag specifies the command to use to edit a specific MIME type. NeoMutt supports this from the compose menu, and also uses it to compose new attachments. NeoMutt will default to the defined - $editor for text attachments.
+ $editor for text attachments.Using it allows you to control the lifespan of the temporary file. Without this option, the file will be deleted after - $timeout seconds.
+ $timeout seconds.text/html; firefox %s & x-neomutt-keep@@ -638,7 +638,7 @@
x-neomutt-nowrap tells the NeoMutt pager to ignore the
- $wrap parameter and to assume the output from the mailcap command to already be correctly wrapped.
text/html; /usr/local/bin/w3m -s -T text/html -o display_link_number=1 %s; nametemplate=%s.html; copiousoutput; x-neomutt-nowrap;diff --git a/guide/optionalfeatures.html b/guide/optionalfeatures.html index 8875a06..6a4f707 100644 --- a/guide/optionalfeatures.html +++ b/guide/optionalfeatures.html @@ -70,7 +70,7 @@
Since all protocols supported by NeoMutt support/require authentication, login credentials may be specified in the URL. This has the advantage that multiple IMAP, POP3 or SMTP servers may be specified (which isn't possible using, for example,
- $imap_user). The username may contain the
+ $imap_user). The username may contain the
“@” symbol being used by many mail systems as part of the login name. The special characters
“/”(
%2F ),
@@ -136,17 +136,17 @@
STARTTLS can be used to negotiate an encrypted connection after the initial unencrypted connection and exchange.
Two configuration variables control NeoMutt's behavior with
STARTTLS.
- $ssl_starttls will initiate
+ $ssl_starttls will initiate
STARTTLS if the server advertises support for it.
- $ssl_force_tls will always try to initiate it, whether the server advertises support or not.
NeoMutt
highly recommends
setting
- $ssl_force_tls unless you need to connect to an unencrypted server. It's possible for an attacker to spoof interactions during the initial connection and hide support for
+ $ssl_force_tls unless you need to connect to an unencrypted server. It's possible for an attacker to spoof interactions during the initial connection and hide support for
STARTTLS. The only way to prevent these attacks is by forcing
STARTTLS with the
- $ssl_force_tls configuration variable.
When connecting through a - $tunnel and - $tunnel_is_secure is set(the default), NeoMutt will assume the connection to the server through the pipe is already secured. NeoMutt will ignore - $ssl_starttls and - $ssl_force_tls, behaving as if TLS has already been negotiated.
+ $tunnel and + $tunnel_is_secure is set(the default), NeoMutt will assume the connection to the server through the pipe is already secured. NeoMutt will ignore + $ssl_starttls and + $ssl_force_tls, behaving as if TLS has already been negotiated.When
- $tunnel_is_secure is unset, NeoMutt will respect the values of
- $ssl_starttls and
- $ssl_force_tls. It is
+ $tunnel_is_secure is unset, NeoMutt will respect the values of
+ $ssl_starttls and
+ $ssl_force_tls. It is
highly recommended
to set
- $ssl_force_tls in this case, to force
+ $ssl_force_tls in this case, to force
STARTTLS negotiation. Note that doing so will prevent connection to an IMAP server configured for preauthentication(
PREAUTH ). If you use this configuration, it is recommended to use a secure tunnel.
Polling for new mail is more expensive over POP3 than locally. For this reason the frequency at which NeoMutt will check for mail remotely can be controlled by the - $pop_check_interval variable, which defaults to every 60 seconds.
+ $pop_check_interval variable, which defaults to every 60 seconds.Due to limitations in POP3, this method doesn't allow for some features such as editing messages, changing their flags or even deleting them. However, using Section 8.1, “Header Caching” and Section 8.2, “Body Caching”, NeoMutt simulates the new/old/read flags as well as flagged and replied. NeoMutt applies some logic on top of remote messages but cannot change them so that modifications of flags are lost when messages are downloaded from the POP3 server (either by NeoMutt or other tools).
@@ -227,8 +227,8 @@Another way to access your POP3 mail is the
<fetch-mail> function (default: G). It allows to connect to
- $pop_host, fetch all your new mail and place it in the local
- $spool_file. After this point, NeoMutt runs exactly as if the mail had always been local. The
+ $pop_host, fetch all your new mail and place it in the local
+ $spool_file. After this point, NeoMutt runs exactly as if the mail had always been local. The
<fetch-mail> function will ask whether you want to delete the messages on the remote server, leaving only your local copies.
s and
u ) to subscribe to or unsubscribe from a folder while browsing the folders on the IMAP server. The browser can be instructed to only display the folders you are subscribed to with the
<toggle-subscribed> functions. See also the
- $imap_list_subscribed variable.
+ $imap_list_subscribed variable.
Because the list of subscribed folders is managed by the IMAP server, NeoMutt can also ask the server for that list. If - $imap_check_subscribed is set, NeoMutt will do that and add those folders to its mailboxes list just as if you had used the + $imap_check_subscribed is set, NeoMutt will do that and add those folders to its mailboxes list just as if you had used the mailboxes command on each of them, so that these folders get checked periodically for new mail.
Polling for new mail on an IMAP server can cause noticeable delays. So, you'll want to carefully tune the - $mail_check and - $timeout variables. Reasonable values are:
+ $mail_check and + $timeout variables. Reasonable values are:set mail_check=90 set timeout=15 @@ -370,16 +370,16 @@
- $imap_user– controls the username under which you request authentication on the IMAP server, for all authenticators. This is overridden by an explicit username in the mailbox path (i.e. by using a mailbox name of the form + $imap_user– controls the username under which you request authentication on the IMAP server, for all authenticators. This is overridden by an explicit username in the mailbox path (i.e. by using a mailbox name of the form
{user@host}).- $imap_pass– a password which you may preset, used by all authentication methods where a password is needed.
+ $imap_pass– a password which you may preset, used by all authentication methods where a password is needed.- $imap_authenticators– a colon-delimited list of IMAP authentication methods to try, in the order you wish to try them. If specified, this overrides NeoMutt's default (attempt everything, in the order listed above).
+ $imap_authenticators– a colon-delimited list of IMAP authentication methods to try, in the order you wish to try them. If specified, this overrides NeoMutt's default (attempt everything, in the order listed above).
Besides supporting traditional mail delivery through a sendmail-compatible program, NeoMutt supports delivery through SMTP.
If the configuration variable - $smtp_url is set, NeoMutt will contact the given SMTP server to deliver messages; if it is unset, NeoMutt will use the program specified by - $sendmail.
+ $smtp_url is set, NeoMutt will contact the given SMTP server to deliver messages; if it is unset, NeoMutt will use the program specified by + $sendmail.For details on the URL syntax, please see Section 1.2, “URL Syntax”.
The built-in SMTP support supports encryption (the
smtps protocol using SSL or TLS) as well as SMTP authentication using SASL. The authentication mechanisms for SASL are specified in
- $smtp_authenticators defaulting to an empty list which makes NeoMutt try all available methods from most-secure to least-secure.
To manage multiple accounts with, for example, different values of
- $record or sender addresses,
+ $record or sender addresses,
folder-hook
@@ -527,21 +527,21 @@
folder-hook
triggers when one mailbox below each IMAP account is opened and sets
- $folder to the account's root folder. Next, it sets
- $record to the
+ $folder to the account's root folder. Next, it sets
+ $record to the
INBOX/Sent
folder below the newly set
- $folder. Please notice that the value the
+ $folder. Please notice that the value the
“+”
mailbox shortcut refers to depends on the
current
value of
- $folder and therefore has to be set separately per account. Setting other values like
- $from or
- $signature is analogous to setting
- $record.
NeoMutt provides optional support for caching message headers for the following types of folders: IMAP, POP, Maildir and MH. Header caching greatly speeds up opening large folders because for remote folders, headers usually only need to be downloaded once. For Maildir and MH, reading the headers from a single file is much faster than looking at possibly thousands of single files (since Maildir and MH use one file per message.)
Header caching can be enabled by configuring one of the database backends. One of bdb, gdbm, kyotocabinet, lmdb, qdbm, rocksdb, tdb, tokyocabinet.
If enabled, - $header_cache can be used to either point to a file or a directory. If set to point to a file, one database file for all folders will be used (which may result in lower performance), but one file per folder if it points to a directory.
+ $header_cache can be used to either point to a file or a directory. If set to point to a file, one database file for all folders will be used (which may result in lower performance), but one file per folder if it points to a directory.Additionally, - $header_cache_backend can be set to specify which backend to use. The list of available backends can be specified at configure time with a set of --with-<backend> options. Currently, the following backends are supported: bdb, gdbm, kyotocabinet, lmdb, qdbm, rocksdb, tdb, tokyocabinet.
+ $header_cache_backend can be set to specify which backend to use. The list of available backends can be specified at configure time with a set of --with-<backend> options. Currently, the following backends are supported: bdb, gdbm, kyotocabinet, lmdb, qdbm, rocksdb, tdb, tokyocabinet.Take a look at the benchmark script provided in the following repository: contrib-hcache-benchmark. There you can find a way of finding the storage backend for your needs.
Both cache methods can be combined using the same directory for storage (and for IMAP/POP even provide meaningful file names) which simplifies manual maintenance tasks.
In addition to caching message headers only, NeoMutt can also cache whole message bodies. This results in faster display of messages for POP and IMAP folders because messages usually have to be downloaded only once.
For configuration, the variable - $message_cache_dir must point to a directory. There, NeoMutt will create a hierarchy of subdirectories named like the account and mailbox path the cache is for.
+ $message_cache_dir must point to a directory. There, NeoMutt will create a hierarchy of subdirectories named like the account and mailbox path the cache is for.For using both, header and body caching, - $header_cache and - $message_cache_dir can be safely set to the same value.
+ $header_cache and + $message_cache_dir can be safely set to the same value.In a header or body cache directory, NeoMutt creates a directory hierarchy named like:
proto:user@hostname where
proto is either
@@ -625,7 +625,7 @@
NeoMutt does not (yet) support maintenance features for header cache database files so that files have to be removed in case they grow too big. It depends on the database library used for header caching whether disk space freed by removing messages is re-used.
For body caches, NeoMutt can keep the local cache in sync with the remote mailbox if the - $message_cache_clean variable is set. Cleaning means to remove messages from the cache which are no longer present in the mailbox which only happens when other mail clients or instances of NeoMutt using a different body cache location delete messages (NeoMutt itself removes deleted messages from the cache when syncing a mailbox). As cleaning can take a noticeable amount of time, it should not be set in general but only occasionally.
+ $message_cache_clean variable is set. Cleaning means to remove messages from the cache which are no longer present in the mailbox which only happens when other mail clients or instances of NeoMutt using a different body cache location delete messages (NeoMutt itself removes deleted messages from the cache when syncing a mailbox). As cleaning can take a noticeable amount of time, it should not be set in general but only occasionally. diff --git a/guide/reference.html b/guide/reference.html index a6b53e0..de7c8c4 100644 --- a/guide/reference.html +++ b/guide/reference.html @@ -112,8 +112,8 @@file for debugging output (default "
~/.neomuttdebug0 "). This overrules
- $debug_file setting and NeoMutt keeps up to five debug logs ({
+ $debug_file setting and NeoMutt keeps up to five debug logs ({
file |
- $debug_file|
+ $debug_file|
~/.neomuttdebug }[
0-4 ]) before override the oldest fileand give it the same color as your attachment color (see also - $crypt_timestamp).
+ $crypt_timestamp).This variable is a colon-separated list of character encoding schemes for text file attachments. NeoMutt uses this setting to guess which encoding files being attached are encoded in to convert them to a proper character set given in - $send_charset.
+ $send_charset.If
unset
@@ -2192,7 +2192,7 @@
For an explanation of "soft-fill", see the - $index_format documentation.
+ $index_format documentation.This is the string that will precede a replied-to message which is quoted in the main body of the reply (this is the case when - $include is set).
+ $include is set).For a full listing of defined
printf(3)-like sequences see the section on
- $index_format. See also
+ $index_format. See also
$attribution_locale.
Affected variables are: $attribution_intro, $attribution_trailer, - $forward_attribution_intro, - $forward_attribution_trailer, - $indent_string.
+ $forward_attribution_intro, + $forward_attribution_trailer, + $indent_string.Similar to the $attribution_intro variable, this is the string that will come after a replied-to message which is quoted in the main body of the reply (this is the case when - $include is set).
+ $include is set).For a full listing of defined
printf(3)-like sequences see the section on
- $index_format. See also
+ $index_format. See also
$attribution_locale.
Note:
@@ -2379,7 +2379,7 @@
set
, you can't use send-hooks that depend on the recipients when composing a new (non-reply) message, as the initial list of recipients is empty.
Also see - $fast_reply.
+ $fast_reply.The default
"alpha" setting of
- $sort_browser uses locale-based sorting (using
+ $sort_browser uses locale-based sorting (using
strcoll(3) ), which ignores some punctuation. This can lead to some situations where the order doesn't make intuitive sense. In those cases, it may be desirable to
unset
@@ -2778,7 +2778,7 @@
Default: (empty)
Character set your terminal uses to display and enter textual data. It is also the fallback for - $send_charset.
+ $send_charset.Upon startup NeoMutt tries to derive this value from environment variables such as
$LC_CTYPE or
$LANG.
Controls the format of the status line displayed in the "compose" menu. This string is similar to
- $status_format, but has its own set of
+ $status_format, but has its own set of
printf(3)-like sequences:
See the text describing the - $status_format option for more information on how to set + $status_format option for more information on how to set $compose_format.
This variable controls whether or not copies of your outgoing messages will be saved for later references. Also see - $record, - $save_name, - $force_name and " + $record, + $save_name, + $force_name and " fcc-hook".
Setting this variable will cause NeoMutt to always attempt to PGP encrypt outgoing messages. This is probably only useful in connection to the " send-hook" command. It can be overridden by use of the pgp menu, when encryption is not required or signing is requested as well. If - $smime_is_default is + $smime_is_default is set , then OpenSSL is used instead to create S/MIME messages and settings can be overridden by use of the smime menu instead. (Crypto only)
@@ -3222,7 +3222,7 @@Setting this variable will cause NeoMutt to always attempt to cryptographically sign outgoing messages. This can be overridden by use of the pgp menu, when signing is not required or encryption is requested as well. If - $smime_is_default is + $smime_is_default is set , then OpenSSL is used instead to create S/MIME messages and settings can be overridden by use of the smime menu instead of the pgp menu. (Crypto only)
@@ -3265,7 +3265,7 @@Setting this variable will cause NeoMutt to automatically enable and disable encryption, based on whether all message recipient keys can be located by NeoMutt.
When this option is enabled, NeoMutt will enable/disable encryption each time the TO, CC, and BCC lists are edited. If - $edit_headers is set, NeoMutt will also do so each time the message is edited.
+ $edit_headers is set, NeoMutt will also do so each time the message is edited.While this is set, encryption can't be manually enabled/disabled. The pgp or smime menus provide a selection to temporarily disable this option for the current message.
If $crypt_auto_encrypt or @@ -3630,7 +3630,25 @@
Type: boolean
+
Default: yes
If + + set + , NeoMutt will include an informative block before an encrypted part, with details about the encryption. (Crypto only)
+ +Note that the GPGME backend does not support creating old-style inline (traditional) PGP encrypted or signed messages (see - $pgp_auto_inline).
+ $pgp_auto_inline).Instead of using - $date_format it is encouraged to use "%[fmt]" directly in the corresponding format strings, where "fmt" is the value of - $date_format. This allows for a more fine grained control of the different menu needs.
+ $date_format it is encouraged to use "%[fmt]" directly in the corresponding format strings, where "fmt" is the value of + $date_format. This allows for a more fine grained control of the different menu needs.This variable controls the format of the date printed by the "%d" sequence in
- $index_format. This is passed to the
+ $index_format. This is passed to the
strftime(3) function to process the date, see the man page for the proper syntax.
Unless the first character in the string is a bang ("!"), the month and week day names are expanded according to the locale. If the first character in the string is a bang, the bang is discarded, and the month and week day names in the rest of the string are expanded in the
@@ -3774,16 +3792,16 @@
locale (that is in US English).
Format strings using this variable are:
UI: - $folder_format, - $index_format, - $mailbox_folder_format, - $message_format
+ $folder_format, + $index_format, + $mailbox_folder_format, + $message_formatComposing: $attribution_intro, - $forward_attribution_intro, - $forward_attribution_trailer, - $forward_format, - $indent_string.
+ $forward_attribution_intro, + $forward_attribution_trailer, + $forward_format, + $indent_string. @@ -3804,18 +3822,18 @@Debug logging is controlled by the variables
- $debug_file
+ $debug_file
and
- $debug_level
+ $debug_level
.
- $debug_file
+ $debug_file
specifies the root of the filename. NeoMutt will add "0" to the end. Each time NeoMutt is run with logging enabled, the log files are rotated. A maximum of five log files are kept, numbered 0 (most recent) to 4 (oldest).
This option can be enabled on the command line, "neomutt -l mylog"
See also:
- $debug_level
+ $debug_level
Debug logging is controlled by the variables
- $debug_file
+ $debug_file
and
- $debug_level
+ $debug_level
.
The debug level controls how much information is saved to the log file. If you have a problem with NeoMutt, then enabling logging may help find the cause. Levels 1-3 will usually provide enough information for writing a bug report. Levels 4,5 will be extremely verbose.
Warning: Logging at high levels may save private information to the file.
This option can be enabled on the command line, "neomutt -d 2"
See also:
- $debug_file
+ $debug_file
When set, specifies a command used to filter messages. When a message is viewed it is passed as standard input to - $display_filter, and the filtered message is read from the standard output.
+ $display_filter, and the filtered message is read from the standard output.When preparing the message, NeoMutt inserts some escape sequences into the text. They are of the form:
<esc>]9;XXX<bel> where "XXX" is a random 64-bit number.
If these escape sequences interfere with your filter, they can be removed using a tool like @@ -3983,7 +4001,7 @@
sendmail(1)-compatible interface supporting the
-N option for DSN. For SMTP delivery, DSN support is auto-detected so that it depends on the server whether DSN will be used or not.
@@ -4021,7 +4039,7 @@ sendmail(1)-compatible interface supporting the
-R option for DSN. For SMTP delivery, DSN support is auto-detected so that it depends on the server whether DSN will be used or not.
@@ -4053,7 +4071,7 @@ This variable controls whether NeoMutt, when - $sort is set to + $sort is set to threads , threads messages with the same Message-Id together. If it is @@ -4075,20 +4093,20 @@
$EDITOR, environment variable, or to the string "vi" if neither of those are set.
The
- $editor
+ $editor
string may contain a
%s
@@ -4133,7 +4151,7 @@
%s
escape does not appear in
- $editor
+ $editor
, a space and the name to be edited are appended.
The resulting string is then executed by running
@@ -4144,7 +4162,7 @@string is the expansion of
- $editor + $editordescribed above. @@ -4170,7 +4188,7 @@@@ -4188,7 +4206,7 @@
@@ -4203,20 +4221,20 @@
+ $use_envelope_from(2021-03-21)Note
Renamed to - $use_envelope_from(2021-03-21)@@ -4228,7 +4246,7 @@@@ -4250,7 +4268,7 @@envelope sender for outgoing messages. This value is ignored if - $use_envelope_from is + $use_envelope_from is unset . @@ -4238,7 +4256,7 @@
Note
Deprecated, since 2021-03-18 @@ -4260,7 +4278,7 @@
If set, contains the name of the external program used by "~I" patterns. This will usually be a wrapper script around mairix, mu, or similar indexers other than notmuch (for which there is optional special support).
Here is an example how it works. Let's assume - $external_search_command is set to "mairix_filter", and mairix_filter is a script which runs the old but well loved mairix indexer with the arguments given to mairix_filter, in the "raw" mode of mairix, producing on the standard output a list of Message-IDs, one per line.
+ $external_search_command is set to "mairix_filter", and mairix_filter is a script which runs the old but well loved mairix indexer with the arguments given to mairix_filter, in the "raw" mode of mairix, producing on the standard output a list of Message-IDs, one per line.If possible, it also filters down the results coming from mairix such that only messages in the current folder remain. It can do this because it gets a hidden first argument which is the path to the folder. (This can be the type of clean and simple script called a one-liner @@ -4273,7 +4291,7 @@
@@ -4295,7 +4313,7 @@
.
See also: $auto_edit, - $edit_headers, + $edit_headers, $ask_cc, $ask_bcc
@@ -4304,7 +4322,7 @@@@ -4314,14 +4332,14 @@
This variable controls whether or not attachments on outgoing messages are saved along with the main body of your message.
Note: - $fcc_before_send forces the default (set) behavior of this option.
+ $fcc_before_send forces the default (set) behavior of this option.@@ -4333,21 +4351,21 @@set , FCCs will occur before sending the message. Before sending, the message cannot be manipulated, so it will be stored the exact same as sent: - $fcc_attach and - $fcc_clear will be ignored (using their default values). + $fcc_attach and + $fcc_clear will be ignored (using their default values).
When unset , the default, FCCs will occur after sending. Variables - $fcc_attach and - $fcc_clear will be respected, allowing it to be stored without attachments or encryption/signing if desired.
+ $fcc_attach and + $fcc_clear will be respected, allowing it to be stored without attachments or encryption/signing if desired.@@ -4360,17 +4378,17 @@@@ -4485,7 +4503,7 @@set , FCCs will be stored unencrypted and unsigned, even when the actual message is encrypted and/or signed.
Note: - $fcc_before_send forces the default (unset) behavior of this option. (PGP only)
+ $fcc_before_send forces the default (unset) behavior of this option. (PGP only)See also - $pgp_self_encrypt, - $smime_self_encrypt
+ $pgp_self_encrypt, + $smime_self_encrypt@@ -4507,7 +4525,7 @@
@@ -4519,7 +4537,7 @@
”
This variable allows you to customize the file browser display to your personal taste. This string is similar to - $index_format, but has its own set of + $index_format, but has its own set of
printf(3)-like sequences:@@ -4547,8 +4565,8 @@
%D Date/time folder was last modified using - $date_format. It is encouraged to use "%[fmt]" instead, where "fmt" is the value of - $date_format. + $date_format. It is encouraged to use "%[fmt]" instead, where "fmt" is the value of + $date_format.%f @@ -4636,18 +4654,18 @@
For an explanation of "soft-fill", see the - $index_format documentation.
+ $index_format documentation.* = can be optionally printed if nonzero
%m, %n, and %N only work for monitored mailboxes. %m requires - $mail_check_stats to be set. %n requires - $mail_check_stats to be set (except for IMAP mailboxes).
+ $mail_check_stats to be set. %n requires + $mail_check_stats to be set (except for IMAP mailboxes).@@ -4669,7 +4687,7 @@@@ -4690,7 +4708,7 @@
@@ -4699,68 +4717,68 @@
Default: noThis variable is similar to - $save_name, except that NeoMutt will store a copy of your outgoing message by the username of the address you are sending to even if that mailbox does not exist.
+ $save_name, except that NeoMutt will store a copy of your outgoing message by the username of the address you are sending to even if that mailbox does not exist.Also see the - $record variable.
+ $record variable.+ $forward_decode(2021-03-21)Note
Renamed to - $forward_decode(2021-03-21)+ $forward_decrypt(2021-03-21)Note
Renamed to - $forward_decrypt(2021-03-21)+ $forward_format(2021-03-21)Note
Renamed to - $forward_format(2021-03-21)+ $forward_quote(2021-03-21)Note
Renamed to - $forward_quote(2021-03-21)When forwarding inline (i.e. - $mime_forward + $mime_forward unset or answered with "no" and - $forward_decode + $forward_decode set ), attachments which cannot be decoded in a reasonable manner will be attached to the newly composed message if this quadoption is @@ -4786,7 +4804,7 @@
@@ -4798,9 +4816,9 @@
”
This is the string that will precede a message which has been forwarded in the main body of a message (when - $mime_forward is unset). For a full listing of defined + $mime_forward is unset). For a full listing of defined
@@ -4820,9 +4838,9 @@printf(3)-like sequences see the section on - $index_format. See also + $index_format. See also $attribution_locale.”
This is the string that will follow a message which has been forwarded in the main body of a message (when - $mime_forward is unset). For a full listing of defined + $mime_forward is unset). For a full listing of defined
@@ -4840,11 +4858,11 @@printf(3)-like sequences see the section on - $index_format. See also + $index_format. See also $attribution_locale.
Controls the decoding of complex MIME messages into
+ $mime_forward_decode is used instead.text/plainwhen forwarding a message. The message header is also RFC2047 decoded. This variable is only used, if - $mime_forward is + $mime_forward is unset , otherwise - $mime_forward_decode is used instead.@@ -4853,7 +4871,7 @@Note
Before 2021-03-21, this was called $forw_decodeNote
Before 2021-03-21, this was called $forw_decode @@ -4865,11 +4883,11 @@set , the outer layer of encryption is stripped off. This variable is only used if - $mime_forward is + $mime_forward is set and - $mime_forward_decode is + $mime_forward_decode is unset . @@ -4881,7 +4899,7 @@
Note
Before 2021-03-21, this was called $forw_decrypt @@ -4896,7 +4914,7 @@@@ -4908,7 +4926,7 @@
”
This variable controls the default subject when forwarding a message. It uses the same format sequences as the - $index_format variable.
+ $index_format variable.@@ -4917,7 +4935,7 @@Note
Before 2021-03-21, this was called $forw_formatNote
Before 2021-03-21, this was called $forw_format @@ -4929,11 +4947,11 @@set , forwarded messages included in the main body of the message (when - $mime_forward is + $mime_forward is unset ) will be quoted using - $indent_string. + $indent_string.
@@ -4942,7 +4960,7 @@Note
Before 2021-03-21, this was called $forw_quoteNote
Before 2021-03-21, this was called $forw_quote @@ -4960,7 +4978,7 @@@@ -4974,8 +4992,8 @@
, this variable contains a default "from" address. It can be overridden using " my_hdr" (including from a " send-hook") and - $reverse_name. This variable is ignored if - $use_from is + $reverse_name. This variable is ignored if + $use_from is unset . @@ -4987,7 +5005,7 @@
@@ -5042,7 +5060,7 @@
@@ -5056,14 +5074,14 @@
A regular expression used by NeoMutt to parse the GECOS field of a password entry when expanding the alias. The default value will return the string up to the first "," encountered. If the GECOS field contains a string like "lastname, firstname" then you should set it to "
.*".This can be useful if you see the following behavior: you address an e-mail to user ID "stevef" whose full name is "Steve Franklin". If NeoMutt expands "stevef" to '"Franklin" stevef@foo.bar' then you should set the - $gecos_mask to a regular expression that will match the whole name so NeoMutt will expand "Franklin" to "Franklin, Steve".
+ $gecos_mask to a regular expression that will match the whole name so NeoMutt will expand "Franklin" to "Franklin, Steve".@@ -5102,7 +5120,7 @@@@ -5114,7 +5132,7 @@
”
This variable allows you to customize the newsgroup browser display to your personal taste. This string is similar to " - index_format", but has its own set of printf()-like sequences:
+ index_format", but has its own set of printf()-like sequences:
@@ -5179,20 +5197,20 @@
+ $index_format(2021-03-21) @@ -5229,14 +5247,14 @@Note
Renamed to - $index_format(2021-03-21)set , this variable causes NeoMutt to include the header of the message you are replying to into the edit buffer. The - $weed setting applies. + $weed setting applies.
@@ -5256,7 +5274,7 @@@@ -5271,7 +5289,7 @@
@@ -5283,7 +5301,7 @@
Note
Deprecated, since 2020-03-25 @@ -5298,7 +5316,7 @@@@ -5313,7 +5331,7 @@
@@ -5325,7 +5343,7 @@
Note
Deprecated, since 2020-03-25 @@ -5349,7 +5367,7 @@@@ -5371,7 +5389,7 @@
@@ -5383,14 +5401,14 @@- 3.161. hidden_host
+ 3.162. hidden_hostset , NeoMutt will skip the host name part of - $hostname variable when adding the domain part to addresses. + $hostname variable when adding the domain part to addresses.
@@ -5426,7 +5444,7 @@@@ -5408,7 +5426,7 @@- 3.162. hidden_tags
+ 3.163. hidden_tags
@@ -5444,7 +5462,7 @@
@@ -5462,7 +5480,7 @@
@@ -5474,7 +5492,7 @@
set , NeoMutt will not show the presence of messages that are hidden by limiting, at the top of threads in the thread tree. Note that when - $hide_limited is + $hide_limited is set , this option will have no effect. @@ -5484,7 +5502,7 @@
@@ -5496,7 +5514,7 @@
set , NeoMutt will not show the presence of missing messages at the top of threads in the thread tree. Note that when - $hide_missing is + $hide_missing is set , this option will have no effect. @@ -5506,7 +5524,7 @@
@@ -5517,14 +5535,14 @@
This variable controls the size (in number of strings remembered) of the string history buffer per category. The buffer is cleared each time the variable is set.
Note that strings (e.g. commands) starting with a space are never recorded in the history. This is for example useful to prevent leaking sensitive information into the history file or for one off tests.
Also note that a string is not added to the history if it exactly matches its immediate predecessor, e.g. executing the same command twice in a row results in only one copy being added to the history. To prevent duplicates over all entries use - $history_remove_dups.
+ $history_remove_dups.The file in which NeoMutt will save its history.
Also see - $save_history.
+ $save_history.Controls the format of the entries of the history list. This string is similar to - $index_format, but has its own set of + $index_format, but has its own set of
printf(3)-like sequences:@@ -5594,7 +5612,7 @@
@@ -5606,14 +5624,14 @@
set , all of the string history will be scanned for duplicates when a new entry is added. Duplicate entries in the - $history_file will also be removed when it is periodically compacted. + $history_file will also be removed when it is periodically compacted.
@@ -5635,7 +5653,7 @@@@ -5650,7 +5668,7 @@
@@ -5662,15 +5680,15 @@
If not specified in a config file, then NeoMutt will try to determine the hostname itself.
Optionally, NeoMutt can be compiled with a fixed domain name.
Also see - $use_domain and - $hidden_host.
+ $use_domain and + $hidden_host.@@ -5691,7 +5709,7 @@@@ -5709,7 +5727,7 @@
@@ -5721,7 +5739,7 @@
Note
Deprecated, since 2021-03-18 @@ -5749,7 +5767,7 @@@@ -5775,7 +5793,7 @@
@@ -5797,7 +5815,7 @@
@@ -5816,7 +5834,7 @@
@@ -5835,7 +5853,7 @@
@@ -5853,7 +5871,7 @@
@@ -5868,7 +5886,7 @@
@@ -5887,7 +5905,7 @@
@@ -5905,7 +5923,7 @@
@@ -5922,20 +5940,20 @@
Note
Before 2023-05-31, this was called $imap_keepalive+ $imap_keep_alive(2023-05-31)Note
Renamed to - $imap_keep_alive(2023-05-31)@@ -5951,7 +5969,7 @@@@ -5961,14 +5979,14 @@
Your login name on the IMAP server.
This variable defaults to the value of - $imap_user.
+ $imap_user.@@ -5984,7 +6002,7 @@@@ -6007,7 +6025,7 @@
@@ -6025,7 +6043,7 @@
@@ -6043,7 +6061,7 @@
@@ -6062,7 +6080,7 @@
@@ -6077,7 +6095,7 @@
@@ -6096,7 +6114,7 @@
@@ -6114,7 +6132,7 @@
@@ -6132,7 +6150,7 @@
@@ -6152,20 +6170,20 @@
Note
Before 2021-02-11, this was called $imap_servernoise+ $imap_server_noise(2021-02-11)Note
Renamed to - $imap_server_noise(2021-02-11)@@ -6181,7 +6199,7 @@@@ -6202,20 +6220,20 @@
Note
Before 2023-01-25, this was called $implicit_autovie+ $implicit_auto_view(2023-01-25)Note
Renamed to - $implicit_auto_view(2023-01-25)@@ -6230,7 +6248,7 @@@@ -6246,20 +6264,20 @@
+ $include_only_first(2021-03-21)Note
Renamed to - $include_only_first(2021-03-21)@@ -6276,20 +6294,20 @@Note
Before 2021-03-21, this was called $include_onlyfirs+ $indent_string(2021-03-21)Note
Renamed to - $indent_string(2021-03-21)Specifies the string to prepend to each line of text quoted in a message to which you are replying. You are strongly encouraged not to change this value, as it tends to agitate the more fanatical netizens.
The value of this option is ignored if - $text_flowed is set, because the quoting mechanism is strictly defined for format=flowed.
+ $text_flowed is set, because the quoting mechanism is strictly defined for format=flowed.This option is a format string, please see the description of - $index_format for supported + $index_format for supported
printf(3)-style sequences.@@ -6314,7 +6332,7 @@Note
Before 2021-03-21, this was called $indent_strNote
Before 2021-03-21, this was called $indent_str @@ -6328,7 +6346,7 @@
This variable allows you to customize the message index display to your personal taste.
"Format strings" are similar to the strings used in the C function
+ status_format description. The following sequences are defined in NeoMutt:printf(3)to format output (see the man page for more details). For an explanation of the %<...> construct, see the - status_format description. The following sequences are defined in NeoMutt:
@@ -6369,14 +6387,14 @@
%d Date and time of message using - date_format and sender's timezone It is encouraged to use "%{fmt}" instead, where "fmt" is the value of - $date_format. + date_format and sender's timezone It is encouraged to use "%{fmt}" instead, where "fmt" is the value of + $date_format.%D Date and time of message using - date_format and local timezone It is encouraged to use "%[fmt]" instead, where "fmt" is the value of - $date_format. + date_format and local timezone It is encouraged to use "%[fmt]" instead, where "fmt" is the value of + $date_format.%e @@ -6486,7 +6504,7 @@
%T The appropriate character from the - $to_chars string + $to_chars string%u @@ -6529,7 +6547,7 @@
%Z A three character set of message status flags. The first character is new/read/replied flags ("n"/"o"/"r"/"O"/"N"). The second is deleted or encryption flags ("D"/"d"/"S"/"P"/"s"/"K"). The third is either tagged/flagged ("*"/"!"), or one of the characters Listed in - $to_chars. + $to_chars.%zc @@ -6593,7 +6611,7 @@Note
Before 2021-03-21, this was called $hdr_format @@ -6646,7 +6664,7 @@@@ -6664,7 +6682,7 @@
@@ -6676,18 +6694,18 @@
set , read messages marked as flagged will not be moved from your spool mailbox to your - $mbox mailbox or to the "mbox" specified by a + $mbox mailbox or to the "mbox" specified by a mbox-hook command.
Note that - $keep_flagged only has an effect if - $move is set.
+ $keep_flagged only has an effect if + $move is set.@@ -6705,7 +6723,7 @@@@ -6714,14 +6732,14 @@
Default: 5This variable configures how often (in seconds) NeoMutt should look for new mail. Also see the - $timeout variable.
+ $timeout variable.@@ -6742,7 +6760,7 @@@@ -6758,7 +6776,7 @@
unset , and has a separate option, - $mail_check_stats_interval, to control how often to update these counts. + $mail_check_stats_interval, to control how often to update these counts.
Message statistics can also be explicitly calculated by invoking the
@@ -6767,7 +6785,7 @@<check-stats>function.@@ -6776,7 +6794,7 @@
Default: 60When - $mail_check_stats is + $mail_check_stats is set , this variable configures how often (in seconds) NeoMutt will update message counts.
@@ -6786,7 +6804,7 @@@@ -6798,14 +6816,14 @@
”
This variable allows you to customize the file browser display to your personal taste. It's only used to customize network mailboxes (e.g. imap). This string is identical in formatting to the one used by " - $folder_format".
+ $folder_format".@@ -6819,7 +6837,7 @@@@ -6828,7 +6846,7 @@
This variable specifies a list of colon-separated files to consult when attempting to display MIME bodies not directly supported by NeoMutt. The default value is generated during startup: see the " mailcap" section of the manual.
- $mailcap_path is overridden by the environment variable + $mailcap_path is overridden by the environment variable
$MAILCAPS.The default search path is from RFC1524.
@@ -6851,7 +6869,7 @@
@@ -6869,7 +6887,7 @@
@@ -6890,7 +6908,7 @@
@@ -6906,7 +6924,7 @@
@@ -6927,7 +6945,7 @@
@@ -6951,7 +6969,7 @@
@@ -6978,7 +6996,7 @@
@@ -6988,14 +7006,14 @@
Controls the display of wrapped lines in the internal pager. If set, a "+" marker is displayed at the beginning of wrapped lines.
Also see the - $smart_wrap variable.
+ $smart_wrap variable. @@ -7028,16 +7046,16 @@”
This specifies the folder into which read mail in your - $spool_file folder will be appended.
+ $spool_file folder will be appended.Also see the - $move variable.
+ $move variable. @@ -7075,7 +7093,7 @@Note
Before 2021-03-21, this was called $metoo @@ -7084,14 +7102,14 @@
Default: 0This variable controls the number of lines of context that are given when scrolling through menus. (Similar to - $pager_context.)
+ $pager_context.)@@ -7112,7 +7130,7 @@@@ -7133,7 +7151,7 @@
@@ -7151,7 +7169,7 @@
@@ -7162,7 +7180,7 @@
Set this to a directory and NeoMutt will cache copies of messages from your IMAP and POP servers here. You are free to remove entries at any time.
When setting this variable to a directory, NeoMutt needs to fetch every remote message only once and can perform regular expression searches as fast as for local folders.
Also see the - $message_cache_clean variable.
+ $message_cache_clean variable.@@ -7171,20 +7189,20 @@Note
Before 2023-01-25, this was called message_cachedirNote
Before 2023-01-25, this was called message_cachedir<+ $message_cache_dir(2023-01-25)Note
Renamed to - $message_cache_dir(2023-01-25)@@ -7198,7 +7216,7 @@@@ -7207,7 +7225,7 @@
This is the string displayed in the "attachment" menu for attachments of type
+ $index_format.message/rfc822. For a full listing of definedprintf(3)-like sequences see the section on - $index_format.Note
Before 2021-03-21, this was called $msg_formatNote
Before 2021-03-21, this was called $msg_format @@ -7228,20 +7246,20 @@
+ $me_too(2021-03-21)Note
Renamed to - $me_too(2021-03-21)@@ -7260,14 +7278,14 @@set , the message files will simply be deleted.
This option is similar to - $maildir_trash for Maildir folders.
+ $maildir_trash for Maildir folders.@@ -7285,7 +7303,7 @@@@ -7303,7 +7321,7 @@
@@ -7321,7 +7339,7 @@
@@ -7335,8 +7353,8 @@
, the message you are forwarding will be attached as a separate
message/rfc822MIME part instead of included in the main body of the message. This is useful for forwarding MIME messages so the receiver can properly view the message as it was delivered to you. If you like to switch between MIME and not MIME from mail to mail, set this variable to "ask-no" or "ask-yes".Also see - $forward_decode and - $mime_forward_decode.
+ $forward_decode and + $mime_forward_decode.@@ -7345,7 +7363,7 @@Note
Before 2021-03-21, this was called $mime_fwdNote
Before 2021-03-21, this was called $mime_fwd @@ -7355,18 +7373,18 @@
Controls the decoding of complex MIME messages into
+ $forward_decode is used instead.text/plainwhen forwarding a message while - $mime_forward is + $mime_forward is set . Otherwise - $forward_decode is used instead.@@ -7384,20 +7402,20 @@
+ $mime_forward(2021-03-21) @@ -7418,7 +7436,7 @@Note
Renamed to - $mime_forward(2021-03-21)
Default: (empty)This specifies a command to run, to determine the mime type of a new attachment when composing a message. Unless - $mime_type_query_first is set, this will only be run if the attachment's extension is not found in the mime.types file.
+ $mime_type_query_first is set, this will only be run if the attachment's extension is not found in the mime.types file.The string may contain a "%s", which will be substituted with the attachment filename. NeoMutt will add quotes around the string substituted for "%s" automatically according to shell quoting rules, so you should avoid adding your own. If no "%s" is found in the string, NeoMutt will append the attachment filename to the end of the string.
The command should output a single line containing the attachment's mime type.
Suggested values are "xdg-mime query filetype" or "file -bi".
@@ -7428,7 +7446,7 @@@@ -7440,14 +7458,14 @@
set , the - $mime_type_query_command will be run before the mime.types lookup. + $mime_type_query_command will be run before the mime.types lookup.
@@ -7459,30 +7477,30 @@set , then NeoMutt will move read messages from your spool mailbox to your - $mbox mailbox or to the "mbox" specified by a + $mbox mailbox or to the "mbox" specified by a mbox-hook command.
See also - $keep_flagged.
+ $keep_flagged.@@ -7509,18 +7527,18 @@+ $message_format(2021-03-21)Note
Renamed to - $message_format(2021-03-21)
Default: 10Operations that expect to transfer a large amount of data over the network will update their progress every - $net_inc kilobytes. If set to 0, no progress messages will be displayed.
+ $net_inc kilobytes. If set to 0, no progress messages will be displayed.See also - $read_inc, - $write_inc and - $net_inc.
+ $read_inc, + $write_inc and + $net_inc.@@ -7532,14 +7550,14 @@set , NeoMutt will call this command after a new message is received. See the - $status_format documentation for the values that can be formatted into this command. + $status_format documentation for the values that can be formatted into this command.
@@ -7560,7 +7578,7 @@@@ -7579,7 +7597,7 @@
@@ -7597,7 +7615,7 @@
@@ -7684,7 +7702,7 @@
@@ -7702,7 +7720,7 @@
@@ -7717,7 +7735,7 @@
@@ -7732,20 +7750,20 @@
+ $nm_default_url(2021-02-11)Note
Renamed to - $nm_default_url(2021-02-11)@@ -7762,7 +7780,7 @@@@ -7777,7 +7795,7 @@Note
Before 2021-02-11, this was called $nm_default_uri@@ -7795,7 +7813,7 @@
@@ -7810,7 +7828,7 @@
@@ -7828,7 +7846,7 @@
@@ -7843,7 +7861,7 @@
@@ -7858,7 +7876,7 @@
@@ -7873,7 +7891,7 @@
@@ -7888,7 +7906,7 @@
@@ -7906,7 +7924,7 @@
@@ -7924,7 +7942,7 @@
@@ -7933,15 +7951,15 @@
Default: noThis variable specifies whether, when writing a just-sent message to the - $record, the message should also be added to the notmuch DB. Replies inherit the notmuch tags from the original message. See - $nm_record_tags for how to modify the set of notmuch tags assigned to sent messages written to the record.
+ $record, the message should also be added to the notmuch DB. Replies inherit the notmuch tags from the original message. See + $nm_record_tags for how to modify the set of notmuch tags assigned to sent messages written to the record.This variable specifies the notmuch tag modifications (addition, removal, toggling) applied to messages added to the Neomutt record when - $nm_record is true. See the description of the + $nm_record is true. See the description of the
@@ -7976,7 +7994,7 @@<modify-labels>function for the syntax.@@ -7994,7 +8012,7 @@
@@ -8020,7 +8038,7 @@
@@ -8035,7 +8053,7 @@
@@ -8050,7 +8068,7 @@
@@ -8065,7 +8083,7 @@
@@ -8080,7 +8098,7 @@
@@ -8095,7 +8113,7 @@
@@ -8113,7 +8131,7 @@
@@ -8129,7 +8147,7 @@
@@ -8145,7 +8163,7 @@
@@ -8157,14 +8175,14 @@
”
This variable controls the format of the one-line message "status" displayed before each message in either the internal or an external pager. The valid sequences are listed in the - $index_format section.
+ $index_format section.@@ -8179,7 +8197,7 @@@@ -8188,14 +8206,14 @@
Default: 0Determines the number of seconds that must elapse after first opening a new message in the pager before that message will be marked as read. A value of 0 results in the message being marked read unconditionally; for other values, navigating to another message or exiting the pager before the timeout will leave the message marked unread. This setting is ignored if - $pager is set.
+ $pager is set.@@ -8217,7 +8235,7 @@@@ -8239,7 +8257,7 @@Note
Before 2021-06-18, this was called $skip_quoted_offs@@ -8293,7 +8311,7 @@
@@ -8314,7 +8332,7 @@
@@ -8325,7 +8343,7 @@
This option controls whether NeoMutt generates old-style inline (traditional) PGP encrypted or signed messages under certain circumstances. This can be overridden by use of the pgp menu, when inline is not required. The GPGME backend does not support this option.
Note that NeoMutt might automatically use PGP/MIME for messages which consist of more than a single MIME part. NeoMutt can be configured to ask before sending PGP/MIME messages when inline (traditional) would not work.
Also see the - $pgp_mime_auto variable.
+ $pgp_mime_auto variable.Also note that using the old-style PGP message format is strongly @@ -8341,7 +8359,7 @@
+ $pgp_decrypt_command and + $pgp_decode_command for GnuPG status codes indicating successful decryption. This will check for the presence of DECRYPTION_OKAY, absence of DECRYPTION_FAILED, and that all PLAINTEXT occurs between the BEGIN_DECRYPTION and END_DECRYPTION status codes.Note
Before 2004-04-12, this was called $pgp_create_tradi @@ -8354,20 +8372,20 @@Note
Renamed to+ $pgp_auto_inline(2021-02-11)Note
Renamed to - $pgp_auto_inline(2021-02-11)@@ -8380,20 +8398,20 @@Note
Renamed to+ $pgp_reply_inline(2021-03-21)Note
Renamed to - $pgp_reply_inline(2021-03-21)@@ -8411,7 +8429,7 @@@@ -8423,20 +8441,20 @@
set , NeoMutt will check the status file descriptor output of - $pgp_decrypt_command and - $pgp_decode_command for GnuPG status codes indicating successful decryption. This will check for the presence of DECRYPTION_OKAY, absence of DECRYPTION_FAILED, and that all PLAINTEXT occurs between the BEGIN_DECRYPTION and END_DECRYPTION status codes.
If unset , NeoMutt will instead match the status fd output against - $pgp_decryption_okay. (PGP only)
+ $pgp_decryption_okay. (PGP only)@@ -8452,7 +8470,7 @@deprecated .
This is a format string, see the - $pgp_decode_command command for possible + $pgp_decode_command command for possible
printf(3)-like sequences. Note that in this case, %r expands to the search string, which is a list of one or more quoted values such as email address, name, or keyid. (PGP only)@@ -8462,33 +8480,33 @@Note
Before 2021-02-11, this was called $pgp_clearsign_commandNote
Before 2021-02-11, this was called $pgp_clearsign_co+ $pgp_clear_sign_command(2021-02-11)Note
Renamed to - $pgp_clear_sign_command(2021-02-11)+ $pgp_auto_inline(2004-04-12)Note
Renamed to - $pgp_auto_inline(2004-04-12)@@ -8509,8 +8527,8 @@
%a The value of - $pgp_sign_as if set, otherwise the value of - $pgp_default_key. + $pgp_sign_as if set, otherwise the value of + $pgp_default_key.%f @@ -8541,7 +8559,7 @@Note
Before 2018-01-11, this was called $pgp_self_encrypt @@ -8551,7 +8569,7 @@
This command is used to decrypt a PGP encrypted message.
This is a format string, see the - $pgp_decode_command command for possible + $pgp_decode_command command for possible
printf(3)-like sequences. (PGP only)Note: When decrypting messages using
gpg, a pinentry program needs to be invoked unless the password is cached within @@ -8565,7 +8583,7 @@@@ -8574,16 +8592,16 @@
Default: (empty)If you assign text to this variable, then an encrypted PGP message is only considered successfully decrypted if the output from - $pgp_decrypt_command contains the text. This is used to protect against a spoofed encrypted message, with multipart/encrypted headers but containing a block that is not actually encrypted. (e.g. simply signed and ascii armored text).
+ $pgp_decrypt_command contains the text. This is used to protect against a spoofed encrypted message, with multipart/encrypted headers but containing a block that is not actually encrypted. (e.g. simply signed and ascii armored text).Note that if - $pgp_check_gpg_decrypt_status_fd is set, this variable is ignored. (PGP only)
+ $pgp_check_gpg_decrypt_status_fd is set, this variable is ignored. (PGP only)This is the default key-pair to use for PGP operations. It will be used for encryption (see - $postpone_encrypt and - $pgp_self_encrypt).
+ $postpone_encrypt and + $pgp_self_encrypt).It will also be used for signing unless - $pgp_sign_as is set.
+ $pgp_sign_as is set.The (now deprecated) pgp_self_encrypt_as @@ -8606,7 +8624,7 @@
@@ -8616,7 +8634,7 @@
This command is used to encrypt a body part without signing it.
This is a format string, see the - $pgp_decode_command command for possible + $pgp_decode_command command for possible
@@ -8636,7 +8654,7 @@printf(3)-like sequences. Note that in this case, %r expands to the search string, which is a list of one or more quoted values such as email address, name, or keyid. (PGP only)Note
Deprecated, since 2019-09-09 @@ -8646,7 +8664,7 @@
This command is used to both sign and encrypt a body part.
This is a format string, see the - $pgp_decode_command command for possible + $pgp_decode_command command for possible
@@ -8666,11 +8684,11 @@printf(3)-like sequences. (PGP only)”
This variable allows you to customize the PGP key selection menu to your personal taste. If - $crypt_use_gpgme is + $crypt_use_gpgme is set , then it applies to S/MIME key selection menu also. This string is similar to - $index_format, but has its own set of + $index_format, but has its own set of
printf(3)-like sequences:@@ -8747,7 +8765,7 @@
@@ -8757,7 +8775,7 @@
This command is used to export a public key from the user's key ring.
This is a format string, see the - $pgp_decode_command command for possible + $pgp_decode_command command for possible
@@ -8774,7 +8792,7 @@printf(3)-like sequences. (PGP only)
Default: (empty)This command is invoked whenever NeoMutt needs to fetch the public key associated with an email address. Of the sequences supported by - $pgp_decode_command, %r is the only + $pgp_decode_command, %r is the only
printf(3)-like sequence used with this format. Note that in this case, %r expands to the email address, not the public key ID (the key ID is unknown, which is why NeoMutt is invoking this command). (PGP only)@@ -8784,20 +8802,20 @@Note
Before 2021-02-11, this was called $pgp_getkeys_commandNote
Before 2021-02-11, this was called $pgp_getkeys_comm+ $pgp_get_keys_command(2021-02-11)Note
Renamed to - $pgp_get_keys_command(2021-02-11)If you assign a text to this variable, then a PGP signature is only considered verified if the output from - $pgp_verify_command contains the text. Use this variable if the exit code from the command is 0 even for bad signatures. (PGP only)
+ $pgp_verify_command contains the text. Use this variable if the exit code from the command is 0 even for bad signatures. (PGP only)@@ -8831,7 +8849,7 @@@@ -8841,7 +8859,7 @@
This command is used to import a key from a message into the user's public key ring.
This is a format string, see the - $pgp_decode_command command for possible + $pgp_decode_command command for possible
@@ -8864,7 +8882,7 @@printf(3)-like sequences. (PGP only)
Note: gpg's
fixed-list-modeoption should not be used. It produces a different date format which may result in NeoMutt showing incorrect key generation dates.This is a format string, see the - $pgp_decode_command command for possible + $pgp_decode_command command for possible
@@ -8887,7 +8905,7 @@printf(3)-like sequences. (PGP only)
Note: gpg's
fixed-list-modeoption should not be used. It produces a different date format which may result in NeoMutt showing incorrect key generation dates.This is a format string, see the - $pgp_decode_command command for possible + $pgp_decode_command command for possible
@@ -8916,7 +8934,7 @@printf(3)-like sequences. (PGP only)@@ -8938,7 +8956,7 @@
@@ -8949,7 +8967,7 @@
Setting this variable will cause NeoMutt to always attempt to create an inline (traditional) message when replying to a message which is PGP encrypted/signed inline. This can be overridden by use of the pgp menu, when inline is not required. This option does not automatically detect if the (replied-to) message is inline; instead it relies on NeoMutt internals for previously checked/flagged messages.
Note that NeoMutt might automatically use PGP/MIME for messages which consist of more than a single MIME part. NeoMutt can be configured to ask before sending PGP/MIME messages when inline (traditional) would not work.
Also see the - $pgp_mime_auto variable.
+ $pgp_mime_auto variable.Also note that using the old-style PGP message format is strongly @@ -8965,7 +8983,7 @@
+ $pgp_default_key. (PGP only)Note
Before 2021-03-21, this was called $pgp_auto_traditi @@ -8978,20 +8996,20 @@Note
Renamed to+ $pgp_reply_inline(2021-03-21)Note
Renamed to - $pgp_reply_inline(2021-03-21)@@ -9004,7 +9022,7 @@@@ -9017,7 +9035,7 @@Note
Renamed toNote
Renamed to @@ -9040,7 +9058,7 @@@@ -9052,27 +9070,27 @@
set , PGP encrypted messages will also be encrypted using the key in - $pgp_default_key. (PGP only)
+ $pgp_default_key(2018-01-11)Note
Renamed to - $pgp_default_key(2018-01-11)@@ -9090,7 +9108,7 @@@@ -9099,7 +9117,7 @@
Default: (empty)If you have a different key pair to use for signing, you should set this to the signing key. Most people will only need to set - $pgp_default_key. It is recommended that you use the keyid form to specify your key (e.g. + $pgp_default_key. It is recommended that you use the keyid form to specify your key (e.g.
@@ -9118,7 +9136,7 @@0x00112233). (PGP only)
This command is used to create the detached PGP signature for a
multipart/signedPGP/MIME body part.This is a format string, see the - $pgp_decode_command command for possible + $pgp_decode_command command for possible
@@ -9168,7 +9186,7 @@printf(3)-like sequences. (PGP only)@@ -9186,7 +9204,7 @@
@@ -9201,7 +9219,7 @@
@@ -9232,7 +9250,7 @@
@@ -9242,7 +9260,7 @@
This command is used to verify PGP signatures.
This is a format string, see the - $pgp_decode_command command for possible + $pgp_decode_command command for possible
@@ -9260,7 +9278,7 @@printf(3)-like sequences. (PGP only)
This command is used to verify key information from the key selection menu.
This is a format string, see the - $pgp_decode_command command for possible + $pgp_decode_command command for possible
printf(3)-like sequences. (PGP only)+ $crypt_verify_sig(2002-01-24)Note
Renamed to - $crypt_verify_sig(2002-01-24)@@ -9298,7 +9316,7 @@@@ -9318,14 +9336,14 @@set , NeoMutt will attempt to decode the messages first.
Also see - $pipe_decode_weed, which controls whether headers will be weeded when this is + $pipe_decode_weed, which controls whether headers will be weeded when this is set .
@@ -9308,7 +9326,7 @@
For
+ $pipe_decode is set, this further controls whether NeoMutt will weed headers. @@ -9360,14 +9378,14 @@<pipe-message>, when - $pipe_decode is set, this further controls whether NeoMutt will weed headers.set , NeoMutt will pipe the messages one by one. In both cases the messages are piped in the current sorted order, and the - $pipe_sep separator is added after each message. + $pipe_sep separator is added after each message.
@@ -9388,7 +9406,7 @@@@ -9410,7 +9428,7 @@
@@ -9427,20 +9445,20 @@
Note
Before 2021-02-11, this was called $pop_checkinterva+ $pop_check_interval(2021-02-11) @@ -9486,7 +9504,7 @@Note
Renamed to - $pop_check_interval(2021-02-11)@@ -9508,7 +9526,7 @@
@@ -9524,7 +9542,7 @@
@@ -9546,7 +9564,7 @@
@@ -9561,7 +9579,7 @@
@@ -9577,20 +9595,20 @@
+ $post_indent_string(2021-03-21)Note
Renamed to - $post_indent_string(2021-03-21)@@ -9603,7 +9621,7 @@@@ -9624,7 +9642,7 @@Note
Renamed to@@ -9633,7 +9651,7 @@
Default: ask-yesControls whether or not messages are saved in the - $postponed mailbox when you elect not to send immediately. If set to + $postponed mailbox when you elect not to send immediately. If set to ask-yes or @@ -9641,14 +9659,14 @@
ask-no , you will be prompted with "Save (postpone) draft message?" when quitting from the "compose" screen.
Also see the - $recall variable.
+ $recall variable.@@ -9660,16 +9678,16 @@set , postponed messages that are marked for encryption will be self-encrypted. NeoMutt will first try to encrypt using the value specified in - $pgp_default_key or - $smime_default_key. If those are not set, it will try the deprecated - $postpone_encrypt_as. (Crypto only) + $pgp_default_key or + $smime_default_key. If those are not set, it will try the deprecated + $postpone_encrypt_as. (Crypto only)
This is a deprecated fall-back variable for - $postpone_encrypt. Please use - $pgp_default_key or - $smime_default_key. (Crypto only)
+ $postpone_encrypt. Please use + $pgp_default_key or + $smime_default_key. (Crypto only)NeoMutt allows you to indefinitely " - postpone sending a message" which you are editing. When you choose to postpone a message, NeoMutt saves it in the mailbox specified by this variable.
+ postpone sending a message" which you are editing. When you choose to postpone a message, NeoMutt saves it in the mailbox specified by this variable.Also see the - $postpone variable.
+ $postpone variable.@@ -9733,7 +9751,7 @@@@ -9751,7 +9769,7 @@
@@ -9766,20 +9784,20 @@
+ $print_command(2021-03-21)Note
Renamed to - $print_command(2021-03-21)@@ -9799,7 +9817,7 @@@@ -9812,12 +9830,12 @@Note
Before 2021-03-21, this was called $print_cmdset , the message is decoded before it is passed to the external command specified by - $print_command. If this option is + $print_command. If this option is unset , no processing will be applied to the message when printing it. The latter setting may be useful if you are using some advanced printer filter which is able to properly format e-mail messages for printing.
Also see - $print_decode_weed, which controls whether headers will be weeded when this is + $print_decode_weed, which controls whether headers will be weeded when this is set .
@@ -9827,7 +9845,7 @@@@ -9837,14 +9855,14 @@
For
+ $print_decode is set, this further controls whether NeoMutt will weed headers.<print-message>, when - $print_decode is set, this further controls whether NeoMutt will weed headers.@@ -9857,11 +9875,11 @@@@ -9885,7 +9903,7 @@set , the command specified by - $print_command is executed once for each message which is to be printed. If this option is + $print_command is executed once for each message which is to be printed. If this option is unset , the command specified by - $print_command is executed only once, and all the messages are concatenated, with a form feed as the message separator. + $print_command is executed only once, and all the messages are concatenated, with a form feed as the message separator.
Those who use the
enscript(1) program's mail-printing mode will most likely want to @@ -9873,7 +9891,7 @@
external - $pager, setting this variable will cause NeoMutt to prompt you for a command when the pager exits rather than returning to the index menu. If + $pager, setting this variable will cause NeoMutt to prompt you for a command when the pager exits rather than returning to the index menu. If unset , NeoMutt will return to the index menu when the external pager exits. @@ -9895,7 +9913,7 @@
@@ -9911,7 +9929,7 @@
@@ -9980,16 +9998,16 @@
For an explanation of "soft-fill", see the - $index_format documentation.
+ $index_format documentation.* = can be optionally printed if nonzero, see the - $status_format documentation.
+ $status_format documentation. @@ -10035,7 +10053,7 @@
<toggle-quoted>command, or colored according to the "color quoted" family of directives.Higher levels of quoting may be colored differently ("color quoted1", "color quoted2", etc.). The quoting level is determined by removing the last character from the matched text and recursively reapplying the regular expression until it fails to produce a match.
Match detection may be overridden by the - $smileys regular expression.
+ $smileys regular expression.@@ -10044,20 +10062,20 @@Note
Before 2021-03-21, this was called $quote_regexpNote
Before 2021-03-21, this was called $quote_regexp+ $quote_regex(2021-03-21)Note
Renamed to - $quote_regex(2021-03-21)If set to a value greater than 0, NeoMutt will display which message it is currently on when reading a mailbox or when performing search actions such as search and limit. The message is printed after this many messages have been read or searched (e.g., if set to 25, NeoMutt will print a message when it is at message 25, and then again when it gets to message 50). This variable is meant to indicate progress when reading or searching large mailboxes which may take some time. When set to 0, only a single message will appear before the reading the mailbox.
Also see the - $write_inc, - $net_inc and - $time_inc variables and the " + $write_inc, + $net_inc and + $time_inc variables and the " tuning" section of the manual for performance considerations.
@@ -10095,7 +10113,7 @@@@ -10106,7 +10124,7 @@
This variable specifies what "real" or "personal" name should be used when sending messages.
If not specified, then the user's "real name" will be read from
+ $from" is set./etc/passwd. This option will not be used, if " - $from" is set.@@ -10115,20 +10133,20 @@Note
Before 2021-03-21, this was called $realnameNote
Before 2021-03-21, this was called $realname+ $real_name(2021-03-21)Note
Renamed to - $real_name(2021-03-21)@@ -10143,14 +10161,14 @@is not generally useful, and thus not recommended. Note that the
<recall-message>function can be used to manually recall postponed messages.Also see - $postponed variable.
+ $postponed variable.@@ -10166,21 +10184,21 @@
The value of - $record + $record is overridden by the - $force_name and - $save_name variables, and the " + $force_name and + $save_name variables, and the " fcc-hook" command. Also see $copy and - $write_bcc.
+ $write_bcc.This option controls how quotes from format=flowed messages are displayed in the pager and when replying (with - $text_flowed + $text_flowed unset ). When set, this option adds spaces after each level of quote marks, turning ">>>foo" into "> > > foo".
@@ -10197,11 +10215,11 @@Note: If - $reflow_text is + $reflow_text is unset , this option has no effect. Also, this option does not affect replies when - $text_flowed is + $text_flowed is set . @@ -10211,7 +10229,7 @@
@@ -10230,15 +10248,15 @@
format=flowed format.
Also see - $reflow_wrap, and - $wrap.
+ $reflow_wrap, and + $wrap.This variable controls the maximum paragraph width when reformatting text/plain parts when - $reflow_text is + $reflow_text is set . When the value is 0, paragraphs will be wrapped at the terminal's right margin. A positive value sets the paragraph width relative to the left margin. A negative value set the paragraph width relative to the right margin.
Be aware that the reformatted lines of a paragraph are still subject to - $wrap. This means if - $reflow_wrap is 40 and - $wrap is 30, then the paragraph gets reformatted to 40 characters a line (due to - $reflow_wrap) and afterwards each 40-character-line is split at 30 characters (due to - $wrap), resulting in alternating line lengths of 30 and 10 characters.
+ $wrap. This means if + $reflow_wrap is 40 and + $wrap is 30, then the paragraph gets reformatted to 40 characters a line (due to + $reflow_wrap) and afterwards each 40-character-line is split at 30 characters (due to + $wrap), resulting in alternating line lengths of 30 and 10 characters.Also see - $wrap.
+ $wrap.@@ -10299,20 +10317,20 @@@@ -10290,7 +10308,7 @@- 3.391. reply_regex
+ 3.390. reply_regex
The last part matches a colon followed by an optional space or tab. Note
"\t"is converted to a literal tab inside a double quoted string. If you use a single quoted string, you would have to type an actual tab character, and would need to convert the double-backslashes to single backslashes.Note: the result of this regex match against the subject is stored in the header cache. Mutt isn't smart enough to invalidate a header cache entry based on changing - $reply_regex, so if you aren't seeing correct values in the index, try temporarily turning off the header cache. If that fixes the problem, then once the variable is set to your liking, remove your stale header cache files and turn the header cache back on.
+ $reply_regex, so if you aren't seeing correct values in the index, try temporarily turning off the header cache. If that fixes the problem, then once the variable is set to your liking, remove your stale header cache files and turn the header cache back on.Note
Before 2021-03-21, this was called $reply_regexpNote
Before 2021-03-21, this was called $reply_regexp- 3.392. reply_regexp
+ 3.391. reply_regexp+ $reply_regex(2021-03-21)Note
Renamed to - $reply_regex(2021-03-21)@@ -10353,7 +10371,7 @@@@ -10332,7 +10350,7 @@- 3.393. reply_self
+ 3.392. reply_self
- 3.394. reply_to
+ 3.393. reply_to
@@ -10362,7 +10380,7 @@- 3.395. reply_with_xorig
+ 3.394. reply_with_xorig
Default: noThis variable provides a toggle. When active, the From: header will be extracted from the current mail's 'X-Original-To:' header. This setting does not have precedence over " - reverse_real_name".
+ reverse_real_name".Assuming 'fast_reply' is disabled, this option will prompt the user with a prefilled From: header.
@@ -10389,7 +10407,7 @@@@ -10408,7 +10426,7 @@
@@ -10421,9 +10439,9 @@
set , draft files previously edited (via
-E -Hon the command line) will have - $resume_draft_files automatically set when they are used as a draft file again. + $resume_draft_files automatically set when they are used as a draft file again.The first time a draft file is saved, NeoMutt will add a header, X-Mutt-Resume-Draft to the saved file. The next time the draft file is read in, if NeoMutt sees the header, it will set - $resume_draft_files.
+ $resume_draft_files.This option is designed to prevent multiple signatures, user-defined headers, and other processing effects from being made multiple times to the draft file.
@@ -10454,7 +10472,7 @@@@ -10482,14 +10500,14 @@
line will use your address on the current machine.
Also see the " alternates" command and - $reverse_real_name.
+ $reverse_real_name.This variable fine-tunes the behavior of the - $reverse_name feature.
+ $reverse_name feature.When it is unset @@ -10508,7 +10526,7 @@
set
, NeoMutt will use the matching address as-is.In either case, a missing real name will be filled in afterwards using the value of - $real_name.
+ $real_name.@@ -10517,20 +10535,20 @@Note
Before 2021-03-21, this was called $reverse_realnameNote
Before 2021-03-21, this was called $reverse_realname+ $reverse_real_name(2021-03-21)Note
Renamed to - $reverse_real_name(2021-03-21)@@ -10564,7 +10582,7 @@@@ -10576,8 +10594,8 @@
set , NeoMutt will take the sender's full address when choosing a default folder for saving a mail. If - $save_name or - $force_name is + $save_name or + $force_name is set too, the selection of the Fcc folder will be changed as well. @@ -10587,7 +10605,7 @@
@@ -10599,7 +10617,7 @@
unset , mailboxes which contain no saved messages will be removed when closed (the exception is - $spool_file which is never removed). If + $spool_file which is never removed). If set , mailboxes are never removed. @@ -10613,7 +10631,7 @@
@@ -10622,17 +10640,17 @@
Default: 0This variable controls the size of the history (per category) saved in the - $history_file file.
+ $history_file file.Setting this to a value greater than - $history is possible. However, there will never be more than - $history entries to select from even if more are recorded in the history file.
+ $history is possible. However, there will never be more than + $history entries to select from even if more are recorded in the history file.@@ -10644,20 +10662,20 @@set , a check is made to see if a mailbox specified by the recipient address exists (this is done by searching for a mailbox in the - $folder directory with the + $folder directory with the username part of the recipient address). If the mailbox exists, the outgoing message will be saved to that mailbox, otherwise the message is saved to the - $record mailbox. + $record mailbox.
Also see the - $force_name variable.
+ $force_name variable.@@ -10675,7 +10693,7 @@@@ -10687,14 +10705,14 @@
unset , scoring is turned off. This can be useful to selectively disable scoring for certain folders when the - $score_threshold_delete variable and related are used. + $score_threshold_delete variable and related are used.
@@ -10709,7 +10727,7 @@@@ -10724,7 +10742,7 @@
@@ -10739,7 +10757,7 @@
@@ -10754,7 +10772,7 @@
@@ -10775,7 +10793,7 @@
@@ -10788,10 +10806,10 @@
Specifies the program and arguments used to deliver mail sent by NeoMutt. NeoMutt expects that the specified program interprets additional arguments as recipient addresses. NeoMutt appends all recipients after adding a
+ $use_8bit_mime, + $use_envelope_from, + $dsn_notify, or + $dsn_return will be added before the delimiter.--delimiter (if not already present). Additional flags, such as for - $use_8bit_mime, - $use_envelope_from, - $dsn_notify, or - $dsn_return will be added before the delimiter.Note: @@ -10801,14 +10819,14 @@
+ $write_bcc.See also: - $write_bcc.
Specifies the number of seconds to wait for the - $sendmail process to finish before giving up and putting delivery in the background.
+ $sendmail process to finish before giving up and putting delivery in the background.NeoMutt interprets the value of this variable as follows:
@@ -10848,7 +10866,7 @@
@@ -10867,7 +10885,7 @@
@@ -10890,7 +10908,7 @@
@@ -10908,7 +10926,7 @@
@@ -10926,7 +10944,7 @@
@@ -10935,13 +10953,13 @@
Default: 0By default the sidebar will show the mailbox's path, relative to the - $folder variable. This specifies the number of parent directories to hide from display in the sidebar. For example: If a maildir is normally displayed in the sidebar as dir1/dir2/dir3/maildir, setting + $folder variable. This specifies the number of parent directories to hide from display in the sidebar. For example: If a maildir is normally displayed in the sidebar as dir1/dir2/dir3/maildir, setting
sidebar_component_depth=2will display it as dir3/maildir, having truncated the 2 highest directories.See also: - $sidebar_short_path + $sidebar_short_path
@@ -10973,16 +10991,16 @@See also: - $sidebar_short_path, - $sidebar_folder_indent, - $sidebar_indent_string. + $sidebar_short_path, + $sidebar_folder_indent, + $sidebar_indent_string.
@@ -11002,7 +11020,7 @@@@ -11015,16 +11033,16 @@
See also: - $sidebar_short_path, - $sidebar_indent_string, - $sidebar_delim_chars. + $sidebar_short_path, + $sidebar_indent_string, + $sidebar_delim_chars.
This variable allows you to customize the sidebar display. This string is similar to - $index_format, but has its own set of + $index_format, but has its own set of
printf(3)-like sequences:@@ -11141,7 +11159,7 @@
* = Can be optionally printed if nonzero
@ = Only applicable to the current folder
In order to use %S, %N, %F, and %!, - $mail_check_stats must be + $mail_check_stats must be set . When thus set, a suggested value for this option is "%B%<F? [%F]>%* %<N?%N/>%S".
@@ -11151,7 +11169,7 @@@@ -11167,16 +11185,16 @@
See also: - $sidebar_short_path, - $sidebar_folder_indent, - $sidebar_delim_chars. + $sidebar_short_path, + $sidebar_folder_indent, + $sidebar_delim_chars.
@@ -11190,14 +11208,14 @@See also: sidebar_pin, - $sidebar_non_empty_mailbox_only. + $sidebar_non_empty_mailbox_only.
@@ -11214,7 +11232,7 @@@@ -11227,7 +11245,7 @@
See also: - $sidebar_new_mail_only, + $sidebar_new_mail_only, sidebar_pin. @@ -11250,7 +11268,7 @@
@@ -11259,7 +11277,7 @@
Default: noBy default the sidebar will show the mailbox's path, relative to the - $folder variable. Setting + $folder variable. Setting
sidebar_shortpath=yeswill shorten the names relative to the previous name. Here's an example:@@ -11336,17 +11354,17 @@
See also: - $sidebar_delim_chars, - $sidebar_folder_indent, - $sidebar_indent_string, - $sidebar_component_depth. + $sidebar_delim_chars, + $sidebar_folder_indent, + $sidebar_indent_string, + $sidebar_component_depth.
@@ -11417,7 +11435,7 @@@@ -11430,15 +11448,15 @@
See also: - $sidebar_format, - $sidebar_width + $sidebar_format, + $sidebar_width
@@ -11453,7 +11471,7 @@@@ -11465,7 +11483,7 @@
set , a line containing "-- " (note the trailing space) will be inserted before your - $signature. It is + $signature. It is strongly recommended that you not @@ -11478,7 +11496,7 @@
@@ -11499,7 +11517,7 @@
@@ -11517,7 +11535,7 @@
@@ -11540,7 +11558,7 @@
@@ -11559,7 +11577,7 @@
@@ -11578,7 +11596,7 @@
@@ -11597,7 +11615,7 @@
@@ -11616,20 +11634,20 @@
+ $pager_skip_quoted_context(2021-06-18)Note
Renamed to - $pager_skip_quoted_context(2021-06-18)@@ -11644,7 +11662,7 @@@@ -11659,14 +11677,14 @@
unset , lines are simply wrapped at the screen edge. Also see the - $markers variable. + $markers variable.
@@ -11681,15 +11699,15 @@pager uses this variable to catch some common false positives of - $quote_regex, most notably smileys and not consider a line quoted text if it also matches - $smileys. This mostly happens at the beginning of a line. + $quote_regex, most notably smileys and not consider a line quoted text if it also matches + $smileys. This mostly happens at the beginning of a line.
@@ -11707,7 +11725,7 @@@@ -11722,7 +11740,7 @@
@@ -11737,7 +11755,7 @@
@@ -11767,14 +11785,14 @@
%C CA location: Depending on whether - $smime_ca_location points to a directory or file, this expands to "-CApath - $smime_ca_location" or "-CAfile - $smime_ca_location". + $smime_ca_location points to a directory or file, this expands to "-CApath + $smime_ca_location" or "-CAfile + $smime_ca_location".%d The message digest algorithm specified with - $smime_sign_digest_alg. + $smime_sign_digest_alg.%f @@ -11787,7 +11805,7 @@
%k The key-pair specified with - $smime_default_key + $smime_default_key%s @@ -11806,7 +11824,7 @@@@ -11824,7 +11842,7 @@
@@ -11834,15 +11852,15 @@
This is the default key-pair to use for S/MIME operations, and must be set to the keyid (the hash-value that OpenSSL generates) to work properly.
It will be used for encryption (see - $postpone_encrypt and - $smime_self_encrypt). If GPGME is enabled, this is the key id displayed by gpgsm.
+ $postpone_encrypt and + $smime_self_encrypt). If GPGME is enabled, this is the key id displayed by gpgsm.It will be used for decryption unless - $smime_decrypt_use_default_key is + $smime_decrypt_use_default_key is unset .
It will also be used for signing unless - $smime_sign_as is set.
+ $smime_sign_as is set.The (now deprecated) smime_self_encrypt_as @@ -11855,7 +11873,7 @@
Note
Before 2018-01-11, this was called $smime_self_encry @@ -11865,17 +11883,17 @@
This command is used to create encrypted S/MIME messages.
This is a format string, see the - $smime_decrypt_command command for possible + $smime_decrypt_command command for possible
printf(3)-like sequences. (S/MIME only)Encrypt the message to - $smime_default_key too. (S/MIME only)
+ $smime_default_key too. (S/MIME only)@@ -11887,7 +11905,7 @@@@ -11905,7 +11923,7 @@Note
Deprecated, since 2019-09-09@@ -11915,7 +11933,7 @@
This command is used to extract X509 certificates from a PKCS7 structure.
This is a format string, see the - $smime_decrypt_command command for possible + $smime_decrypt_command command for possible
@@ -11933,7 +11951,7 @@printf(3)-like sequences. (S/MIME only)
This command is used to extract the mail address(es) used for storing X509 certificates, and for verification purposes (to check whether the certificate was issued for the sender's mailbox).
This is a format string, see the - $smime_decrypt_command command for possible + $smime_decrypt_command command for possible
printf(3)-like sequences. (S/MIME only)@@ -11941,7 +11959,7 @@@@ -11951,7 +11969,7 @@
This command is used to extract only the signers X509 certificate from a S/MIME signature, so that the certificate's owner may get compared to the email's "From:" field.
This is a format string, see the - $smime_decrypt_command command for possible + $smime_decrypt_command command for possible
@@ -11969,17 +11987,17 @@printf(3)-like sequences. (S/MIME only)
This command is used to import a certificate via smime_keys.
This is a format string, see the - $smime_decrypt_command command for possible + $smime_decrypt_command command for possible
+ $smime_sign_as if set, otherwise + $smime_default_key. (S/MIME only)printf(3)-like sequences. NOTE: %c and %k will default to - $smime_sign_as if set, otherwise - $smime_default_key. (S/MIME only)@@ -11998,7 +12016,7 @@@@ -12013,7 +12031,7 @@
@@ -12023,7 +12041,7 @@
This command is used to extract PKCS7 structures of S/MIME signatures, in order to extract the public X509 certificate(s).
This is a format string, see the - $smime_decrypt_command command for possible + $smime_decrypt_command command for possible
@@ -12043,27 +12061,27 @@printf(3)-like sequences. (S/MIME only)set , S/MIME encrypted messages will also be encrypted using the certificate in - $smime_default_key. (S/MIME only) + $smime_default_key. (S/MIME only)
+ $smime_default_key(2018-01-11)Note
Renamed to - $smime_default_key(2018-01-11)If you have a separate key to use for signing, you should set this to the signing key. Most people will only need to set - $smime_default_key. (S/MIME only)
+ $smime_default_key. (S/MIME only)@@ -12090,7 +12108,7 @@@@ -12116,7 +12134,7 @@
This command is used to created S/MIME signatures of type
multipart/signed, which can be read by all mail clients.This is a format string, see the - $smime_decrypt_command command for possible + $smime_decrypt_command command for possible
printf(3)-like sequences. (S/MIME only)@@ -12131,7 +12149,7 @@
@@ -12142,7 +12160,7 @@
This command is used to verify S/MIME signatures of type
multipart/signed.This is a format string, see the - $smime_decrypt_command command for possible + $smime_decrypt_command command for possible
@@ -12161,7 +12179,7 @@printf(3)-like sequences. (S/MIME only)
This command is used to verify S/MIME signatures of type
application/pkcs7-mime.This is a format string, see the - $smime_decrypt_command command for possible + $smime_decrypt_command command for possible
@@ -12188,7 +12206,7 @@printf(3)-like sequences. (S/MIME only)@@ -12204,7 +12222,7 @@
@@ -12216,7 +12234,7 @@
unset , NeoMutt will prompt you for your password when you first send mail via SMTP. See - $smtp_url to configure NeoMutt to send mail via SMTP. + $smtp_url to configure NeoMutt to send mail via SMTP.
Warning @@ -12227,7 +12245,7 @@
@@ -12240,16 +12258,16 @@
smtp[s]://[user[:pass]@]host[:port]
where "[...]" denotes an optional part. Setting this variable overrides the value of the - $sendmail variable.
+ $sendmail variable.Also see - $write_bcc.
+ $write_bcc.@@ -12265,7 +12283,7 @@@@ -12280,7 +12298,7 @@
@@ -12325,23 +12343,23 @@
You may optionally use the "reverse-" prefix to specify reverse sorting order, or the "last-" prefix to sort threads based on the corresponding attribute of the last descendant rather than the thread root. If both prefixes are in use, "reverse-" must come before "last-". The "last-" prefix has no effect on a flat view.
Any ties in the primary sort are broken by - $sort_aux. When - $use_threads is "threads" or "reverse", - $sort controls the sorting between threads, and - $sort_aux controls the sorting within a thread.
+ $sort_aux. When + $use_threads is "threads" or "reverse", + $sort controls the sorting between threads, and + $sort_aux controls the sorting within a thread.The "date-sent" value is a synonym for "date". The "mailbox-order" value is a synonym for "unsorted".
The values of "threads" and "reverse-threads" are legacy options, which cause the value of
- $sort_aux + $sort_auxto also control sorting between threads, and they may not be used with the "last-" prefix. The preferred way to enable a threaded view is via- $use_threads + $use_threads. This variable can also be set via the<sort-mailbox>and<sort-reverse>functions.Note: When - $use_threads is "threads", the last thread sorts to the bottom; when it is "reversed", the last thread sorts to the top. The use of "reverse-" in - $sort swaps which end the last thread will sort to.
+ $use_threads is "threads", the last thread sorts to the bottom; when it is "reversed", the last thread sorts to the top. The use of "reverse-" in + $sort swaps which end the last thread will sort to.See the "Use Threads Feature" section for further explanation and examples, https://neomutt.org/feature/use-threads
@@ -12372,14 +12390,14 @@
Note: This also affects the entries of the address query menu, thus potentially overruling the order of entries as generated by - $query_command.
+ $query_command.This provides a secondary sort for messages in the "index" menu, used when the - $sort value is equal for two messages.
+ $sort value is equal for two messages.When sorting by threads, this variable controls how subthreads are sorted within a single thread (for the order between threads, see - $sort). This can be set to any value that - $sort can, including with the use of "reverse-" and "last-" prefixes, except for variations using "threads" (in that case, NeoMutt will just use "date"). For instance,
+ $sort). This can be set to any value that + $sort can, including with the use of "reverse-" and "last-" prefixes, except for variations using "threads" (in that case, NeoMutt will just use "date"). For instance,set sort_aux=last-date-receivedwould mean that if a new message is received in a thread, that subthread becomes the last one displayed (or the first, if you have "
+ $use_threads, it is more common to use "last-" with + $sort and not with + $sort_aux.set use_threads=reverse".) When using - $use_threads, it is more common to use "last-" with - $sort and not with - $sort_aux.See the "Use Threads Feature" section for further explanation and examples, https://neomutt.org/feature/use-threads
@@ -12450,7 +12468,7 @@@@ -12459,27 +12477,27 @@
Default: yesThis variable is only useful when sorting by threads with - $strict_threads + $strict_threads unset . In that case, it changes the heuristic neomutt uses to thread messages by subject. With - $sort_re + $sort_re set , neomutt will only attach a message as the child of another message by subject if the subject of the child message starts with a substring matching the setting of - $reply_regex. With - $sort_re + $reply_regex. With + $sort_re unset , neomutt will attach the message whether or not this is the case, as long as the non- - $reply_regex parts of both messages are identical.
+ $reply_regex parts of both messages are identical.@@ -12503,7 +12521,7 @@@@ -12523,20 +12541,20 @@
Note
Before 2021-03-21, this was called $spoolfile+ $spool_file(2021-03-21)Note
Renamed to - $spool_file(2021-03-21)@@ -12555,7 +12573,7 @@@@ -12571,7 +12589,7 @@
@@ -12586,7 +12604,7 @@
@@ -12598,14 +12616,14 @@
set , NeoMutt will require that all connections to remote servers be encrypted. Furthermore it will attempt to negotiate TLS even if the server does not advertise the capability, since it would otherwise have to abort the connection anyway. This option supersedes - $ssl_starttls. + $ssl_starttls.
@@ -12620,7 +12638,7 @@@@ -12642,7 +12660,7 @@
Note that
STARTTLSis subject to many kinds of attacks, including the ability of a machine-in-the-middle to suppress the advertising of support. Setting - $ssl_force_tls is recommended if you rely on + $ssl_force_tls is recommended if you rely onSTARTTLS. @@ -12671,7 +12689,7 @@@@ -12692,7 +12710,7 @@
@@ -12712,7 +12730,7 @@
Note
Before 2021-02-11, this was called $ssl_usesystemcer @@ -12733,7 +12751,7 @@@@ -12754,7 +12772,7 @@
@@ -12772,7 +12790,7 @@
@@ -12790,20 +12808,20 @@
+ $ssl_use_system_certs(2021-02-11)Note
Renamed to - $ssl_use_system_certs(2021-02-11)@@ -12824,7 +12842,7 @@@@ -12845,7 +12863,7 @@
@@ -12866,7 +12884,7 @@
@@ -12878,7 +12896,7 @@
”
Controls the characters used by the "%r" indicator in - $status_format.
+ $status_format.
@@ -12933,7 +12951,7 @@ @@ -12945,7 +12963,7 @@
”
Controls the format of the status line displayed in the "index" menu. This string is similar to - $index_format, but has its own set of + $index_format, but has its own set of
printf(3)-like sequences:@@ -13030,7 +13048,7 @@
%r Modified/read-only/won't-write/attach-message indicator, According to - $status_chars + $status_chars%R @@ -13041,13 +13059,13 @@
%s Current sorting mode ( - $sort) + $sort)%S Current aux sorting method ( - $sort_aux) + $sort_aux)%t @@ -13058,7 +13076,7 @@
%T * Current threading mode ( - $use_threads) + $use_threads)%u @@ -13094,7 +13112,7 @@
For an explanation of "soft-fill", see the - $index_format documentation.
+ $index_format documentation.* = can be optionally printed if nonzero
Some of the above sequences can be used to optionally print a string if their value is nonzero. For example, you may only want to see the number of flagged messages if such messages exist, since zero is not particularly meaningful. To optionally print a string based upon one of the above sequences, the following construct is used:
@@ -13135,11 +13153,11 @@
else_string will be expanded.
As another example, here is how to show either - $sort and - $sort_aux or - $use_threads and - $sort, based on whether threads are enabled with - $use_threads:
+ $sort and + $sort_aux or + $use_threads and + $sort, based on whether threads are enabled with + $use_threads:@@ -13153,7 +13171,7 @@
%<T?%s/%S&%T/%s>@@ -13162,7 +13180,7 @@
Default: noSetting this variable causes the "status bar" to be displayed on the first line of the screen rather than near the bottom. If - $help is + $help is set too, it'll be placed at the bottom.
@@ -13172,7 +13190,7 @@@@ -13184,15 +13202,15 @@
set , threading will only make use of the "In-Reply-To" and "References:" fields when you - $sort by message threads. By default, messages with the same subject are grouped together in "pseudo threads.". This may not always be desirable, such as in a personal mailbox where you might have several unrelated messages with the subjects like "hi" which will get grouped together. See also - $sort_re for a less drastic way of controlling this behavior. + $sort by message threads. By default, messages with the same subject are grouped together in "pseudo threads.". This may not always be desirable, such as in a personal mailbox where you might have several unrelated messages with the subjects like "hi" which will get grouped together. See also + $sort_re for a less drastic way of controlling this behavior.
@@ -13209,7 +13227,7 @@@@ -13232,7 +13250,7 @@key, usually "^Z". This is useful if you run NeoMutt inside an xterm using a command like "
xterm -e neomutt".On startup NeoMutt tries to detect if it is the process session leader. If so, the default of - suspend is "no" otherwise "yes". This default covers the above mentioned use case of " + suspend is "no" otherwise "yes". This default covers the above mentioned use case of "
xterm -e neomutt".
text/plain; format=flowed". This format is easier to handle for some mailing software, and generally just looks like ordinary text. To actually make use of this format's features, you'll need support in your editor.The option only controls newly composed messages. Postponed messages, resent messages, and draft messages (via -H on the command line) will use the content-type of the source message.
Note that - $indent_string is ignored when this option is + $indent_string is ignored when this option is set .
@@ -13242,7 +13260,7 @@@@ -13271,7 +13289,7 @@
@@ -13280,26 +13298,26 @@
Default: noIf - $strict_threads is + $strict_threads is unset , then messages may also be grouped by subject. Unlike threading by "In-Reply-To:" and "References:" header, grouping by subject does not imply a parent-child relation between two messages.
To determine the ancestry between messages grouped by subject, Neomutt uses their date: only newer messages can be descendants of older ones.
When - $thread_received is + $thread_received is set , NeoMutt uses the date received rather than the date sent when comparing messages for the date.
See also - $strict_threads, and - $sort_re.
+ $strict_threads, and + $sort_re. @@ -13326,10 +13344,10 @@
Default: 0Along with - $read_inc, - $write_inc, and - $net_inc, this variable controls the frequency with which progress updates are displayed. It suppresses updates less than - $time_inc milliseconds apart. This can improve throughput on systems with slow terminals, or when running NeoMutt on a remote system.
+ $read_inc, + $write_inc, and + $net_inc, this variable controls the frequency with which progress updates are displayed. It suppresses updates less than + $time_inc milliseconds apart. This can improve throughput on systems with slow terminals, or when running NeoMutt on a remote system.Also see the " tuning" section of the manual for performance considerations.
@@ -13338,7 +13356,7 @@@@ -13355,7 +13373,7 @@
@@ -13378,20 +13396,20 @@
Note
Before 2023-01-25, this was called $tmpdir+ $tmp_dir(2023-01-25)Note
Renamed to - $tmp_dir(2023-01-25)@@ -13477,7 +13495,7 @@@@ -13494,7 +13512,7 @@
@@ -13510,7 +13528,7 @@
@@ -13527,7 +13545,7 @@
Note
Before 2021-03-21, this was called $xterm_set_titles @@ -13539,8 +13557,8 @@”
Controls the format of the icon title, as long as " - $ts_enabled" is set. This string is identical in formatting to the one used by " - $status_format".
+ $ts_enabled" is set. This string is identical in formatting to the one used by " + $status_format".@@ -13549,7 +13567,7 @@Note
Before 2021-03-21, this was called $xterm_iconNote
Before 2021-03-21, this was called $xterm_icon @@ -13561,8 +13579,8 @@”
Controls the format of the terminal status line (or window title), provided that " - $ts_enabled" has been set. This string is identical in formatting to the one used by " - $status_format".
+ $ts_enabled" has been set. This string is identical in formatting to the one used by " + $status_format".@@ -13571,7 +13589,7 @@Note
Before 2021-03-21, this was called $xterm_titleNote
Before 2021-03-21, this was called $xterm_title @@ -13592,7 +13610,7 @@@@ -13604,24 +13622,24 @@
set , NeoMutt will assume the - $tunnel connection does not need STARTTLS to be enabled. It will also allow IMAP PREAUTH server responses inside a - tunnel to proceed. This is appropriate if - $tunnel uses ssh or directly invokes the server locally. + $tunnel connection does not need STARTTLS to be enabled. It will also allow IMAP PREAUTH server responses inside a + tunnel to proceed. This is appropriate if + $tunnel uses ssh or directly invokes the server locally.
When unset , NeoMutt will negotiate STARTTLS according to the - ssl_starttls and - ssl_force_tls variables. If - ssl_force_tls is set, NeoMutt will abort connecting if an IMAP server responds with PREAUTH. This setting is appropriate if - $tunnel does not provide security and could be tampered with by attackers.
+ ssl_starttls and + ssl_force_tls variables. If + ssl_force_tls is set, NeoMutt will abort connecting if an IMAP server responds with PREAUTH. This setting is appropriate if + $tunnel does not provide security and could be tampered with by attackers.@@ -13642,7 +13660,7 @@@@ -13663,7 +13681,7 @@
@@ -13680,7 +13698,7 @@
set , NeoMutt will invoke - $sendmail with the + $sendmail with the
-B8BITMIMEflag when sending 8-bit messages to enable ESMTP negotiation.@@ -13690,20 +13708,20 @@Note
Before 2021-03-21, this was called $use_8bitmimeNote
Before 2021-03-21, this was called $use_8bitmime+ $use_8bit_mime(2021-03-21)Note
Renamed to - $use_8bit_mime(2021-03-21)@@ -13715,7 +13733,7 @@@@ -13740,7 +13758,7 @@set , NeoMutt will qualify all local addresses (ones without the "@host" portion) with the value of - $hostname. If + $hostname. If unset , no addresses will be qualified. @@ -13725,7 +13743,7 @@
envelope sender of the message. If - $envelope_from_address is + $envelope_from_address is set , it will be used as the sender address. If @@ -13749,9 +13767,9 @@
, NeoMutt will attempt to derive the sender from the "From:" header.
Note that this information is passed to sendmail command using the
-fcommand line switch. Therefore setting this option is not useful if the - $sendmail variable already contains + $sendmail variable already contains-for if the executable pointed to by - $sendmail doesn't support the + $sendmail doesn't support the-fswitch.@@ -13761,7 +13779,7 @@Note
Before 2021-03-21, this was called $envelope_fromNote
Before 2021-03-21, this was called $envelope_from @@ -13783,7 +13801,7 @@@@ -13804,7 +13822,7 @@
@@ -13815,27 +13833,27 @@
The style of threading used in the index. May be one of "flat" (no threading), "threads" (threaded, with subthreads below root message) or "reverse" (threaded, with subthreads above root message). For convenience, the value "yes" is a synonym for "threads", and "no" is a synonym for "flat".
If this variable is never set, then
- $sort + $sortcontrols whether threading is used,- $sort_aux + $sort_auxcontrols both the sorting of threads and subthreads, and using<sort-mailbox>to select threads affects only- $sort + $sort. Once this variable is set, attempting to set- $sort + $sortto a value using "threads" will warn, the value of- $sort + $sortcontrols the sorting between threads while- $sort_aux + $sort_auxcontrols sorting within a thread, and<sort-mailbox>toggles- $use_threads + $use_threads.Example:
@@ -13848,7 +13866,7 @@@@ -13866,7 +13884,7 @@
@@ -13878,7 +13896,7 @@
Note
Deprecated, since 2018-11-01 @@ -13887,7 +13905,7 @@
Default: noThis command is now unnecessary. - $spool_file has been extended to support mailbox descriptions as a value.
+ $spool_file has been extended to support mailbox descriptions as a value.When set @@ -13900,20 +13918,20 @@
Note
Before 2021-02-11, this was called $virtual_spoolfil+ $virtual_spool_file(2021-02-11) @@ -13957,7 +13975,7 @@Note
Renamed to - $virtual_spool_file(2021-02-11)@@ -13971,15 +13989,15 @@
, NeoMutt will weed headers when displaying, forwarding, or replying to messages.
Also see $copy_decode_weed, - $pipe_decode_weed, - $print_decode_weed.
+ $pipe_decode_weed, + $print_decode_weed.When set to a positive value, NeoMutt will wrap text at - $wrap characters. When set to a negative value, NeoMutt will wrap text so that there are - $wrap characters of empty space on the right side of the terminal. Setting it to zero makes NeoMutt wrap at the terminal width.
+ $wrap characters. When set to a negative value, NeoMutt will wrap text so that there are + $wrap characters of empty space on the right side of the terminal. Setting it to zero makes NeoMutt wrap at the terminal width.Also see - $reflow_wrap.
+ $reflow_wrap.@@ -14020,7 +14038,7 @@@@ -14042,7 +14060,7 @@
@@ -14052,7 +14070,7 @@
Controls whether NeoMutt writes out the "Bcc:" header when preparing messages to be sent. Some MTAs, such as Exim and Courier, do not strip the "Bcc:" header; so it is advisable to leave this unset unless you have a particular need for the header to be in the sent message.
If NeoMutt is set to deliver directly via SMTP(see - $smtp_url), this option does nothing: NeoMutt will never write out the "Bcc:" header in this case.
+ $smtp_url), this option does nothing: NeoMutt will never write out the "Bcc:" header in this case.Note this option only affects the sending of messages. Fcc'ed copies of a message will always contain the "Bcc:" header if one exists.
@@ -14069,11 +14087,11 @@
Default: 10When writing a mailbox, a message will be printed every - $write_inc messages to indicate progress. If set to 0, only a single message will be displayed before writing a mailbox.
+ $write_inc messages to indicate progress. If set to 0, only a single message will be displayed before writing a mailbox.Also see the - $read_inc, - $net_inc and - $time_inc variables and the " + $read_inc, + $net_inc and + $time_inc variables and the " tuning" section of the manual for performance considerations.
@@ -14099,39 +14117,39 @@
+ $ts_icon_format(2021-03-21)Note
Renamed to - $ts_icon_format(2021-03-21)+ $ts_enabled(2021-03-21)Note
Renamed to - $ts_enabled(2021-03-21)+ $ts_status_format(2021-03-21)Note
Renamed to - $ts_status_format(2021-03-21)- Table 45.14. Default Editor Menu Bindings + Table 45.13. Default Editor Menu Bindings
@@ -18129,14 +18147,14 @@
- Table 45.15. Default Autocrypt Account Menu Bindings + Table 45.14. Default Autocrypt Account Menu Bindings
diff --git a/guide/security.html b/guide/security.html index d98861f..c3223d0 100644 --- a/guide/security.html +++ b/guide/security.html @@ -34,7 +34,7 @@
NeoMutt uses many temporary files for viewing messages, verifying digital signatures, etc. As long as being used, these files are visible by other users and maybe even readable in case of misconfiguration. Also, a different location for these files may be desired which can be changed via the - $tmp_dir variable.
+ $tmp_dir variable.@@ -69,7 +69,7 @@
As NeoMutt be can be set up to be the mail client to handle
diff --git a/guide/tuning.html b/guide/tuning.html index 9f2f52b..a11009c 100644 --- a/guide/tuning.html +++ b/guide/tuning.html @@ -29,10 +29,10 @@mailto:style links in websites, there're security considerations, too. Arbitrary header fields can be embedded in these links which could override existing header fields or attach arbitrary files using the Attach: pseudoheader. This may be problematic if the - $edit-headers variable is + $edit-headers variable is unset , i.e. the user doesn't want to see header fields while editing the message and doesn't pay enough attention to the compose menu's listing of attachments.
NeoMutt provides the - $read_inc and - $write_inc variables to specify at which rate to update progress counters. If these values are too low, NeoMutt may spend more time on updating the progress counter than it spends on actually reading/writing folders.
+ $read_inc and + $write_inc variables to specify at which rate to update progress counters. If these values are too low, NeoMutt may spend more time on updating the progress counter than it spends on actually reading/writing folders.For example, when opening a maildir folder with a few thousand messages, the default value for - $read_inc may be too low. It can be tuned on on a folder-basis using + $read_inc may be too low. It can be tuned on on a folder-basis using folder-hook @@ -49,7 +49,7 @@
These settings work on a per-message basis. However, as messages may greatly differ in size and certain operations are much faster than others, even per-folder settings of the increment variables may not be desirable as they produce either too few or too much progress updates. Thus, NeoMutt allows to limit the number of progress updates per second it'll actually send to the terminal using the - $time_inc variable.
+ $time_inc variable.@@ -65,8 +65,8 @@body caching and header caching for details.
Additionally, it may be worth trying some of NeoMutt's experimental features. - $imap_qresync(which requires header caching) can provide a huge speed boost opening mailboxes if your IMAP server supports it. - $imap_deflate enables compression, which can also noticeably reduce download time for large mailboxes and messages.
+ $imap_qresync(which requires header caching) can provide a huge speed boost opening mailboxes if your IMAP server supports it. + $imap_deflate enables compression, which can also noticeably reduce download time for large mailboxes and messages.