9331 lines
221 KiB
Groff
9331 lines
221 KiB
Groff
|
'\" t
|
||
|
|
.\" -*- nroff -*-
|
||
|
|
.\"
|
||
|
|
.\" Copyright (C) 1996-2000 Michael R. Elkins <me@cs.hmc.edu>
|
||
|
|
.\" Copyright (C) 1999-2000 Thomas Roessler <roessler@does-not-exist.org>
|
||
|
|
.\"
|
||
|
|
.\" This program is free software; you can redistribute it and/or modify
|
||
|
|
.\" it under the terms of the GNU General Public License as published by
|
||
|
|
.\" the Free Software Foundation; either version 2 of the License, or
|
||
|
|
.\" (at your option) any later version.
|
||
|
|
.\"
|
||
|
|
.\" This program is distributed in the hope that it will be useful,
|
||
|
|
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
|
.\" GNU General Public License for more details.
|
||
|
|
.\"
|
||
|
|
.\" You should have received a copy of the GNU General Public License
|
||
|
|
.\" along with this program; if not, write to the Free Software
|
||
|
|
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||
|
|
.\"
|
||
|
|
.de EX
|
||
|
|
.nf
|
||
|
|
.ft CW
|
||
|
|
..
|
||
|
|
.de EE
|
||
|
|
.ft
|
||
|
|
.fi
|
||
|
|
..
|
||
|
|
.TH neomuttrc 5 "2021-02-05" Unix "User Manuals"
|
||
|
|
.\" --------------------------------------------------------------------
|
||
|
|
.SH NAME
|
||
|
|
.\" --------------------------------------------------------------------
|
||
|
|
neomuttrc \- Configuration file for the NeoMutt Mail User Agent (MUA)
|
||
|
|
.
|
||
|
|
.\" --------------------------------------------------------------------
|
||
|
|
.SH DESCRIPTION
|
||
|
|
.\" --------------------------------------------------------------------
|
||
|
|
.PP
|
||
|
|
A NeoMutt configuration file consists of a series of \(lqcommands\(rq. Each
|
||
|
|
line of the file may contain one or more commands. When multiple commands are
|
||
|
|
used, they must be separated by a semicolon (\(lq\fB;\fP\(rq).
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
The hash mark, or pound sign (\(lq\fB#\fP\(rq), is used as a \(lqcomment\(rq
|
||
|
|
character. You can use it to annotate your initialization file. All text after
|
||
|
|
the comment character to the end of the line is ignored.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
Single quotes (\(lq\fB\(aq\fP\(rq) and double quotes (\(lq\fB\(dq\fP\(rq) can
|
||
|
|
be used to quote strings which contain spaces or other special characters. The
|
||
|
|
difference between the two types of quotes is similar to that of many popular
|
||
|
|
shell programs, namely that a single quote is used to specify a literal string
|
||
|
|
(one that is not interpreted for shell variables or quoting with a backslash
|
||
|
|
[see next paragraph]), while double quotes indicate a string which should be
|
||
|
|
evaluated. For example, backticks are evaluated inside of double quotes, but
|
||
|
|
not single quotes.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
\(lq\fB\(rs\fP\(rq quotes the next character, just as in shells such as Bash
|
||
|
|
and Zsh. For example, if you want to put quotes (\(lq\fB\(dq\fP\(rq) inside of
|
||
|
|
a string, you can use \(lq\fB\(rs\fP\(rq to force the next character to be
|
||
|
|
a literal instead of interpreted character.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
\(lq\fB\(rs\(rs\fP\(rq means to insert a literal \(lq\fB\(rs\fP\(rq into the
|
||
|
|
line. \(lq\fB\(rsn\fP\(rq and \(lq\fB\(rsr\fP\(rq have their usual C meanings
|
||
|
|
of line feed (LF) and carriage return (CR), respectively.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
A \(lq\fB\(rs\fP\(rq at the end of a line can be used to split commands over
|
||
|
|
multiple lines, provided that the split points don't appear in the middle of
|
||
|
|
command names.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
It is also possible to substitute the output of a Unix command in an
|
||
|
|
initialization file. This is accomplished by enclosing the command in backticks
|
||
|
|
(\fB\(ga\fP\fIcommand\fP\fB\(ga\fP).
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
Unix environment variables can be accessed like the way it is done in shells
|
||
|
|
like sh and Bash: Prepend the name of the variable by a dollar
|
||
|
|
(\(lq\fB\(Do\fP\(rq) sign.
|
||
|
|
.
|
||
|
|
.\" --------------------------------------------------------------------
|
||
|
|
.SH COMMANDS
|
||
|
|
.\" --------------------------------------------------------------------
|
||
|
|
.SS "\s-1Configuration Commands\s0"
|
||
|
|
.\" --------------------------------------------------------------------
|
||
|
|
.PP
|
||
|
|
The following are the commands understood by NeoMutt:
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBaccount-hook\fP \fIregex\fP \fIcommand\fP
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This hook is executed whenever you access a remote mailbox. Useful to adjust
|
||
|
|
configuration settings to different IMAP or POP servers.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBalias\fP [ \fB\-group\fP \fIname\fP ... ] \fIkey\fP \fIaddress\fP [\fB,\fP \fIaddress\fP ... ]
|
||
|
|
\fBunalias\fP [ \fB\-group\fP \fIname\fP ... ] { \fB*\fP | \fIkey\fP ... }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
\fBalias\fP defines a surrogate \fIkey\fP for the given address(es). Each
|
||
|
|
\fIaddress\fP will be resolved into either an email address
|
||
|
|
(user@\:example.com) or a named email address (User Name <user@\:example.com>).
|
||
|
|
The address may be specified in either format, or in the format
|
||
|
|
\(lquser@\:example.com (User Name)\(rq.
|
||
|
|
.IP
|
||
|
|
\fBNote\fP: If you want to create an alias for more than one address, you
|
||
|
|
\fBmust\fP separate the addresses with a comma (\(lq\fB,\fP\(rq).
|
||
|
|
.IP
|
||
|
|
\fBunalias\fP removes the alias corresponding to the given \fIkey\fP or all
|
||
|
|
aliases when \(lq\fB*\fP\(rq is used as an argument.
|
||
|
|
.IP
|
||
|
|
The optional \fB\-group\fP flag causes the address(es) to be added to or
|
||
|
|
removed from the \fIname\fPd group.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBalternates\fP [ \fB\-group\fP \fIname\fP ... ] \fIregex\fP [ \fIregex\fP ... ]
|
||
|
|
\fBunalternates\fP [ \fB\-group\fP \fIname\fP ... ] { \fB*\fP | \fIregex\fP ... }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
\fBalternates\fP is used to inform NeoMutt about alternate addresses where you
|
||
|
|
receive mail; you can use regular expressions (\fIregex\fP) to specify
|
||
|
|
alternate addresses. This affects NeoMutt's idea about messages from you, and
|
||
|
|
messages addressed to you.
|
||
|
|
.IP
|
||
|
|
\fBunalternates\fP can be used to write exceptions to alternates patterns. To
|
||
|
|
remove a regular expression from the alternates list, use the unalternates
|
||
|
|
command with exactly the same \fIregex\fP or use \(lq\fB*\fP\(rq to remove all
|
||
|
|
entries.
|
||
|
|
.IP
|
||
|
|
The optional \fB\-group\fP flag causes all of the subsequent regular expressions
|
||
|
|
to be added to or removed from the \fIname\fPd group.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBalternative_order\fP \fImime-type\fP[/\fImime-subtype\fP] [ \fImime-type\fP[/\fImime-subtype\fP] ... ]
|
||
|
|
\fBunalternative_order\fP { \fB*\fP | \fImime-type\fP[/\fImime-subtype\fP] ... }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
\fBalternative_order\fP command permits you to define an order of preference
|
||
|
|
that is used by NeoMutt to determine which part of
|
||
|
|
a \fBmultipart/\:alternative\fP body to display. A \fImime-subtype\fP of
|
||
|
|
\(lq\fB*\fP\(rq matches any \fBmultipart/\:alternative\fP subtype, as does an
|
||
|
|
empty \fImime-subtype\fP.
|
||
|
|
.IP
|
||
|
|
\fBunalternative_order\fP removes entries from the ordered list or deletes the
|
||
|
|
entire list when \(lq\fB*\fP\(rq is used as an argument.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBattachments\fP { \fB+\fP | \fB\-\fP }\fIdisposition\fP \fImime-type\fP
|
||
|
|
\fBunattachments\fP { \fB+\fP | \fB\-\fP }\fIdisposition\fP \fImime-type\fP
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
You can make your message index display the number of qualifying attachments in
|
||
|
|
each message, or search for messages by attachment count. You also can
|
||
|
|
configure what kinds of attachments qualify for this feature with the
|
||
|
|
\fBattachments\fP and \fBunattachments\fP commands.
|
||
|
|
.IP
|
||
|
|
\fIdisposition\fP is the attachment's Content-Disposition type \(em either
|
||
|
|
inline or attachment. You can abbreviate this to \fBI\fP or \fBA\fP.
|
||
|
|
.IP
|
||
|
|
\fImime-type\fP is the MIME type of the attachment you want the command to
|
||
|
|
affect. A MIME type is always of the format \fBmajor/minor\fP. The major part
|
||
|
|
of \fImime-type\fP must be literal text (or the special token \(lq\fB*\fP\(rq,
|
||
|
|
but the minor part may be a regular expression. Therefore, \(lq\fB*/.*\fP\(rq
|
||
|
|
matches any MIME type.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBauto_view\fP \fImime-type\fP[\fB/\fP\fImime-subtype\fP] [ \fImime-type\fP[\fB/\fP\fImime-subtype\fP] ... ]
|
||
|
|
\fBunauto_view\fP { \fB*\fP | \fImime-type\fP[\fB/\fP\fImime-subtype\fP] ... }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This commands permits you to specify that NeoMutt should automatically convert
|
||
|
|
the given \fImime-type\fPs to text/plain when displaying messages. For this to work,
|
||
|
|
there must be a
|
||
|
|
.BR mailcap (5)
|
||
|
|
entry for the given \fImime-type\fP with the \fBcopiousoutput\fP option set.
|
||
|
|
A \fImime-subtype\fP of \(lq\fB*\fP\(rq matches any
|
||
|
|
\fBmultipart/\:alternative\fP subtype, as does an empty \fImime-subtype\fP.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBbind\fP \fImap\fP[\fB,\fP\fImap\fP ... ] \fIkey\fP \fIfunction\fP
|
||
|
|
\fBunbind\fP { \fB*\fP | \fImap\fP | [\fB,\fP\fImap\fP...]} [ \fIkey\fP ]
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command allows you to change the default or define additional key bindings
|
||
|
|
(operation invoked when pressing a key).
|
||
|
|
.IP
|
||
|
|
\fImap\fP specifies in which menu the binding belongs. Multiple \fImap\fPs may
|
||
|
|
be specified by separating them with commas (no additional whitespace is
|
||
|
|
allowed). The currently defined \fImap\fPs are:
|
||
|
|
.BR alias ", " attach ", " browser ", " compose ", " editor ", " generic ", "
|
||
|
|
.BR index ", " mix ", " pager ", " pgp ", " postpone ", " query " and " smime "."
|
||
|
|
.IP
|
||
|
|
\fIkey\fP is the key (or key sequence) you wish to bind, e.g.
|
||
|
|
\(lq\fB\(rsCa\fP\(rq for control-A. In addition, \fIkey\fP may be specified as
|
||
|
|
a three digit octal number prefixed with a \(lq\fB\(rs\fP\(rq or as a symbolic
|
||
|
|
name. The \fB<what-key>\fP function can be used to explore keycode and
|
||
|
|
symbolic names for the keys on your keyboard.
|
||
|
|
.IP
|
||
|
|
\fIfunction\fP specifies which action to take when key is pressed. Note that
|
||
|
|
the function name is to be specified without angle brackets.
|
||
|
|
.IP
|
||
|
|
Missing key sequence in \fBunbind\fP command means unbind all bindings in menus given in \fImap\fP .
|
||
|
|
.IP
|
||
|
|
For more information on keys and functions, please consult the NeoMutt manual.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBcharset-hook\fP \fIalias\fP \fIcharset\fP
|
||
|
|
\fBiconv-hook\fP \fIcharset\fP \fIlocal-charset\fP
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
\fBcharset-hook\fP defines an \fIalias\fP for a character set. This is useful to
|
||
|
|
properly display messages which are tagged with a character set name not known
|
||
|
|
to NeoMutt.
|
||
|
|
.IP
|
||
|
|
\fBiconv-hook\fP defines a system-specific name for a character set. This is
|
||
|
|
useful when your system's
|
||
|
|
.BR iconv (3)
|
||
|
|
implementation does not understand MIME character set names (such as
|
||
|
|
\fBiso-8859-1\fP), but instead insists on being fed with
|
||
|
|
implementation-specific character set names (such as \fB8859-1\fP). In this
|
||
|
|
specific case, you'd put \(lq\fBiconv-hook\fP\~iso-8859-1\~8859-1\(rq into your
|
||
|
|
configuration file.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBcolor\fP \fIobject\fP [ \fIattribute\fP ... ] \fIforeground\fP \fIbackground\fP
|
||
|
|
\fBcolor\fP { header | body } [ \fIattribute\fP ... ] \fIforeground\fP \fIbackground\fP \fIregex\fP
|
||
|
|
\fBcolor\fP index-object [ \fIattribute\fP ... ] \fIforeground\fP \fIbackground\fP \fIpattern\fP
|
||
|
|
\fBcolor\fP compose \fIcomposeobject\fP \fIforeground\fP \fIbackground\fP
|
||
|
|
\fBcolor\fP compose \fIcomposeobject\fP [ \fIattribute\fP ... ] \fIforeground\fP \fIbackground\fP
|
||
|
|
\fBuncolor\fP { index-object | header | body } { \fB*\fP | \fIpattern\fP ... }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If your terminal supports color, these commands can be used to assign
|
||
|
|
\fIforeground\fP/\:\fIbackground\fP combinations to certain \fIobject\fPs. The
|
||
|
|
currently defined \fIobject\fPs are:
|
||
|
|
.BR attach_\:headers ", "
|
||
|
|
.BR attachment ", "
|
||
|
|
.BR body ", "
|
||
|
|
.BR bold ", "
|
||
|
|
.BR error ", "
|
||
|
|
.BR hdrdefault ", "
|
||
|
|
.BR header ", "
|
||
|
|
.BR index ", "
|
||
|
|
.BR index_\:author ", "
|
||
|
|
.BR index_\:collapsed ", "
|
||
|
|
.BR index_\:date ", "
|
||
|
|
.BR index_\:flags ", "
|
||
|
|
.BR index_\:label ", "
|
||
|
|
.BR index_\:number ", "
|
||
|
|
.BR index_\:size ", "
|
||
|
|
.BR index_\:subject ", "
|
||
|
|
.BR index_\:tag ", "
|
||
|
|
.BR index_\:tags ", "
|
||
|
|
.BR indicator ", "
|
||
|
|
.BR markers ", "
|
||
|
|
.BR message ", "
|
||
|
|
.BR normal ", "
|
||
|
|
.BR progress ", "
|
||
|
|
.BR prompt ", "
|
||
|
|
.BR quoted ", "
|
||
|
|
.BR quoted\fIN\fP ", "
|
||
|
|
.BR search ", "
|
||
|
|
.BR signature ", "
|
||
|
|
.BR status ", "
|
||
|
|
.BR tilde ", "
|
||
|
|
.BR tree ", "
|
||
|
|
.BR underline "."
|
||
|
|
.IP
|
||
|
|
If the sidebar is enabled the following \fIobject\fPs are also valid:
|
||
|
|
.BR sidebar_\:divider ", "
|
||
|
|
.BR sidebar_\:flagged ", "
|
||
|
|
.BR sidebar_\:highlight ", "
|
||
|
|
.BR sidebar_\:indicator ", "
|
||
|
|
.BR sidebar_\:new ", "
|
||
|
|
.BR sidebar_\:ordinary ", "
|
||
|
|
.BR sidebar_\:spoolfile "."
|
||
|
|
.IP
|
||
|
|
The \fBbody\fP and \fBheader\fP objects allow you to restrict the colorization
|
||
|
|
to a regular expression. The \fBindex-object\fP permits you to select colored
|
||
|
|
messages by pattern.
|
||
|
|
.IP
|
||
|
|
The \fBheader\fP and \fBbody\fP match \fIregex\fP in the header/body of
|
||
|
|
a message, \fBindex-object\fP can match \fIpattern\fP in the message index.
|
||
|
|
Note that IMAP server-side searches (=b, =B, =h) are not supported for color
|
||
|
|
index patterns.
|
||
|
|
.IP
|
||
|
|
Valid composeobjects include
|
||
|
|
.BR header ", " security_encrypt ", " security_sign ", "
|
||
|
|
.BR security_both ", " security_none .
|
||
|
|
.IP
|
||
|
|
Valid colors include:
|
||
|
|
.BR default ", "
|
||
|
|
.BR black ", "
|
||
|
|
.BR red ", "
|
||
|
|
.BR green ", "
|
||
|
|
.BR yellow ", "
|
||
|
|
.BR blue ", "
|
||
|
|
.BR magenta ", "
|
||
|
|
.BR cyan ", "
|
||
|
|
.BR white ", "
|
||
|
|
.BR color\fIN\fP "."
|
||
|
|
.IP
|
||
|
|
Valid attributes include:
|
||
|
|
.BR none ", " bold ", " underline ", "
|
||
|
|
.BR reverse ", and " standout .
|
||
|
|
IP
|
||
|
|
The \fBuncolor\fP command can be applied to the index, header and body objects
|
||
|
|
only. It removes entries from the list. You must specify the same \fIpattern\fP
|
||
|
|
specified in the \fBcolor\fP command for it to be removed. The pattern
|
||
|
|
\(lq\fB*\fP\(rq is a special token which means to clear the color list of all
|
||
|
|
entries.
|
||
|
|
.IP
|
||
|
|
For further information on colorization, please consult the NeoMutt manual.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBcrypt-hook\fP \fIregex\fP \fIkeyid\fP
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The crypt-hook command provides a method by which you can specify the ID of the
|
||
|
|
public key to be used when encrypting messages to a certain recipient. The
|
||
|
|
meaning of \fIkeyid\fP is to be taken broadly: This can be a different email
|
||
|
|
address, a numerical \fIkeyid\fP, or even just an arbitrary search string. You
|
||
|
|
may use multiple \fBcrypt-hook\fPs with the same \fIregex\fP; multiple matching
|
||
|
|
\fBcrypt-hook\fPs result in the use of multiple \fIkeyid\fPs for a recipient.
|
||
|
|
.TP
|
||
|
|
\fBindex-format-hook\fP \fIname\fP [\fB!\fP]\fIpattern\fP \fIformat-string\fP
|
||
|
|
This command is used to inject format strings dynamically into
|
||
|
|
$index_format based on pattern matching against the current message.
|
||
|
|
.IP
|
||
|
|
The $index_format expando \fI%@name@\fP specifies a placeholder for
|
||
|
|
the injection. Index-format-hooks with the same \fIname\fP are matched
|
||
|
|
using \fIpattern\fP against the current message. Matching is done in
|
||
|
|
the order specified in the .neomuttrc, with the first match being
|
||
|
|
used. The hook's \fIformat-string\fP is then substituted and evaluated.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBexec\fP \fIfunction\fP [ \fIfunction\fP ... ]
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command can be used to execute any \fIfunction\fP. Functions are listed in
|
||
|
|
the function reference. \(lq\fBexec\fP \fIfunction\fP\(rq is equivalent to
|
||
|
|
\(lq\fBpush\fP <\fIfunction\fP>\(rq.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBfcc-save-hook\fP \fIpattern\fP \fImailbox\fP
|
||
|
|
\fBfcc-hook\fP \fIpattern\fP \fImailbox\fP
|
||
|
|
\fBsave-hook\fP \fIpattern\fP \fImailbox\fP
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
\fBfcc-save-hook\fP is a shortcut, equivalent to doing both a \fBfcc-hook\fP
|
||
|
|
and a \fBsave-hook\fP with its arguments, including %-expansion on
|
||
|
|
\fImailbox\fP according to $index_format.
|
||
|
|
.IP
|
||
|
|
\fBfcc-hook\fP is used to save outgoing mail in a mailbox other than $record.
|
||
|
|
NeoMutt searches the initial list of message recipients for the first matching
|
||
|
|
\fIpattern\fP and uses \fImailbox\fP as the default \(lqFcc:\(rq mailbox. If no
|
||
|
|
match is found the message will be saved to $record mailbox.
|
||
|
|
.IP
|
||
|
|
\fBsave-hook\fP is used to override the default mailbox used when saving
|
||
|
|
messages. \fImailbox\fP will be used as the default if the message matches
|
||
|
|
\fIpattern\fP.
|
||
|
|
.IP
|
||
|
|
To provide more flexibility and good defaults, NeoMutt applies the expandos of
|
||
|
|
$index_format to \fImailbox\fP after it was expanded. See \fIPATTERNS\fP
|
||
|
|
section below or consult section \(lq\fBMessage Matching in Hooks\fP\(rq in
|
||
|
|
NeoMutt manual for information on the exact format of \fIpattern\fP.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBfolder-hook\fP \fIregex\fP \fIcommand\fP
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When NeoMutt enters a folder which matches \fIregex\fP (or, when \fIregex\fP is
|
||
|
|
preceded by an exclamation mark, does not match \fIregex\fP), the given
|
||
|
|
\fIcommand\fP is executed.
|
||
|
|
.IP
|
||
|
|
When several \fBfolder-hook\fPs match a given mail folder, they are executed in
|
||
|
|
the order given in the configuration file.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBgroup\fP [ \fB\-group\fP \fIname\fP ... ] { \fB\-rx\fP \fIexpr\fP ... | \fB\-addr\fP \fIaddress\fP ... }
|
||
|
|
\fBungroup\fP [ \fB\-group\fP \fIname\fP ... ] { \fB*\fP | \fB\-rx\fP \fIexpr\fP ... | \fB\-addr\fP \fIaddress\fP ... }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
\fBgroup\fP is used to directly add either addresses or regular expressions to
|
||
|
|
the specified group or groups. The different categories of arguments to the
|
||
|
|
\fBgroup\fP command can be in any order. The flags \fB\-rx\fP and \fB\-addr\fP
|
||
|
|
specify what the following strings (that cannot begin with a hyphen) should be
|
||
|
|
interpreted as: either a regular expression or an email address, respectively.
|
||
|
|
.IP
|
||
|
|
\fBungroup\fP is used to remove addresses or regular expressions from the
|
||
|
|
specified group or groups. The syntax is similar to the \fBgroup\fP command,
|
||
|
|
however the special character \(lq\fB*\fP\(rq can be used to empty a group of
|
||
|
|
all of its contents.
|
||
|
|
.IP
|
||
|
|
These address groups can also be created implicitly by the \fBalias\fP,
|
||
|
|
\fBlists\fP, \fBsubscribe\fP and \fBalternates\fP commands by specifying the
|
||
|
|
optional \fB\-group\fP option.
|
||
|
|
.IP
|
||
|
|
Once defined, these address groups can be used in patterns to search for and
|
||
|
|
limit the display to messages matching a group.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBhdr_order\fP \fIheader\fP [ \fIheader\fP ... ]
|
||
|
|
\fBunhdr_order\fP { \fB*\fP | \fIheader\fP ... }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
With the \fBhdr_order\fP command you can specify an order in which NeoMutt will
|
||
|
|
attempt to present these headers to you when viewing messages.
|
||
|
|
.IP
|
||
|
|
\(lq\fBunhdr_order\~*\fP\(rq will clear all previous headers from the order
|
||
|
|
list, thus removing the header order effects set by the system-wide startup
|
||
|
|
file.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBifdef\fP \fIsymbol\fP "\fIconfig-command\fP [ \fIargs\fP ... ]"
|
||
|
|
\fBifndef\fP \fIsymbol\fP "\fIconfig-command\fP [ \fIargs\fP ... ]"
|
||
|
|
\fBfinish\fP
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The \fBifdef\fP feature introduces three new commands to NeoMutt and allow you
|
||
|
|
to share one config file between versions of NeoMutt that may have different
|
||
|
|
features compiled in.
|
||
|
|
.IP
|
||
|
|
Here a \fIsymbol\fP can be a
|
||
|
|
.BR $variable ", <" function ">, " command " or " "compile-time symbol" ", "
|
||
|
|
such as \(lq\fBimap\fP\(rq. A list of compile-time \fIsymbol\fPs can be seen in
|
||
|
|
the output of the command \(lq\fBneomutt\~\-v\fP\(rq (in the
|
||
|
|
\(lq\fBCompile options\fP\(rq section).
|
||
|
|
.IP
|
||
|
|
\fBfinish\fP is particularly useful when combined with \fBifndef\fP.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBignore\fP \fIpattern\fP [ \fIpattern\fP ... ]
|
||
|
|
\fBunignore\fP { \fB*\fP | \fIpattern\fP ... }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The \fBignore\fP command allows you to specify header fields which you don't
|
||
|
|
normally want to see in the pager. You do not need to specify the full header
|
||
|
|
field name. For example, \(lq\fBignore\fP content-\(rq will ignore all header
|
||
|
|
fields that begin with the pattern \(lqcontent-\(rq, \(lq\fBignore\fP\~*\(rq
|
||
|
|
will ignore all headers.
|
||
|
|
.IP
|
||
|
|
To remove a previously added token from the list, use the \fBunignore\fP
|
||
|
|
command. For example, \(lq\fBunignore\fP\~*\(rq will remove all tokens from the
|
||
|
|
ignore list.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBlists\fP [ \fB\-group\fP \fIname\fP ... ] \fIregex\fP [ \fIregex\fP ... ]
|
||
|
|
\fBunlists\fP [ \fB\-group\fP \fIname\fP ... ] { \fB*\fP | \fIregex\fP ... }
|
||
|
|
\fBsubscribe\fP [ \fB\-group\fP \fIname\fP ... ] \fIregex\fP [ \fIregex\fP ... ]
|
||
|
|
\fBunsubscribe\fP [ \fB\-group\fP \fIname\fP ... ] { \fB*\fP | \fIregex\fP ... }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
NeoMutt maintains two lists of mailing list address patterns, a list of
|
||
|
|
subscribed mailing lists, and a list of known mailing lists. All subscribed
|
||
|
|
mailing lists are known. Patterns use regular expressions.
|
||
|
|
.IP
|
||
|
|
The \fBlists\fP command adds a mailing list address to the list of known
|
||
|
|
mailing lists. The \fBunlists\fP command removes a mailing list from the lists
|
||
|
|
of known and subscribed mailing lists.
|
||
|
|
.IP
|
||
|
|
The \fBsubscribe\fP command adds a mailing list to the lists of known and
|
||
|
|
subscribed mailing lists. The \fBunsubscribe\fP command removes it from the
|
||
|
|
list of subscribed mailing lists.
|
||
|
|
.IP
|
||
|
|
The \fB\-group\fP flag adds all of the subsequent regular expressions to the
|
||
|
|
\fIname\fPd group.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBmacro\fP \fImenu\fP[\fB,\fP\fImenu\fP ... ] \fIkey\fP \fIsequence\fP [ \fIdescription\fP ]
|
||
|
|
\fBunmacro\fP { \fB*\fP | \fImenu\fP | [\fB,\fP\fImenu\fP...]} [ \fIkey\fP ]
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command binds the given \fIsequence\fP of keys to the given \fIkey\fP in
|
||
|
|
the given \fImenu\fP or menus. For currently defined menus, see \fBbind\fP
|
||
|
|
command above. To specify multiple menus, put only a comma between the menus.
|
||
|
|
.IP
|
||
|
|
Optionally you can specify a descriptive text after \fIsequence\fP, which is
|
||
|
|
shown in the help screens if they contain a \fIdescription\fP.
|
||
|
|
.IP
|
||
|
|
Missing key sequence in \fBunmacro\fP command means unmacro all macros in menus given in \fImenu\fP.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBmailboxes\fP \fImailbox\fP [ \fImailbox\fP ... ]
|
||
|
|
\fBnamed-mailboxes\fP \fIdescription\fP \fImailbox\fP [\fIdescription\fP \fImailbox\fP ... ]
|
||
|
|
\fBunmailboxes\fP { \fB*\fP | \fImailbox\fP ... }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The \fBmailboxes\fP specifies folders which can receive mail and which will be
|
||
|
|
checked for new messages. When changing folders, pressing space will cycle
|
||
|
|
through folders with new mail.
|
||
|
|
.IP
|
||
|
|
The \fBnamed-mailboxes\fP is an alternative to \fBmailboxes\fP that allows
|
||
|
|
adding a description for a mailbox. NeoMutt can be configured to display the
|
||
|
|
description instead of the mailbox path.
|
||
|
|
.IP
|
||
|
|
The \fBunmailboxes\fP command is used to remove a file name from the list of
|
||
|
|
folders which can receive mail. If \(lq\fB*\fP\(rq is specified as the file
|
||
|
|
name, the list is emptied.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBmailto_allow\fP { \fB*\fP | \fIheader-field\fP ... }
|
||
|
|
\fBunmailto_allow\fP { \fB*\fP | \fIheader-field\fP ... }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
As a security measure, NeoMutt will only add user-approved \fIheader-field\fPs
|
||
|
|
from a \fImailto:\fP URL. This is necessary since NeoMutt will handle certain
|
||
|
|
\fIheader-field\fPs, such as \fBAttach\fP, in a special way. The
|
||
|
|
\fBmailto_allow\fP and \fBunmailto_allow\fP commands allow the user to modify
|
||
|
|
the list of approved headers.
|
||
|
|
.IP
|
||
|
|
NeoMutt initializes the default list to contain only the \fBSubject\fP and
|
||
|
|
\fBBody\fP \fIheader-field\fPs, which are the only requirement specified by the
|
||
|
|
\fImailto:\fP specification in RFC2368, and the \fBCc\fP, \fBIn-Reply-To\fP,
|
||
|
|
\fBReferences\fP headers to aid with replies to mailing lists.
|
||
|
|
.TP
|
||
|
|
\fBecho\fP \fImessage\fP
|
||
|
|
Prints \fImessage\fP to the message window. After printing the
|
||
|
|
message, echo will pause for the number of seconds specified by
|
||
|
|
$sleep_time.
|
||
|
|
.TP
|
||
|
|
\fBcd\fP \fIdirectory\fP
|
||
|
|
Changes the current working directory.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBmbox-hook\fP \fIregex\fP \fImailbox\fP
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When NeoMutt changes to a mail folder which matches \fIregex\fP, \fImailbox\fP
|
||
|
|
will be used as the \(lqmbox\(rq folder, i.e. read messages will be moved to
|
||
|
|
that folder when the mail folder is left.
|
||
|
|
.IP
|
||
|
|
Note that execution of \fBmbox-hook\fPs is dependent on the $move configuration
|
||
|
|
variable. If set to \(lqno\(rq (the default), \fBmbox-hook\fPs will not be
|
||
|
|
executed.
|
||
|
|
.IP
|
||
|
|
The first matching \fBmbox-hook\fP applies.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBmessage-hook\fP \fIpattern\fP \fIcommand\fP
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Before NeoMutt displays (or formats for replying or forwarding) a message which
|
||
|
|
matches the given \fIpattern\fP (or, when it is preceded by an exclamation
|
||
|
|
mark, does not match the \fIpattern\fP), the given \fIcommand\fP is executed.
|
||
|
|
When multiple \fBmessage-hook\fPs match, they are executed in the order in
|
||
|
|
which they occur in the configuration file.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBmime_lookup\fP \fImime-type\fP[\fB/\fP\fImime-subtype\fP] [ \fImime-type\fP[\fB/\fP\fImime-subtype\fP] ... ]
|
||
|
|
\fBunmime_lookup\fP { \fB*\fP | \fImime-type\fP[\fB/\fP\fImime-subtype\fP] ... }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command permits you to define a list of \(lqdata\(rq MIME content types
|
||
|
|
for which NeoMutt will try to determine the actual file type from the file
|
||
|
|
name, and not use a
|
||
|
|
.BR mailcap (5)
|
||
|
|
entry given for the original MIME type. For instance, you may add the
|
||
|
|
\fBapplication/\:octet-stream\fP MIME type to this list.
|
||
|
|
.IP
|
||
|
|
In addition, the \fBunmime_lookup\fP command may be used to disable this
|
||
|
|
feature for any particular MIME type if it had been set, for example in
|
||
|
|
a global \fIneomuttrc\fP.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBmono\fP \fIobject\fP \fIattribute\fP
|
||
|
|
\fBmono\fP { header | body } \fIattribute\fP \fIregex\fP
|
||
|
|
\fBmono\fP index-object \fIattribute\fP \fIpattern\fP
|
||
|
|
\fBunmono\fP { index-object | header | body } { \fB*\fP | \fIpattern\fP ... }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
For terminals which don't support color, you can still assign
|
||
|
|
attributes to objects.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBmy_hdr\fP \fIstring\fP
|
||
|
|
\fBunmy_hdr\fP { \fB*\fP | \fIfield\fP ... }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Using \fBmy_hdr\fP, you can define headers which will be added to the messages
|
||
|
|
you compose. \fBunmy_hdr\fP will remove the given user-defined headers.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBopen-hook\fP \fIregex\fP "\fIshell-command\fP"
|
||
|
|
\fBclose-hook\fP \fIregex\fP "\fIshell-command\fP"
|
||
|
|
\fBappend-hook\fP \fIregex\fP "\fIshell-command\fP"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
These commands provide a way to handle compressed folders. The given
|
||
|
|
\fIregex\fP specifies which folders are taken as compressed (e.g.
|
||
|
|
\(dq\fB\(rs.gz$\fP\(dq). The commands tell NeoMutt how to uncompress a folder
|
||
|
|
(\fBopen-hook\fP), compress a folder (\fBclose-hook\fP) or append a compressed
|
||
|
|
mail to a compressed folder (\fBappend-hook\fP). The \fIshell-command\fP is a
|
||
|
|
.BR printf (3)
|
||
|
|
like format string and must contain two placeholders for from (\fB%f\fP) and to
|
||
|
|
(\fB%t\fP) filenames which should be placed inside single-quotes to prevent
|
||
|
|
unintended shell expansions. Examples:
|
||
|
|
.RS
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
.BR append-hook " \(aq" "\(rs.gz$" "\(aq \(dqgzip \-\-stdout \(aq" "%t" "\(aq >> \(aq" "%f" "\(aq\(dq"
|
||
|
|
.BR close-hook " \(aq" "\(rs.gz$" "\(aq \(dqgzip \-\-stdout \(aq" "%t" "\(aq > \(aq" "%f" "\(aq\(dq"
|
||
|
|
.BR open-hook " \(aq" "\(rs.gz$" "\(aq \(dqgzip \-\-stdout \-\-decompress \(aq" "%f" "\(aq > \(aq" "%t" "\(aq\(dq"
|
||
|
|
.EE
|
||
|
|
.RE
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBpush\fP \fIstring\fP
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command adds the named \fIstring\fP to the beginning of the keyboard
|
||
|
|
buffer. The string may contain control characters, key names and function names
|
||
|
|
like the sequence string in the \fBmacro\fP command. You may use it to
|
||
|
|
automatically run a sequence of commands at startup, or when entering certain
|
||
|
|
folders.
|
||
|
|
.IP
|
||
|
|
For using functions, it's important to use angle brackets (\(lq<\(rq and
|
||
|
|
\(lq>\(rq) to make NeoMutt recognize the input as a function name. Otherwise
|
||
|
|
it will simulate individual just keystrokes.
|
||
|
|
.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBreply-hook\fP \fIpattern\fP \fIcommand\fP
|
||
|
|
\fBsend-hook\fP \fIpattern\fP \fIcommand\fP
|
||
|
|
\fBsend2-hook\fP \fIpattern\fP \fIcommand\fP
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
These commands can be used to execute arbitrary configuration commands based
|
||
|
|
upon recipients of the message. \fIpattern\fP is used to match the message, see
|
||
|
|
section \(lq\fBMessage Matching in Hooks\fP\(rq in manual for details.
|
||
|
|
\fIcommand\fP is executed when \fIpattern\fP matches.
|
||
|
|
.IP
|
||
|
|
\fBreply-hook\fP is matched against the message you are replying to, instead of
|
||
|
|
the message you are sending. \fBsend-hook\fP is matched against all messages,
|
||
|
|
both new and replies. \fBNote\fP, \fBreply-hook\fPs are matched before the
|
||
|
|
\fBsend-hook\fP, regardless of the order specified in the user's configuration
|
||
|
|
file.
|
||
|
|
.IP
|
||
|
|
\fBsend2-hook\fP is matched every time a message is changed, either by editing
|
||
|
|
it, or by using the compose menu to change its recipients or subject.
|
||
|
|
\fBsend2-hook\fP is executed after \fBsend-hook\fP, and can, e.g., be used to
|
||
|
|
set parameters such as the $sendmail variable depending on the message's sender
|
||
|
|
address. \fBNote\fP, \fBsend-hook\fPs are only executed once after getting the
|
||
|
|
initial list of recipients.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBscore\fP \fIpattern\fP \fIvalue\fP
|
||
|
|
\fBunscore\fP { \fB*\fP | \fIpattern\fP ... }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The \fBscore\fP command adds \fIvalue\fP to a message's score if \fIpattern\fP
|
||
|
|
matches it. \fIpattern\fP is a string in the format described in the
|
||
|
|
\fIPATTERNS\fP section below. \fIvalue\fP is a positive or negative integer.
|
||
|
|
A message's final score is the sum total of all matching score entries.
|
||
|
|
.IP
|
||
|
|
The \fBunscore\fP command removes score entries from the list. You must specify
|
||
|
|
the same \fIpattern\fP specified in the \fBscore\fP command for it to be
|
||
|
|
removed. The pattern \(lq\fB*\fP\(rq is a special token which means to clear
|
||
|
|
the list of all score entries.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBset\fP { [ \fBno\fP | \fBinv\fP | \fB&\fP | \fB?\fP ]\fIvariable\fP } [ ... ]
|
||
|
|
\fBset\fP { \fIvariable\fP=\fIvalue\fP | \fIvariable+=increment\fP | \fIvariable-=decrement\fP } [ ... ]
|
||
|
|
\fBunset\fP \fIvariable\fP [ \fIvariable\fP ... ]
|
||
|
|
\fBreset\fP \fIvariable\fP [ \fIvariable\fP ... ]
|
||
|
|
\fBtoggle\fP \fIvariable\fP [ \fIvariable\fP ... ]
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
These commands are used to set and manipulate configuration \fIvariable\fPs.
|
||
|
|
.IP
|
||
|
|
NeoMutt knows four basic types of \fIvariable\fPs: boolean, number, string, string
|
||
|
|
list and quadoption. Boolean \fIvariable\fPs can be \fBset\fP (true), \fBunset\fP
|
||
|
|
(false), or \fBtoggle\fPd. Number \fIvariable\fPs can be assigned a positive
|
||
|
|
integer \fIvalue\fP. Value of number \fIvariable\fPs can be incremented "\fB+=\fP"
|
||
|
|
and decremented "\fB-=\fP". String list \fIvariable\fPs use "\fB+=\fP" for
|
||
|
|
appending increment to the string list and "\fB-=\fP" for removal decrement from
|
||
|
|
the string list.
|
||
|
|
.IP
|
||
|
|
String \fIvariable\fPs consist of any number of printable characters and must
|
||
|
|
be enclosed in quotes if they contain spaces or tabs. You may also use the
|
||
|
|
escape sequences \(lq\fB\(rsn\fP\(rq and \(lq\fB\(rst\fP\(rq for newline and
|
||
|
|
tab, respectively. Content of a string \fIvariable\fPs can be extended using
|
||
|
|
"\fB+=\fP"
|
||
|
|
.IP
|
||
|
|
Quadoption \fIvariable\fPs are used to control whether or not to be prompted
|
||
|
|
for certain actions, or to specify a default action. A \fIvalue\fP of \fByes\fP
|
||
|
|
will cause the action to be carried out automatically as if you had answered
|
||
|
|
\(lqyes\(rq to the question. Similarly, a \fIvalue\fP of \fBno\fP will cause
|
||
|
|
the action to be carried out as if you had answered \(lqno\(rq. A \fIvalue\fP
|
||
|
|
of \fBask-yes\fP will cause a prompt with a default answer of \(lqyes\(rq and
|
||
|
|
\fBask-no\fP will provide a default answer of \(lqno\(rq.
|
||
|
|
.IP
|
||
|
|
The \fBtoggle\fP command automatically prepends the \(lq\fBinv\fP\(rq prefix to
|
||
|
|
all specified \fIvariable\fPs. The \fBunset\fP command automatically prepends
|
||
|
|
the \(lq\fBno\fP\(rq prefix to all specified \fIvariable\fPs. If you use the
|
||
|
|
command \fBset\fP and prefix the \fIvariable\fP with \(lq\fB&\fP\(rq this has
|
||
|
|
the same behavior as the \fBreset\fP command.
|
||
|
|
.IP
|
||
|
|
The \fBreset\fP command resets all given \fIvariable\fPs to the compile time
|
||
|
|
defaults. With the \fBreset\fP command there exists the special \fIvariable\fP
|
||
|
|
\fBall\fP, which allows you to reset all \fIvariable\fPs to their system
|
||
|
|
defaults.
|
||
|
|
.IP
|
||
|
|
Using the <\fBenter-command\fP> function, you can query the \fIvalue\fP of
|
||
|
|
a \fIvariable\fP by prefixing the name of the \fIvariable\fP with a question
|
||
|
|
mark: \(dq:\fBset\~?\fPallow_8bit\(dq.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBsetenv\fP { \fB?\fP\fIvariable\fP | \fIvariable\fP \fIvalue\fP }
|
||
|
|
\fBunsetenv\fP \fIvariable\fP
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
You can alter the environment that NeoMutt passes on to its child processes
|
||
|
|
using the \fBsetenv\fP and \fBunsetenv\fP operators.
|
||
|
|
.IP
|
||
|
|
You can also query current environment \fIvalue\fPs by prefixing a
|
||
|
|
\(lq\fB?\fP\(rq character.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBsidebar_whitelist\fP \fImailbox\fP [ \fImailbox\fP ...]
|
||
|
|
\fBunsidebar_whitelist\fP { \fB*\fP | \fImailbox\fP ... }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The \fBsidebar_whitelist\fP command specifies \fImailbox\fPes that will always
|
||
|
|
be displayed in the sidebar, even if $sidebar_new_mail_only is set and the
|
||
|
|
\fImailbox\fP does not contain new mail.
|
||
|
|
.IP
|
||
|
|
The \fBunsidebar_whitelist\fP command is used to remove a \fImailbox\fP from
|
||
|
|
the list of whitelisted \fImailbox\fPes. Use
|
||
|
|
\(lq\fBunsidebar_whitelist\~*\fP\(rq to remove all \fImailbox\fPes.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBsource\fP \fIfilename\fP
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command allows the inclusion of initialization commands from other files.
|
||
|
|
If the \fIfilename\fP begins with a tilde (\(lq~\(rq), it will be expanded to
|
||
|
|
the path of your home directory.
|
||
|
|
.IP
|
||
|
|
If the \fIfilename\fP ends with a vertical bar (\(lq|\(rq), then \fIfilename\fP
|
||
|
|
is considered to be an executable program from which to read input, (e.g.
|
||
|
|
\(lq\fBsource\fP\~\fI~/\:bin/\:myscript\fP|\(rq).
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBspam\fP \fIpattern\fP \fIformat\fP
|
||
|
|
\fBnospam\fP { \fB*\fP | \fIpattern\fP }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
NeoMutt has generalized support for external spam-scoring filters. By defining
|
||
|
|
your spam \fIpattern\fPs with the \fBspam\fP and \fBnospam\fP commands, you can
|
||
|
|
limit, search, and sort your mail based on its spam attributes, as determined
|
||
|
|
by the external filter. You also can display the spam attributes in your index
|
||
|
|
display using the %H selector in the $index_format variable. (Tip: try
|
||
|
|
\(dq%?H?[%H]\~?\(dq to display spam tags only when they are defined for a given
|
||
|
|
message).
|
||
|
|
.IP
|
||
|
|
For further information on spam-scoring filters, please consult the
|
||
|
|
section \(lq\fBSpam Detection\fP\(rq in the NeoMutt manual.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBsubjectrx\fP \fIpattern\fP \fIreplacement\fP
|
||
|
|
\fBunsubjectrx\fP { \fB*\fP | \fIpattern\fP }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The \fBsubjectrx\fP command specifies a regular expression \fIpattern\fP which,
|
||
|
|
if detected in a message subject, causes the subject to be replaced with the
|
||
|
|
\fIreplacement\fP value. The \fIreplacement\fP is subject to substitutions in
|
||
|
|
the same way as for the \fBspam\fP command: %L for the text to the left of the
|
||
|
|
match, %R for text to the right of the match, and %1 for the first subgroup in
|
||
|
|
the match (etc). If you simply want to erase the match, set it to \(lq%L%R\(rq.
|
||
|
|
Any number of \fBsubjectrx\fP commands may coexist.
|
||
|
|
.IP
|
||
|
|
Note this well: the \fIreplacement\fP value replaces the entire subject, not
|
||
|
|
just the match!
|
||
|
|
.IP
|
||
|
|
\fBunsubjectrx\fP removes a given \fBsubjectrx\fP from the substitution list.
|
||
|
|
If \(lq\fB*\fP\(rq is used as the pattern, all substitutions will be removed.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBtimeout-hook\fP \fIcommand\fP
|
||
|
|
\fBstartup-hook\fP \fIcommand\fP
|
||
|
|
\fBshutdown-hook\fP \fIcommand\fP
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The \fBGlobal Hooks\fP feature introduces these hooks to NeoMutt. They are
|
||
|
|
called when global events take place in NeoMutt. \fBstartup-hook\fP and
|
||
|
|
\fBshutdown-hook\fP are most likely to be useful to users of
|
||
|
|
.BR notmuch (1).
|
||
|
|
.IP
|
||
|
|
\fBtimeout-hook\fP runs a \fIcommand\fP periodically when NeoMutt checks for
|
||
|
|
new mail. This hook is called every $timeout seconds.
|
||
|
|
.IP
|
||
|
|
Before NeoMutt opens the first mailbox when first starting, NeoMutt will run
|
||
|
|
the \fBstartup-hook\fP for the given \fIcommand\fP.
|
||
|
|
.IP
|
||
|
|
Before NeoMutt is about to exit, and before the mailbox is closed, NeoMutt will
|
||
|
|
run the \fBshutdown-hook\fP for the given \fIcommand\fP.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
\fBunhook\fP { \fB*\fP | \fIhook-type\fP }
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command permits you to flush hooks you have previously defined. You can
|
||
|
|
either remove all hooks by giving the \(lq\fB*\fP\(rq character as an argument,
|
||
|
|
or you can remove all hooks of a specific \fIhook-type\fP by saying something
|
||
|
|
like \(lq\fBunhook\fP\~\fIsend-hook\fP\(rq.
|
||
|
|
.
|
||
|
|
.\" --------------------------------------------------------------------
|
||
|
|
.SH PATTERNS
|
||
|
|
.\" --------------------------------------------------------------------
|
||
|
|
.SS "\s-1Pattern Modifier\s0"
|
||
|
|
.\" --------------------------------------------------------------------
|
||
|
|
.PP
|
||
|
|
Many of NeoMutt's commands allow you to specify a pattern to match messages
|
||
|
|
.RB ( limit ", " tag-pattern ", " delete-pattern ", the above mentioned " hook
|
||
|
|
commands etc.). The table \(lq\fBPattern modifiers\fP\(rq shows several ways to
|
||
|
|
select messages.
|
||
|
|
.
|
||
|
|
.na
|
||
|
|
.TS
|
||
|
|
box tab(|);
|
||
|
|
lb s | lb
|
||
|
|
l s | lx
|
||
|
|
.
|
||
|
|
\0Pattern|Description
|
||
|
|
_
|
||
|
|
\0~A|T{
|
||
|
|
all messages
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0=B \fISTRING\fP|T{
|
||
|
|
messages which contain \fISTRING\fP in the whole message. If IMAP is enabled,
|
||
|
|
searches for \fISTRING\fP on the server, rather than downloading each message
|
||
|
|
and searching it locally.
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0=b \fISTRING\fP|T{
|
||
|
|
messages which contain \fISTRING\fP in the message body. If IMAP is enabled,
|
||
|
|
searches for \fISTRING\fP on the server, rather than downloading each message
|
||
|
|
and searching it locally.
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~B \fIEXPR\fP|T{
|
||
|
|
messages which contain \fIEXPR\fP in the whole message
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~b \fIEXPR\fP|T{
|
||
|
|
messages which contain \fIEXPR\fP in the message body
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0%C \fIGROUP\fP|T{
|
||
|
|
messages either \(lqTo:\(rq or \(lqCc:\(rq to any member of \fIGROUP\fP
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0%c \fIGROUP\fP|T{
|
||
|
|
messages carbon-copied to any member of \fIGROUP\fP
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~C \fIEXPR\fP|T{
|
||
|
|
messages either \(lqTo:\(rq or \(lqCc:\(rq \fIEXPR\fP
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~c \fIEXPR\fP|T{
|
||
|
|
messages carbon-copied to \fIEXPR\fP
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~D|T{
|
||
|
|
deleted messages
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~d \fIMIN\fP-\fIMAX\fP|T{
|
||
|
|
messages with \(lqdate-sent\(rq in a date range
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0%e \fIGROUP\fP|T{
|
||
|
|
messages which contain a member of \fIGROUP\fP in the \(lqSender:\(rq field
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~E|T{
|
||
|
|
expired messages
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~e \fIEXPR\fP|T{
|
||
|
|
messages which contain \fIEXPR\fP in the \(lqSender:\(rq field
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0%f \fIGROUP\fP|T{
|
||
|
|
messages originating from any member of \fIGROUP\fP
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~F|T{
|
||
|
|
flagged messages
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~f \fIEXPR\fP|T{
|
||
|
|
messages originating from \fIEXPR\fP
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~G|T{
|
||
|
|
cryptographically encrypted messages
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~g|T{
|
||
|
|
cryptographically signed messages
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0=h \fISTRING\fP|T{
|
||
|
|
messages which contain \fISTRING\fP in the message header. If IMAP is enabled,
|
||
|
|
searches for \fISTRING\fP on the server, rather than downloading each message
|
||
|
|
and searching it locally; \fISTRING\fP must be of the form \(lqHeader:
|
||
|
|
substring\(rq (see below).
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~H \fIEXPR\fP|T{
|
||
|
|
messages with spam attribute matching \fIEXPR\fP
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~h \fIEXPR\fP|T{
|
||
|
|
messages which contain \fIEXPR\fP in the message header
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~i \fIEXPR\fP|T{
|
||
|
|
messages which match \fIEXPR\fP in the \(lqMessage-ID:\(rq field
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~k|T{
|
||
|
|
messages containing PGP key material
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0%L \fIGROUP\fP|T{
|
||
|
|
messages either originated or received by any member of \fIGROUP\fP
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~L \fIEXPR\fP|T{
|
||
|
|
messages either originated or received by \fIEXPR\fP
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~l|T{
|
||
|
|
messages addressed to a known mailing list
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~m <\fIMAX\fP|T{
|
||
|
|
messages with numbers less than \fIMAX\fP \fB*\fP)
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~m >\fIMIN\fP|T{
|
||
|
|
messages with numbers greater than \fIMIN\fP \fB*\fP)
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~m \fIMIN\fP,\fIMAX\fP|T{
|
||
|
|
messages with offsets (from selected message) in the range \fIMIN\fP to
|
||
|
|
\fIMAX\fP \fB*\fP)
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~m \fIMIN\fP-\fIMAX\fP|T{
|
||
|
|
message in the range \fIMIN\fP to \fIMAX\fP \fB*\fP)
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~m \fIN\fP|T{
|
||
|
|
just message number \fIN\fP \fB*\fP)
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~N|T{
|
||
|
|
new messages
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~n \fIMIN\fP-\fIMAX\fP|T{
|
||
|
|
messages with a score in the range \fIMIN\fP to \fIMAX\fP \fB**\fP)
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~O|T{
|
||
|
|
old messages
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~P|T{
|
||
|
|
messages from you (consults $from, \fBalternates\fP, and local account/hostname information)
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~p|T{
|
||
|
|
messages addressed to you (consults $from, \fBalternates\fP, and local account/hostname information)
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~Q|T{
|
||
|
|
messages which have been replied to
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~R|T{
|
||
|
|
read messages
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~r \fIMIN\fP-\fIMAX\fP|T{
|
||
|
|
messages with \(lqdate-received\(rq in a date range
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~S|T{
|
||
|
|
superseded messages
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~s \fIEXPR\fP|T{
|
||
|
|
messages having \fIEXPR\fP in the \(lqSubject:\(rq field
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~T|T{
|
||
|
|
tagged messages
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~t \fIEXPR\fP|T{
|
||
|
|
messages addressed to \fIEXPR\fP
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~U|T{
|
||
|
|
unread messages
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~u|T{
|
||
|
|
messages addressed to a subscribed mailing list
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~V|T{
|
||
|
|
cryptographically verified messages
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~v|T{
|
||
|
|
message is part of a collapsed thread.
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~X \fIMIN\fP-\fIMAX\fP|T{
|
||
|
|
messages with \fIMIN\fP to \fIMAX\fP attachments \fB**\fP)
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~x \fIEXPR\fP|T{
|
||
|
|
messages which contain \fIEXPR\fP in the \(lqReferences:\(rq or
|
||
|
|
\(lqIn-Reply-To:\(rq field
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~y \fIEXPR\fP|T{
|
||
|
|
messages which contain \fIEXPR\fP in their keywords
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~Y \fIEXPR\fP|T{
|
||
|
|
messages whose tags match \fIEXPR\fP
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~z \fIMIN\fP-\fIMAX\fP|T{
|
||
|
|
messages with a size in the range \fIMIN\fP to \fIMAX\fP \fB**\fP) \fB***\fP)
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0=/ \fISTRING\fP|T{
|
||
|
|
IMAP custom server-side search for \fISTRING\fP. Currently only defined for
|
||
|
|
Gmail. See section \(lq\fBGmail Patterns\fP\(rq in NeoMutt manual.
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~=|T{
|
||
|
|
duplicated messages (see $duplicate_threads)
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~#|T{
|
||
|
|
broken threads (see $strict_threads)
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~$|T{
|
||
|
|
unreferenced message (requires threaded view)
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~(\fIPATTERN\fP)|T{
|
||
|
|
messages in threads containing messages matching \fIPATTERN\fP, e.g. all
|
||
|
|
threads containing messages from you: ~(~P)
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~<(\fIPATTERN\fP)|T{
|
||
|
|
messages whose immediate parent matches \fIPATTERN\fP, e.g. replies to your
|
||
|
|
messages: ~<(~P)
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
\0~>(\fIPATTERN\fP)|T{
|
||
|
|
messages having an immediate child matching \fIPATTERN\fP, e.g. messages you
|
||
|
|
replied to: ~>(~P)
|
||
|
|
T}
|
||
|
|
_
|
||
|
|
.T&
|
||
|
|
l s s .
|
||
|
|
T{
|
||
|
|
\0Where \fIEXPR\fP is a regular expression, and \fIGROUP\fP is an address group.
|
||
|
|
T}
|
||
|
|
.T&
|
||
|
|
l l s .
|
||
|
|
.PP
|
||
|
|
\0\fB*\fP)|T{
|
||
|
|
The message number ranges (introduced by \(lq\fB~m\fP\(rq) are even
|
||
|
|
more general and powerful than the other types of ranges. Read on and see
|
||
|
|
section \(lq\fBMessage Ranges\fP\(rq in manual.
|
||
|
|
T}
|
||
|
|
\0\fB**\fP)|T{
|
||
|
|
The forms \(lq<\fIMAX\fP\(rq, \(lq>\fIMIN\fP\(rq, \(lq\fIMIN\fP-\(rq and
|
||
|
|
\(lq-\fIMAX\fP\(rq are allowed, too.
|
||
|
|
T}
|
||
|
|
\0\fB***\fP)|T{
|
||
|
|
The suffixes \(lqK\(rq and \(lqM\(rq are allowed to specify
|
||
|
|
kilobyte and megabyte respectively.
|
||
|
|
T}
|
||
|
|
.TE
|
||
|
|
.PP
|
||
|
|
.ad
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
Special attention has to be paid when using regular expressions inside of
|
||
|
|
patterns. Specifically, NeoMutt's parser for these patterns will strip one
|
||
|
|
level of backslash (\(lq\fB\(rs\fP\(rq), which is normally used for quoting. If
|
||
|
|
it is your intention to use a backslash in the regular expression, you will
|
||
|
|
need to use two backslashes (\(lq\fB\(rs\(rs\fP\(rq) instead.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
You can force NeoMutt to treat \fIEXPR\fP as a simple \fISTRING\fP instead of
|
||
|
|
a regular expression by using \(lq\fB=\fP\(rq instead of \(lq\fB~\fP\(rq in the
|
||
|
|
pattern name. For example, \(lq\fB=b\~*.*\fP\(rq will find all messages that
|
||
|
|
contain the literal \fISTRING\fP \(lq\fB*.*\fP\(rq. Simple substring matches
|
||
|
|
are less powerful than regular expressions but can be considerably faster. This
|
||
|
|
is especially true for IMAP folders, because substring matches can be performed
|
||
|
|
on the server instead of by fetching every message. IMAP treats
|
||
|
|
\(lq\fB=h\fP\(rq specially: it must be of the form
|
||
|
|
\(lqHeader:\~\fIsubstring\fP\(rq and will \fBnot\fP partially match header
|
||
|
|
names. The \fIsubstring\fP part may be omitted if you simply wish to find
|
||
|
|
messages containing a particular header without regard to its value.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
Patterns matching lists of addresses (notably
|
||
|
|
.BR c ", " C ", " p ", " P " and " t )
|
||
|
|
match if there is at least one match in the whole list. If you want to make
|
||
|
|
sure that all elements of that list match, you need to prefix your pattern with
|
||
|
|
\(lq\fB^\fP\(rq.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
This example matches all mails which only has recipients from Germany.
|
||
|
|
.IP
|
||
|
|
Matching all addresses in address lists:
|
||
|
|
.BI ^~C\~ \(rs.de$
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
You can restrict address pattern matching to aliases that you have defined with
|
||
|
|
the \(lq\fB@\fP\(rq modifier. This example matches messages whose recipients
|
||
|
|
are all from Germany \fBand\fP who are known to your alias list.
|
||
|
|
.
|
||
|
|
.IP
|
||
|
|
Matching restricted to aliases:
|
||
|
|
.BI ^@~C\~ \(rs.de$
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
To match any defined alias, use a regular expression that matches \fBany\fP
|
||
|
|
string. This example matches messages whose senders are known aliases.
|
||
|
|
.
|
||
|
|
.IP
|
||
|
|
Matching any defined alias:
|
||
|
|
.BI @~f\~ .
|
||
|
|
.
|
||
|
|
.SS "\s-1Nesting and Boolean Operators\s0"
|
||
|
|
.\" --------------------------------------------------------------------
|
||
|
|
.PP
|
||
|
|
Logical AND is performed by specifying more than one criterion.
|
||
|
|
.IP
|
||
|
|
For example:
|
||
|
|
.BI ~t\~ work " ~f\~" elkins
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
would select messages which contain the word \(lqwork\(rq in the list of
|
||
|
|
recipients \fBand\fP that have the word \(lqelkins\(rq in the \(lqFrom:\(rq
|
||
|
|
header field.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
NeoMutt also recognizes the following operators to create more complex
|
||
|
|
search patterns:
|
||
|
|
.
|
||
|
|
.RS
|
||
|
|
.TP 4
|
||
|
|
\(bu \(lq\fB!\fP\(rq \(em logical NOT operator
|
||
|
|
.TQ
|
||
|
|
\(bu \(lq\fB|\fP\(rq \(em logical OR operator
|
||
|
|
.TQ
|
||
|
|
\(bu \(lq\fB()\fP\(rq \(em logical grouping operator
|
||
|
|
.RE
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
Here is an example illustrating a complex search pattern. This pattern will
|
||
|
|
select all messages which do \fBnot\fP contain \(lqwork\(rq in the \(lqTo:\(rq
|
||
|
|
\fBor\fP \(lqCc:\(rq field \fBand\fP which are from \(lqelkins\(rq.
|
||
|
|
.
|
||
|
|
.IP
|
||
|
|
Using boolean operators in patterns:
|
||
|
|
.BI !(~t\~ work |~c\~ work ") ~f\~" elkins
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
Here is an example using white space in the regular expression (note the
|
||
|
|
\(lq\fB\(aq\fP\(rq and \(lq\fB\(dq\fP\(rq delimiters). For this to match, the
|
||
|
|
mail's subject must match the \(lq^Junk +From +Me$\(rq \fBand\fP it must be
|
||
|
|
from either \(lqJim +Somebody\(rq \fBor\fP \(lqEd +SomeoneElse\(rq:
|
||
|
|
.
|
||
|
|
.IP
|
||
|
|
Quoting regex:
|
||
|
|
.na
|
||
|
|
.IB \(aq ~s\~ "\(dq^Junk +From +Me$\(dq"
|
||
|
|
.BI ~f\~( "\(dqJim +Somebody\(dq" | "\(dqEd +SomeoneElse\(dq" ) \(aq
|
||
|
|
.ad
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
\fBNote\fP: If a regular expression contains parenthesis, or a vertical bar
|
||
|
|
(\(lq\fB|\fP\(rq), you must enclose the expression in double or single quotes
|
||
|
|
since those characters are also used to separate different parts of NeoMutt's
|
||
|
|
pattern language.
|
||
|
|
.
|
||
|
|
.IP
|
||
|
|
For example:
|
||
|
|
.BI ~f \~\(dquser@ ( home\(rs.org | work\(rs.com ) \(dq
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
Without the quotes, the parenthesis wouldn't end. This would be separated to
|
||
|
|
two OR'd patterns:
|
||
|
|
.BI ~f \~user@(home\(rs.org
|
||
|
|
.RI "and " work\(rs.com) ". They are never what you want."
|
||
|
|
.
|
||
|
|
.SS "\s-1Searching by Date\s0"
|
||
|
|
.\" --------------------------------------------------------------------
|
||
|
|
.PP
|
||
|
|
NeoMutt supports two types of dates, \fBabsolute\fP and \fBrelative\fP for
|
||
|
|
the \(lq\fB~d\fP\(rq and \(lq\fB~r\fP\(rq pattern.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
.B Absolute Dates
|
||
|
|
.fi
|
||
|
|
Dates must be in
|
||
|
|
.IR dd [/ mm [/[ CC ] YY ]]
|
||
|
|
format (day, month, century and year \(em all parts, with the exception of day,
|
||
|
|
are optional, defaulting to the current month and year). An example of a valid
|
||
|
|
range of dates is:
|
||
|
|
.
|
||
|
|
.IP
|
||
|
|
Limit to messages matching:
|
||
|
|
.IR \fB~d\fP\~20 / 1 / 95 - 31 / 10
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
Alternatively, you may use \fIYYYYMMDD\fP to specify a date.
|
||
|
|
.PP
|
||
|
|
When given a two-digit year, NeoMutt will interpret values less than \(lq70\(rq
|
||
|
|
as lying in the 21st century (i.e., \(lq38\(rq means 2038 and not 1938, and
|
||
|
|
\(lq00\(rq is interpreted as 2000), and values greater than or equal to
|
||
|
|
\(lq70\(rq as lying in the 20th century.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
If you omit the \fIMIN\fPimum (first) date, and just specify
|
||
|
|
.RI - dd / mm / YY ,
|
||
|
|
all messages before the given date will be selected. If you omit the
|
||
|
|
\fIMAX\fPimum (second) date, and specify
|
||
|
|
.IR dd / mm / YY -,
|
||
|
|
all messages after the given date will be selected. If you specify a single
|
||
|
|
date with no dash (\(lq\fB-\fP\(rq), only messages sent/received on the given
|
||
|
|
date will be selected.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
You can add error margins to absolute dates. An error margin is a sign
|
||
|
|
(\(lq\fB+\fP\(rq or \(lq\fB-\fP\(rq), followed by a digit, followed by one of
|
||
|
|
the units in table \(lq\fBDate units\fP\(rq below. As a special case, you can
|
||
|
|
replace the sign by a \(lq\fB*\fP\(rq character, which is equivalent to giving
|
||
|
|
identical plus and minus error margins.
|
||
|
|
.
|
||
|
|
.\".TS
|
||
|
|
.\"allbox tab(|);
|
||
|
|
.\"cb cb
|
||
|
|
.\"c l .
|
||
|
|
.\"\0Unit|Description
|
||
|
|
.\"\0d|Days
|
||
|
|
.\"\0w|Weeks
|
||
|
|
.\"\0m|Months
|
||
|
|
.\"\0y|Years
|
||
|
|
.\".TE
|
||
|
|
.\".PP
|
||
|
|
.\".
|
||
|
|
.TS
|
||
|
|
allbox center tab(|);
|
||
|
|
lb c c c c
|
||
|
|
lb l l l l .
|
||
|
|
\0Date Unit|S|M|H|d|w|m|y
|
||
|
|
\0Description|Seconds|Minutes|Hours|Days|Weeks|Months|Years
|
||
|
|
.TE
|
||
|
|
.PP
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
\fBExample\fP: To select any messages two weeks around January 15, 2001, you'd
|
||
|
|
use the following pattern:
|
||
|
|
.
|
||
|
|
.IP
|
||
|
|
Limit to messages matching:
|
||
|
|
.IR \fB~d\fP\~15 / 1 / 2001 \fB*\fP 2 \fBw\fP
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
It is possible to give multiple error margins:
|
||
|
|
.
|
||
|
|
.IP
|
||
|
|
which cumulate:
|
||
|
|
.IR \fB~d\fP\~1 / 1 / 2001 \fB-\fP 1 \fBw+\fP 2 \fBw*\fP 3 \fBd\fP
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
.B Relative Dates
|
||
|
|
.fi
|
||
|
|
This type of date is relative to the current date, and may be specified as:
|
||
|
|
.
|
||
|
|
.RS
|
||
|
|
.TP 4
|
||
|
|
\(bu \(lq\fB<\fP\fIoffset\fP\(rq for messages newer than \fIoffset\fP units
|
||
|
|
.TQ
|
||
|
|
\(bu \(lq\fB=\fP\fIoffset\fP\(rq for messages exactly \fIoffset\fP units old
|
||
|
|
.TQ
|
||
|
|
\(bu \(lq\fB>\fP\fIoffset\fP\(rq for messages older than \fIoffset\fP units
|
||
|
|
.RE
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
\fIoffset\fP is specified as a positive number with one of the units from table
|
||
|
|
\(lq\fBDate units\fP\(rq.
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
\fBExample\fP: To select messages less than 1 month old, you would use:
|
||
|
|
.
|
||
|
|
.IP
|
||
|
|
Limit to messages matching:
|
||
|
|
.BI ~d\~< 1 m
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
\fBNote\fP: All dates used when searching are relative to the \fBlocal\fP time
|
||
|
|
zone, so unless you change the setting of your $index_format to include
|
||
|
|
a \(lq\fB%[...]\fP\(rq format, these are \fBnot\fP the dates shown in the main
|
||
|
|
index.
|
||
|
|
.
|
||
|
|
.\" --------------------------------------------------------------------
|
||
|
|
.SH CONFIGURATION VARIABLES
|
||
|
|
.\" --------------------------------------------------------------------
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B abort_backspace
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, hitting backspace against an empty prompt aborts the
|
||
|
|
prompt.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B abort_key
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "007"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies the key that can be used to abort prompts. The format is the
|
||
|
|
same as used in "bind" commands. The default is equivalent to "\\G".
|
||
|
|
Note that the specified key should not be used in other bindings, as the
|
||
|
|
abort operation has higher precedence and the binding will not have the
|
||
|
|
desired effect.
|
||
|
|
.IP
|
||
|
|
Example:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set abort_key = "<Esc>"
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
Please note that when using <Esc> as the abort key, you may also want to
|
||
|
|
set the environment variable ESCDELAY to a low value or even 0 which will
|
||
|
|
reduce the time that ncurses waits to distinguish singular <Esc> key
|
||
|
|
presses from the start of a terminal escape sequence. The default time is
|
||
|
|
1000 milliseconds and thus quite noticeable.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B abort_noattach
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If set to \fIyes\fP, when composing messages containing the regular
|
||
|
|
expression specified by $abort_noattach_regex and no attachments are
|
||
|
|
given, composition will be aborted. If set to \fIno\fP, composing messages
|
||
|
|
as such will never be aborted.
|
||
|
|
.IP
|
||
|
|
Example:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set abort_noattach_regex = "\\\\<attach(|ed|ments?)\\\\>"
|
||
|
|
|
||
|
|
.EE
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B abort_noattach_regex
|
||
|
|
.nf
|
||
|
|
Type: regular expression
|
||
|
|
Default: "\\<(attach|attached|attachments?)\\>"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies a regular expression to match against the body of the message, to
|
||
|
|
determine if an attachment was mentioned but mistakenly forgotten. If it
|
||
|
|
matches, $abort_noattach will be consulted to determine if message sending
|
||
|
|
will be aborted.
|
||
|
|
.IP
|
||
|
|
Like other regular expressions in NeoMutt, the search is case sensitive
|
||
|
|
if the pattern contains at least one upper case letter, and case
|
||
|
|
insensitive otherwise.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B abort_nosubject
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: ask\-yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If set to \fIyes\fP, when composing messages and no subject is given
|
||
|
|
at the subject prompt, composition will be aborted. If set to
|
||
|
|
\fIno\fP, composing messages with no subject given at the subject
|
||
|
|
prompt will never be aborted.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B abort_unmodified
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If set to \fIyes\fP, composition will automatically abort after
|
||
|
|
editing the message body if no changes are made to the file (this
|
||
|
|
check only happens after the \fIfirst\fP edit of the file). When set
|
||
|
|
to \fIno\fP, composition will never be aborted.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B alias_file
|
||
|
|
.nf
|
||
|
|
Type: path
|
||
|
|
Default: "~/.neomuttrc"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The default file in which to save aliases created by the
|
||
|
|
\fC<create-alias>\fP function. Entries added to this file are
|
||
|
|
encoded in the character set specified by $config_charset if it
|
||
|
|
is \fIset\fP or the current character set otherwise.
|
||
|
|
.IP
|
||
|
|
\fBNote:\fP NeoMutt will not automatically source this file; you must
|
||
|
|
explicitly use the "source" command for it to be executed in case
|
||
|
|
this option points to a dedicated alias file.
|
||
|
|
.IP
|
||
|
|
The default for this option is the currently used neomuttrc file, or
|
||
|
|
"~/.neomuttrc" if no user neomuttrc was found.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B alias_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "%3n %f%t %\-15a %\-56r | %c"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies the format of the data displayed for the "alias" menu. The
|
||
|
|
following \fCprintf(3)\fP\-style sequences are available:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
%a
|
||
|
|
Alias name
|
||
|
|
.TP
|
||
|
|
%c
|
||
|
|
Comment
|
||
|
|
.TP
|
||
|
|
%f
|
||
|
|
Flags \- currently, a "d" for an alias marked for deletion
|
||
|
|
.TP
|
||
|
|
%n
|
||
|
|
Index number
|
||
|
|
.TP
|
||
|
|
%r
|
||
|
|
Address which alias expands to
|
||
|
|
.TP
|
||
|
|
%t
|
||
|
|
Character which indicates if the alias is tagged for inclusion
|
||
|
|
.TP
|
||
|
|
%>X
|
||
|
|
right justify the rest of the string and pad with character "X"
|
||
|
|
.TP
|
||
|
|
%|X
|
||
|
|
pad to the end of the line with character "X"
|
||
|
|
.TP
|
||
|
|
%*X
|
||
|
|
soft\-fill with character "X" as pad
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B allow_8bit
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether 8\-bit data is converted to 7\-bit using either Quoted\-
|
||
|
|
Printable or Base64 encoding when sending mail.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B allow_ansi
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether ANSI color codes in messages (and color tags in
|
||
|
|
rich text messages) are to be interpreted.
|
||
|
|
Messages containing these codes are rare, but if this option is \fIset\fP,
|
||
|
|
their text will be colored accordingly. Note that this may override
|
||
|
|
your color choices, and even present a security problem, since a
|
||
|
|
message could include a line like
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
[\-\- PGP output follows ...
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
and give it the same color as your attachment color (see also
|
||
|
|
$crypt_timestamp).
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B arrow_cursor
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, an arrow ("\->") will be used to indicate the current entry
|
||
|
|
in menus instead of highlighting the whole line. On slow network or modem
|
||
|
|
links this will make response faster because there is less that has to
|
||
|
|
be redrawn on the screen when moving to the next or previous entries
|
||
|
|
in the menu.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B arrow_string
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "\->"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies the string of arrow_cursor when arrow_cursor enabled.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ascii_chars
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, NeoMutt will use plain ASCII characters when displaying thread
|
||
|
|
and attachment trees, instead of the default \fIACS\fP characters.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ask_follow_up
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If set, NeoMutt will prompt you for follow\-up groups before editing
|
||
|
|
the body of an outgoing message.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ask_x_comment_to
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If set, NeoMutt will prompt you for x\-comment\-to field before editing
|
||
|
|
the body of an outgoing message.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B askbcc
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, NeoMutt will prompt you for blind\-carbon\-copy (Bcc) recipients
|
||
|
|
before editing an outgoing message.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B askcc
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, NeoMutt will prompt you for carbon\-copy (Cc) recipients before
|
||
|
|
editing the body of an outgoing message.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B assumed_charset
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable is a colon\-separated list of character encoding
|
||
|
|
schemes for messages without character encoding indication.
|
||
|
|
Header field values and message body content without character encoding
|
||
|
|
indication would be assumed that they are written in one of this list.
|
||
|
|
By default, all the header fields and message body without any charset
|
||
|
|
indication are assumed to be in "us\-ascii".
|
||
|
|
.IP
|
||
|
|
For example, Japanese users might prefer this:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set assumed_charset="iso\-2022\-jp:euc\-jp:shift_jis:utf\-8"
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
However, only the first content is valid for the message body.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B attach_charset
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
If \fIunset\fP, the value of $charset will be used instead.
|
||
|
|
For example, the following configuration would work for Japanese
|
||
|
|
text handling:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set attach_charset="iso\-2022\-jp:euc\-jp:shift_jis:utf\-8"
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
Note: for Japanese users, "iso\-2022\-*" must be put at the head
|
||
|
|
of the value as shown above if included.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B attach_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] "
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable describes the format of the "attachment" menu. The
|
||
|
|
following \fCprintf(3)\fP\-style sequences are understood:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
%C
|
||
|
|
Charset
|
||
|
|
.TP
|
||
|
|
%c
|
||
|
|
Requires charset conversion ("n" or "c")
|
||
|
|
.TP
|
||
|
|
%D
|
||
|
|
Deleted flag
|
||
|
|
.TP
|
||
|
|
%d
|
||
|
|
Description (if none, falls back to %F)
|
||
|
|
.TP
|
||
|
|
%e
|
||
|
|
MIME content\-transfer\-encoding
|
||
|
|
.TP
|
||
|
|
%f
|
||
|
|
Filename
|
||
|
|
.TP
|
||
|
|
%F
|
||
|
|
Filename in content\-disposition header (if none, falls back to %f)
|
||
|
|
.TP
|
||
|
|
%I
|
||
|
|
Disposition ("I" for inline, "A" for attachment)
|
||
|
|
.TP
|
||
|
|
%m
|
||
|
|
Major MIME type
|
||
|
|
.TP
|
||
|
|
%M
|
||
|
|
MIME subtype
|
||
|
|
.TP
|
||
|
|
%n
|
||
|
|
Attachment number
|
||
|
|
.TP
|
||
|
|
%Q
|
||
|
|
"Q", if MIME part qualifies for attachment counting
|
||
|
|
.TP
|
||
|
|
%s
|
||
|
|
Size (see formatstrings-size)
|
||
|
|
.TP
|
||
|
|
%T
|
||
|
|
Graphic tree characters
|
||
|
|
.TP
|
||
|
|
%t
|
||
|
|
Tagged flag
|
||
|
|
.TP
|
||
|
|
%u
|
||
|
|
Unlink (=to delete) flag
|
||
|
|
.TP
|
||
|
|
%X
|
||
|
|
Number of qualifying MIME parts in this part and its children
|
||
|
|
(please see the "attachments" section for possible speed effects)
|
||
|
|
.TP
|
||
|
|
%>X
|
||
|
|
Right justify the rest of the string and pad with character "X"
|
||
|
|
.TP
|
||
|
|
%|X
|
||
|
|
Pad to the end of the line with character "X"
|
||
|
|
.TP
|
||
|
|
%*X
|
||
|
|
Soft\-fill with character "X" as pad
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
For an explanation of "soft\-fill", see the $index_format documentation.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B attach_save_dir
|
||
|
|
.nf
|
||
|
|
Type: path
|
||
|
|
Default: "./"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The directory where attachments are saved.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B attach_save_without_prompting
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable, when set to true, will cause attachments to be saved to
|
||
|
|
the 'attach_save_dir' location without prompting the user for the filename.
|
||
|
|
.IP
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B attach_sep
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "\\n"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The separator to add between attachments when operating (saving,
|
||
|
|
printing, piping, etc) on a list of tagged attachments.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B attach_split
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If this variable is \fIunset\fP, when operating (saving, printing, piping,
|
||
|
|
etc) on a list of tagged attachments, NeoMutt will concatenate the
|
||
|
|
attachments and will operate on them as a single attachment. The
|
||
|
|
$attach_sep separator is added after each attachment. When \fIset\fP,
|
||
|
|
NeoMutt will operate on the attachments one by one.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B attribution
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "On %d, %n wrote:"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This is the string that will precede a message which has been included
|
||
|
|
in a reply. For a full listing of defined \fCprintf(3)\fP\-like sequences see
|
||
|
|
the section on $index_format.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B attribution_locale
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The locale used by \fCstrftime(3)\fP to format dates in the
|
||
|
|
attribution string. Legal values are the strings your system
|
||
|
|
accepts for the locale environment variable \fC$LC_TIME\fP.
|
||
|
|
.IP
|
||
|
|
This variable is to allow the attribution date format to be
|
||
|
|
customized by recipient or folder using hooks. By default, NeoMutt
|
||
|
|
will use your locale environment, so there is no need to set
|
||
|
|
this except to override that default.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B auto_subscribe
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt assumes the presence of a List\-Post header
|
||
|
|
means the recipient is subscribed to the list. Unless the mailing list
|
||
|
|
is in the "unsubscribe" or "unlist" lists, it will be added
|
||
|
|
to the "subscribe" list. Parsing and checking these things slows
|
||
|
|
header reading down, so this option is disabled by default.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B auto_tag
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, functions in the \fIindex\fP menu which affect a message
|
||
|
|
will be applied to all tagged messages (if there are any). When
|
||
|
|
unset, you must first use the \fC<tag\-prefix>\fP function (bound to ";"
|
||
|
|
by default) to make the next function apply to all tagged messages.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B autocrypt
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, enables autocrypt, which provides
|
||
|
|
passive encryption protection with keys exchanged via headers.
|
||
|
|
See "autocryptdoc" for more details.
|
||
|
|
(Autocrypt only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B autocrypt_acct_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "%4n %\-30a %20p %10s"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable describes the format of the "autocrypt account" menu.
|
||
|
|
The following \fCprintf(3)\fP\-style sequences are understood
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
%a
|
||
|
|
email address
|
||
|
|
.TP
|
||
|
|
%k
|
||
|
|
gpg keyid
|
||
|
|
.TP
|
||
|
|
%n
|
||
|
|
current entry number
|
||
|
|
.TP
|
||
|
|
%p
|
||
|
|
prefer\-encrypt flag
|
||
|
|
.TP
|
||
|
|
%s
|
||
|
|
status flag (active/inactive)
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
(Autocrypt only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B autocrypt_dir
|
||
|
|
.nf
|
||
|
|
Type: path
|
||
|
|
Default: "~/.mutt/autocrypt"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable sets where autocrypt files are stored, including the GPG
|
||
|
|
keyring and SQLite database. See "autocryptdoc" for more details.
|
||
|
|
(Autocrypt only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B autocrypt_reply
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, replying to an autocrypt email automatically
|
||
|
|
enables autocrypt in the reply. You may want to unset this if you're using
|
||
|
|
the same key for autocrypt as normal web\-of\-trust, so that autocrypt
|
||
|
|
isn't forced on for all encrypted replies.
|
||
|
|
(Autocrypt only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B autoedit
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP along with $edit_headers, NeoMutt will skip the initial
|
||
|
|
send\-menu (prompting for subject and recipients) and allow you to
|
||
|
|
immediately begin editing the body of your
|
||
|
|
message. The send\-menu may still be accessed once you have finished
|
||
|
|
editing the body of your message.
|
||
|
|
.IP
|
||
|
|
\fBNote:\fP when this option is \fIset\fP, 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.
|
||
|
|
.IP
|
||
|
|
Also see $fast_reply.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B beep
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When this variable is \fIset\fP, NeoMutt will beep when an error occurs.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B beep_new
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When this variable is \fIset\fP, NeoMutt will beep whenever it prints a message
|
||
|
|
notifying you of new mail. This is independent of the setting of the
|
||
|
|
$beep variable.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B bounce
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: ask\-yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether you will be asked to confirm bouncing messages.
|
||
|
|
If set to \fIyes\fP you don't get asked if you want to bounce a
|
||
|
|
message. Setting this variable to \fIno\fP is not generally useful,
|
||
|
|
and thus not recommended, because you are unable to bounce messages.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B bounce_delivered
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When this variable is \fIset\fP, NeoMutt will include Delivered\-To headers when
|
||
|
|
bouncing messages. Postfix users may wish to \fIunset\fP this variable.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B braille_friendly
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When this variable is \fIset\fP, NeoMutt will place the cursor at the beginning
|
||
|
|
of the current line in menus, even when the $arrow_cursor variable
|
||
|
|
is \fIunset\fP, making it easier for blind persons using Braille displays to
|
||
|
|
follow these menus. The option is \fIunset\fP by default because many
|
||
|
|
visual terminals don't permit making the cursor invisible.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B browser_abbreviate_mailboxes
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When this variable is \fIset\fP, NeoMutt will abbreviate mailbox
|
||
|
|
names in the browser mailbox list, using '~' and '='
|
||
|
|
shortcuts.
|
||
|
|
.IP
|
||
|
|
The default \fC"alpha"\fP setting of $sort_browser uses
|
||
|
|
locale\-based sorting (using \fCstrcoll(3)\fP), 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 \fIunset\fP this variable.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B catchup_newsgroup
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: ask\-yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If this variable is \fIset\fP, NeoMutt will mark all articles in newsgroup
|
||
|
|
as read when you quit the newsgroup (catchup newsgroup).
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B certificate_file
|
||
|
|
.nf
|
||
|
|
Type: path
|
||
|
|
Default: "~/.mutt_certificates"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies the file where the certificates you trust
|
||
|
|
are saved. When an unknown certificate is encountered, you are asked
|
||
|
|
if you accept it or not. If you accept it, the certificate can also
|
||
|
|
be saved in this file and further connections are automatically
|
||
|
|
accepted.
|
||
|
|
.IP
|
||
|
|
You can also manually add CA certificates in this file. Any server
|
||
|
|
certificate that is signed with one of these CA certificates is
|
||
|
|
also automatically accepted.
|
||
|
|
.IP
|
||
|
|
Example:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set certificate_file=~/.neomutt/certificates
|
||
|
|
|
||
|
|
.EE
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B change_folder_next
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When this variable is \fIset\fP, the \fC<change\-folder>\fP function
|
||
|
|
mailbox suggestion will start at the next folder in your "mailboxes"
|
||
|
|
list, instead of starting at the first folder in the list.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B charset
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Character set your terminal uses to display and enter textual data.
|
||
|
|
It is also the fallback for $send_charset.
|
||
|
|
.IP
|
||
|
|
Upon startup NeoMutt tries to derive this value from environment variables
|
||
|
|
such as \fC$LC_CTYPE\fP or \fC$LANG\fP.
|
||
|
|
.IP
|
||
|
|
\fBNote:\fP It should only be set in case NeoMutt isn't able to determine the
|
||
|
|
character set used correctly.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B check_mbox_size
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When this variable is \fIset\fP, NeoMutt will use file size attribute instead of
|
||
|
|
access time when checking for new mail in mbox and mmdf folders.
|
||
|
|
.IP
|
||
|
|
This variable is \fIunset\fP by default and should only be enabled when
|
||
|
|
new mail detection for these folder types is unreliable or doesn't work.
|
||
|
|
.IP
|
||
|
|
Note that enabling this variable should happen before any "mailboxes"
|
||
|
|
directives occur in configuration files regarding mbox or mmdf folders
|
||
|
|
because NeoMutt needs to determine the initial new mail status of such a
|
||
|
|
mailbox by performing a fast mailbox scan when it is defined.
|
||
|
|
Afterwards the new mail status is tracked by file size changes.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B check_new
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
\fBNote:\fP this option only affects \fImaildir\fP and \fIMH\fP style
|
||
|
|
mailboxes.
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will check for new mail delivered while the
|
||
|
|
mailbox is open. Especially with MH mailboxes, this operation can
|
||
|
|
take quite some time since it involves scanning the directory and
|
||
|
|
checking each file to see if it has already been looked at. If
|
||
|
|
this variable is \fIunset\fP, no check for new mail is performed
|
||
|
|
while the mailbox is open.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B collapse_all
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will collapse all threads when entering a folder.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B collapse_flagged
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIunset\fP, NeoMutt will not collapse a thread if it contains any
|
||
|
|
flagged messages.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B collapse_unread
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIunset\fP, NeoMutt will not collapse a thread if it contains any
|
||
|
|
unread messages.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B compose_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "\-\- NeoMutt: Compose [Approx. msg size: %l Atts: %a]%>\-"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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 \fCprintf(3)\fP\-like sequences:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
%a
|
||
|
|
Total number of attachments
|
||
|
|
.TP
|
||
|
|
%h
|
||
|
|
Local hostname
|
||
|
|
.TP
|
||
|
|
%l
|
||
|
|
Approximate size (in bytes) of the current message (see formatstrings-size)
|
||
|
|
.TP
|
||
|
|
%v
|
||
|
|
NeoMutt version string
|
||
|
|
.TP
|
||
|
|
%>X
|
||
|
|
right justify the rest of the string and pad with character "X"
|
||
|
|
.TP
|
||
|
|
%|X
|
||
|
|
pad to the end of the line with character "X"
|
||
|
|
.TP
|
||
|
|
%*X
|
||
|
|
soft\-fill with character "X" as pad
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
See the text describing the $status_format option for more
|
||
|
|
information on how to set $compose_format.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B compose_show_user_headers
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, Neomutt will display user\-defined headers (set via my_hdr
|
||
|
|
or from editing with edit\-headers).
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B config_charset
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When defined, NeoMutt will recode commands in rc files from this
|
||
|
|
encoding to the current character set as specified by $charset
|
||
|
|
and aliases written to $alias_file from the current character set.
|
||
|
|
.IP
|
||
|
|
Please note that if setting $charset it must be done before
|
||
|
|
setting $config_charset.
|
||
|
|
.IP
|
||
|
|
Recoding should be avoided as it may render unconvertable
|
||
|
|
characters as question marks which can lead to undesired
|
||
|
|
side effects (for example in regular expressions).
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B confirmappend
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will prompt for confirmation when appending messages to
|
||
|
|
an existing mailbox.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B confirmcreate
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will prompt for confirmation when saving messages to a
|
||
|
|
mailbox which does not yet exist before creating it.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B connect_timeout
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 30
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Causes NeoMutt to timeout a network connection (for IMAP, POP or SMTP) after this
|
||
|
|
many seconds if the connection is not able to be established. A negative
|
||
|
|
value causes NeoMutt to wait indefinitely for the connection attempt to succeed.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B content_type
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "text/plain"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Sets the default Content\-Type for the body of newly composed messages.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B copy
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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 "fcc-hook".
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B copy_decode_weed
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether NeoMutt will weed headers when invoking the
|
||
|
|
\fC<decode\-copy>\fP or \fC<decode\-save>\fP functions.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B count_alternatives
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, Mutt will recurse inside multipart/alternatives while
|
||
|
|
performing attachment searching and counting(see attachments).
|
||
|
|
.IP
|
||
|
|
Traditionally, multipart/alternative parts have simply represented
|
||
|
|
different encodings of the main content of the email. Unfortunately,
|
||
|
|
some mail clients have started to place email attachments inside
|
||
|
|
one of alternatives. Setting this will allow Mutt to find
|
||
|
|
and count matching attachments hidden there, and include them
|
||
|
|
in the index via %X or through ~X pattern matching.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_autoencrypt
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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 \fIset\fP,
|
||
|
|
then OpenSSL is used instead to create S/MIME messages and
|
||
|
|
settings can be overridden by use of the smime menu instead.
|
||
|
|
(Crypto only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_autopgp
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls whether or not NeoMutt may automatically enable
|
||
|
|
PGP encryption/signing for messages. See also $crypt_autoencrypt,
|
||
|
|
$crypt_replyencrypt,
|
||
|
|
$crypt_autosign, $crypt_replysign and $smime_is_default.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_autosign
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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 \fIset\fP,
|
||
|
|
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)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_autosmime
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls whether or not NeoMutt may automatically enable
|
||
|
|
S/MIME encryption/signing for messages. See also $crypt_autoencrypt,
|
||
|
|
$crypt_replyencrypt,
|
||
|
|
$crypt_autosign, $crypt_replysign and $smime_is_default.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_chars
|
||
|
|
.nf
|
||
|
|
Type: character string
|
||
|
|
Default: "SPsK "
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls the characters used in cryptography flags.
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
\fBCharacter\fP
|
||
|
|
\fBDefault\fP
|
||
|
|
\fBDescription\fP
|
||
|
|
.TP
|
||
|
|
1
|
||
|
|
S
|
||
|
|
The mail is signed, and the signature is successfully verified.
|
||
|
|
.TP
|
||
|
|
2
|
||
|
|
P
|
||
|
|
The mail is PGP encrypted.
|
||
|
|
.TP
|
||
|
|
3
|
||
|
|
s
|
||
|
|
The mail is signed.
|
||
|
|
.TP
|
||
|
|
4
|
||
|
|
K
|
||
|
|
The mail contains a PGP public key.
|
||
|
|
.TP
|
||
|
|
5
|
||
|
|
<space>
|
||
|
|
The mail has no crypto info.
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_confirmhook
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If set, then you will be prompted for confirmation of keys when using
|
||
|
|
the \fIcrypt\-hook\fP command. If unset, no such confirmation prompt will
|
||
|
|
be presented. This is generally considered unsafe, especially where
|
||
|
|
typos are concerned.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_opportunistic_encrypt
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Setting this variable will cause NeoMutt to automatically enable and
|
||
|
|
disable encryption, based on whether all message recipient keys
|
||
|
|
can be located by NeoMutt.
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
If $crypt_autoencrypt or $crypt_replyencrypt enable encryption for
|
||
|
|
a message, this option will be disabled for that message. It can
|
||
|
|
be manually re\-enabled in the pgp or smime menus.
|
||
|
|
(Crypto only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_opportunistic_encrypt_strong_keys
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When set, this modifies the behavior of $crypt_opportunistic_encrypt
|
||
|
|
to only search for "strong keys", that is, keys with full validity
|
||
|
|
according to the web\-of\-trust algorithm. A key with marginal or no
|
||
|
|
validity will not enable opportunistic encryption.
|
||
|
|
.IP
|
||
|
|
For S/MIME, the behavior depends on the backend. Classic S/MIME will
|
||
|
|
filter for certificates with the 't'(trusted) flag in the .index file.
|
||
|
|
The GPGME backend will use the same filters as with OpenPGP, and depends
|
||
|
|
on GPGME's logic for assigning the GPGME_VALIDITY_FULL and
|
||
|
|
GPGME_VALIDITY_ULTIMATE validity flag.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_protected_headers_read
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When set, NeoMutt will display protected headers ("Memory Hole") in the pager,
|
||
|
|
When set, NeoMutt will display protected headers in the pager,
|
||
|
|
and will update the index and header cache with revised headers.
|
||
|
|
.IP
|
||
|
|
Protected headers are stored inside the encrypted or signed part of an
|
||
|
|
an email, to prevent disclosure or tampering.
|
||
|
|
For more information see https://github.com/autocrypt/protected\-headers
|
||
|
|
Currently NeoMutt only supports the Subject header.
|
||
|
|
.IP
|
||
|
|
Encrypted messages using protected headers often substitute the exposed
|
||
|
|
Subject header with a dummy value (see $crypt_protected_headers_subject).
|
||
|
|
NeoMutt will update its concept of the correct subject \fBafter\fP the
|
||
|
|
message is opened, i.e. via the \fC<display\-message>\fP function.
|
||
|
|
If you reply to a message before opening it, NeoMutt will end up using
|
||
|
|
the dummy Subject header, so be sure to open such a message first.
|
||
|
|
(Crypto only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_protected_headers_save
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When $crypt_protected_headers_read is set, and a message with a
|
||
|
|
protected Subject is opened, NeoMutt will save the updated Subject
|
||
|
|
into the header cache by default. This allows searching/limiting
|
||
|
|
based on the protected Subject header if the mailbox is
|
||
|
|
re\-opened, without having to re\-open the message each time.
|
||
|
|
However, for mbox/mh mailbox types, or if header caching is not
|
||
|
|
set up, you would need to re\-open the message each time the
|
||
|
|
mailbox was reopened before you could see or search/limit on the
|
||
|
|
protected subject again.
|
||
|
|
.IP
|
||
|
|
When this variable is set, NeoMutt additionally saves the protected
|
||
|
|
Subject back \fBin the clear\-text message headers\fP. This
|
||
|
|
provides better usability, but with the tradeoff of reduced
|
||
|
|
security. The protected Subject header, which may have
|
||
|
|
previously been encrypted, is now stored in clear\-text in the
|
||
|
|
message headers. Copying the message elsewhere, via NeoMutt or
|
||
|
|
external tools, could expose this previously encrypted data.
|
||
|
|
Please make sure you understand the consequences of this before
|
||
|
|
you enable this variable.
|
||
|
|
(Crypto only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_protected_headers_subject
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "..."
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When $crypt_protected_headers_write is set, and the message is marked
|
||
|
|
for encryption, this will be substituted into the Subject field in the
|
||
|
|
message headers.
|
||
|
|
.IP
|
||
|
|
To prevent a subject from being substituted, unset this variable, or set it
|
||
|
|
to the empty string.
|
||
|
|
(Crypto only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_protected_headers_write
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When set, NeoMutt will generate protected headers for signed and encrypted
|
||
|
|
emails.
|
||
|
|
.IP
|
||
|
|
Protected headers are stored inside the encrypted or signed part of an
|
||
|
|
an email, to prevent disclosure or tampering.
|
||
|
|
For more information see https://github.com/autocrypt/protected\-headers
|
||
|
|
.IP
|
||
|
|
Currently NeoMutt only supports the Subject header.
|
||
|
|
(Crypto only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_replyencrypt
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, automatically PGP or OpenSSL encrypt replies to messages which are
|
||
|
|
encrypted.
|
||
|
|
(Crypto only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_replysign
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, automatically PGP or OpenSSL sign replies to messages which are
|
||
|
|
signed.
|
||
|
|
.IP
|
||
|
|
\fBNote:\fP this does not work on messages that are encrypted
|
||
|
|
\fIand\fP signed!
|
||
|
|
(Crypto only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_replysignencrypted
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, automatically PGP or OpenSSL sign replies to messages
|
||
|
|
which are encrypted. This makes sense in combination with
|
||
|
|
$crypt_replyencrypt, because it allows you to sign all
|
||
|
|
messages which are automatically encrypted. This works around
|
||
|
|
the problem noted in $crypt_replysign, that NeoMutt is not able
|
||
|
|
to find out whether an encrypted message is also signed.
|
||
|
|
(Crypto only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_timestamp
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, NeoMutt will include a time stamp in the lines surrounding
|
||
|
|
PGP or S/MIME output, so spoofing such lines is more difficult.
|
||
|
|
If you are using colors to mark these lines, and rely on these,
|
||
|
|
you may \fIunset\fP this setting.
|
||
|
|
(Crypto only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_use_gpgme
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls the use of the GPGME\-enabled crypto backends.
|
||
|
|
If it is \fIset\fP and NeoMutt was built with GPGME support, the gpgme code for
|
||
|
|
S/MIME and PGP will be used instead of the classic code. Note that
|
||
|
|
you need to set this option in .neomuttrc; it won't have any effect when
|
||
|
|
used interactively.
|
||
|
|
.IP
|
||
|
|
Note that the GPGME backend does not support creating old\-style inline
|
||
|
|
(traditional) PGP encrypted or signed messages (see $pgp_autoinline).
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_use_pka
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether NeoMutt uses PKA
|
||
|
|
(see http://www.g10code.de/docs/pka\-intro.de.pdf) during signature
|
||
|
|
verification (only supported by the GPGME backend).
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B crypt_verify_sig
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fI"yes"\fP, always attempt to verify PGP or S/MIME signatures.
|
||
|
|
If \fI"ask\-*"\fP, ask whether or not to verify the signature.
|
||
|
|
If \fI"no"\fP, never attempt to verify cryptographic signatures.
|
||
|
|
(Crypto only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B date_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "!%a, %b %d, %Y at %I:%M:%S%p %Z"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls the format of the date printed by the "%d"
|
||
|
|
sequence in $index_format. This is passed to the \fCstrftime(3)\fP
|
||
|
|
function to process the date, see the man page for the proper syntax.
|
||
|
|
.IP
|
||
|
|
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 \fIC\fP locale (that is in US
|
||
|
|
English).
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B debug_file
|
||
|
|
.nf
|
||
|
|
Type: path
|
||
|
|
Default: "~/.neomuttdebug"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Debug logging is controlled by the variables \fC$debug_file\fP and \fC$debug_level\fP.
|
||
|
|
\fC$debug_file\fP 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).
|
||
|
|
.IP
|
||
|
|
This option can be enabled on the command line, "neomutt \-l mylog"
|
||
|
|
.IP
|
||
|
|
See also: \fC$debug_level\fP
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B debug_level
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 0
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Debug logging is controlled by the variables \fC$debug_file\fP and \fC$debug_level\fP.
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
Warning: Logging at high levels may save private information to the file.
|
||
|
|
.IP
|
||
|
|
This option can be enabled on the command line, "neomutt \-d 2"
|
||
|
|
.IP
|
||
|
|
See also: \fC$debug_file\fP
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B default_hook
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "~f %s !~P | (~P ~C %s)"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls how "message-hook", "reply-hook", "send-hook",
|
||
|
|
"send2-hook", "save-hook", and "fcc-hook" will
|
||
|
|
be interpreted if they are specified with only a simple regex,
|
||
|
|
instead of a matching pattern. The hooks are expanded when they are
|
||
|
|
declared, so a hook will be interpreted according to the value of this
|
||
|
|
variable at the time the hook is declared.
|
||
|
|
.IP
|
||
|
|
The default value matches
|
||
|
|
if the message is either from a user matching the regular expression
|
||
|
|
given, or if it is from you (if the from address matches
|
||
|
|
"alternates") and is to or cc'ed to a user matching the given
|
||
|
|
regular expression.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B delete
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: ask\-yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether or not messages are really deleted when closing or
|
||
|
|
synchronizing a mailbox. If set to \fIyes\fP, messages marked for
|
||
|
|
deleting will automatically be purged without prompting. If set to
|
||
|
|
\fIno\fP, messages marked for deletion will be kept in the mailbox.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B delete_untag
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If this option is \fIset\fP, NeoMutt will untag messages when marking them
|
||
|
|
for deletion. This applies when you either explicitly delete a message,
|
||
|
|
or when you save it to another folder.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B digest_collapse
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If this option is \fIset\fP, NeoMutt's received\-attachments menu will not show the subparts of
|
||
|
|
individual messages in a multipart/digest. To see these subparts, press "v" on that menu.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B display_filter
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
When preparing the message, NeoMutt inserts some escape sequences into the
|
||
|
|
text. They are of the form: \fC<esc>]9;XXX<bel>\fP where "XXX" is a random
|
||
|
|
64\-bit number.
|
||
|
|
.IP
|
||
|
|
If these escape sequences interfere with your filter, they can be removed
|
||
|
|
using a tool like \fCansifilter\fP or \fCsed 's/^\\x1b]9;[0\-9]\\+\\x7//'\fP
|
||
|
|
.IP
|
||
|
|
If they are removed, then PGP and MIME headers will no longer be coloured.
|
||
|
|
This can be fixed by adding this to your config:
|
||
|
|
\fCcolor body magenta default '^\\[\-\- .* \-\-\\]$'\fP.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B dsn_notify
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable sets the request for when notification is returned. The
|
||
|
|
string consists of a comma separated list (no spaces!) of one or more
|
||
|
|
of the following: \fInever\fP, to never request notification,
|
||
|
|
\fIfailure\fP, to request notification on transmission failure,
|
||
|
|
\fIdelay\fP, to be notified of message delays, \fIsuccess\fP, to be
|
||
|
|
notified of successful transmission.
|
||
|
|
.IP
|
||
|
|
Example:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set dsn_notify="failure,delay"
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
\fBNote:\fP when using $sendmail for delivery, you should not enable
|
||
|
|
this unless you are either using Sendmail 8.8.x or greater or a MTA
|
||
|
|
providing a \fCsendmail(1)\fP\-compatible interface supporting the \fC\-N\fP 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.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B dsn_return
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls how much of your message is returned in DSN
|
||
|
|
messages. It may be set to either \fIhdrs\fP to return just the
|
||
|
|
message header, or \fIfull\fP to return the full message.
|
||
|
|
.IP
|
||
|
|
Example:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set dsn_return=hdrs
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
\fBNote:\fP when using $sendmail for delivery, you should not enable
|
||
|
|
this unless you are either using Sendmail 8.8.x or greater or a MTA
|
||
|
|
providing a \fCsendmail(1)\fP\-compatible interface supporting the \fC\-R\fP 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.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B duplicate_threads
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls whether NeoMutt, when $sort is set to \fIthreads\fP, threads
|
||
|
|
messages with the same Message\-Id together. If it is \fIset\fP, it will indicate
|
||
|
|
that it thinks they are duplicates of each other with an equals sign
|
||
|
|
in the thread tree.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B edit_headers
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This option allows you to edit the header of your outgoing messages
|
||
|
|
along with the body of your message.
|
||
|
|
.IP
|
||
|
|
Although the compose menu may have localized header labels, the
|
||
|
|
labels passed to your editor will be standard RFC2822 headers,
|
||
|
|
(e.g. To:, Cc:, Subject:). Headers added in your editor must
|
||
|
|
also be RFC2822 headers, or one of the pseudo headers listed in
|
||
|
|
"edit-header". NeoMutt will not understand localized header
|
||
|
|
labels, just as it would not when parsing an actual email.
|
||
|
|
.IP
|
||
|
|
\fBNote\fP that changes made to the References: and Date: headers are
|
||
|
|
ignored for interoperability reasons.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B editor
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: "vi"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies which editor is used by NeoMutt.
|
||
|
|
It defaults to the value of the \fC$VISUAL\fP, or \fC$EDITOR\fP, environment
|
||
|
|
variable, or to the string "vi" if neither of those are set.
|
||
|
|
.IP
|
||
|
|
The \fC$editor\fP string may contain a \fI%s\fP escape, which will be replaced by the name
|
||
|
|
of the file to be edited. If the \fI%s\fP escape does not appear in \fC$editor\fP, a
|
||
|
|
space and the name to be edited are appended.
|
||
|
|
.IP
|
||
|
|
The resulting string is then executed by running
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
sh \-c 'string'
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
where \fIstring\fP is the expansion of \fC$editor\fP described above.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B empty_subject
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "Re: your mail"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies the subject to be used when replying to an email
|
||
|
|
with an empty subject. It defaults to "Re: your mail".
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B encode_from
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will quoted\-printable encode messages when
|
||
|
|
they contain the string "From " (note the trailing space) in the beginning of a line.
|
||
|
|
This is useful to avoid the tampering certain mail delivery and transport
|
||
|
|
agents tend to do with messages (in order to prevent tools from
|
||
|
|
misinterpreting the line as a mbox message separator).
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B entropy_file
|
||
|
|
.nf
|
||
|
|
Type: path
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The file which includes random data that is used to initialize SSL
|
||
|
|
library functions.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B envelope_from_address
|
||
|
|
.nf
|
||
|
|
Type: e-mail address
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Manually sets the \fIenvelope\fP sender for outgoing messages.
|
||
|
|
This value is ignored if $use_envelope_from is \fIunset\fP.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B external_search_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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).
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
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 \fIone\-liner\fP.)
|
||
|
|
.IP
|
||
|
|
Now if NeoMutt gets a limit or tag command followed by the pattern
|
||
|
|
"~I '\-t s:bleeping='", mairix_filter runs mairix with the
|
||
|
|
arguments from inside the quotes (the quotes are needed because
|
||
|
|
of the space after "\-t"), mairix finds all messages with
|
||
|
|
"bleeping" in the Subject plus all messages sharing threads
|
||
|
|
with these and outputs their file names, and mairix_filter
|
||
|
|
translates the file names into Message\-IDs. Finally, NeoMutt
|
||
|
|
reads the Message\-IDs and targets the matching messages with the
|
||
|
|
command given to it.
|
||
|
|
.IP
|
||
|
|
You, the user, still have to rewrite the mairix_filter script to
|
||
|
|
match the behavior of your indexer, but this should help users
|
||
|
|
of indexers other than notmuch to integrate them cleanly with NeoMutt.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B fast_reply
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, the initial prompt for recipients and subject are skipped
|
||
|
|
when replying to messages, and the initial prompt for subject is
|
||
|
|
skipped when forwarding messages.
|
||
|
|
.IP
|
||
|
|
\fBNote:\fP this variable has no effect when the $autoedit
|
||
|
|
variable is \fIset\fP.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B fcc_attach
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls whether or not attachments on outgoing messages
|
||
|
|
are saved along with the main body of your message.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B fcc_before_send
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When this variable is \fIset\fP, 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).
|
||
|
|
.IP
|
||
|
|
When \fIunset\fP, 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.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B fcc_clear
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When this variable is \fIset\fP, FCCs will be stored unencrypted and
|
||
|
|
unsigned, even when the actual message is encrypted and/or
|
||
|
|
signed.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B flag_chars
|
||
|
|
.nf
|
||
|
|
Type: character string
|
||
|
|
Default: "*!DdrONon\- "
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls the characters used in several flags.
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
\fBCharacter\fP
|
||
|
|
\fBDefault\fP
|
||
|
|
\fBDescription\fP
|
||
|
|
.TP
|
||
|
|
1
|
||
|
|
*
|
||
|
|
The mail is tagged.
|
||
|
|
.TP
|
||
|
|
2
|
||
|
|
!
|
||
|
|
The mail is flagged as important.
|
||
|
|
.TP
|
||
|
|
3
|
||
|
|
D
|
||
|
|
The mail is marked for deletion.
|
||
|
|
.TP
|
||
|
|
4
|
||
|
|
d
|
||
|
|
The mail has attachments marked for deletion.
|
||
|
|
.TP
|
||
|
|
5
|
||
|
|
r
|
||
|
|
The mail has been replied to.
|
||
|
|
.TP
|
||
|
|
6
|
||
|
|
O
|
||
|
|
The mail is Old (Unread but seen).
|
||
|
|
.TP
|
||
|
|
7
|
||
|
|
N
|
||
|
|
The mail is New (Unread but not seen).
|
||
|
|
.TP
|
||
|
|
8
|
||
|
|
o
|
||
|
|
The mail thread is Old (Unread but seen).
|
||
|
|
.TP
|
||
|
|
9
|
||
|
|
n
|
||
|
|
The mail thread is New (Unread but not seen).
|
||
|
|
.TP
|
||
|
|
10
|
||
|
|
\-
|
||
|
|
The mail is read \- %S expando.
|
||
|
|
.TP
|
||
|
|
11
|
||
|
|
<space>
|
||
|
|
The mail is read \- %Z expando.
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B flag_safe
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If set, flagged messages can't be deleted.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B folder
|
||
|
|
.nf
|
||
|
|
Type: mailbox
|
||
|
|
Default: "~/Mail"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies the default location of your mailboxes. A "+" or "=" at the
|
||
|
|
beginning of a pathname will be expanded to the value of this
|
||
|
|
variable. Note that if you change this variable (from the default)
|
||
|
|
value you need to make sure that the assignment occurs \fIbefore\fP
|
||
|
|
you use "+" or "=" for any other variables since expansion takes place
|
||
|
|
when handling the "mailboxes" command.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B folder_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "%2C %t %N %F %2l %\-8.8u %\-8.8g %8s %d %i"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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 \fCprintf(3)\fP\-like sequences:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
%C
|
||
|
|
|
||
|
|
Current file number
|
||
|
|
.TP
|
||
|
|
%d
|
||
|
|
|
||
|
|
Date/time folder was last modified
|
||
|
|
.TP
|
||
|
|
%D
|
||
|
|
|
||
|
|
Date/time folder was last modified using $date_format.
|
||
|
|
.TP
|
||
|
|
%f
|
||
|
|
|
||
|
|
Filename ("/" is appended to directory names,
|
||
|
|
"@" to symbolic links and "*" to executable files)
|
||
|
|
.TP
|
||
|
|
%F
|
||
|
|
|
||
|
|
File permissions
|
||
|
|
.TP
|
||
|
|
%g
|
||
|
|
|
||
|
|
Group name (or numeric gid, if missing)
|
||
|
|
.TP
|
||
|
|
%i
|
||
|
|
|
||
|
|
Description of the folder
|
||
|
|
.TP
|
||
|
|
%l
|
||
|
|
|
||
|
|
Number of hard links
|
||
|
|
.TP
|
||
|
|
%m
|
||
|
|
*
|
||
|
|
Number of messages in the mailbox
|
||
|
|
.TP
|
||
|
|
%n
|
||
|
|
*
|
||
|
|
Number of unread messages in the mailbox
|
||
|
|
.TP
|
||
|
|
%N
|
||
|
|
|
||
|
|
"N" if mailbox has new mail, blank otherwise
|
||
|
|
.TP
|
||
|
|
%s
|
||
|
|
|
||
|
|
Size in bytes (see formatstrings-size)
|
||
|
|
.TP
|
||
|
|
%t
|
||
|
|
|
||
|
|
"*" if the file is tagged, blank otherwise
|
||
|
|
.TP
|
||
|
|
%u
|
||
|
|
|
||
|
|
Owner name (or numeric uid, if missing)
|
||
|
|
.TP
|
||
|
|
%>X
|
||
|
|
|
||
|
|
Right justify the rest of the string and pad with character "X"
|
||
|
|
.TP
|
||
|
|
%|X
|
||
|
|
|
||
|
|
Pad to the end of the line with character "X"
|
||
|
|
.TP
|
||
|
|
%*X
|
||
|
|
|
||
|
|
Soft\-fill with character "X" as pad
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
For an explanation of "soft\-fill", see the $index_format documentation.
|
||
|
|
.IP
|
||
|
|
* = can be optionally printed if nonzero
|
||
|
|
.IP
|
||
|
|
%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).
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B followup_to
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether or not the "Mail\-Followup\-To:" header field is
|
||
|
|
generated when sending mail. When \fIset\fP, NeoMutt will generate this
|
||
|
|
field when you are replying to a known mailing list, specified with
|
||
|
|
the "subscribe" or "lists" commands.
|
||
|
|
.IP
|
||
|
|
This field has two purposes. First, preventing you from
|
||
|
|
receiving duplicate copies of replies to messages which you send
|
||
|
|
to mailing lists, and second, ensuring that you do get a reply
|
||
|
|
separately for any messages sent to known lists to which you are
|
||
|
|
not subscribed.
|
||
|
|
.IP
|
||
|
|
The header will contain only the list's address
|
||
|
|
for subscribed lists, and both the list address and your own
|
||
|
|
email address for unsubscribed lists. Without this header, a
|
||
|
|
group reply to your message sent to a subscribed list will be
|
||
|
|
sent to both the list and your address, resulting in two copies
|
||
|
|
of the same email for you.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B followup_to_poster
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: ask\-yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If this variable is \fIset\fP and the keyword "poster" is present in
|
||
|
|
\fIFollowup\-To\fP header, follow\-up to newsgroup function is not
|
||
|
|
permitted. The message will be mailed to the submitter of the
|
||
|
|
message via mail.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B force_name
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This 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.
|
||
|
|
.IP
|
||
|
|
Also see the $record variable.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B forward_attachments
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: ask\-yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When forwarding inline (i.e. $mime_forward \fIunset\fP or
|
||
|
|
answered with "no" and $forward_decode \fIset\fP), attachments
|
||
|
|
which cannot be decoded in a reasonable manner will be attached
|
||
|
|
to the newly composed message if this quadoption is \fIset\fP or
|
||
|
|
answered with "yes".
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B forward_attribution_intro
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "\-\-\-\-\- Forwarded message from %f \-\-\-\-\-"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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 \fCprintf(3)\fP\-like sequences see
|
||
|
|
the section on $index_format. See also $attribution_locale.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B forward_attribution_trailer
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "\-\-\-\-\- End forwarded message \-\-\-\-\-"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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 \fCprintf(3)\fP\-like sequences see
|
||
|
|
the section on $index_format. See also $attribution_locale.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B forward_decode
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls the decoding of complex MIME messages into \fCtext/plain\fP when
|
||
|
|
forwarding a message. The message header is also RFC2047 decoded.
|
||
|
|
This variable is only used, if $mime_forward is \fIunset\fP,
|
||
|
|
otherwise $mime_forward_decode is used instead.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B forward_decrypt
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls the handling of encrypted messages when forwarding a message.
|
||
|
|
When \fIset\fP, the outer layer of encryption is stripped off. This
|
||
|
|
variable is only used if $mime_forward is \fIset\fP and
|
||
|
|
$mime_forward_decode is \fIunset\fP.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B forward_edit
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This quadoption controls whether or not the user is automatically
|
||
|
|
placed in the editor when forwarding messages. For those who always want
|
||
|
|
to forward with no modification, use a setting of "no".
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B forward_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "[%a: %s]"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls the default subject when forwarding a message.
|
||
|
|
It uses the same format sequences as the $index_format variable.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B forward_quote
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, forwarded messages included in the main body of the
|
||
|
|
message (when $mime_forward is \fIunset\fP) will be quoted using
|
||
|
|
$indent_string.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B forward_references
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, forwarded messages set the "In\-Reply\-To:" and
|
||
|
|
"References:" headers in the same way as normal replies would. Hence the
|
||
|
|
forwarded message becomes part of the original thread instead of starting
|
||
|
|
a new one.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B from
|
||
|
|
.nf
|
||
|
|
Type: e-mail address
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, 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 \fIunset\fP.
|
||
|
|
.IP
|
||
|
|
If not specified, then it may be read from the environment variable \fC$EMAIL\fP.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B from_chars
|
||
|
|
.nf
|
||
|
|
Type: character string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls the character used to prefix the %F and %L fields in the
|
||
|
|
index.
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
\fBCharacter\fP
|
||
|
|
\fBDescription\fP
|
||
|
|
.TP
|
||
|
|
1
|
||
|
|
Mail is written by you and has a To address, or has a known mailing list in the To address.
|
||
|
|
.TP
|
||
|
|
2
|
||
|
|
Mail is written by you and has a Cc address, or has a known mailing list in the Cc address.
|
||
|
|
.TP
|
||
|
|
3
|
||
|
|
Mail is written by you and has a Bcc address.
|
||
|
|
.TP
|
||
|
|
4
|
||
|
|
All remaining cases.
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
If this is empty or unset (default), the traditional long "To ",
|
||
|
|
"Cc " and "Bcc " prefixes are used. If set but too short to
|
||
|
|
include a character for a particular case, a single space will be
|
||
|
|
prepended to the field. To prevent any prefix at all from being
|
||
|
|
added in a particular case, use the special value CR (aka ^M)
|
||
|
|
for the corresponding character.
|
||
|
|
.IP
|
||
|
|
This slightly odd interface is necessitated by NeoMutt's handling of
|
||
|
|
string variables; one can't tell a variable that is unset from one
|
||
|
|
that is set to the empty string.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B gecos_mask
|
||
|
|
.nf
|
||
|
|
Type: regular expression
|
||
|
|
Default: "^[^,]*"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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 "\fC.*\fP".
|
||
|
|
.IP
|
||
|
|
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".
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B group_index_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "%4C %M%N %5s %\-45.45f %d"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
%C
|
||
|
|
Current newsgroup number
|
||
|
|
.TP
|
||
|
|
%d
|
||
|
|
Description of newsgroup (becomes from server)
|
||
|
|
.TP
|
||
|
|
%f
|
||
|
|
Newsgroup name
|
||
|
|
.TP
|
||
|
|
%M
|
||
|
|
\- if newsgroup not allowed for direct post (moderated for example)
|
||
|
|
.TP
|
||
|
|
%N
|
||
|
|
N if newsgroup is new, u if unsubscribed, blank otherwise
|
||
|
|
.TP
|
||
|
|
%n
|
||
|
|
Number of new articles in newsgroup
|
||
|
|
.TP
|
||
|
|
%s
|
||
|
|
Number of unread articles in newsgroup
|
||
|
|
.TP
|
||
|
|
%>X
|
||
|
|
Right justify the rest of the string and pad with character "X"
|
||
|
|
.TP
|
||
|
|
%|X
|
||
|
|
Pad to the end of the line with character "X"
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B hdrs
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIunset\fP, the header fields normally added by the "my_hdr"
|
||
|
|
command are not created. This variable \fImust\fP be unset before
|
||
|
|
composing a new message or replying in order to take effect. If \fIset\fP,
|
||
|
|
the user defined header fields are added to every new message.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B header
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, this variable causes NeoMutt to include the header
|
||
|
|
of the message you are replying to into the edit buffer.
|
||
|
|
The $weed setting applies.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B header_cache
|
||
|
|
.nf
|
||
|
|
Type: path
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable points to the header cache database. If the path points to
|
||
|
|
an existing directory, NeoMutt will create a dedicated header cache
|
||
|
|
database per folder. Otherwise, the path points to a regular file, which
|
||
|
|
will be created as needed and used as a shared global header cache for
|
||
|
|
all folders.
|
||
|
|
By default it is \fIunset\fP so no header caching will be used.
|
||
|
|
.IP
|
||
|
|
Header caching can greatly improve speed when opening POP, IMAP
|
||
|
|
MH or Maildir folders, see "caching" for details.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B header_cache_backend
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies the header cache backend. By default it is
|
||
|
|
\fIunset\fP so no header caching will be used.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B header_cache_compress_level
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 1
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When NeoMutt is compiled with lz4, zstd or zlib, this option can be used
|
||
|
|
to setup the compression level.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B header_cache_compress_method
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When NeoMutt is compiled with lz4, zstd or zlib, the header cache backend
|
||
|
|
can use these compression methods for compressing the cache files.
|
||
|
|
This results in much smaller cache file sizes and may even improve speed.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B header_color_partial
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, color header regexes behave like color body regexes:
|
||
|
|
color is applied to the exact text matched by the regex. When
|
||
|
|
\fIunset\fP, color is applied to the entire header.
|
||
|
|
.IP
|
||
|
|
One use of this option might be to apply color to just the header labels.
|
||
|
|
.IP
|
||
|
|
See "color" for more details.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B help
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, help lines describing the bindings for the major functions
|
||
|
|
provided by each menu are displayed on the first line of the screen.
|
||
|
|
.IP
|
||
|
|
\fBNote:\fP The binding will not be displayed correctly if the
|
||
|
|
function is bound to a sequence rather than a single keystroke. Also,
|
||
|
|
the help line may not be updated if a binding is changed while NeoMutt is
|
||
|
|
running. Since this variable is primarily aimed at new users, neither
|
||
|
|
of these should present a major problem.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B hidden_host
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will skip the host name part of $hostname variable
|
||
|
|
when adding the domain part to addresses. This variable does not
|
||
|
|
affect the generation of Message\-IDs, and it will not lead to the
|
||
|
|
cut\-off of first\-level domains.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B hidden_tags
|
||
|
|
.nf
|
||
|
|
Type: string list
|
||
|
|
Default: "unread,draft,flagged,passed,replied,attachment,signed,encrypted"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies private notmuch/imap tags which should not be printed
|
||
|
|
on screen.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B hide_limited
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will not show the presence of messages that are hidden
|
||
|
|
by limiting, in the thread tree.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B hide_missing
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will not show the presence of missing messages in the
|
||
|
|
thread tree.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B hide_thread_subject
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will not show the subject of messages in the thread
|
||
|
|
tree that have the same subject as their parent or closest previously
|
||
|
|
displayed sibling.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B hide_top_limited
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, 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 \fIset\fP, this option will have no effect.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B hide_top_missing
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will not show the presence of missing messages at the
|
||
|
|
top of threads in the thread tree. Note that when $hide_missing is
|
||
|
|
\fIset\fP, this option will have no effect.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B history
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 10
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B history_file
|
||
|
|
.nf
|
||
|
|
Type: path
|
||
|
|
Default: "~/.mutthistory"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The file in which NeoMutt will save its history.
|
||
|
|
.IP
|
||
|
|
Also see $save_history.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B history_remove_dups
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, 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.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B honor_disposition
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will not display attachments with a
|
||
|
|
disposition of "attachment" inline even if it could
|
||
|
|
render the part to plain text. These MIME parts can only
|
||
|
|
be viewed from the attachment menu.
|
||
|
|
.IP
|
||
|
|
If \fIunset\fP, NeoMutt will render all MIME parts it can
|
||
|
|
properly transform to plain text.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B honor_followup_to
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls whether or not a Mail\-Followup\-To header is
|
||
|
|
honored when group\-replying to a message.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B hostname
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies the fully\-qualified hostname of the system NeoMutt is running on
|
||
|
|
containing the host's name and the DNS domain it belongs to. It is used
|
||
|
|
as the domain part (after "@") for local email addresses as well as
|
||
|
|
Message\-Id headers.
|
||
|
|
.IP
|
||
|
|
If not specified in a config file, then NeoMutt will try to determine the hostname itself.
|
||
|
|
.IP
|
||
|
|
Optionally, NeoMutt can be compiled with a fixed domain name.
|
||
|
|
.IP
|
||
|
|
Also see $use_domain and $hidden_host.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B idn_decode
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will show you international domain names decoded.
|
||
|
|
Note: You can use IDNs for addresses even if this is \fIunset\fP.
|
||
|
|
This variable only affects decoding. (IDN only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B idn_encode
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will encode international domain names using
|
||
|
|
IDN. Unset this if your SMTP server can handle newer (RFC6531)
|
||
|
|
UTF\-8 encoded domains. (IDN only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ignore_list_reply_to
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Affects the behavior of the \fC<reply>\fP function when replying to
|
||
|
|
messages from mailing lists (as defined by the "subscribe" or
|
||
|
|
"lists" commands). When \fIset\fP, if the "Reply\-To:" field is
|
||
|
|
set to the same value as the "To:" field, NeoMutt assumes that the
|
||
|
|
"Reply\-To:" field was set by the mailing list to automate responses
|
||
|
|
to the list, and will ignore this field. To direct a response to the
|
||
|
|
mailing list when this option is \fIset\fP, use the \fC<list-reply>\fP
|
||
|
|
function; \fC<group\-reply>\fP will reply to both the sender and the
|
||
|
|
list.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_authenticators
|
||
|
|
.nf
|
||
|
|
Type: string list
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This is a colon\-delimited list of authentication methods NeoMutt may
|
||
|
|
attempt to use to log in to an IMAP server, in the order NeoMutt should
|
||
|
|
try them. Authentication methods are either "login" or the right
|
||
|
|
side of an IMAP "AUTH=xxx" capability string, e.g. "digest\-md5", "gssapi"
|
||
|
|
or "cram\-md5". This option is case\-insensitive. If it's
|
||
|
|
\fIunset\fP (the default) NeoMutt will try all available methods,
|
||
|
|
in order from most\-secure to least\-secure.
|
||
|
|
.IP
|
||
|
|
Example:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set imap_authenticators="gssapi:cram\-md5:login"
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
\fBNote:\fP NeoMutt will only fall back to other authentication methods if
|
||
|
|
the previous methods are unavailable. If a method is available but
|
||
|
|
authentication fails, NeoMutt will not connect to the IMAP server.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_check_subscribed
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will fetch the set of subscribed folders from
|
||
|
|
your server whenever a mailbox is \fBselected\fP, and add them to the set
|
||
|
|
of mailboxes it polls for new mail just as if you had issued individual
|
||
|
|
"mailboxes" commands.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_condstore
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will use the CONDSTORE extension (RFC7162)
|
||
|
|
if advertised by the server. NeoMutt's current implementation is basic,
|
||
|
|
used only for initial message fetching and flag updates.
|
||
|
|
.IP
|
||
|
|
For some IMAP servers, enabling this will slightly speed up
|
||
|
|
downloading initial messages. Unfortunately, Gmail is not one
|
||
|
|
those, and displays worse performance when enabled. Your
|
||
|
|
mileage may vary.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_deflate
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will use the COMPRESS=DEFLATE extension (RFC4978)
|
||
|
|
if advertised by the server.
|
||
|
|
.IP
|
||
|
|
In general a good compression efficiency can be achieved, which
|
||
|
|
speeds up reading large mailboxes also on fairly good connections.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_delim_chars
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "/."
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This contains the list of characters that NeoMutt will use as folder
|
||
|
|
separators for IMAP paths, when no separator is provided on the IMAP
|
||
|
|
connection.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_fetch_chunk_size
|
||
|
|
.nf
|
||
|
|
Type: number (long)
|
||
|
|
Default: 0
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When set to a value greater than 0, new headers will be
|
||
|
|
downloaded in groups of this many headers per request. If you
|
||
|
|
have a very large mailbox, this might prevent a timeout and
|
||
|
|
disconnect when opening the mailbox, by sending a FETCH per set
|
||
|
|
of this many headers, instead of a single FETCH for all new
|
||
|
|
headers.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_headers
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
NeoMutt requests these header fields in addition to the default headers
|
||
|
|
("Date:", "From:", "Sender:", "Subject:", "To:", "Cc:", "Message\-Id:",
|
||
|
|
"References:", "Content\-Type:", "Content\-Description:", "In\-Reply\-To:",
|
||
|
|
"Reply\-To:", "Lines:", "List\-Post:", "X\-Label:") from IMAP
|
||
|
|
servers before displaying the index menu. You may want to add more
|
||
|
|
headers for spam detection.
|
||
|
|
.IP
|
||
|
|
\fBNote:\fP This is a space separated list, items should be uppercase
|
||
|
|
and not contain the colon, e.g. "X\-BOGOSITY X\-SPAM\-STATUS" for the
|
||
|
|
"X\-Bogosity:" and "X\-Spam\-Status:" header fields.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_idle
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will attempt to use the IMAP IDLE extension
|
||
|
|
to check for new mail in the current mailbox. Some servers
|
||
|
|
(dovecot was the inspiration for this option) react badly
|
||
|
|
to NeoMutt's implementation. If your connection seems to freeze
|
||
|
|
up periodically, try unsetting this.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_keepalive
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 300
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies the maximum amount of time in seconds that NeoMutt
|
||
|
|
will wait before polling open IMAP connections, to prevent the server
|
||
|
|
from closing them before NeoMutt has finished with them. The default is
|
||
|
|
well within the RFC\-specified minimum amount of time (30 minutes) before
|
||
|
|
a server is allowed to do this, but in practice the RFC does get
|
||
|
|
violated every now and then. Reduce this number if you find yourself
|
||
|
|
getting disconnected from your IMAP server due to inactivity.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_list_subscribed
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable configures whether IMAP folder browsing will look for
|
||
|
|
only subscribed folders or all folders. This can be toggled in the
|
||
|
|
IMAP browser with the \fC<toggle\-subscribed>\fP function.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_login
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Your login name on the IMAP server.
|
||
|
|
.IP
|
||
|
|
This variable defaults to the value of $imap_user.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_oauth_refresh_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The command to run to generate an OAUTH refresh token for
|
||
|
|
authorizing your connection to your IMAP server. This command will be
|
||
|
|
run on every connection attempt that uses the OAUTHBEARER authentication
|
||
|
|
mechanism. See "oauth" for details.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_pass
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies the password for your IMAP account. If \fIunset\fP, NeoMutt will
|
||
|
|
prompt you for your password when you invoke the \fC<imap\-fetch\-mail>\fP function
|
||
|
|
or try to open an IMAP folder.
|
||
|
|
.IP
|
||
|
|
\fBWarning\fP: you should only use this option when you are on a
|
||
|
|
fairly secure machine, because the superuser can read your neomuttrc even
|
||
|
|
if you are the only one who can read the file.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_passive
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will not open new IMAP connections to check for new
|
||
|
|
mail. NeoMutt will only check for new mail over existing IMAP
|
||
|
|
connections. This is useful if you don't want to be prompted for
|
||
|
|
user/password pairs on NeoMutt invocation, or if opening the connection
|
||
|
|
is slow.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_peek
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will avoid implicitly marking your mail as read whenever
|
||
|
|
you fetch a message from the server. This is generally a good thing,
|
||
|
|
but can make closing an IMAP folder somewhat slower. This option
|
||
|
|
exists to appease speed freaks.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_pipeline_depth
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 15
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls the number of IMAP commands that may be queued up before they
|
||
|
|
are sent to the server. A deeper pipeline reduces the amount of time
|
||
|
|
NeoMutt must wait for the server, and can make IMAP servers feel much
|
||
|
|
more responsive. But not all servers correctly handle pipelined commands,
|
||
|
|
so if you have problems you might want to try setting this variable to 0.
|
||
|
|
.IP
|
||
|
|
\fBNote:\fP Changes to this variable have no effect on open connections.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_poll_timeout
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 15
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies the maximum amount of time in seconds
|
||
|
|
that NeoMutt will wait for a response when polling IMAP connections
|
||
|
|
for new mail, before timing out and closing the connection. Set
|
||
|
|
to 0 to disable timing out.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_qresync
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will use the QRESYNC extension (RFC7162)
|
||
|
|
if advertised by the server. NeoMutt's current implementation is basic,
|
||
|
|
used only for initial message fetching and flag updates.
|
||
|
|
.IP
|
||
|
|
Note: this feature is currently experimental. If you experience
|
||
|
|
strange behavior, such as duplicate or missing messages please
|
||
|
|
file a bug report to let us know.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_rfc5161
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will use the IMAP ENABLE extension (RFC5161) to
|
||
|
|
select CAPABILITIES. Some servers (notably Coremail System IMap Server) do
|
||
|
|
not properly respond to ENABLE commands, which might cause NeoMutt to hang.
|
||
|
|
If your connection seems to freeze at login, try unsetting this. See also
|
||
|
|
https://github.com/neomutt/neomutt/issues/1689
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_servernoise
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will display warning messages from the IMAP
|
||
|
|
server as error messages. Since these messages are often
|
||
|
|
harmless, or generated due to configuration problems on the
|
||
|
|
server which are out of the users' hands, you may wish to suppress
|
||
|
|
them at some point.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B imap_user
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The name of the user whose mail you intend to access on the IMAP
|
||
|
|
server.
|
||
|
|
.IP
|
||
|
|
This variable defaults to your user name on the local machine.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B implicit_autoview
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If set to "yes", NeoMutt will look for a mailcap entry with the
|
||
|
|
"\fCcopiousoutput\fP" flag set for \fIevery\fP MIME attachment it doesn't have
|
||
|
|
an internal viewer defined for. If such an entry is found, NeoMutt will
|
||
|
|
use the viewer defined in that entry to convert the body part to text
|
||
|
|
form.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B include
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: ask\-yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether or not a copy of the message(s) you are replying to
|
||
|
|
is included in your reply.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B include_encrypted
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether or not NeoMutt includes separately encrypted attachment
|
||
|
|
contents when replying.
|
||
|
|
.IP
|
||
|
|
This variable was added to prevent accidental exposure of encrypted
|
||
|
|
contents when replying to an attacker. If a previously encrypted message
|
||
|
|
were attached by the attacker, they could trick an unwary recipient into
|
||
|
|
decrypting and including the message in their reply.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B include_onlyfirst
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether or not NeoMutt includes only the first attachment
|
||
|
|
of the message you are replying.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B indent_string
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "> "
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
The value of this option is ignored if $text_flowed is set, because
|
||
|
|
the quoting mechanism is strictly defined for format=flowed.
|
||
|
|
.IP
|
||
|
|
This option is a format string, please see the description of
|
||
|
|
$index_format for supported \fCprintf(3)\fP\-style sequences.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B index_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "%4C %Z %{%b %d} %\-15.15L (%?l?%4l&%4c?) %s"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable allows you to customize the message index display to
|
||
|
|
your personal taste.
|
||
|
|
.IP
|
||
|
|
"Format strings" are similar to the strings used in the C
|
||
|
|
function \fCprintf(3)\fP 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:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
%a
|
||
|
|
Address of the author
|
||
|
|
.TP
|
||
|
|
%A
|
||
|
|
Reply\-to address (if present; otherwise: address of author)
|
||
|
|
.TP
|
||
|
|
%b
|
||
|
|
Filename of the original message folder (think mailbox)
|
||
|
|
.TP
|
||
|
|
%B
|
||
|
|
The list to which the letter was sent, or else the folder name (%b).
|
||
|
|
.TP
|
||
|
|
%C
|
||
|
|
Current message number
|
||
|
|
.TP
|
||
|
|
%c
|
||
|
|
Number of characters (bytes) in the body of the message (see formatstrings-size)
|
||
|
|
.TP
|
||
|
|
%cr
|
||
|
|
Number of characters (bytes) in the raw message, including the header (see formatstrings-size)
|
||
|
|
.TP
|
||
|
|
%D
|
||
|
|
Date and time of message using date_format and local timezone
|
||
|
|
.TP
|
||
|
|
%d
|
||
|
|
Date and time of message using date_format and sender's timezone
|
||
|
|
.TP
|
||
|
|
%e
|
||
|
|
Current message number in thread
|
||
|
|
.TP
|
||
|
|
%E
|
||
|
|
Number of messages in current thread
|
||
|
|
.TP
|
||
|
|
%F
|
||
|
|
Author name, or recipient name if the message is from you
|
||
|
|
.TP
|
||
|
|
%Fp
|
||
|
|
Like %F, but plain. No contextual formatting is applied to recipient name
|
||
|
|
.TP
|
||
|
|
%f
|
||
|
|
Sender (address + real name), either From: or Return\-Path:
|
||
|
|
.TP
|
||
|
|
%g
|
||
|
|
Newsgroup name (if compiled with NNTP support)
|
||
|
|
.TP
|
||
|
|
%g
|
||
|
|
Message tags (e.g. notmuch tags/imap flags)
|
||
|
|
.TP
|
||
|
|
%Gx
|
||
|
|
Individual message tag (e.g. notmuch tags/imap flags)
|
||
|
|
.TP
|
||
|
|
%H
|
||
|
|
Spam attribute(s) of this message
|
||
|
|
.TP
|
||
|
|
%I
|
||
|
|
Initials of author
|
||
|
|
.TP
|
||
|
|
%i
|
||
|
|
Message\-id of the current message
|
||
|
|
.TP
|
||
|
|
%J
|
||
|
|
Message tags (if present, tree unfolded, and != parent's tags)
|
||
|
|
.TP
|
||
|
|
%K
|
||
|
|
The list to which the letter was sent (if any; otherwise: empty)
|
||
|
|
.TP
|
||
|
|
%L
|
||
|
|
If an address in the "To:" or "Cc:" header field matches an address
|
||
|
|
Defined by the user's "subscribe" command, this displays
|
||
|
|
"To <list\-name>", otherwise the same as %F
|
||
|
|
.TP
|
||
|
|
%l
|
||
|
|
number of lines in the unprocessed message (may not work with
|
||
|
|
maildir, mh, and IMAP folders)
|
||
|
|
.TP
|
||
|
|
%M
|
||
|
|
Number of hidden messages if the thread is collapsed
|
||
|
|
.TP
|
||
|
|
%m
|
||
|
|
Total number of message in the mailbox
|
||
|
|
.TP
|
||
|
|
%N
|
||
|
|
Message score
|
||
|
|
.TP
|
||
|
|
%n
|
||
|
|
Author's real name (or address if missing)
|
||
|
|
.TP
|
||
|
|
%O
|
||
|
|
Original save folder where NeoMutt would formerly have
|
||
|
|
Stashed the message: list name or recipient name
|
||
|
|
If not sent to a list
|
||
|
|
.TP
|
||
|
|
%P
|
||
|
|
Progress indicator for the built\-in pager (how much of the file has been displayed)
|
||
|
|
.TP
|
||
|
|
%q
|
||
|
|
Newsgroup name (if compiled with NNTP support)
|
||
|
|
.TP
|
||
|
|
%R
|
||
|
|
Comma separated list of "Cc:" recipients
|
||
|
|
.TP
|
||
|
|
%r
|
||
|
|
Comma separated list of "To:" recipients
|
||
|
|
.TP
|
||
|
|
%S
|
||
|
|
Single character status of the message ("N"/"O"/"D"/"d"/"!"/"r"/"*")
|
||
|
|
.TP
|
||
|
|
%s
|
||
|
|
Subject of the message
|
||
|
|
.TP
|
||
|
|
%T
|
||
|
|
The appropriate character from the $to_chars string
|
||
|
|
.TP
|
||
|
|
%t
|
||
|
|
"To:" field (recipients)
|
||
|
|
.TP
|
||
|
|
%u
|
||
|
|
User (login) name of the author
|
||
|
|
.TP
|
||
|
|
%v
|
||
|
|
First name of the author, or the recipient if the message is from you
|
||
|
|
.TP
|
||
|
|
%W
|
||
|
|
Name of organization of author ("Organization:" field)
|
||
|
|
.TP
|
||
|
|
%x
|
||
|
|
"X\-Comment\-To:" field (if present and compiled with NNTP support)
|
||
|
|
.TP
|
||
|
|
%X
|
||
|
|
Number of MIME attachments
|
||
|
|
(please see the "attachments" section for possible speed effects)
|
||
|
|
.TP
|
||
|
|
%Y
|
||
|
|
"X\-Label:" field, if present, and \fI(1)\fP not at part of a thread tree,
|
||
|
|
\fI(2)\fP at the top of a thread, or \fI(3)\fP "X\-Label:" is different from
|
||
|
|
Preceding message's "X\-Label:"
|
||
|
|
.TP
|
||
|
|
%y
|
||
|
|
"X\-Label:" field, if present
|
||
|
|
.TP
|
||
|
|
%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.
|
||
|
|
.TP
|
||
|
|
%zc
|
||
|
|
Message crypto flags
|
||
|
|
.TP
|
||
|
|
%zs
|
||
|
|
Message status flags
|
||
|
|
.TP
|
||
|
|
%zt
|
||
|
|
Message tag flags
|
||
|
|
.TP
|
||
|
|
%@name@
|
||
|
|
insert and evaluate format\-string from the matching
|
||
|
|
"index-format-hook" command
|
||
|
|
.TP
|
||
|
|
%{fmt}
|
||
|
|
the date and time of the message is converted to sender's
|
||
|
|
time zone, and "fmt" is expanded by the library function
|
||
|
|
\fCstrftime(3)\fP; a leading bang disables locales
|
||
|
|
.TP
|
||
|
|
%[fmt]
|
||
|
|
the date and time of the message is converted to the local
|
||
|
|
time zone, and "fmt" is expanded by the library function
|
||
|
|
\fCstrftime(3)\fP; a leading bang disables locales
|
||
|
|
.TP
|
||
|
|
%(fmt)
|
||
|
|
the local date and time when the message was received.
|
||
|
|
"fmt" is expanded by the library function \fCstrftime(3)\fP;
|
||
|
|
a leading bang disables locales
|
||
|
|
.TP
|
||
|
|
%>X
|
||
|
|
right justify the rest of the string and pad with character "X"
|
||
|
|
.TP
|
||
|
|
%|X
|
||
|
|
pad to the end of the line with character "X"
|
||
|
|
.TP
|
||
|
|
%*X
|
||
|
|
soft\-fill with character "X" as pad
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
Date format expressions can be constructed based on relative dates. Using
|
||
|
|
the date formatting operators along with nested conditionals, the date
|
||
|
|
format can be modified based on how old a message is. See the section on
|
||
|
|
"Conditional Dates" for an explanation and examples
|
||
|
|
.IP
|
||
|
|
Note that for mbox/mmdf, "%l" applies to the unprocessed message, and
|
||
|
|
for maildir/mh, the value comes from the "Lines:" header field when
|
||
|
|
present (the meaning is normally the same). Thus the value depends on
|
||
|
|
the encodings used in the different parts of the message and has little
|
||
|
|
meaning in practice.
|
||
|
|
.IP
|
||
|
|
"Soft\-fill" deserves some explanation: Normal right\-justification
|
||
|
|
will print everything to the left of the "%>", displaying padding and
|
||
|
|
whatever lies to the right only if there's room. By contrast,
|
||
|
|
soft\-fill gives priority to the right\-hand side, guaranteeing space
|
||
|
|
to display it and showing padding only if there's still room. If
|
||
|
|
necessary, soft\-fill will eat text leftwards to make room for
|
||
|
|
rightward text.
|
||
|
|
.IP
|
||
|
|
Note that these expandos are supported in
|
||
|
|
"save-hook", "fcc-hook" and "fcc-save-hook", too.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B inews
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If set, specifies the program and arguments used to deliver news posted
|
||
|
|
by NeoMutt. Otherwise, NeoMutt posts article using current connection to
|
||
|
|
news server. The following printf\-style sequence is understood:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
%a
|
||
|
|
account url
|
||
|
|
.TP
|
||
|
|
%p
|
||
|
|
port
|
||
|
|
.TP
|
||
|
|
%P
|
||
|
|
port if specified
|
||
|
|
.TP
|
||
|
|
%s
|
||
|
|
news server name
|
||
|
|
.TP
|
||
|
|
%S
|
||
|
|
url schema
|
||
|
|
.TP
|
||
|
|
%u
|
||
|
|
username
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
Example:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set inews="/usr/local/bin/inews \-hS"
|
||
|
|
|
||
|
|
.EE
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ispell
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: "ispell"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
How to invoke ispell (GNU's spell\-checking software).
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B keep_flagged
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, read messages marked as flagged will not be moved
|
||
|
|
from your spool mailbox to your $mbox mailbox, or as a result of
|
||
|
|
a "mbox-hook" command.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mail_check
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 5
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable configures how often (in seconds) NeoMutt should look for
|
||
|
|
new mail. Also see the $timeout variable.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mail_check_recent
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will only notify you about new mail that has been received
|
||
|
|
since the last time you opened the mailbox. When \fIunset\fP, NeoMutt will notify you
|
||
|
|
if any new mail exists in the mailbox, regardless of whether you have visited it
|
||
|
|
recently.
|
||
|
|
.IP
|
||
|
|
When \fI$mark_old\fP is set, NeoMutt does not consider the mailbox to contain new
|
||
|
|
mail if only old messages exist.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mail_check_stats
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will periodically calculate message
|
||
|
|
statistics of a mailbox while polling for new mail. It will
|
||
|
|
check for unread, flagged, and total message counts. Because
|
||
|
|
this operation is more performance intensive, it defaults to
|
||
|
|
\fIunset\fP, and has a separate option, $mail_check_stats_interval, to
|
||
|
|
control how often to update these counts.
|
||
|
|
.IP
|
||
|
|
Message statistics can also be explicitly calculated by invoking the
|
||
|
|
\fC<check\-stats>\fP function.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mail_check_stats_interval
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 60
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When $mail_check_stats is \fIset\fP, this variable configures
|
||
|
|
how often (in seconds) NeoMutt will update message counts.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mailcap_path
|
||
|
|
.nf
|
||
|
|
Type: string list
|
||
|
|
Default: "~/.mailcap:/usr/share/neomutt/mailcap:/etc/mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies which 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.
|
||
|
|
.IP
|
||
|
|
$mailcap_path is overridden by the environment variable \fC$MAILCAPS\fP.
|
||
|
|
.IP
|
||
|
|
The default search path is from RFC1524.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mailcap_sanitize
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, NeoMutt will restrict possible characters in mailcap % expandos
|
||
|
|
to a well\-defined set of safe characters. This is the safe setting,
|
||
|
|
but we are not sure it doesn't break some more advanced MIME stuff.
|
||
|
|
.IP
|
||
|
|
\fBDON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE
|
||
|
|
DOING!\fP
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B maildir_check_cur
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, NeoMutt will poll both the new and cur directories of
|
||
|
|
a maildir folder for new messages. This might be useful if other
|
||
|
|
programs interacting with the folder (e.g. dovecot) are moving new
|
||
|
|
messages to the cur directory. Note that setting this option may
|
||
|
|
slow down polling for new messages in large folders, since NeoMutt has
|
||
|
|
to scan all cur messages.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B maildir_header_cache_verify
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Check for Maildir unaware programs other than NeoMutt having modified maildir
|
||
|
|
files when the header cache is in use. This incurs one \fCstat(2)\fP per
|
||
|
|
message every time the folder is opened (which can be very slow for NFS
|
||
|
|
folders).
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B maildir_trash
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, messages marked as deleted will be saved with the maildir
|
||
|
|
trashed flag instead of unlinked. \fBNote:\fP this only applies
|
||
|
|
to maildir\-style mailboxes. Setting it will have no effect on other
|
||
|
|
mailbox types.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mark_macro_prefix
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "'"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Prefix for macros created using mark\-message. A new macro
|
||
|
|
automatically generated with \fI<mark\-message>a\fP will be composed
|
||
|
|
from this prefix and the letter \fIa\fP.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mark_old
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether or not NeoMutt marks \fInew\fP \fBunread\fP
|
||
|
|
messages as \fIold\fP if you exit a mailbox without reading them.
|
||
|
|
With this option \fIset\fP, the next time you start NeoMutt, the messages
|
||
|
|
will show up with an "O" next to them in the index menu,
|
||
|
|
indicating that they are old.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B markers
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls the display of wrapped lines in the internal pager. If set, a
|
||
|
|
"+" marker is displayed at the beginning of wrapped lines.
|
||
|
|
.IP
|
||
|
|
Also see the $smart_wrap variable.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mask
|
||
|
|
.nf
|
||
|
|
Type: regular expression
|
||
|
|
Default: "!^\\.[^.]"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
A regular expression used in the file browser, optionally preceded by
|
||
|
|
the \fInot\fP operator "!". Only files whose names match this mask
|
||
|
|
will be shown. The match is always case\-sensitive.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mbox
|
||
|
|
.nf
|
||
|
|
Type: mailbox
|
||
|
|
Default: "~/mbox"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This specifies the folder into which read mail in your $spoolfile
|
||
|
|
folder will be appended.
|
||
|
|
.IP
|
||
|
|
Also see the $move variable.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mbox_type
|
||
|
|
.nf
|
||
|
|
Type: enumeration
|
||
|
|
Default: mbox
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The default mailbox type used when creating new folders. May be any of
|
||
|
|
"mbox", "MMDF", "MH" or "Maildir".
|
||
|
|
.IP
|
||
|
|
This can also be set using the \fC\-m\fP command\-line option.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B menu_context
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 0
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls the number of lines of context that are given
|
||
|
|
when scrolling through menus. (Similar to $pager_context.)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B menu_move_off
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIunset\fP, the bottom entry of menus will never scroll up past
|
||
|
|
the bottom of the screen, unless there are less entries than lines.
|
||
|
|
When \fIset\fP, the bottom entry may move off the bottom.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B menu_scroll
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, menus will be scrolled up or down one line when you
|
||
|
|
attempt to move across a screen boundary. If \fIunset\fP, the screen
|
||
|
|
is cleared and the next or previous page of the menu is displayed
|
||
|
|
(useful for slow links to avoid many redraws).
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B message_cache_clean
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, NeoMutt will clean out obsolete entries from the message cache when
|
||
|
|
the mailbox is synchronized. You probably only want to set it
|
||
|
|
every once in a while, since it can be a little slow
|
||
|
|
(especially for large folders).
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B message_cachedir
|
||
|
|
.nf
|
||
|
|
Type: path
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
Also see the $message_cache_clean variable.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B message_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "%s"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This is the string displayed in the "attachment" menu for
|
||
|
|
attachments of type \fCmessage/rfc822\fP. For a full listing of defined
|
||
|
|
\fCprintf(3)\fP\-like sequences see the section on $index_format.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B meta_key
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, forces NeoMutt to interpret keystrokes with the high bit (bit 8)
|
||
|
|
set as if the user had pressed the Esc key and whatever key remains
|
||
|
|
after having the high bit removed. For example, if the key pressed
|
||
|
|
has an ASCII value of \fC0xf8\fP, then this is treated as if the user had
|
||
|
|
pressed Esc then "x". This is because the result of removing the
|
||
|
|
high bit from \fC0xf8\fP is \fC0x78\fP, which is the ASCII character
|
||
|
|
"x".
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B metoo
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIunset\fP, NeoMutt will remove your address (see the "alternates"
|
||
|
|
command) from the list of recipients when replying to a message.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mh_purge
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIunset\fP, NeoMutt will mimic mh's behavior and rename deleted messages
|
||
|
|
to \fI,<old file name>\fP in mh folders instead of really deleting
|
||
|
|
them. This leaves the message on disk but makes programs reading the folder
|
||
|
|
ignore it. If the variable is \fIset\fP, the message files will simply be
|
||
|
|
deleted.
|
||
|
|
.IP
|
||
|
|
This option is similar to $maildir_trash for Maildir folders.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mh_seq_flagged
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "flagged"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The name of the MH sequence used for flagged messages.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mh_seq_replied
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "replied"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The name of the MH sequence used to tag replied messages.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mh_seq_unseen
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "unseen"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The name of the MH sequence used for unseen messages.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mime_forward
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, the message you are forwarding will be attached as a
|
||
|
|
separate \fCmessage/rfc822\fP MIME 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".
|
||
|
|
.IP
|
||
|
|
Also see $forward_decode and $mime_forward_decode.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mime_forward_decode
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls the decoding of complex MIME messages into \fCtext/plain\fP when
|
||
|
|
forwarding a message while $mime_forward is \fIset\fP. Otherwise
|
||
|
|
$forward_decode is used instead.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mime_forward_rest
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When forwarding multiple attachments of a MIME message from the attachment
|
||
|
|
menu, attachments which can't be decoded in a reasonable manner will
|
||
|
|
be attached to the newly composed message if this option is \fIset\fP.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mime_subject
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIunset\fP, 8\-bit "subject:" line in article header will not be
|
||
|
|
encoded according to RFC2047 to base64. This is useful when message
|
||
|
|
is Usenet article, because MIME for news is nonstandard feature.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mime_type_query_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
The command should output a single line containing the
|
||
|
|
attachment's mime type.
|
||
|
|
.IP
|
||
|
|
Suggested values are "xdg\-mime query filetype" or
|
||
|
|
"file \-bi".
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mime_type_query_first
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, the $mime_type_query_command will be run before the
|
||
|
|
mime.types lookup.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mix_entry_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "%4n %c %\-16s %a"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable describes the format of a remailer line on the mixmaster
|
||
|
|
chain selection screen. The following \fCprintf(3)\fP\-like sequences are
|
||
|
|
supported:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
%a
|
||
|
|
The remailer's e\-mail address
|
||
|
|
.TP
|
||
|
|
%c
|
||
|
|
Remailer capabilities
|
||
|
|
.TP
|
||
|
|
%n
|
||
|
|
The running number on the menu
|
||
|
|
.TP
|
||
|
|
%s
|
||
|
|
The remailer's short name
|
||
|
|
.TP
|
||
|
|
%>X
|
||
|
|
right justify the rest of the string and pad with character "X"
|
||
|
|
.TP
|
||
|
|
%|X
|
||
|
|
pad to the end of the line with character "X"
|
||
|
|
.TP
|
||
|
|
%*X
|
||
|
|
soft\-fill with character "X" as pad
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B mixmaster
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: "mixmaster"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable contains the path to the Mixmaster binary on your
|
||
|
|
system. It is used with various sets of parameters to gather the
|
||
|
|
list of known remailers, and to finally send a message through the
|
||
|
|
mixmaster chain.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B move
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether or not NeoMutt will move read messages
|
||
|
|
from your spool mailbox to your $mbox mailbox, or as a result of
|
||
|
|
a "mbox-hook" command.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B narrow_tree
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable, when \fIset\fP, makes the thread tree narrower, allowing
|
||
|
|
deeper threads to fit on the screen.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B net_inc
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 10
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Operations 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.
|
||
|
|
.IP
|
||
|
|
See also $read_inc, $write_inc and $net_inc.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B new_mail_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, 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.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B news_cache_dir
|
||
|
|
.nf
|
||
|
|
Type: path
|
||
|
|
Default: "~/.neomutt"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable pointing to directory where NeoMutt will save cached news
|
||
|
|
articles and headers in. If \fIunset\fP, articles and headers will not be
|
||
|
|
saved at all and will be reloaded from the server each time.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B news_server
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies domain name or address of NNTP server.
|
||
|
|
.IP
|
||
|
|
You can also specify username and an alternative port for each news server,
|
||
|
|
e.g. \fC[[s]news://][username[:password]@]server[:port]\fP
|
||
|
|
.IP
|
||
|
|
This option can also be set using the command line option "\-g", the
|
||
|
|
environment variable \fC$NNTPSERVER\fP, or putting the server name in the
|
||
|
|
file "/etc/nntpserver".
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B newsgroups_charset
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "utf\-8"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Character set of newsgroups descriptions.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B newsrc
|
||
|
|
.nf
|
||
|
|
Type: path
|
||
|
|
Default: "~/.newsrc"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The file, containing info about subscribed newsgroups \- names and
|
||
|
|
indexes of read articles. The following printf\-style sequence
|
||
|
|
is understood:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
\fBExpando\fP
|
||
|
|
\fBDescription\fP
|
||
|
|
\fBExample\fP
|
||
|
|
.TP
|
||
|
|
%a
|
||
|
|
Account url
|
||
|
|
\fCnews:news.gmane.org\fP
|
||
|
|
.TP
|
||
|
|
%p
|
||
|
|
Port
|
||
|
|
\fC119\fP
|
||
|
|
.TP
|
||
|
|
%P
|
||
|
|
Port if specified
|
||
|
|
\fC10119\fP
|
||
|
|
.TP
|
||
|
|
%s
|
||
|
|
News server name
|
||
|
|
\fCnews.gmane.org\fP
|
||
|
|
.TP
|
||
|
|
%S
|
||
|
|
Url schema
|
||
|
|
\fCnews\fP
|
||
|
|
.TP
|
||
|
|
%u
|
||
|
|
Username
|
||
|
|
\fCusername\fP
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nm_db_limit
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 0
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies the default limit used in notmuch queries.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nm_default_url
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies the default Notmuch database in format
|
||
|
|
notmuch://<absolute path>.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nm_exclude_tags
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The messages tagged with these tags are excluded and not loaded
|
||
|
|
from notmuch DB to NeoMutt unless specified explicitly.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nm_flagged_tag
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "flagged"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies notmuch tag which is used for flagged messages. The
|
||
|
|
variable is used to count flagged messages in DB and set the flagged flag when
|
||
|
|
modifying tags. All other NeoMutt commands use standard (e.g. maildir) flags.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nm_open_timeout
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 5
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies the timeout for database open in seconds.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nm_query_type
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "messages"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies the default query type (threads or messages) used in notmuch queries.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nm_query_window_current_position
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 0
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable contains the position of the current search for window based vfolder.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nm_query_window_current_search
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable contains the currently setup notmuch search for window based vfolder.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nm_query_window_duration
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 0
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable sets the time duration of a windowed notmuch query.
|
||
|
|
Accepted values all non negative integers. A value of 0 disables the feature.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nm_query_window_timebase
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "week"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable sets the time base of a windowed notmuch query.
|
||
|
|
Accepted values are 'minute', 'hour', 'day', 'week', 'month', 'year'
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nm_record
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies if the NeoMutt record should indexed by notmuch.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nm_record_tags
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies the default tags applied to messages stored to the NeoMutt record.
|
||
|
|
When set to 0 this variable disable the window feature.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nm_replied_tag
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "replied"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies notmuch tag which is used for replied messages. The
|
||
|
|
variable is used to set the replied flag when modifiying tags. All other NeoMutt
|
||
|
|
commands use standard (e.g. maildir) flags.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nm_unread_tag
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "unread"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies notmuch tag which is used for unread messages. The
|
||
|
|
variable is used to count unread messages in DB and set the unread flag when
|
||
|
|
modifiying tags. All other NeoMutt commands use standard (e.g. maildir) flags.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nntp_authenticators
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This is a colon\-delimited list of authentication methods NeoMutt may
|
||
|
|
attempt to use to log in to a news server, in the order NeoMutt should
|
||
|
|
try them. Authentication methods are either "user" or any
|
||
|
|
SASL mechanism, e.g. "digest\-md5", "gssapi" or "cram\-md5".
|
||
|
|
This option is case\-insensitive. If it's \fIunset\fP (the default)
|
||
|
|
NeoMutt will try all available methods, in order from most\-secure to
|
||
|
|
least\-secure.
|
||
|
|
.IP
|
||
|
|
Example:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set nntp_authenticators="digest\-md5:user"
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
\fBNote:\fP NeoMutt will only fall back to other authentication methods if
|
||
|
|
the previous methods are unavailable. If a method is available but
|
||
|
|
authentication fails, NeoMutt will not connect to the IMAP server.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nntp_context
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 1000
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable defines number of articles which will be in index when
|
||
|
|
newsgroup entered. If active newsgroup have more articles than this
|
||
|
|
number, oldest articles will be ignored. Also controls how many
|
||
|
|
articles headers will be saved in cache when you quit newsgroup.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nntp_listgroup
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls whether or not existence of each article is
|
||
|
|
checked when newsgroup is entered.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nntp_load_description
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls whether or not descriptions for each newsgroup
|
||
|
|
must be loaded when newsgroup is added to list (first time list
|
||
|
|
loading or new newsgroup adding).
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nntp_pass
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Your password for NNTP account.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nntp_poll
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 60
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The time in seconds until any operations on newsgroup except post new
|
||
|
|
article will cause recheck for new news. If set to 0, NeoMutt will
|
||
|
|
recheck newsgroup on each operation in index (stepping, read article,
|
||
|
|
etc.).
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B nntp_user
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Your login name on the NNTP server. If \fIunset\fP and NNTP server requires
|
||
|
|
authentication, NeoMutt will prompt you for your account name when you
|
||
|
|
connect to news server.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pager
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: "builtin"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies which pager you would like to use to view
|
||
|
|
messages. The value "builtin" means to use the built\-in pager, otherwise this
|
||
|
|
variable should specify the pathname of the external pager you would
|
||
|
|
like to use.
|
||
|
|
.IP
|
||
|
|
Using an external pager may have some disadvantages: Additional
|
||
|
|
keystrokes are necessary because you can't call NeoMutt functions
|
||
|
|
directly from the pager, and screen resizes cause lines longer than
|
||
|
|
the screen width to be badly formatted in the help menu.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pager_context
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 0
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls the number of lines of context that are given
|
||
|
|
when displaying the next or previous page in the internal pager. By
|
||
|
|
default, NeoMutt will display the line after the last one on the screen
|
||
|
|
at the top of the next page (0 lines of context).
|
||
|
|
.IP
|
||
|
|
This variable also specifies the amount of context given for search
|
||
|
|
results. If positive, this many lines will be given before a match,
|
||
|
|
if 0, the match will be top\-aligned.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pager_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "\-%Z\- %C/%m: %\-20.20n %s%* \-\- (%P)"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pager_index_lines
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 0
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Determines the number of lines of a mini\-index which is shown when in
|
||
|
|
the pager. The current message, unless near the top or bottom of the
|
||
|
|
folder, will be roughly one third of the way down this mini\-index,
|
||
|
|
giving the reader the context of a few messages before and after the
|
||
|
|
message. This is useful, for example, to determine how many messages
|
||
|
|
remain to be read in the current thread. A value of 0 results in no index
|
||
|
|
being shown. If the number of messages in the current folder is less than
|
||
|
|
$pager_index_lines, then the index will only use as many lines as it needs.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pager_stop
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, the internal\-pager will \fBnot\fP move to the next message
|
||
|
|
when you are at the end of a message and invoke the \fC<next\-page>\fP
|
||
|
|
function.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pattern_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "%2n %\-15e %d"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable describes the format of the "pattern completion" menu. The
|
||
|
|
following \fCprintf(3)\fP\-style sequences are understood:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
%d
|
||
|
|
pattern description
|
||
|
|
.TP
|
||
|
|
%e
|
||
|
|
pattern expression
|
||
|
|
.TP
|
||
|
|
%n
|
||
|
|
index number
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_auto_decode
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, NeoMutt will automatically attempt to decrypt traditional PGP
|
||
|
|
messages whenever the user performs an operation which ordinarily would
|
||
|
|
result in the contents of the message being operated on. For example,
|
||
|
|
if the user displays a pgp\-traditional message which has not been manually
|
||
|
|
checked with the \fC<check-traditional-pgp>\fP function, NeoMutt will automatically
|
||
|
|
check the message for traditional pgp.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_autoinline
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
Also see the $pgp_mime_auto variable.
|
||
|
|
.IP
|
||
|
|
Also note that using the old\-style PGP message format is \fBstrongly\fP
|
||
|
|
\fBdeprecated\fP.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_check_exit
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, NeoMutt will check the exit code of the PGP subprocess when
|
||
|
|
signing or encrypting. A non\-zero exit code means that the
|
||
|
|
subprocess failed.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_check_gpg_decrypt_status_fd
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, 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.
|
||
|
|
.IP
|
||
|
|
If \fIunset\fP, NeoMutt will instead match the status fd output
|
||
|
|
against $pgp_decryption_okay.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_clearsign_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This format is used to create an old\-style "clearsigned" PGP
|
||
|
|
message. Note that the use of this format is \fBstrongly\fP
|
||
|
|
\fBdeprecated\fP.
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $pgp_decode_command command for
|
||
|
|
possible \fCprintf(3)\fP\-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)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_decode_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This format strings specifies a command which is used to decode
|
||
|
|
application/pgp attachments.
|
||
|
|
.IP
|
||
|
|
The PGP command formats have their own set of \fCprintf(3)\fP\-like sequences:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
%a
|
||
|
|
The value of $pgp_sign_as if set, otherwise the value
|
||
|
|
of $pgp_default_key.
|
||
|
|
.TP
|
||
|
|
%f
|
||
|
|
Expands to the name of a file containing a message.
|
||
|
|
.TP
|
||
|
|
%p
|
||
|
|
Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty
|
||
|
|
string otherwise. Note: This may be used with a %? construct.
|
||
|
|
.TP
|
||
|
|
%r
|
||
|
|
One or more key IDs (or fingerprints if available).
|
||
|
|
.TP
|
||
|
|
%s
|
||
|
|
Expands to the name of a file containing the signature part
|
||
|
|
of a \fCmultipart/signed\fP attachment when verifying it.
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
For examples on how to configure these formats for the various versions
|
||
|
|
of PGP which are floating around, see the pgp and gpg sample configuration files in
|
||
|
|
the \fCsamples/\fP subdirectory which has been installed on your system
|
||
|
|
alongside the documentation.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_decrypt_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command is used to decrypt a PGP encrypted message.
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $pgp_decode_command command for
|
||
|
|
possible \fCprintf(3)\fP\-like sequences.
|
||
|
|
(PGP only)
|
||
|
|
.IP
|
||
|
|
Note: When decrypting messages using \fCgpg\fP, a pinentry program needs to
|
||
|
|
be invoked unless the password is cached within \fCgpg\-agent\fP.
|
||
|
|
Currently, the \fCpinentry\-tty\fP program (usually distributed with
|
||
|
|
\fCgpg\fP) isn't suitable for being invoked by NeoMutt. You are encouraged
|
||
|
|
to use a different pinentry\-program when running NeoMutt in order to avoid
|
||
|
|
problems.
|
||
|
|
.IP
|
||
|
|
See also: https://github.com/neomutt/neomutt/issues/1014
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_decryption_okay
|
||
|
|
.nf
|
||
|
|
Type: regular expression
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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).
|
||
|
|
.IP
|
||
|
|
Note that if $pgp_check_gpg_decrypt_status_fd is set, this variable
|
||
|
|
is ignored.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_default_key
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This is the default key\-pair to use for PGP operations. It will be
|
||
|
|
used for encryption (see $postpone_encrypt and $pgp_self_encrypt).
|
||
|
|
.IP
|
||
|
|
It will also be used for signing unless $pgp_sign_as is set.
|
||
|
|
.IP
|
||
|
|
The (now deprecated) \fIpgp_self_encrypt_as\fP is an alias for this
|
||
|
|
variable, and should no longer be used.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_encrypt_only_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command is used to encrypt a body part without signing it.
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $pgp_decode_command command for
|
||
|
|
possible \fCprintf(3)\fP\-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)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_encrypt_sign_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command is used to both sign and encrypt a body part.
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $pgp_decode_command command for
|
||
|
|
possible \fCprintf(3)\fP\-like sequences.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_entry_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "%4n %t%f %4l/0x%k %\-4a %2c %u"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable allows you to customize the PGP key selection menu to
|
||
|
|
your personal taste. If $crypt_use_gpgme is \fIset\fP, then it applies
|
||
|
|
to S/MIME key selection menu also. This string is similar to $index_format,
|
||
|
|
but has its own set of \fCprintf(3)\fP\-like sequences:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
%a
|
||
|
|
Algorithm
|
||
|
|
.TP
|
||
|
|
%c
|
||
|
|
Capabilities
|
||
|
|
.TP
|
||
|
|
%f
|
||
|
|
Flags
|
||
|
|
.TP
|
||
|
|
%k
|
||
|
|
Key id
|
||
|
|
.TP
|
||
|
|
%l
|
||
|
|
Key length
|
||
|
|
.TP
|
||
|
|
%n
|
||
|
|
Number
|
||
|
|
.TP
|
||
|
|
%p
|
||
|
|
Protocol
|
||
|
|
.TP
|
||
|
|
%t
|
||
|
|
Trust/validity of the key\-uid association
|
||
|
|
.TP
|
||
|
|
%u
|
||
|
|
User id
|
||
|
|
.TP
|
||
|
|
%[<s>]
|
||
|
|
Date of the key where <s> is an \fCstrftime(3)\fP expression
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
(Crypto only) or (PGP only when GPGME disabled)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_export_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command is used to export a public key from the user's
|
||
|
|
key ring.
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $pgp_decode_command command for
|
||
|
|
possible \fCprintf(3)\fP\-like sequences.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_getkeys_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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 \fCprintf(3)\fP\-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)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_good_sign
|
||
|
|
.nf
|
||
|
|
Type: regular expression
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_ignore_subkeys
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Setting this variable will cause NeoMutt to ignore OpenPGP subkeys. Instead,
|
||
|
|
the principal key will inherit the subkeys' capabilities. \fIUnset\fP this
|
||
|
|
if you want to play interesting key selection games.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_import_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command is used to import a key from a message into
|
||
|
|
the user's public key ring.
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $pgp_decode_command command for
|
||
|
|
possible \fCprintf(3)\fP\-like sequences.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_list_pubring_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command is used to list the public key ring's contents. The
|
||
|
|
output format must be analogous to the one used by
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
gpg \-\-list\-keys \-\-with\-colons \-\-with\-fingerprint
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
Note: gpg's \fCfixed\-list\-mode\fP option should not be used. It
|
||
|
|
produces a different date format which may result in NeoMutt showing
|
||
|
|
incorrect key generation dates.
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $pgp_decode_command command for
|
||
|
|
possible \fCprintf(3)\fP\-like sequences.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_list_secring_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command is used to list the secret key ring's contents. The
|
||
|
|
output format must be analogous to the one used by:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
gpg \-\-list\-keys \-\-with\-colons \-\-with\-fingerprint
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
Note: gpg's \fCfixed\-list\-mode\fP option should not be used. It
|
||
|
|
produces a different date format which may result in NeoMutt showing
|
||
|
|
incorrect key generation dates.
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $pgp_decode_command command for
|
||
|
|
possible \fCprintf(3)\fP\-like sequences.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_long_ids
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, use 64 bit PGP key IDs, if \fIunset\fP use the normal 32 bit key IDs.
|
||
|
|
NOTE: Internally, NeoMutt has transitioned to using fingerprints (or long key IDs
|
||
|
|
as a fallback). This option now only controls the display of key IDs
|
||
|
|
in the key selection menu and a few other places.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_mime_auto
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: ask\-yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This option controls whether NeoMutt will prompt you for
|
||
|
|
automatically sending a (signed/encrypted) message using
|
||
|
|
PGP/MIME when inline (traditional) fails (for any reason).
|
||
|
|
.IP
|
||
|
|
Also note that using the old\-style PGP message format is \fBstrongly\fP
|
||
|
|
\fBdeprecated\fP.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_replyinline
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
Also see the $pgp_mime_auto variable.
|
||
|
|
.IP
|
||
|
|
Also note that using the old\-style PGP message format is \fBstrongly\fP
|
||
|
|
\fBdeprecated\fP.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_retainable_sigs
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, signed and encrypted messages will consist of nested
|
||
|
|
\fCmultipart/signed\fP and \fCmultipart/encrypted\fP body parts.
|
||
|
|
.IP
|
||
|
|
This is useful for applications like encrypted and signed mailing
|
||
|
|
lists, where the outer layer (\fCmultipart/encrypted\fP) can be easily
|
||
|
|
removed, while the inner \fCmultipart/signed\fP part is retained.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_self_encrypt
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, PGP encrypted messages will also be encrypted
|
||
|
|
using the key in $pgp_default_key.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_show_unusable
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, NeoMutt will display non\-usable keys on the PGP key selection
|
||
|
|
menu. This includes keys which have been revoked, have expired, or
|
||
|
|
have been marked as "disabled" by the user.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_sign_as
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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. \fC0x00112233\fP).
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_sign_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command is used to create the detached PGP signature for a
|
||
|
|
\fCmultipart/signed\fP PGP/MIME body part.
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $pgp_decode_command command for
|
||
|
|
possible \fCprintf(3)\fP\-like sequences.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_sort_keys
|
||
|
|
.nf
|
||
|
|
Type: sort order
|
||
|
|
Default: address
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies how the entries in the pgp menu are sorted. The
|
||
|
|
following are legal values:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
address
|
||
|
|
sort alphabetically by user id
|
||
|
|
.TP
|
||
|
|
keyid
|
||
|
|
sort alphabetically by key id
|
||
|
|
.TP
|
||
|
|
date
|
||
|
|
sort by key creation date
|
||
|
|
.TP
|
||
|
|
trust
|
||
|
|
sort by the trust of the key
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
If you prefer reverse order of the above values, prefix it with
|
||
|
|
"reverse\-".
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_strict_enc
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, NeoMutt will automatically encode PGP/MIME signed messages as
|
||
|
|
quoted\-printable. Please note that unsetting this variable may
|
||
|
|
lead to problems with non\-verifyable PGP signatures, so only change
|
||
|
|
this if you know what you are doing.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_timeout
|
||
|
|
.nf
|
||
|
|
Type: number (long)
|
||
|
|
Default: 300
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The number of seconds after which a cached passphrase will expire if
|
||
|
|
not used.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_use_gpg_agent
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, NeoMutt expects a \fCgpg\-agent(1)\fP process will handle
|
||
|
|
private key passphrase prompts. If \fIunset\fP, NeoMutt will prompt
|
||
|
|
for the passphrase and pass it via stdin to the pgp command.
|
||
|
|
.IP
|
||
|
|
Note that as of version 2.1, GnuPG automatically spawns an agent
|
||
|
|
and requires the agent be used for passphrase management. Since
|
||
|
|
that version is increasingly prevalent, this variable now
|
||
|
|
defaults \fIset\fP.
|
||
|
|
.IP
|
||
|
|
NeoMutt works with a GUI or curses pinentry program. A TTY pinentry
|
||
|
|
should not be used.
|
||
|
|
.IP
|
||
|
|
If you are using an older version of GnuPG without an agent running,
|
||
|
|
or another encryption program without an agent, you will need to
|
||
|
|
\fIunset\fP this variable.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_verify_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command is used to verify PGP signatures.
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $pgp_decode_command command for
|
||
|
|
possible \fCprintf(3)\fP\-like sequences.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pgp_verify_key_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command is used to verify key information from the key selection
|
||
|
|
menu.
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $pgp_decode_command command for
|
||
|
|
possible \fCprintf(3)\fP\-like sequences.
|
||
|
|
(PGP only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pipe_decode
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Used in connection with the \fC<pipe\-message>\fP function. When \fIunset\fP,
|
||
|
|
NeoMutt will pipe the messages without any preprocessing. When \fIset\fP, NeoMutt
|
||
|
|
will attempt to decode the messages first.
|
||
|
|
.IP
|
||
|
|
Also see $pipe_decode_weed, which controls whether headers will
|
||
|
|
be weeded when this is \fIset\fP.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pipe_decode_weed
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
For \fC<pipe\-message>\fP, when $pipe_decode is set, this further
|
||
|
|
controls whether NeoMutt will weed headers.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pipe_sep
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "\\n"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The separator to add between messages when piping a list of tagged
|
||
|
|
messages to an external Unix command.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pipe_split
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Used in connection with the \fC<pipe\-message>\fP function following
|
||
|
|
\fC<tag\-prefix>\fP. If this variable is \fIunset\fP, when piping a list of
|
||
|
|
tagged messages NeoMutt will concatenate the messages and will pipe them
|
||
|
|
all concatenated. When \fIset\fP, 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.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pop_auth_try_all
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, NeoMutt will try all available authentication methods.
|
||
|
|
When \fIunset\fP, NeoMutt will only fall back to other authentication
|
||
|
|
methods if the previous methods are unavailable. If a method is
|
||
|
|
available but authentication fails, NeoMutt will not connect to the POP server.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pop_authenticators
|
||
|
|
.nf
|
||
|
|
Type: string list
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This is a colon\-delimited list of authentication methods NeoMutt may
|
||
|
|
attempt to use to log in to an POP server, in the order NeoMutt should
|
||
|
|
try them. Authentication methods are either "user", "apop" or any
|
||
|
|
SASL mechanism, e.g. "digest\-md5", "gssapi" or "cram\-md5".
|
||
|
|
This option is case\-insensitive. If this option is \fIunset\fP
|
||
|
|
(the default) NeoMutt will try all available methods, in order from
|
||
|
|
most\-secure to least\-secure.
|
||
|
|
.IP
|
||
|
|
Example:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set pop_authenticators="digest\-md5:apop:user"
|
||
|
|
|
||
|
|
.EE
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pop_checkinterval
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 60
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable configures how often (in seconds) NeoMutt should look for
|
||
|
|
new mail in the currently selected mailbox if it is a POP mailbox.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pop_delete
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: ask\-no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, NeoMutt will delete successfully downloaded messages from the POP
|
||
|
|
server when using the \fC<fetch-mail>\fP function. When \fIunset\fP, NeoMutt will
|
||
|
|
download messages but also leave them on the POP server.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pop_host
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The name of your POP server for the \fC<fetch-mail>\fP function. You
|
||
|
|
can also specify an alternative port, username and password, i.e.:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
[pop[s]://][username[:password]@]popserver[:port]
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
where "[...]" denotes an optional part.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pop_last
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If this variable is \fIset\fP, NeoMutt will try to use the "\fCLAST\fP" POP command
|
||
|
|
for retrieving only unread messages from the POP server when using
|
||
|
|
the \fC<fetch-mail>\fP function.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pop_oauth_refresh_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The command to run to generate an OAUTH refresh token for
|
||
|
|
authorizing your connection to your POP server. This command will be
|
||
|
|
run on every connection attempt that uses the OAUTHBEARER authentication
|
||
|
|
mechanism. See "oauth" for details.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pop_pass
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies the password for your POP account. If \fIunset\fP, NeoMutt will
|
||
|
|
prompt you for your password when you open a POP mailbox.
|
||
|
|
.IP
|
||
|
|
\fBWarning\fP: you should only use this option when you are on a
|
||
|
|
fairly secure machine, because the superuser can read your neomuttrc
|
||
|
|
even if you are the only one who can read the file.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pop_reconnect
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: ask\-yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether or not NeoMutt will try to reconnect to the POP server if
|
||
|
|
the connection is lost.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B pop_user
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Your login name on the POP server.
|
||
|
|
.IP
|
||
|
|
This variable defaults to your user name on the local machine.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B post_indent_string
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Similar to the $attribution variable, NeoMutt will append this
|
||
|
|
string after the inclusion of a message which is being replied to.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B post_moderated
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: ask\-yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If set to \fIyes\fP, NeoMutt will post article to newsgroup that have
|
||
|
|
not permissions to posting (e.g. moderated). \fBNote:\fP if news server
|
||
|
|
does not support posting to that newsgroup or totally read\-only, that
|
||
|
|
posting will not have an effect.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B postpone
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: ask\-yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether or not messages are saved in the $postponed
|
||
|
|
mailbox when you elect not to send immediately. If set to
|
||
|
|
\fIask\-yes\fP or \fIask\-no\fP, you will be prompted with "Save
|
||
|
|
(postpone) draft message?" when quitting from the "compose"
|
||
|
|
screen.
|
||
|
|
.IP
|
||
|
|
Also see the $recall variable.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B postpone_encrypt
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, 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)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B postpone_encrypt_as
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This is a deprecated fall\-back variable for $postpone_encrypt.
|
||
|
|
Please use $pgp_default_key or $smime_default_key.
|
||
|
|
(Crypto only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B postponed
|
||
|
|
.nf
|
||
|
|
Type: mailbox
|
||
|
|
Default: "~/postponed"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
Also see the $postpone variable.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B preconnect
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, a shell command to be executed if NeoMutt fails to establish
|
||
|
|
a connection to the server. This is useful for setting up secure
|
||
|
|
connections, e.g. with \fCssh(1)\fP. If the command returns a nonzero
|
||
|
|
status, NeoMutt gives up opening the server. Example:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set preconnect="ssh \-f \-q \-L 1234:mailhost.net:143 mailhost.net \\
|
||
|
|
sleep 20 < /dev/null > /dev/null"
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
Mailbox "foo" on "mailhost.net" can now be reached
|
||
|
|
as "{localhost:1234}foo".
|
||
|
|
.IP
|
||
|
|
Note: For this example to work, you must be able to log in to the
|
||
|
|
remote machine without having to enter a password.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B preferred_languages
|
||
|
|
.nf
|
||
|
|
Type: string list
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
RFC8255 : user preferred languages to be search in parts and display
|
||
|
|
Ex. : set preferred_languages="en,fr,de"
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B print
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: ask\-no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether or not NeoMutt really prints messages.
|
||
|
|
This is set to "ask\-no" by default, because some people
|
||
|
|
accidentally hit "p" often.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B print_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: "lpr"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This specifies the command pipe that should be used to print messages.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B print_decode
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Used in connection with the \fC<print\-message>\fP function. If this
|
||
|
|
option is \fIset\fP, the message is decoded before it is passed to the
|
||
|
|
external command specified by $print_command. If this option
|
||
|
|
is \fIunset\fP, 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.
|
||
|
|
.IP
|
||
|
|
Also see $print_decode_weed, which controls whether headers will
|
||
|
|
be weeded when this is \fIset\fP.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B print_decode_weed
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
For \fC<print\-message>\fP, when $print_decode is set, this
|
||
|
|
further controls whether NeoMutt will weed headers.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B print_split
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Used in connection with the \fC<print\-message>\fP function. If this option
|
||
|
|
is \fIset\fP, the command specified by $print_command is executed once for
|
||
|
|
each message which is to be printed. If this option is \fIunset\fP,
|
||
|
|
the command specified by $print_command is executed only once, and
|
||
|
|
all the messages are concatenated, with a form feed as the message
|
||
|
|
separator.
|
||
|
|
.IP
|
||
|
|
Those who use the \fCenscript\fP(1) program's mail\-printing mode will
|
||
|
|
most likely want to \fIset\fP this option.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B prompt_after
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If you use an \fIexternal\fP $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 \fIunset\fP, NeoMutt will return to the
|
||
|
|
index menu when the external pager exits.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B query_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This specifies the command NeoMutt will use to make external address
|
||
|
|
queries. The string may contain a "%s", which will be substituted
|
||
|
|
with the query string the user types. 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 user's query to the end of the string.
|
||
|
|
See "query" for more information.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B query_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "%3c %t %\-25.25n %\-25.25a | %e"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable describes the format of the "query" menu. The
|
||
|
|
following \fCprintf(3)\fP\-style sequences are understood:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
%a
|
||
|
|
|
||
|
|
Destination address
|
||
|
|
.TP
|
||
|
|
%c
|
||
|
|
|
||
|
|
Current entry number
|
||
|
|
.TP
|
||
|
|
%e
|
||
|
|
*
|
||
|
|
Extra information
|
||
|
|
.TP
|
||
|
|
%n
|
||
|
|
|
||
|
|
Destination name
|
||
|
|
.TP
|
||
|
|
%t
|
||
|
|
|
||
|
|
"*" if current entry is tagged, a space otherwise
|
||
|
|
.TP
|
||
|
|
%>X
|
||
|
|
|
||
|
|
Right justify the rest of the string and pad with "X"
|
||
|
|
.TP
|
||
|
|
%|X
|
||
|
|
|
||
|
|
Pad to the end of the line with "X"
|
||
|
|
.TP
|
||
|
|
%*X
|
||
|
|
|
||
|
|
Soft\-fill with character "X" as pad
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
For an explanation of "soft\-fill", see the $index_format documentation.
|
||
|
|
.IP
|
||
|
|
* = can be optionally printed if nonzero, see the $status_format documentation.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B quit
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls whether "quit" and "exit" actually quit
|
||
|
|
from NeoMutt. If this option is \fIset\fP, they do quit, if it is \fIunset\fP, they
|
||
|
|
have no effect, and if it is set to \fIask\-yes\fP or \fIask\-no\fP, you are
|
||
|
|
prompted for confirmation when you try to quit.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B quote_regex
|
||
|
|
.nf
|
||
|
|
Type: regular expression
|
||
|
|
Default: "^([ \\t]*[|>:}#])+"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
A regular expression used in the internal pager to determine quoted
|
||
|
|
sections of text in the body of a message. Quoted text may be filtered
|
||
|
|
out using the \fC<toggle\-quoted>\fP command, or colored according to the
|
||
|
|
"color quoted" family of directives.
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
Match detection may be overridden by the $smileys regular expression.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B read_inc
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 10
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
Also see the $write_inc, $net_inc and $time_inc variables and the
|
||
|
|
"tuning" section of the manual for performance considerations.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B read_only
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, all folders are opened in read\-only mode.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B realname
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies what "real" or "personal" name should be used
|
||
|
|
when sending messages.
|
||
|
|
.IP
|
||
|
|
If not specified, then the user's "real name" will be read from \fC/etc/passwd\fP.
|
||
|
|
This option will not be used, if "$from" is set.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B recall
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: ask\-yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether or not NeoMutt recalls postponed messages
|
||
|
|
when composing a new message.
|
||
|
|
.IP
|
||
|
|
Setting this variable to \fIyes\fP is not generally useful, and thus not
|
||
|
|
recommended. Note that the \fC<recall\-message>\fP function can be used
|
||
|
|
to manually recall postponed messages.
|
||
|
|
.IP
|
||
|
|
Also see $postponed variable.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B record
|
||
|
|
.nf
|
||
|
|
Type: mailbox
|
||
|
|
Default: "~/sent"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This specifies the file into which your outgoing messages should be
|
||
|
|
appended. (This is meant as the primary method for saving a copy of
|
||
|
|
your messages, but another way to do this is using the "my_hdr"
|
||
|
|
command to create a "Bcc:" field with your email address in it.)
|
||
|
|
.IP
|
||
|
|
The value of \fI$record\fP is overridden by the $force_name and
|
||
|
|
$save_name variables, and the "fcc-hook" command. Also see $copy
|
||
|
|
and $write_bcc.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B reflow_space_quotes
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This option controls how quotes from format=flowed messages are displayed
|
||
|
|
in the pager and when replying (with $text_flowed \fIunset\fP).
|
||
|
|
When set, this option adds spaces after each level of quote marks, turning
|
||
|
|
">>>foo" into "> > > foo".
|
||
|
|
.IP
|
||
|
|
\fBNote:\fP If $reflow_text is \fIunset\fP, this option has no effect.
|
||
|
|
Also, this option does not affect replies when $text_flowed is \fIset\fP.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B reflow_text
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will reformat paragraphs in text/plain
|
||
|
|
parts marked format=flowed. If \fIunset\fP, NeoMutt will display paragraphs
|
||
|
|
unaltered from how they appear in the message body. See RFC3676 for
|
||
|
|
details on the \fIformat=flowed\fP format.
|
||
|
|
.IP
|
||
|
|
Also see $reflow_wrap, and $wrap.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B reflow_wrap
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 78
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls the maximum paragraph width when reformatting text/plain
|
||
|
|
parts when $reflow_text is \fIset\fP. 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.
|
||
|
|
.IP
|
||
|
|
Also see $wrap.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B reply_regex
|
||
|
|
.nf
|
||
|
|
Type: regular expression
|
||
|
|
Default: "^((re|aw|sv)(\\[[0\-9]+\\])*:[ \\t]*)*"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
A regular expression used to recognize reply messages when threading
|
||
|
|
and replying. The default value corresponds to the English "Re:", the
|
||
|
|
German "Aw:" and the Swedish "Sv:".
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B reply_self
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIunset\fP and you are replying to a message sent by you, NeoMutt will
|
||
|
|
assume that you want to reply to the recipients of that message rather
|
||
|
|
than to yourself.
|
||
|
|
.IP
|
||
|
|
Also see the "alternates" command.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B reply_to
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: ask\-yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, when replying to a message, NeoMutt will use the address listed
|
||
|
|
in the Reply\-to: header as the recipient of the reply. If \fIunset\fP,
|
||
|
|
it will use the address in the From: header field instead. This
|
||
|
|
option is useful for reading a mailing list that sets the Reply\-To:
|
||
|
|
header field to the list address and you want to send a private
|
||
|
|
message to the author of a message.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B reply_with_xorig
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This 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_realname".
|
||
|
|
.IP
|
||
|
|
Assuming 'fast_reply' is disabled, this option will prompt the user with a
|
||
|
|
prefilled From: header.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B resolve
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, the cursor will be automatically advanced to the next
|
||
|
|
(possibly undeleted) message whenever a command that modifies the
|
||
|
|
current message is executed.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B resume_draft_files
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, draft files (specified by \fC\-H\fP on the command
|
||
|
|
line) are processed similarly to when resuming a postponed
|
||
|
|
message. Recipients are not prompted for; send\-hooks are not
|
||
|
|
evaluated; no alias expansion takes place; user\-defined headers
|
||
|
|
and signatures are not added to the message.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B resume_edited_draft_files
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, draft files previously edited (via \fC\-E \-H\fP on
|
||
|
|
the command line) will have $resume_draft_files automatically
|
||
|
|
set when they are used as a draft file again.
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
This option is designed to prevent multiple signatures,
|
||
|
|
user\-defined headers, and other processing effects from being
|
||
|
|
made multiple times to the draft file.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B reverse_alias
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls whether or not NeoMutt will display the "personal"
|
||
|
|
name from your aliases in the index menu if it finds an alias that
|
||
|
|
matches the message's sender. For example, if you have the following
|
||
|
|
alias:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
alias juser abd30425@somewhere.net (Joe User)
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
and then you receive mail which contains the following header:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
From: abd30425@somewhere.net
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
It would be displayed in the index menu as "Joe User" instead of
|
||
|
|
"abd30425@somewhere.net." This is useful when the person's e\-mail
|
||
|
|
address is not human friendly.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B reverse_name
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
It may sometimes arrive that you receive mail to a certain machine,
|
||
|
|
move the messages to another machine, and reply to some the messages
|
||
|
|
from there. If this variable is \fIset\fP, the default \fIFrom:\fP line of
|
||
|
|
the reply messages is built using the address where you received the
|
||
|
|
messages you are replying to \fBif\fP that address matches your
|
||
|
|
"alternates". If the variable is \fIunset\fP, or the address that would be
|
||
|
|
used doesn't match your "alternates", the \fIFrom:\fP line will use
|
||
|
|
your address on the current machine.
|
||
|
|
.IP
|
||
|
|
Also see the "alternates" command and $reverse_realname.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B reverse_realname
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable fine\-tunes the behavior of the $reverse_name feature.
|
||
|
|
.IP
|
||
|
|
When it is \fIunset\fP, NeoMutt will remove the real name part of a
|
||
|
|
matching address. This allows the use of the email address
|
||
|
|
without having to also use what the sender put in the real name
|
||
|
|
field.
|
||
|
|
.IP
|
||
|
|
When it is \fIset\fP, NeoMutt will use the matching address as\-is.
|
||
|
|
.IP
|
||
|
|
In either case, a missing real name will be filled in afterwards
|
||
|
|
using the value of $realname.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B rfc2047_parameters
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When this variable is \fIset\fP, NeoMutt will decode RFC2047\-encoded MIME
|
||
|
|
parameters. You want to set this variable when NeoMutt suggests you
|
||
|
|
to save attachments to files named like:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
=?iso\-8859\-1?Q?file=5F=E4=5F991116=2Ezip?=
|
||
|
|
=?utf\-8?Q?z=C4=99ta.png?=
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
When this variable is \fIset\fP interactively, the change won't be
|
||
|
|
active until you change folders.
|
||
|
|
.IP
|
||
|
|
Note that this use of RFC2047's encoding is explicitly
|
||
|
|
prohibited by the standard, but nevertheless encountered in the
|
||
|
|
wild and produced by, e.g., Outlook.
|
||
|
|
.IP
|
||
|
|
Also note that setting this parameter will \fInot\fP have the effect
|
||
|
|
that NeoMutt \fIgenerates\fP this kind of encoding. Instead, NeoMutt will
|
||
|
|
unconditionally use the encoding specified in RFC2231.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B save_address
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, NeoMutt will take the sender's full address when choosing a
|
||
|
|
default folder for saving a mail. If $save_name or $force_name
|
||
|
|
is \fIset\fP too, the selection of the Fcc folder will be changed as well.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B save_empty
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIunset\fP, mailboxes which contain no saved messages will be removed
|
||
|
|
when closed (the exception is $spoolfile which is never removed).
|
||
|
|
If \fIset\fP, mailboxes are never removed.
|
||
|
|
.IP
|
||
|
|
\fBNote:\fP This only applies to mbox and MMDF folders, NeoMutt does not
|
||
|
|
delete MH and Maildir directories.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B save_history
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 0
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls the size of the history (per category) saved in the
|
||
|
|
$history_file file.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B save_name
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls how copies of outgoing messages are saved.
|
||
|
|
When \fIset\fP, 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 \fIusername\fP 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.
|
||
|
|
.IP
|
||
|
|
Also see the $force_name variable.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B save_unsubscribed
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, info about unsubscribed newsgroups will be saved into
|
||
|
|
"newsrc" file and into cache.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B score
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When this variable is \fIunset\fP, 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.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B score_threshold_delete
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: \-1
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Messages which have been assigned a score equal to or lower than the value
|
||
|
|
of this variable are automatically marked for deletion by NeoMutt. Since
|
||
|
|
NeoMutt scores are always greater than or equal to zero, the default setting
|
||
|
|
of this variable will never mark a message for deletion.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B score_threshold_flag
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 9999
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Messages which have been assigned a score greater than or equal to this
|
||
|
|
variable's value are automatically marked "flagged".
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B score_threshold_read
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: \-1
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Messages which have been assigned a score equal to or lower than the value
|
||
|
|
of this variable are automatically marked as read by NeoMutt. Since
|
||
|
|
NeoMutt scores are always greater than or equal to zero, the default setting
|
||
|
|
of this variable will never mark a message read.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B search_context
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 0
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
For the pager, this variable specifies the number of lines shown
|
||
|
|
before search results. By default, search results will be top\-aligned.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B send_charset
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "us\-ascii:iso\-8859\-1:utf\-8"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
A colon\-delimited list of character sets for outgoing messages. NeoMutt will use the
|
||
|
|
first character set into which the text can be converted exactly.
|
||
|
|
If your $charset is not "iso\-8859\-1" and recipients may not
|
||
|
|
understand "UTF\-8", it is advisable to include in the list an
|
||
|
|
appropriate widely used standard character set (such as
|
||
|
|
"iso\-8859\-2", "koi8\-r" or "iso\-2022\-jp") either instead of or after
|
||
|
|
"iso\-8859\-1".
|
||
|
|
.IP
|
||
|
|
In case the text can't be converted into one of these exactly,
|
||
|
|
NeoMutt uses $charset as a fallback.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sendmail
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: "/usr/sbin/sendmail \-oem \-oi"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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 \fC\-\-\fP delimiter (if not already present). Additional
|
||
|
|
flags, such as for $use_8bitmime, $use_envelope_from,
|
||
|
|
$dsn_notify, or $dsn_return will be added before the delimiter.
|
||
|
|
.IP
|
||
|
|
\fBSee also:\fP $write_bcc.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sendmail_wait
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 0
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies the number of seconds to wait for the $sendmail process
|
||
|
|
to finish before giving up and putting delivery in the background.
|
||
|
|
.IP
|
||
|
|
NeoMutt interprets the value of this variable as follows:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
>0
|
||
|
|
number of seconds to wait for sendmail to finish before continuing
|
||
|
|
.TP
|
||
|
|
0
|
||
|
|
wait forever for sendmail to finish
|
||
|
|
.TP
|
||
|
|
<0
|
||
|
|
always put sendmail in the background without waiting
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
Note that if you specify a value other than 0, the output of the child
|
||
|
|
process will be put in a temporary file. If there is some error, you
|
||
|
|
will be informed as to where to find the output.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B shell
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: "/bin/sh"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Command to use when spawning a subshell.
|
||
|
|
If not specified, then the user's login shell from \fC/etc/passwd\fP is used.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B show_multipart_alternative
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP to \fCinfo\fP, the multipart/alternative information is shown.
|
||
|
|
When \fIset\fP to \fCinline\fP, all of the alternatives are displayed.
|
||
|
|
When not set, the default behavior is to show only the chosen alternative.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B show_new_news
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, news server will be asked for new newsgroups on entering
|
||
|
|
the browser. Otherwise, it will be done only once for a news server.
|
||
|
|
Also controls whether or not number of new articles of subscribed
|
||
|
|
newsgroups will be then checked.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B show_only_unread
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, only subscribed newsgroups that contain unread articles
|
||
|
|
will be displayed in browser.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sidebar_component_depth
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 0
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
By 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
|
||
|
|
\fCsidebar_component_depth=2\fP will display it as dir3/maildir, having
|
||
|
|
truncated the 2 highest directories.
|
||
|
|
.IP
|
||
|
|
\fBSee also:\fP $sidebar_short_path
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sidebar_delim_chars
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "/."
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This contains the list of characters which you would like to treat
|
||
|
|
as folder separators for displaying paths in the sidebar.
|
||
|
|
.IP
|
||
|
|
Local mail is often arranged in directories: 'dir1/dir2/mailbox'.
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set sidebar_delim_chars='/'
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
IMAP mailboxes are often named: 'folder1.folder2.mailbox'.
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set sidebar_delim_chars='.'
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
\fBSee also:\fP $sidebar_short_path, $sidebar_folder_indent, $sidebar_indent_string.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sidebar_divider_char
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This specifies the characters to be drawn between the sidebar (when
|
||
|
|
visible) and the other NeoMutt panels. ASCII and Unicode line\-drawing
|
||
|
|
characters are supported.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sidebar_folder_indent
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Set this to indent mailboxes in the sidebar.
|
||
|
|
.IP
|
||
|
|
\fBSee also:\fP $sidebar_short_path, $sidebar_indent_string, $sidebar_delim_chars.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sidebar_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "%D%* %n"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable allows you to customize the sidebar display. This string is
|
||
|
|
similar to $index_format, but has its own set of \fCprintf(3)\fP\-like
|
||
|
|
sequences:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
%B
|
||
|
|
|
||
|
|
Name of the mailbox
|
||
|
|
.TP
|
||
|
|
%d
|
||
|
|
* @
|
||
|
|
Number of deleted messages in the mailbox
|
||
|
|
.TP
|
||
|
|
%D
|
||
|
|
|
||
|
|
Descriptive name of the mailbox
|
||
|
|
.TP
|
||
|
|
%F
|
||
|
|
*
|
||
|
|
Number of flagged messages in the mailbox
|
||
|
|
.TP
|
||
|
|
%L
|
||
|
|
* @
|
||
|
|
Number of messages after limiting
|
||
|
|
.TP
|
||
|
|
%n
|
||
|
|
|
||
|
|
'N' if mailbox has new mail, ' ' (space) otherwise
|
||
|
|
.TP
|
||
|
|
%N
|
||
|
|
*
|
||
|
|
Number of unread messages in the mailbox (seen or unseen)
|
||
|
|
.TP
|
||
|
|
%o
|
||
|
|
*
|
||
|
|
Number of old messages in the mailbox (unread, seen)
|
||
|
|
.TP
|
||
|
|
%r
|
||
|
|
*
|
||
|
|
Number of read messages in the mailbox (read, seen)
|
||
|
|
.TP
|
||
|
|
%S
|
||
|
|
*
|
||
|
|
Size of mailbox (total number of messages)
|
||
|
|
.TP
|
||
|
|
%t
|
||
|
|
* @
|
||
|
|
Number of tagged messages in the mailbox
|
||
|
|
.TP
|
||
|
|
%Z
|
||
|
|
*
|
||
|
|
Number of new messages in the mailbox (unread, unseen)
|
||
|
|
.TP
|
||
|
|
%!
|
||
|
|
|
||
|
|
"!" : one flagged message;
|
||
|
|
"!!" : two flagged messages;
|
||
|
|
"n!" : n flagged messages (for n > 2).
|
||
|
|
Otherwise prints nothing.
|
||
|
|
.TP
|
||
|
|
%>X
|
||
|
|
|
||
|
|
Right justify the rest of the string and pad with "X"
|
||
|
|
.TP
|
||
|
|
%|X
|
||
|
|
|
||
|
|
Pad to the end of the line with "X"
|
||
|
|
.TP
|
||
|
|
%*X
|
||
|
|
|
||
|
|
Soft\-fill with character "X" as pad
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
* = Can be optionally printed if nonzero
|
||
|
|
.IP
|
||
|
|
@ = Only applicable to the current folder
|
||
|
|
.IP
|
||
|
|
In order to use %S, %N, %F, and %!, $mail_check_stats must
|
||
|
|
be \fIset\fP. When thus set, a suggested value for this option is
|
||
|
|
"%B%?F? [%F]?%* %?N?%N/?%S".
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sidebar_indent_string
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: " "
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This specifies the string that is used to indent mailboxes in the sidebar.
|
||
|
|
It defaults to two spaces.
|
||
|
|
.IP
|
||
|
|
\fBSee also:\fP $sidebar_short_path, $sidebar_folder_indent, $sidebar_delim_chars.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sidebar_new_mail_only
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When set, the sidebar will only display mailboxes containing new, or
|
||
|
|
flagged, mail.
|
||
|
|
.IP
|
||
|
|
\fBSee also:\fP $sidebar_whitelist, $sidebar_non_empty_mailbox_only.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sidebar_next_new_wrap
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When set, the \fC<sidebar\-next\-new>\fP command will not stop and the end of
|
||
|
|
the list of mailboxes, but wrap around to the beginning. The
|
||
|
|
\fC<sidebar\-prev\-new>\fP command is similarly affected, wrapping around to
|
||
|
|
the end of the list.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sidebar_non_empty_mailbox_only
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When set, the sidebar will only display mailboxes that contain one or more mails.
|
||
|
|
.IP
|
||
|
|
\fBSee also:\fP $sidebar_new_mail_only, $sidebar_whitelist.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sidebar_on_right
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When set, the sidebar will appear on the right\-hand side of the screen.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sidebar_short_path
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
By default the sidebar will show the mailbox's path, relative to the
|
||
|
|
$folder variable. Setting \fCsidebar_shortpath=yes\fP will shorten the
|
||
|
|
names relative to the previous name. Here's an example:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
\fBshortpath=no\fP
|
||
|
|
\fBshortpath=yes\fP
|
||
|
|
\fBshortpath=yes, folderindent=yes, indentstr=".."\fP
|
||
|
|
.TP
|
||
|
|
\fCfruit\fP
|
||
|
|
\fCfruit\fP
|
||
|
|
\fCfruit\fP
|
||
|
|
.TP
|
||
|
|
\fCfruit.apple\fP
|
||
|
|
\fCapple\fP
|
||
|
|
\fC..apple\fP
|
||
|
|
.TP
|
||
|
|
\fCfruit.banana\fP
|
||
|
|
\fCbanana\fP
|
||
|
|
\fC..banana\fP
|
||
|
|
.TP
|
||
|
|
\fCfruit.cherry\fP
|
||
|
|
\fCcherry\fP
|
||
|
|
\fC..cherry\fP
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
\fBSee also:\fP $sidebar_delim_chars, $sidebar_folder_indent,
|
||
|
|
$sidebar_indent_string, $sidebar_component_depth.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sidebar_sort_method
|
||
|
|
.nf
|
||
|
|
Type: sort order
|
||
|
|
Default: order
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies how to sort mailbox entries in the sidebar. By default, the
|
||
|
|
entries are sorted alphabetically. Valid values:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
\(hy path (alphabetically)
|
||
|
|
.TP
|
||
|
|
\(hy count (all message count)
|
||
|
|
.TP
|
||
|
|
\(hy flagged (flagged message count)
|
||
|
|
.TP
|
||
|
|
\(hy new (unread message count)
|
||
|
|
.TP
|
||
|
|
\(hy unread (unread message count)
|
||
|
|
.TP
|
||
|
|
\(hy unsorted
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
You may optionally use the "reverse\-" prefix to specify reverse sorting
|
||
|
|
order (example: "\fCset sidebar_sort_method=reverse\-alpha\fP").
|
||
|
|
.IP
|
||
|
|
The "alpha" and "name" values are synonyms for "path".
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sidebar_visible
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This specifies whether or not to show sidebar. The sidebar shows a list of
|
||
|
|
all your mailboxes.
|
||
|
|
.IP
|
||
|
|
\fBSee also:\fP $sidebar_format, $sidebar_width
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sidebar_width
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 30
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This controls the width of the sidebar. It is measured in screen columns.
|
||
|
|
For example: sidebar_width=20 could display 20 ASCII characters, or 10
|
||
|
|
Chinese characters.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sig_dashes
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, a line containing "\-\- " (note the trailing space) will be inserted before your
|
||
|
|
$signature. It is \fBstrongly\fP recommended that you not \fIunset\fP
|
||
|
|
this variable unless your signature contains just your name. The
|
||
|
|
reason for this is because many software packages use "\-\- \\n" to
|
||
|
|
detect your signature. For example, NeoMutt has the ability to highlight
|
||
|
|
the signature in a different color in the built\-in pager.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sig_on_top
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, the signature will be included before any quoted or forwarded
|
||
|
|
text. It is \fBstrongly\fP recommended that you do not set this variable
|
||
|
|
unless you really know what you are doing, and are prepared to take
|
||
|
|
some heat from netiquette guardians.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B signature
|
||
|
|
.nf
|
||
|
|
Type: path
|
||
|
|
Default: "~/.signature"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies the filename of your signature, which is appended to all
|
||
|
|
outgoing messages. If the filename ends with a pipe ("|"), it is
|
||
|
|
assumed that filename is a shell command and input should be read from
|
||
|
|
its standard output.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B simple_search
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "~f %s | ~s %s"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies how NeoMutt should expand a simple search into a real search
|
||
|
|
pattern. A simple search is one that does not contain any of the "~" pattern
|
||
|
|
operators. See "patterns" for more information on search patterns.
|
||
|
|
.IP
|
||
|
|
For example, if you simply type "joe" at a search or limit prompt, NeoMutt
|
||
|
|
will automatically expand it to the value specified by this variable by
|
||
|
|
replacing "%s" with the supplied string.
|
||
|
|
For the default value, "joe" would be expanded to: "~f joe | ~s joe".
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B size_show_bytes
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, message sizes will display bytes for values less than
|
||
|
|
1 kilobyte. See formatstrings-size.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B size_show_fractions
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, message sizes will be displayed with a single decimal value
|
||
|
|
for sizes from 0 to 10 kilobytes and 1 to 10 megabytes.
|
||
|
|
See formatstrings-size.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B size_show_mb
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, message sizes will display megabytes for values greater than
|
||
|
|
or equal to 1 megabyte. See formatstrings-size.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B size_units_on_left
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, message sizes units will be displayed to the left of the number.
|
||
|
|
See formatstrings-size.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B skip_quoted_offset
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 0
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Lines of quoted text that are displayed before the unquoted text after
|
||
|
|
"skip to quoted" command (S)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sleep_time
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 1
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies time, in seconds, to pause while displaying certain informational
|
||
|
|
messages, while moving from folder to folder and after expunging
|
||
|
|
messages from the current folder. The default is to pause one second, so
|
||
|
|
a value of zero for this option suppresses the pause.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smart_wrap
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls the display of lines longer than the screen width in the
|
||
|
|
internal pager. If \fIset\fP, long lines are wrapped at a word boundary. If
|
||
|
|
\fIunset\fP, lines are simply wrapped at the screen edge. Also see the
|
||
|
|
$markers variable.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smileys
|
||
|
|
.nf
|
||
|
|
Type: regular expression
|
||
|
|
Default: "(>From )|(:[\-^]?[][)(><}{|/DP])"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The \fIpager\fP 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.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_ask_cert_label
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This flag controls whether you want to be asked to enter a label
|
||
|
|
for a certificate about to be added to the database or not. It is
|
||
|
|
\fIset\fP by default.
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_ca_location
|
||
|
|
.nf
|
||
|
|
Type: path
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable contains the name of either a directory, or a file which
|
||
|
|
contains trusted certificates for use with OpenSSL.
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_certificates
|
||
|
|
.nf
|
||
|
|
Type: path
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Since for S/MIME there is no pubring/secring as with PGP, NeoMutt has to handle
|
||
|
|
storage and retrieval of keys by itself. This is very basic right
|
||
|
|
now, and keys and certificates are stored in two different
|
||
|
|
directories, both named as the hash\-value retrieved from
|
||
|
|
OpenSSL. There is an index file which contains mailbox\-address
|
||
|
|
keyid pairs, and which can be manually edited. This option points to
|
||
|
|
the location of the certificates.
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_decrypt_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This format string specifies a command which is used to decrypt
|
||
|
|
\fCapplication/x\-pkcs7\-mime\fP attachments.
|
||
|
|
.IP
|
||
|
|
The OpenSSL command formats have their own set of \fCprintf(3)\fP\-like sequences
|
||
|
|
similar to PGP's:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
%f
|
||
|
|
Expands to the name of a file containing a message.
|
||
|
|
.TP
|
||
|
|
%s
|
||
|
|
Expands to the name of a file containing the signature part
|
||
|
|
of a \fCmultipart/signed\fP attachment when verifying it.
|
||
|
|
.TP
|
||
|
|
%k
|
||
|
|
The key\-pair specified with $smime_default_key
|
||
|
|
.TP
|
||
|
|
%i
|
||
|
|
Intermediate certificates
|
||
|
|
.TP
|
||
|
|
%c
|
||
|
|
One or more certificate IDs.
|
||
|
|
.TP
|
||
|
|
%a
|
||
|
|
The algorithm used for encryption.
|
||
|
|
.TP
|
||
|
|
%d
|
||
|
|
The message digest algorithm specified with $smime_sign_digest_alg.
|
||
|
|
.TP
|
||
|
|
%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".
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
For examples on how to configure these formats, see the \fCsmime.rc\fP in
|
||
|
|
the \fCsamples/\fP subdirectory which has been installed on your system
|
||
|
|
alongside the documentation.
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_decrypt_use_default_key
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP (default) this tells NeoMutt to use the default key for decryption. Otherwise,
|
||
|
|
if managing multiple certificate\-key\-pairs, NeoMutt will try to use the mailbox\-address
|
||
|
|
to determine the key to use. It will ask you to supply a key, if it can't find one.
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_default_key
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
It will be used for encryption (see $postpone_encrypt and
|
||
|
|
$smime_self_encrypt).
|
||
|
|
.IP
|
||
|
|
It will be used for decryption unless $smime_decrypt_use_default_key
|
||
|
|
is \fIunset\fP.
|
||
|
|
.IP
|
||
|
|
It will also be used for signing unless $smime_sign_as is set.
|
||
|
|
.IP
|
||
|
|
The (now deprecated) \fIsmime_self_encrypt_as\fP is an alias for this
|
||
|
|
variable, and should no longer be used.
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_encrypt_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command is used to create encrypted S/MIME messages.
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $smime_decrypt_command command for
|
||
|
|
possible \fCprintf(3)\fP\-like sequences.
|
||
|
|
(S/MIME only)
|
||
|
|
.IP
|
||
|
|
Encrypt the message to $smime_default_key too.
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_encrypt_with
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "aes256"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This sets the algorithm that should be used for encryption.
|
||
|
|
Valid choices are "aes128", "aes192", "aes256", "des", "des3", "rc2\-40", "rc2\-64", "rc2\-128".
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_get_cert_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command is used to extract X509 certificates from a PKCS7 structure.
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $smime_decrypt_command command for
|
||
|
|
possible \fCprintf(3)\fP\-like sequences.
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_get_cert_email_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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).
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $smime_decrypt_command command for
|
||
|
|
possible \fCprintf(3)\fP\-like sequences.
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_get_signer_cert_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $smime_decrypt_command command for
|
||
|
|
possible \fCprintf(3)\fP\-like sequences.
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_import_cert_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command is used to import a certificate via smime_keys.
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $smime_decrypt_command command for
|
||
|
|
possible \fCprintf(3)\fP\-like sequences. NOTE: %c and %k will default
|
||
|
|
to $smime_sign_as if set, otherwise $smime_default_key.
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_is_default
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The default behavior of NeoMutt is to use PGP on all auto\-sign/encryption
|
||
|
|
operations. To override and to use OpenSSL instead this must be \fIset\fP.
|
||
|
|
However, this has no effect while replying, since NeoMutt will automatically
|
||
|
|
select the same application that was used to sign/encrypt the original
|
||
|
|
message. (Note that this variable can be overridden by unsetting $crypt_autosmime.)
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_keys
|
||
|
|
.nf
|
||
|
|
Type: path
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Since for S/MIME there is no pubring/secring as with PGP, NeoMutt has to handle
|
||
|
|
storage and retrieval of keys/certs by itself. This is very basic right now,
|
||
|
|
and stores keys and certificates in two different directories, both
|
||
|
|
named as the hash\-value retrieved from OpenSSL. There is an index file
|
||
|
|
which contains mailbox\-address keyid pair, and which can be manually
|
||
|
|
edited. This option points to the location of the private keys.
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_pk7out_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command is used to extract PKCS7 structures of S/MIME signatures,
|
||
|
|
in order to extract the public X509 certificate(s).
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $smime_decrypt_command command for
|
||
|
|
possible \fCprintf(3)\fP\-like sequences.
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_self_encrypt
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, S/MIME encrypted messages will also be encrypted
|
||
|
|
using the certificate in $smime_default_key.
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_sign_as
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_sign_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command is used to created S/MIME signatures of type
|
||
|
|
\fCmultipart/signed\fP, which can be read by all mail clients.
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $smime_decrypt_command command for
|
||
|
|
possible \fCprintf(3)\fP\-like sequences.
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_sign_digest_alg
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "sha256"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This sets the algorithm that should be used for the signature message digest.
|
||
|
|
Valid choices are "md5", "sha1", "sha224", "sha256", "sha384", "sha512".
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_timeout
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 300
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The number of seconds after which a cached passphrase will expire if
|
||
|
|
not used.
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_verify_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command is used to verify S/MIME signatures of type \fCmultipart/signed\fP.
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $smime_decrypt_command command for
|
||
|
|
possible \fCprintf(3)\fP\-like sequences.
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smime_verify_opaque_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This command is used to verify S/MIME signatures of type
|
||
|
|
\fCapplication/x\-pkcs7\-mime\fP.
|
||
|
|
.IP
|
||
|
|
This is a format string, see the $smime_decrypt_command command for
|
||
|
|
possible \fCprintf(3)\fP\-like sequences.
|
||
|
|
(S/MIME only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smtp_authenticators
|
||
|
|
.nf
|
||
|
|
Type: string list
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This is a colon\-delimited list of authentication methods NeoMutt may
|
||
|
|
attempt to use to log in to an SMTP server, in the order NeoMutt should
|
||
|
|
try them. Authentication methods are any SASL mechanism, e.g. "plain",
|
||
|
|
"digest\-md5", "gssapi" or "cram\-md5".
|
||
|
|
This option is case\-insensitive. If it is "unset"
|
||
|
|
(the default) NeoMutt will try all available methods, in order from
|
||
|
|
most\-secure to least\-secure. Support for the "plain" mechanism is
|
||
|
|
bundled; other mechanisms are provided by an external SASL library (look
|
||
|
|
for +USE_SASL in the output of neomutt \-v).
|
||
|
|
.IP
|
||
|
|
Example:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set smtp_authenticators="digest\-md5:cram\-md5"
|
||
|
|
|
||
|
|
.EE
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smtp_oauth_refresh_command
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The command to run to generate an OAUTH refresh token for
|
||
|
|
authorizing your connection to your SMTP server. This command will be
|
||
|
|
run on every connection attempt that uses the OAUTHBEARER authentication
|
||
|
|
mechanism. See "oauth" for details.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smtp_pass
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies the password for your SMTP account. If \fIunset\fP, 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.
|
||
|
|
.IP
|
||
|
|
\fBWarning\fP: you should only use this option when you are on a
|
||
|
|
fairly secure machine, because the superuser can read your neomuttrc even
|
||
|
|
if you are the only one who can read the file.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smtp_url
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Defines the SMTP smarthost where sent messages should relayed for
|
||
|
|
delivery. This should take the form of an SMTP URL, e.g.:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
smtp[s]://[user[:pass]@]host[:port]
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
where "[...]" denotes an optional part.
|
||
|
|
Setting this variable overrides the value of the $sendmail
|
||
|
|
variable.
|
||
|
|
.IP
|
||
|
|
Also see $write_bcc.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B smtp_user
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The username for the SMTP server.
|
||
|
|
.IP
|
||
|
|
This variable defaults to your user name on the local machine.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sort
|
||
|
|
.nf
|
||
|
|
Type: sort order
|
||
|
|
Default: date
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies how to sort messages in the "index" menu. Valid values
|
||
|
|
are:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
\(hy date
|
||
|
|
.TP
|
||
|
|
\(hy date\-received
|
||
|
|
.TP
|
||
|
|
\(hy from
|
||
|
|
.TP
|
||
|
|
\(hy score
|
||
|
|
.TP
|
||
|
|
\(hy size
|
||
|
|
.TP
|
||
|
|
\(hy spam
|
||
|
|
.TP
|
||
|
|
\(hy subject
|
||
|
|
.TP
|
||
|
|
\(hy threads
|
||
|
|
.TP
|
||
|
|
\(hy to
|
||
|
|
.TP
|
||
|
|
\(hy unsorted
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
You may optionally use the "reverse\-" prefix to specify reverse sorting
|
||
|
|
order.
|
||
|
|
.IP
|
||
|
|
The "date\-sent" value is a synonym for "date". The "mailbox\-order" value is
|
||
|
|
a synonym for "unsorted".
|
||
|
|
.IP
|
||
|
|
Example:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set sort=reverse\-date\-sent
|
||
|
|
|
||
|
|
.EE
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sort_alias
|
||
|
|
.nf
|
||
|
|
Type: sort order
|
||
|
|
Default: alias
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies how the entries in the "alias" menu are sorted. The
|
||
|
|
following are legal values:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
\(hy address (sort alphabetically by email address)
|
||
|
|
.TP
|
||
|
|
\(hy alias (sort alphabetically by alias name)
|
||
|
|
.TP
|
||
|
|
\(hy unsorted (leave in order specified in .neomuttrc)
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
Note: This also affects the entries of the address query menu, thus
|
||
|
|
potentially overruling the order of entries as generated by $query_command.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sort_aux
|
||
|
|
.nf
|
||
|
|
Type: sort order
|
||
|
|
Default: date
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This provides a secondary sort for messages in the "index" menu, used
|
||
|
|
when the $sort value is equal for two messages.
|
||
|
|
.IP
|
||
|
|
When sorting by threads, this variable controls how threads are sorted
|
||
|
|
in relation to other threads, and how the branches of the thread trees
|
||
|
|
are sorted. This can be set to any value that $sort can, except
|
||
|
|
"threads" (in that case, NeoMutt will just use "date"). You can also
|
||
|
|
specify the "last\-" prefix in addition to the "reverse\-" prefix, but "last\-"
|
||
|
|
must come after "reverse\-". The "last\-" prefix causes messages to be
|
||
|
|
sorted against its siblings by which has the last descendant, using
|
||
|
|
the rest of $sort_aux as an ordering. For instance,
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set sort_aux=last\-date\-received
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
would mean that if a new message is received in a
|
||
|
|
thread, that thread becomes the last one displayed (or the first, if
|
||
|
|
you have "\fCset sort=reverse\-threads\fP".)
|
||
|
|
.IP
|
||
|
|
Note: For reversed\-threads $sort
|
||
|
|
order, $sort_aux is reversed again (which is not the right thing to do,
|
||
|
|
but kept to not break any existing configuration setting).
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sort_browser
|
||
|
|
.nf
|
||
|
|
Type: sort order
|
||
|
|
Default: alpha
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies how to sort entries in the file browser. By default, the
|
||
|
|
entries are sorted alphabetically. Valid values:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
\(hy alpha (alphabetically)
|
||
|
|
.TP
|
||
|
|
\(hy count (all message count)
|
||
|
|
.TP
|
||
|
|
\(hy date
|
||
|
|
.TP
|
||
|
|
\(hy desc (description)
|
||
|
|
.TP
|
||
|
|
\(hy new (new message count)
|
||
|
|
.TP
|
||
|
|
\(hy size
|
||
|
|
.TP
|
||
|
|
\(hy unsorted
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
You may optionally use the "reverse\-" prefix to specify reverse sorting
|
||
|
|
order (example: "\fCset sort_browser=reverse\-date\fP").
|
||
|
|
.IP
|
||
|
|
The "unread" value is a synonym for "new".
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B sort_re
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable is only useful when sorting by threads with
|
||
|
|
$strict_threads \fIunset\fP. In that case, it changes the heuristic
|
||
|
|
mutt uses to thread messages by subject. With $sort_re \fIset\fP, mutt 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 \fIunset\fP, mutt will attach
|
||
|
|
the message whether or not this is the case, as long as the
|
||
|
|
non\-$reply_regex parts of both messages are identical.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B spam_separator
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ","
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable controls what happens when multiple spam headers
|
||
|
|
are matched: if \fIunset\fP, each successive header will overwrite any
|
||
|
|
previous matches value for the spam label. If \fIset\fP, each successive
|
||
|
|
match will append to the previous, using this variable's value as a
|
||
|
|
separator.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B spoolfile
|
||
|
|
.nf
|
||
|
|
Type: mailbox
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If your spool mailbox is in a non\-default place where NeoMutt can't find
|
||
|
|
it, you can specify its location with this variable. The description from
|
||
|
|
"named\-mailboxes" or "virtual\-mailboxes" may be used for the spoolfile.
|
||
|
|
.IP
|
||
|
|
If not specified, then the environment variables \fC$MAIL\fP and
|
||
|
|
\fC$MAILDIR\fP will be checked.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ssl_ca_certificates_file
|
||
|
|
.nf
|
||
|
|
Type: path
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies a file containing trusted CA certificates.
|
||
|
|
Any server certificate that is signed with one of these CA
|
||
|
|
certificates is also automatically accepted. (GnuTLS only)
|
||
|
|
.IP
|
||
|
|
Example:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set ssl_ca_certificates_file=/etc/ssl/certs/ca\-certificates.crt
|
||
|
|
|
||
|
|
.EE
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ssl_ciphers
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Contains a colon\-separated list of ciphers to use when using SSL.
|
||
|
|
For OpenSSL, see ciphers(1) for the syntax of the string.
|
||
|
|
.IP
|
||
|
|
For GnuTLS, this option will be used in place of "NORMAL" at the
|
||
|
|
start of the priority string. See gnutls_priority_init(3) for the
|
||
|
|
syntax and more details. (Note: GnuTLS version 2.1.7 or higher is
|
||
|
|
required.)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ssl_client_cert
|
||
|
|
.nf
|
||
|
|
Type: path
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
The file containing a client certificate and its associated private
|
||
|
|
key.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ssl_force_tls
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If this variable is \fIset\fP, 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.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ssl_min_dh_prime_bits
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 0
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable specifies the minimum acceptable prime size (in bits)
|
||
|
|
for use in any Diffie\-Hellman key exchange. A value of 0 will use
|
||
|
|
the default from the GNUTLS library. (GnuTLS only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ssl_starttls
|
||
|
|
.nf
|
||
|
|
Type: quadoption
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP (the default), NeoMutt will attempt to use \fCSTARTTLS\fP on servers
|
||
|
|
advertising the capability. When \fIunset\fP, NeoMutt will not attempt to
|
||
|
|
use \fCSTARTTLS\fP regardless of the server's capabilities.
|
||
|
|
.IP
|
||
|
|
\fBNote\fP that \fCSTARTTLS\fP is 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 \fCSTARTTLS\fP.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ssl_use_sslv2
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP , NeoMutt will use SSLv2 when communicating with servers that
|
||
|
|
request it. \fBN.B. As of 2011, SSLv2 is considered insecure, and using
|
||
|
|
is inadvisable. See https://tools.ietf.org/html/rfc6176 .\fP
|
||
|
|
(OpenSSL only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ssl_use_sslv3
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP , NeoMutt will use SSLv3 when communicating with servers that
|
||
|
|
request it. \fBN.B. As of 2015, SSLv3 is considered insecure, and using
|
||
|
|
it is inadvisable. See https://tools.ietf.org/html/rfc7525 .\fP
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ssl_use_tlsv1
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP , NeoMutt will use TLSv1.0 when communicating with servers that
|
||
|
|
request it. \fBN.B. As of 2015, TLSv1.0 is considered insecure, and using
|
||
|
|
it is inadvisable. See https://tools.ietf.org/html/rfc7525 .\fP
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ssl_use_tlsv1_1
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP , NeoMutt will use TLSv1.1 when communicating with servers that
|
||
|
|
request it. \fBN.B. As of 2015, TLSv1.1 is considered insecure, and using
|
||
|
|
it is inadvisable. See https://tools.ietf.org/html/rfc7525 .\fP
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ssl_use_tlsv1_2
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP , NeoMutt will use TLSv1.2 when communicating with servers that
|
||
|
|
request it.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ssl_use_tlsv1_3
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP , NeoMutt will use TLSv1.3 when communicating with servers that
|
||
|
|
request it.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ssl_usesystemcerts
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If set to \fIyes\fP, NeoMutt will use CA certificates in the
|
||
|
|
system\-wide certificate store when checking if a server certificate
|
||
|
|
is signed by a trusted CA. (OpenSSL only)
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ssl_verify_dates
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP (the default), NeoMutt will not automatically accept a server
|
||
|
|
certificate that is either not yet valid or already expired. You should
|
||
|
|
only unset this for particular known hosts, using the
|
||
|
|
\fC<account-hook>\fP function.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ssl_verify_host
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP (the default), NeoMutt will not automatically accept a server
|
||
|
|
certificate whose host name does not match the host used in your folder
|
||
|
|
URL. You should only unset this for particular known hosts, using
|
||
|
|
the \fC<account-hook>\fP function.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ssl_verify_partial_chains
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This option should not be changed from the default unless you understand
|
||
|
|
what you are doing.
|
||
|
|
.IP
|
||
|
|
Setting this variable to \fIyes\fP will permit verifying partial
|
||
|
|
certification chains, i. e. a certificate chain where not the root,
|
||
|
|
but an intermediate certificate CA, or the host certificate, are
|
||
|
|
marked trusted (in $certificate_file), without marking the root
|
||
|
|
signing CA as trusted.
|
||
|
|
.IP
|
||
|
|
(OpenSSL 1.0.2b and newer only).
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B status_chars
|
||
|
|
.nf
|
||
|
|
Type: character string
|
||
|
|
Default: "\-*%A"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls the characters used by the "%r" indicator in $status_format.
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
\fBCharacter\fP
|
||
|
|
\fBDefault\fP
|
||
|
|
\fBDescription\fP
|
||
|
|
.TP
|
||
|
|
1
|
||
|
|
\-
|
||
|
|
Mailbox is unchanged
|
||
|
|
.TP
|
||
|
|
2
|
||
|
|
*
|
||
|
|
Mailbox has been changed and needs to be resynchronized
|
||
|
|
.TP
|
||
|
|
3
|
||
|
|
%
|
||
|
|
Mailbox is read\-only, or will not be written when exiting.
|
||
|
|
(You can toggle whether to write changes to a mailbox
|
||
|
|
with the \fC<toggle\-write>\fP operation, bound by default
|
||
|
|
to "%")
|
||
|
|
.TP
|
||
|
|
4
|
||
|
|
A
|
||
|
|
Folder opened in attach\-message mode.
|
||
|
|
(Certain operations like composing a new mail, replying,
|
||
|
|
forwarding, etc. are not permitted in this mode)
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B status_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "\-%r\-NeoMutt: %D [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d? Del:%d?%?F? Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l? %l?]\-\-\-(%s/%S)\-%>\-(%P)\-\-\-"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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 \fCprintf(3)\fP\-like sequences:
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
%b
|
||
|
|
*
|
||
|
|
Number of mailboxes with new mail
|
||
|
|
.TP
|
||
|
|
%d
|
||
|
|
*
|
||
|
|
Number of deleted messages
|
||
|
|
.TP
|
||
|
|
%D
|
||
|
|
|
||
|
|
Description of the mailbox
|
||
|
|
.TP
|
||
|
|
%f
|
||
|
|
|
||
|
|
The full pathname of the current mailbox
|
||
|
|
.TP
|
||
|
|
%F
|
||
|
|
*
|
||
|
|
Number of flagged messages
|
||
|
|
.TP
|
||
|
|
%h
|
||
|
|
|
||
|
|
Local hostname
|
||
|
|
.TP
|
||
|
|
%l
|
||
|
|
*
|
||
|
|
Size (in bytes) of the current mailbox (see formatstrings-size)
|
||
|
|
.TP
|
||
|
|
%L
|
||
|
|
*
|
||
|
|
Size (in bytes) of the messages shown
|
||
|
|
(i.e., which match the current limit) (see formatstrings-size)
|
||
|
|
.TP
|
||
|
|
%m
|
||
|
|
*
|
||
|
|
The number of messages in the mailbox
|
||
|
|
.TP
|
||
|
|
%M
|
||
|
|
*
|
||
|
|
The number of messages shown (i.e., which match the current limit)
|
||
|
|
.TP
|
||
|
|
%n
|
||
|
|
*
|
||
|
|
Number of new messages in the mailbox (unread, unseen)
|
||
|
|
.TP
|
||
|
|
%o
|
||
|
|
*
|
||
|
|
Number of old messages in the mailbox (unread, seen)
|
||
|
|
.TP
|
||
|
|
%p
|
||
|
|
*
|
||
|
|
Number of postponed messages
|
||
|
|
.TP
|
||
|
|
%P
|
||
|
|
|
||
|
|
Percentage of the way through the index
|
||
|
|
.TP
|
||
|
|
%r
|
||
|
|
|
||
|
|
Modified/read\-only/won't\-write/attach\-message indicator,
|
||
|
|
According to $status_chars
|
||
|
|
.TP
|
||
|
|
%R
|
||
|
|
*
|
||
|
|
Number of read messages in the mailbox (read, seen)
|
||
|
|
.TP
|
||
|
|
%s
|
||
|
|
|
||
|
|
Current sorting mode ($sort)
|
||
|
|
.TP
|
||
|
|
%S
|
||
|
|
|
||
|
|
Current aux sorting method ($sort_aux)
|
||
|
|
.TP
|
||
|
|
%t
|
||
|
|
*
|
||
|
|
Number of tagged messages in the mailbox
|
||
|
|
.TP
|
||
|
|
%u
|
||
|
|
*
|
||
|
|
Number of unread messages in the mailbox (seen or unseen)
|
||
|
|
.TP
|
||
|
|
%v
|
||
|
|
|
||
|
|
NeoMutt version string
|
||
|
|
.TP
|
||
|
|
%V
|
||
|
|
*
|
||
|
|
Currently active limit pattern, if any
|
||
|
|
.TP
|
||
|
|
%>X
|
||
|
|
|
||
|
|
Right justify the rest of the string and pad with "X"
|
||
|
|
.TP
|
||
|
|
%|X
|
||
|
|
|
||
|
|
Pad to the end of the line with "X"
|
||
|
|
.TP
|
||
|
|
%*X
|
||
|
|
|
||
|
|
Soft\-fill with character "X" as pad
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
.IP
|
||
|
|
For an explanation of "soft\-fill", see the $index_format documentation.
|
||
|
|
.IP
|
||
|
|
* = can be optionally printed if nonzero
|
||
|
|
.IP
|
||
|
|
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:
|
||
|
|
.IP
|
||
|
|
\fC%?<sequence_char>?<optional_string>?\fP
|
||
|
|
.IP
|
||
|
|
where \fIsequence_char\fP is a character from the table above, and
|
||
|
|
\fIoptional_string\fP is the string you would like printed if
|
||
|
|
\fIsequence_char\fP is nonzero. \fIoptional_string\fP \fBmay\fP contain
|
||
|
|
other sequences as well as normal text, but you may \fBnot\fP nest
|
||
|
|
optional strings.
|
||
|
|
.IP
|
||
|
|
Here is an example illustrating how to optionally print the number of
|
||
|
|
new messages in a mailbox:
|
||
|
|
.IP
|
||
|
|
\fC%?n?%n new messages.?\fP
|
||
|
|
.IP
|
||
|
|
You can also switch between two strings using the following construct:
|
||
|
|
.IP
|
||
|
|
\fC%?<sequence_char>?<if_string>&<else_string>?\fP
|
||
|
|
.IP
|
||
|
|
If the value of \fIsequence_char\fP is non\-zero, \fIif_string\fP will
|
||
|
|
be expanded, otherwise \fIelse_string\fP will be expanded.
|
||
|
|
.IP
|
||
|
|
You can force the result of any \fCprintf(3)\fP\-like sequence to be lowercase
|
||
|
|
by prefixing the sequence character with an underscore ("_") sign.
|
||
|
|
For example, if you want to display the local hostname in lowercase,
|
||
|
|
you would use: "\fC%_h\fP".
|
||
|
|
.IP
|
||
|
|
If you prefix the sequence character with a colon (":") character, NeoMutt
|
||
|
|
will replace any dots in the expansion by underscores. This might be helpful
|
||
|
|
with IMAP folders that don't like dots in folder names.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B status_on_top
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Setting this variable causes the "status bar" to be displayed on
|
||
|
|
the first line of the screen rather than near the bottom. If $help
|
||
|
|
is \fIset\fP, too it'll be placed at the bottom.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B strict_threads
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, 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.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B suspend
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIunset\fP, NeoMutt won't stop when the user presses the terminal's
|
||
|
|
\fIsusp\fP key, usually "^Z". This is useful if you run NeoMutt
|
||
|
|
inside an xterm using a command like "\fCxterm \-e neomutt\fP".
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B text_flowed
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will generate "format=flowed" bodies with a content type
|
||
|
|
of "\fCtext/plain; format=flowed\fP".
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
Note that $indent_string is ignored when this option is \fIset\fP.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B thorough_search
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Affects the \fC~b\fP and \fC~h\fP search operations described in
|
||
|
|
section "patterns". If \fIset\fP, the headers and body/attachments of
|
||
|
|
messages to be searched are decoded before searching. If \fIunset\fP,
|
||
|
|
messages are searched as they appear in the folder.
|
||
|
|
.IP
|
||
|
|
Users searching attachments or for non\-ASCII characters should \fIset\fP
|
||
|
|
this value because decoding also includes MIME parsing/decoding and possible
|
||
|
|
character set conversions. Otherwise NeoMutt will attempt to match against the
|
||
|
|
raw message received (for example quoted\-printable encoded or with encoded
|
||
|
|
headers) which may lead to incorrect search results.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B thread_received
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt uses the date received rather than the date sent
|
||
|
|
to thread messages by subject.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B tilde
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, the internal\-pager will pad blank lines to the bottom of the
|
||
|
|
screen with a tilde ("~").
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B time_inc
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 0
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Along 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.
|
||
|
|
.IP
|
||
|
|
Also see the "tuning" section of the manual for performance considerations.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B timeout
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 600
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When NeoMutt is waiting for user input either idling in menus or
|
||
|
|
in an interactive prompt, NeoMutt would block until input is
|
||
|
|
present. Depending on the context, this would prevent certain
|
||
|
|
operations from working, like checking for new mail or keeping
|
||
|
|
an IMAP connection alive.
|
||
|
|
.IP
|
||
|
|
This variable controls how many seconds NeoMutt will at most wait
|
||
|
|
until it aborts waiting for input, performs these operations and
|
||
|
|
continues to wait for input.
|
||
|
|
.IP
|
||
|
|
A value of zero or less will cause NeoMutt to never time out.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B tmpdir
|
||
|
|
.nf
|
||
|
|
Type: path
|
||
|
|
Default: "/tmp"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable allows you to specify where NeoMutt will place its
|
||
|
|
temporary files needed for displaying and composing messages.
|
||
|
|
.IP
|
||
|
|
If this variable is not set, the environment variable \fC$TMPDIR\fP is
|
||
|
|
used. Failing that, then "\fC/tmp\fP" is used.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B to_chars
|
||
|
|
.nf
|
||
|
|
Type: character string
|
||
|
|
Default: " +TCFLR"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls the character used to indicate mail addressed to you.
|
||
|
|
.RS
|
||
|
|
.PD 0
|
||
|
|
.TP
|
||
|
|
\fBCharacter\fP
|
||
|
|
\fBDefault\fP
|
||
|
|
\fBDescription\fP
|
||
|
|
.TP
|
||
|
|
1
|
||
|
|
<space>
|
||
|
|
The mail is \fInot\fP addressed to your address.
|
||
|
|
.TP
|
||
|
|
2
|
||
|
|
+
|
||
|
|
You are the only recipient of the message.
|
||
|
|
.TP
|
||
|
|
3
|
||
|
|
T
|
||
|
|
Your address appears in the "To:" header field, but you are not the only recipient of the message.
|
||
|
|
.TP
|
||
|
|
4
|
||
|
|
C
|
||
|
|
Your address is specified in the "Cc:" header field, but you are not the only recipient.
|
||
|
|
.TP
|
||
|
|
5
|
||
|
|
F
|
||
|
|
Indicates the mail that was sent by \fIyou\fP.
|
||
|
|
.TP
|
||
|
|
6
|
||
|
|
L
|
||
|
|
Indicates the mail was sent to a mailing\-list you subscribe to.
|
||
|
|
.TP
|
||
|
|
7
|
||
|
|
R
|
||
|
|
Your address appears in the "Reply\-To:" header field but none of the above applies.
|
||
|
|
.RE
|
||
|
|
.PD 1
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B toggle_quoted_show_levels
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 0
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Quoted text may be filtered out using the \fC<toggle\-quoted>\fP command.
|
||
|
|
If set to a number greater than 0, then the \fC<toggle\-quoted>\fP
|
||
|
|
command will only filter out quote levels above this number.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B trash
|
||
|
|
.nf
|
||
|
|
Type: mailbox
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If set, this variable specifies the path of the trash folder where the
|
||
|
|
mails marked for deletion will be moved, instead of being irremediably
|
||
|
|
purged.
|
||
|
|
.IP
|
||
|
|
NOTE: When you delete a message in the trash folder, it is really
|
||
|
|
deleted, so that you have a way to clean the trash.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ts_enabled
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether NeoMutt tries to set the terminal status line and icon name.
|
||
|
|
Most terminal emulators emulate the status line in the window title.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ts_icon_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "M%?n?AIL&ail?"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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".
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B ts_status_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "NeoMutt with %?m?%m messages&no messages?%?n? [%n NEW]?"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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".
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B tunnel
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: ""
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Setting this variable will cause NeoMutt to open a pipe to a command
|
||
|
|
instead of a raw socket. You may be able to use this to set up
|
||
|
|
preauthenticated connections to your IMAP/POP3/SMTP server. Example:
|
||
|
|
|
||
|
|
.IP
|
||
|
|
.EX
|
||
|
|
set tunnel="ssh \-q mailhost.net /usr/local/libexec/imapd"
|
||
|
|
|
||
|
|
.EE
|
||
|
|
.IP
|
||
|
|
Note: For this example to work you must be able to log in to the remote
|
||
|
|
machine without having to enter a password.
|
||
|
|
.IP
|
||
|
|
When set, NeoMutt uses the tunnel for all remote connections.
|
||
|
|
Please see "account-hook" in the manual for how to use different
|
||
|
|
tunnel commands per connection.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B tunnel_is_secure
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, 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.
|
||
|
|
.IP
|
||
|
|
When \fIunset\fP, 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.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B uncollapse_jump
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will jump to the next unread message, if any,
|
||
|
|
when the current thread is \fIun\fPcollapsed.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B uncollapse_new
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will automatically uncollapse any collapsed thread
|
||
|
|
that receives a new message. When \fIunset\fP, collapsed threads will
|
||
|
|
remain collapsed. the presence of the new message will still affect
|
||
|
|
index sorting, though.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B use_8bitmime
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
\fBWarning:\fP do not set this variable unless you are using a version
|
||
|
|
of sendmail which supports the \fC\-B8BITMIME\fP flag (such as sendmail
|
||
|
|
8.8.x) or you may not be able to send mail.
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will invoke $sendmail with the \fC\-B8BITMIME\fP
|
||
|
|
flag when sending 8\-bit messages to enable ESMTP negotiation.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B use_domain
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will qualify all local addresses (ones without the
|
||
|
|
"@host" portion) with the value of $hostname. If \fIunset\fP, no
|
||
|
|
addresses will be qualified.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B use_envelope_from
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will set the \fIenvelope\fP sender of the message.
|
||
|
|
If $envelope_from_address is \fIset\fP, it will be used as the sender
|
||
|
|
address. If \fIunset\fP, NeoMutt will attempt to derive the sender from the
|
||
|
|
"From:" header.
|
||
|
|
.IP
|
||
|
|
Note that this information is passed to sendmail command using the
|
||
|
|
\fC\-f\fP command line switch. Therefore setting this option is not useful
|
||
|
|
if the $sendmail variable already contains \fC\-f\fP or if the
|
||
|
|
executable pointed to by $sendmail doesn't support the \fC\-f\fP switch.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B use_from
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will generate the "From:" header field when
|
||
|
|
sending messages. If \fIunset\fP, no "From:" header field will be
|
||
|
|
generated unless the user explicitly sets one using the "my_hdr"
|
||
|
|
command.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B use_ipv6
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will look for IPv6 addresses of hosts it tries to
|
||
|
|
contact. If this option is \fIunset\fP, NeoMutt will restrict itself to IPv4 addresses.
|
||
|
|
Normally, the default should work.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B user_agent
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will add a "User\-Agent:" header to outgoing
|
||
|
|
messages, indicating which version of NeoMutt was used for composing
|
||
|
|
them.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B vfolder_format
|
||
|
|
.nf
|
||
|
|
Type: string
|
||
|
|
Default: "%2C %?n?%4n/& ?%4m %f"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This variable allows you to customize the file browser display for virtual
|
||
|
|
folders to your personal taste. This string uses many of the same
|
||
|
|
expandos as $folder_format.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B virtual_spoolfile
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will use the first defined virtual mailbox (see
|
||
|
|
virtual\-mailboxes) as a spool file.
|
||
|
|
.IP
|
||
|
|
This command is now unnecessary. $spoolfile has been extended to support
|
||
|
|
mailbox descriptions as a value.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B visual
|
||
|
|
.nf
|
||
|
|
Type: command
|
||
|
|
Default: "vi"
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Specifies the visual editor to invoke when the "\fC~v\fP" command is
|
||
|
|
given in the built\-in editor.
|
||
|
|
.IP
|
||
|
|
$visual is overridden by the environment variable \fC$VISUAL\fP or \fC$EDITOR\fP.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B wait_key
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether NeoMutt will ask you to press a key after an external command
|
||
|
|
has been invoked by these functions: \fC<shell\-escape>\fP,
|
||
|
|
\fC<pipe\-message>\fP, \fC<pipe\-entry>\fP, \fC<print\-message>\fP,
|
||
|
|
and \fC<print\-entry>\fP commands.
|
||
|
|
.IP
|
||
|
|
It is also used when viewing attachments with "auto_view", provided
|
||
|
|
that the corresponding mailcap entry has a \fIneedsterminal\fP flag,
|
||
|
|
and the external program is interactive.
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will always ask for a key. When \fIunset\fP, NeoMutt will wait
|
||
|
|
for a key only if the external command returned a non\-zero status.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B weed
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, NeoMutt will weed headers when displaying, forwarding,
|
||
|
|
or replying to messages.
|
||
|
|
.IP
|
||
|
|
Also see $copy_decode_weed, $pipe_decode_weed, $print_decode_weed.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B wrap
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 0
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
Also see $reflow_wrap.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B wrap_headers
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 78
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
This option specifies the number of characters to use for wrapping
|
||
|
|
an outgoing message's headers. Allowed values are between 78 and 998
|
||
|
|
inclusive.
|
||
|
|
.IP
|
||
|
|
\fBNote:\fP This option usually shouldn't be changed. RFC5233
|
||
|
|
recommends a line length of 78 (the default), so \fBplease only change
|
||
|
|
this setting when you know what you're doing\fP.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B wrap_search
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: yes
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
Controls whether searches wrap around the end.
|
||
|
|
.IP
|
||
|
|
When \fIset\fP, searches will wrap around the first (or last) item. When
|
||
|
|
\fIunset\fP, incremental searches will not wrap.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B write_bcc
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
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.
|
||
|
|
.IP
|
||
|
|
Note this option only affects the sending of messages. Fcc'ed
|
||
|
|
copies of a message will always contain the "Bcc:" header if
|
||
|
|
one exists.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B write_inc
|
||
|
|
.nf
|
||
|
|
Type: number
|
||
|
|
Default: 10
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
When 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.
|
||
|
|
.IP
|
||
|
|
Also see the $read_inc, $net_inc and $time_inc variables and the
|
||
|
|
"tuning" section of the manual for performance considerations.
|
||
|
|
|
||
|
|
|
||
|
|
.TP
|
||
|
|
.B x_comment_to
|
||
|
|
.nf
|
||
|
|
Type: boolean
|
||
|
|
Default: no
|
||
|
|
.fi
|
||
|
|
.IP
|
||
|
|
If \fIset\fP, NeoMutt will add "X\-Comment\-To:" field (that contains full
|
||
|
|
name of original article author) to article that followuped to newsgroup.
|
||
|
|
|
||
|
|
|
||
|
|
.\" -*- nroff -*-
|
||
|
|
.\" --------------------------------------------------------------------
|
||
|
|
.SH SEE ALSO
|
||
|
|
.\" --------------------------------------------------------------------
|
||
|
|
.PP
|
||
|
|
.\" sorted by category and name
|
||
|
|
.BR iconv (1),
|
||
|
|
.BR neomutt (1),
|
||
|
|
.BR notmuch (1),
|
||
|
|
.BR iconv (3),
|
||
|
|
.BR printf (3),
|
||
|
|
.BR strftime (3),
|
||
|
|
.BR mailcap (5),
|
||
|
|
.BR maildir (5),
|
||
|
|
.BR mbox (5),
|
||
|
|
.BR regex (7).
|
||
|
|
.
|
||
|
|
.PP
|
||
|
|
For further NeoMutt information:
|
||
|
|
.RS 4
|
||
|
|
.TP
|
||
|
|
.RI "\(bu the full manual, " "/usr/share/doc/neomutt/manual." { html , pdf , txt }
|
||
|
|
.TQ
|
||
|
|
\(bu the home page, <https://neomutt.org>
|
||
|
|
.RE
|
||
|
|
.
|
||
|
|
.\" --------------------------------------------------------------------
|
||
|
|
.SH AUTHOR
|
||
|
|
.\" --------------------------------------------------------------------
|
||
|
|
.PP
|
||
|
|
Michael Elkins, and others. Use <neomutt-devel@\:neomutt.org> to contact the
|
||
|
|
developers.
|
||
|
|
.
|