nail.1: add missing stuff; tweaks

[s-mailx.git] / nail.1

.\" Copyright (c) 1980, 1990, 1993
.\"     The Regents of the University of California.  All rights reserved.
.\" Copyright (c) 2000
.\"     Gunnar Ritter.  All rights reserved.
.\" Copyright (c) 2012 - 2014 Steffen (Daode) Nurpmeso <sdaoden@users.sf.net>.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"     This product includes software developed by the University of
.\"     California, Berkeley and its contributors.
.\"     This product includes software developed by Gunnar Ritter
.\"     and his contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS '\fIAS IS\fR' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd Feb 22, 2014
.\"--MKMAN-START--
.ds UU \\%S-NAIL
.ds UA \\%S-nail
.ds UV \\%S-nail dirty
.ds ua \\%s-nail
.ds UR \\%s-nail.rc
.\"--MKMAN-END--
.\" If not ~/.mailrc, it breaks POSIX compatibility.  And adjust main.c.
.ds ur \\%~/.mailrc
\."
.ds OP [Optional]
.ds LE [Legacy]
.ds OB [Obsolete]
\."
.Dt "\*(UU" 1
.Sh NAME
.Nm \*(UV
.Nd send and receive Internet mail
.\"
.\" --  >8  --  8<  --
.\"
.Sh SYNOPSIS
.Nm \*(ua
.Op Fl BDdEFintv~
.Op Fl A Ar account
.Op Fl a Ar attachment
.Op Fl b Ar bcc-addr
.Op Fl c Ar cc-addr
.Op Fl O Ar mta-option
.Op Fl q Ar quote-file
.Op Fl r Ar from-addr
.Op Fl S Ar variable Ns Op Ns = Ns Ar value
.Op Fl s Ar subject
.Bk
.Ar to-addr ...
.Ek
.Nm \*(ua
.Op Fl BDdEeHiNnRv~#
.Op Fl A Ar account
.Op Fl L Ar spec-list
.Op Fl S Ar variable Ns Op Ns = Ns Ar value
.Bk
.Fl f Op Ar file
.Ek
.Nm \*(ua
.Op Fl BDdEeHiNnRv~#
.Op Fl A Ar account
.Op Fl L Ar spec-list
.Op Fl S Ar variable Ns Op Ns = Ns Ar value
.Op Fl u Ar user
.\"
.\" --  >8  --  8<  --
.\"
.Sh DESCRIPTION
\*(UA is a mail processing system with a command syntax reminiscent of
.Xr ed 1
with lines replaced by messages.
It is intended to provide the functionality of the POSIX
.Xr mailx 1
command and offers (mostly optional) extensions for line editing, IDNA,
MIME, S/MIME, SMTP and POP3 (and IMAP).
It is usable as a mail batch language.
.Pp
In the following list of supported command line options,
.Fl D ,
.Fl d ,
.Fl E ,
.Fl i ,
.Fl N
and
.Fl v
are implemented by means of setting the respective option, as via
.Fl S .
.\" ---
.Bl -tag -width ".Fl A Ar account"
.It Fl A Ar account
Executes an
.Ic account
command (see below) for
.Ar account
after the startup files have been read.
.It Fl a Ar file
Attach the given file to the message.
The same filename conventions as described in the section
.Sx "Commands"
apply.
.It Fl B
Make standard input and standard output line-buffered.
.It Fl b Ar address
Send blind carbon copies to the given list of addresses.
.Sx "Sending mail"
below goes into more detail on that.
.It Fl c Ar address
Send carbon copies to the given list of addresses.
.It Fl D
\*(OP Set the
.Va disconnected
variable.
.It Fl d
Set the
.Va debug
variable, which enables debug messages and disables message delivery.
Note that this is not a real `sandbox' mode.
.It Fl E
Set the
.Va skipemptybody
variable and thus discard messages with an empty message part body.
This is useful for sending messages from scripts.
.It Fl e
Just check if mail is present in the system mailbox.
If yes, return an exit status of zero, a non-zero value otherwise.
.It Fl F
Save the message to send in a file named after the local part of the
first recipient's address.
.It Fl f Op Ar file
Read in the contents of the user's mbox (or the specified file)
for processing;
when \*(UA is quit, it writes undeleted messages back to this file.
The string
.Ar file
is interpreted as described for the
.Ic folder
command below.
Note that
.Ar file
is not a direct argument to the flag
.Fl f ,
but is instead taken from the command line after option processing has
been completed.
.It Fl H
Print a header summary of all messages and exit.
A configurable summary view is available via the
.Fl L
option.
.It Fl i
Set the
.Va ignore
variable to ignore tty interrupt signals.
.It Fl L Ar spec-list
Print a header summary of only those messages that match the given
.Ar spec-list ,
then exit.
See the section
.Sx "Specifying messages"
for the format of
.Ar spec-list .
If the
.Fl H
option has been given in addition to
.Fl L ,
then printing of the header summary is suppressed,
and \*(UA will instead indicate via its exit status wether
.Ar spec-list
matched any messages (`0') or not (`1');
note that messages are forcefully suppressed, then, and unless verbosity
is explicitly enabled (e.g., by using the
.Fl v
option).
.It Fl N
Unset the
.Va header
variable and thus inhibits the initial display of message headers when
reading mail or editing a mail folder.
.It Fl n
Inhibits reading \*(UR upon startup.
This option should be activated for \*(UA scripts that are invoked on
more than one machine, because the contents of that file may differ
between them.
(The same behaviour can be achieved by setting the
.Ev NAIL_NO_SYSTEM_RC
environment variable.)
.It Fl O Ar mta-option
Pass the given option through to the mail-transfer-agent (MTA).
This option has no effect when mail is send via SMTP.
E.g., use
.Ns ` Ns Li "-O-h -Onumber" Ns '
to specify the hop count for an old
.Xr sendmail 1 .
Options set like that persist for an entire (interactive) session.
.It Fl q Ar file
Start the message with the contents of the specified file.
May be given in send mode only.
.It Fl R
Opens any folders read-only.
.It Fl r Ar address
Sets the envelope sender address by passing an
.Fl r
option to the MTA when a message is send.
If a non-empty
.Ar address
argument is given it'll be checked for validity and then fixated to
the given value, but otherwise the content of the variable
.Va from
will be used for that purpose \(en i.e., it'll be passed through to
the MTA via the
.Fl r
option whenever a message is send.
A valid non-empty value will also be set as if an additional
.Ns ` Ns Li "-Sfrom=VALUE" Ns '
option had been used and therefore affect sending of messages via SMTP
(as a consideration for `From:').
.It Fl S Ar variable Ns Op = Ns value
Sets the internal option
.Ar variable
and, in case of a value option, assigns
.Ar value
to it.
Even though options set via
.Fl S
may be overwritten from within resource files,
the command line setting will be reestablished after all resources have
been loaded.
.It Fl s Ar subject
Specify the subject on the command line
(be careful to quote subjects containing spaces).
.It Fl t
The message to be sent is expected to contain a message header with
`To:', `Cc:', or `Bcc:' fields giving its recipients and `Subject:'
giving the subject of the message.
Recipients and subject specified on the command line are ignored.
.It Fl u Ar user
Read the system mailbox of
.Ar user
(appropriate privileges presumed), and `assume to be'
.Ar user
in some aspects, e.g. in respect to expansions of `%' etc.
Also see
.Ev USER .
.It Fl V
Print \*(UA's version and exit.
.It Fl v
Sets the
.Va verbose
option, which enables more verbose messages.
.It Fl ~
Enable tilde escapes even if not in interactive mode.
.It Fl #
This sets multiple options to prepare \*(UA for working in batch mode
(most likely in non-interactive mode):
.Va dot ,
.Va emptystart ,
.Va noheader ,
.Va quiet ,
.Va sendwait ,
as well as
.Va MBOX
and
.Va folder
to
.Pa /dev/null .
it also enables processing of tilde escapes.
E.g., the following should send an email message to `alias'.
.Pp
.Dl printf 'm alias\en~s Subject\enBody\en.\enx\en' | \
   MAILRC=/dev/null s-nail -n -#
.El
.\"
.\" --  >8  --  8<  --
.Ss "Sending mail"
To send a message to one or more people,
\*(UA can be invoked with arguments which are the names of people to
whom the mail will be sent.
These names may be
.Ic alias Ns
es, plain addresses or full address specifications including user names
and comments,
in which case care for proper quoting may be necessary.
If this manual refers to a \fIlist of addresses\fR,
then \*(UA expects a comma-separated list of such names.
The section
.Sx "Recipient address specifications"
below explains the interpretation of names in more detail.
The user is then expected to type in his message, followed by a
.Li `control-D'
at the beginning of a line.
The section
.Sx "Replying to or originating mail"
describes some features of \*(UA available to help when composing
letters.
.\"
.\" --  >8  --  8<  --
.Ss "Reading mail"
In normal usage \*(UA is given no arguments and checks the user's mail
out of the post office,
then prints out a one line header of each message found.
The current message is initially the first message (numbered 1) and can
be printed using the
.Ic print
command, which can be abbreviated `p'.
The commands `p+' and `p\-' move forward to the next and backward to the
previous message, respectively, and messages can be addressed directly
by specifying their message number, as in `p 1'.
.\"
.\" --  >8  --  8<  --
.Ss "Disposing of mail"
After examining a message the user can
.Ic delete
(`d') the message or
.Ic reply
(`r') to it.
Deletion causes the \*(UA program to forget about the message.
This is not irreversible;
one can
.Ic undelete
(`u') the message by giving its number,
or the \*(UA session can be ended by giving the
.Ic exit
(`x') command.
Deleted messages will, however, usually disappear never to be seen
again.
.\"
.\" --  >8  --  8<  --
.Ss "Specifying messages"
Commands such as print and delete can be given a list of message numbers
as arguments to apply to a number of messages at once.
Thus
.Ns ` Ns Li "delete 1 2" Ns '
deletes messages 1 and 2,
whereas
.Ns ` Ns Li "delete 1-5" Ns '
will delete the messages 1 through 5.
In sorted or threaded mode (see the
.Ic sort
and
.Ic thread
commands),
.Ns ` Ns Li "delete 1-5" Ns '
will delete the messages that are located between (and including)
messages 1 through 5 in the sorted/threaded order, as shown in the
header summary.
The following special message names exist:
.\" ---
.Bl -tag -width ".It .Ar :n:u"
.It Ar :n
All new messages.
.It Ar :o
All old messages (any not in state read or new).
.It Ar :u
All unread messages.
.It Ar :d
All deleted messages (for the
.Ic undelete
command).
.It Ar :r
All read messages.
.It Ar :f
All `flagged' messages.
.It Ar :a
All answered messages
(cf. the
.Va markanswered
variable).
.It Ar :t
All messages marked as draft.
.It Ar :s
\*(OP All messages classified as spam.
.It Ar \&.
The current message.
.It Ar \&;
The message that was previously the current message.
.It Ar \&,
The parent message of the current message,
that is the message with the Message-ID given in the `In-Reply-To:' field
or the last entry of the `References:' field of the current message.
.It Ar -
The next previous undeleted message,
or the next previous deleted message for the
.Ic undelete
command.
In sorted/threaded mode,
the next previous such message in the sorted/threaded order.
.It Ar +
The next undeleted message,
or the next deleted message for the
.Ic undelete
command.
In sorted/threaded mode,
the next such message in the sorted/threaded order.
.It Ar ^
The first undeleted message,
or the first deleted message for the
.Ic undelete
command.
In sorted/threaded mode,
the first such message in the sorted/threaded order.
.It Ar $
The last message.
In sorted/threaded mode,
the last message in the sorted/threaded order.
.It Ar & Ns Ar x
In threaded mode,
selects the message addressed with
.Ar x ,
where
.Ar x
is any other message specification,
and all messages from the thread that begins at it.
Otherwise it is identical to
.Ar x .
If
.Ar x
is omitted,
the thread beginning with the current message is selected.
.It Ar *
All messages.
.It Ar `
All messages that were included in the message list for the previous
command.
.It Ar / Ns Ar string
All messages that contain
.Ar string
in the subject field (case ignored).
See also the
.Va searchheaders
variable.
If
.Ar string
is empty,
the string from the previous specification of that type is used again.
.It Xo Op Ar @ Ns Ar name-list Ns
.Ar @ Ns Ar expr
.Xc
All messages that contain the given case-insensitive search
.Ar expr Ns
ession; if the \*(OP regular expression support is available
.Ar expr
will be interpreted as one if any of the `magic'al regular expression
characters is seen.
If the optional
.Ar @ Ns Ar name-list
part is missing, the search is restricted to the subject field body,
but otherwise
.Ar name-list
specifies a comma-separated list of header fields to search, as in
.Pp
.Dl '@to,from,cc@Someone i ought to know'
.Pp
The special names `body' and `text' can be used to search in message
bodies \(en whereas the former searches only the body, the latter form
also performs a fulltext search in the header fields.
In order to search for a string that includes a `@' (commercial at)
character the
.Ar name-list
is effectively non-optional, but may be given as the empty string.
.It Ar address
All messages from
.Ar address .
By default, this is a case-sensitive search for the complete email
address.
If the
.Va allnet
variable is set,
only the local part of the addresses is evaluated for the comparison.
Otherwise if the
.Va showname
variable is set,
a case-sensitive search for the complete real name of a sender is
performed.
The IMAP-style
.Ns ` Ns Li "(from address)" Ns '
expression can be used instead if substring matches are desired.
.El
.\" ---
.Pp
\*(OP IMAP-style SEARCH expressions may also be used.
This addressing mode is available with all types of folders;
for folders not located on IMAP servers,
or for servers unable to execute the SEARCH command,
\*(UA will perform the search locally.
Strings must be enclosed by double quotes `"' in their entirety
if they contain white space or parentheses;
within the quotes,
only backslash `\e' is recognized as an escape character.
All string searches are case-insensitive.
When the description indicates that the `envelope' representation of an
address field is used,
this means that the search string is checked against both a list
constructed as
.Pp
.Dl ( \*q Ns name Ns \*q \*q Ns source Ns \*q \*q Ns \
    local-part Ns \*q \*q Ns domain-part Ns \*q )
.Pp
for each address,
and the addresses without real names from the respective header field.
These search expressions can be nested using parentheses, see below for
examples.
.Bl -tag -width ".It .Ar :n:u"
.It Ar ( criterion )
All messages that satisfy the given
.Ar criterion .
.It Ar ( criterion1 criterion2 ... criterionN )
All messages that satisfy all of the given criteria.
.It Ar ( or criterion1 criterion2 )
All messages that satisfy either
.Ar criterion1
or
.Ar criterion2 ,
or both.
To connect more than two criteria using `or',
(or) specifications have to be nested using additional parentheses,
as with
.Ns ` Ns Li "(or a (or b c))" Ns ',
since
.Ns ` Ns Li "(or a b c)" Ns '
really means
.Ns ` Ns Li "((a or b) and c)" Ns '.
For a simple `or' operation of independent criteria on the lowest
nesting level,
it is possible to achieve similar effects by using three separate
criteria, as with
.Ns ` Ns Li "(a) (b) (c)" Ns '.
.It Ar ( not criterion )
All messages that do not satisfy
.Ar criterion .
.It Ar ( bcc \*q Ns Ar string Ns Ar \*q )
All messages that contain
.Ar string
in the `envelope' representation of the `Bcc:' field.
.It Ar ( cc \*q Ns Ar string Ns Ar \*q )
All messages that contain
.Ar string
in the `envelope' representation of the `Cc:' field.
.It Ar ( from \*q Ns Ar string Ns Ar \*q )
All messages that contain
.Ar string
in the `envelope' representation of the `From:' field.
.It Ar ( subject \*q Ns Ar string Ns Ar \*q )
All messages that contain
.Ar string
in the `Subject:' field.
.It Ar ( to \*q Ns Ar string Ns Ar \*q )
All messages that contain
.Ar string
in the `envelope' representation of the `To:' field.
.It Ar ( header name \*q Ns Ar string Ns Ar \*q )
All messages that contain
.Ar string
in the specified
.Ar Name:
field.
.It Ar ( body \*q Ns Ar string Ns Ar \*q )
All messages that contain
.Ar string
in their body.
.It Ar ( text \*q Ns Ar string Ns Ar \*q )
All messages that contain
.Ar string
in their header or body.
.It Ar ( larger size )
All messages that are larger than
.Ar size
(in bytes).
.It Ar ( smaller size )
All messages that are smaller than
.Ar size
(in bytes).
.It Ar ( before date )
All messages that were received before
.Ar date ,
which must be in the form
.Li "d[d]-mon-yyyy" ,
where `d' denotes the day of the month as one or two digits,
`mon' is the name of the month \(en one of
`Jan', `Feb', `Mar', `Apr', `May', `Jun',
`Jul', `Aug', `Sep', `Oct', `Nov', or `Dec',
and `yyyy' is the year as four digits, e.g., "28-Dec-2012".
.It Ar ( on date )
All messages that were received on the specified date.
.It Ar ( since date )
All messages that were received since the specified date.
.It Ar ( sentbefore date )
All messages that were sent on the specified date.
.It Ar ( senton date )
All messages that were sent on the specified date.
.It Ar ( sentsince date )
All messages that were sent since the specified date.
.It Ar ()
The same criterion as for the previous search.
This specification cannot be used as part of another criterion.
If the previous command line contained more than one independent
criterion then the last of those criteria is used.
.El
.\"
.\" --  >8  --  8<  --
.Ss "Replying to or originating mail"
The command
.Ic reply
can be used to set up a response to a message,
sending it back to the person who it was from.
Text the user types in, up to an end-of-file,
defines the contents of the message.
While the user is composing a message \*(UA treats lines beginning with
the character `~' specially.
For instance, typing `~m' (alone on a line) will place a copy of the
current message into the response right shifting it by a tabstop
(more about the
.Va indentprefix
variable below).
Other escapes will set up subject fields,
add and delete recipients to the message,
attach files to it
and allow the user to escape to an editor to revise the message
or to a shell to run some commands.
(These options are given in the summary below.)
.\"
.\" --  >8  --  8<  --
.Ss "Ending a mail processing session"
The user can end a \*(UA session by issuing the
.Ic quit
(`q') command.
Messages which have been examined go to the user's mbox file unless they
have been deleted,
in which case they are discarded.
Unexamined messages go back to the post office.
(Also see the
.Fl f
option above.)
When command line history is tracked, an updated history file is
written.
None of these actions is performed when the command
.Ic exit
(`x') is used instead of
.Ic quit
(`q').
.\"
.\" --  >8  --  8<  --
.Ss "Personal and systemwide distribution lists"
It is possible to create personal distribution lists so that,
for instance, the user can send mail to `cohorts'
and have it go to a group of people.
Such lists can be defined via the
.Ic alias
command by, e.g., placing lines like
.Pp
.Dl alias cohorts bill ozalp jkf mark kridle@ucbcory
.Pp
in the file \*(ur in the user's home directory.
Using
.Ic alias
without arguments lists all the currently known aliases.
.Pp
Please note that this mechanism has nothing in common with the system
wide aliases that may be used by the local MTA (mail-transfer-agent)
and are often tracked in a file
.Pa /etc/aliases
(and documented in
.Xr aliases 5
and
.Xr sendmail 1 Ns
).
Personal aliases will be expanded by \*(UA before the message is sent.
They are a convenient alternative to specifying each addressee by
itself.
.\"
.\" --  >8  --  8<  --
.Ss "Recipient address specifications"
When an address is used to name a recipient (in `To:', `Cc:', or `Bcc:'),
names of local mail folders and pipes to external commands may also be
specified \(en the message text is then written to them.
The rules are: Any name which starts with a `|' (vertical bar) character
specifies a pipe \(en the command string following the `|' is executed
and the message is sent to its standard input;
any other name which contains a `@' (at sign) character is treated as
a mail address;
any other name which starts with a `+' (plus sign) character specifies
a folder name;
any other name which contains a `/' (slash) character but no `!'
(exclamation mark) or `%' (percent sign) character before also specifies
a folder name;
what remains is treated as a mail address.
Compressed folders are handled as described for the
.Ic folder
command.
.\"
.\" --  >8  --  8<  --
.Ss "Network mail (Internet / ARPA, UUCP, Berknet)"
See
.Xr mailaddr 7
for a description of network addresses.
If support for IDNA (internationalized domain names for applications)
has been compiled into \*(UA,
then the domain name part of network addresses will be converted via
IDNA mechanisms as necessary, effectively treating it as a name in the
.Va ttycharset
character set; see
.Sx "Character sets"
for the complete picture about character sets.
.Pp
\*(UA has a number of options which can be set in the \*(ur file
to alter its behavior; e.g.,
.Ic "set askcc"
enables the
.Va askcc
feature, and
.Ic "set idna-disable"
will disable the mentioned IDNA conversion even if support is available.
(These options are summarized below.)
.\"
.\" --  >8  --  8<  --
.Ss "MIME types"
For any outgoing attachment \*(UA tries to determine the content type.
It does this by reading MIME type files whose lines have the following
syntax:
.Pp
.Dl type/subtype        extension [extension ...]
.Pp
where `type/subtype' are strings describing the file contents,
and `extension' is the part of a filename starting after the last dot.
Any line not immediately beginning with an ASCII alphabetical character
is ignored by \*(UA.
The variable
.Va mimetypes-load-control
can be used to control the sources of MIME types, and the
.Ic mimetypes
command can be used to show the list of mime types known to \*(UA.
If there is a match with the `extension' of the file to attach,
the given `type/subtype' pair is used.
Otherwise, or if the filename has no extension,
the content types `text/plain' or `application/octet-stream' are used,
dependent upon file content inspection.
Also see
.Va mime-allow-text-controls .
.\"
.\" --  >8  --  8<  --
.Ss "Character sets"
\*(UA normally detects the character set of the terminal by using
mechanisms that are controlled by the `LC_CTYPE' locale setting,
if such are supported; the variable
.Va ttycharset
will be set to the detected terminal character set and will thus
show up in the output of the command
.Ic set .
.Pp
A user supplied
.Va ttycharset
value is not overwritten by this detection mechanism;
this feature must be used if the detection doesn't work properly,
and it may be used to adjust the name of the locale character set.
E.g., on BSD systems one may use a locale with the character set
`ISO8859-1', which is not a valid name for this character set;
to be on the safe side, one may set
.Va ttycharset
to the correct name, `ISO-8859-1'.
.Pp
Note that changing the value doesn't mean much beside that,
since several aspects of the real character set are implied by the
locale environment of the system,
and that stays unaffected by the content of an overwritten
.Va ttycharset
variable.
(This is mostly an issue when interactively using \*(UA, though.
It is actually possible to send mail in a completely "faked" locale
environment.)
.Pp
If no character set conversion capabilities have been compiled into
\*(UA (i.e., no
.Xr iconv 3
library has been found), then
.Va ttycharset
will be the only supported character set,
and it is simply assumed that it can be used to exchange 8 bit messages,
and the rest of this section does not apply;
it may however still be necessary to explicitly set it if automatic
detection fails, since in that case it defaults to `ISO-8859-1'.
.Pp
When reading messages, their text is converted into
.Va ttycharset
as necessary in order to display them on the users terminal.
Unprintable characters and illegal byte sequences are detected
and replaced by proper substitution characters
(unless the variable
.Va print-all-chars
was set once \*(UA was started).
.Pp
When sending messages all their parts and attachments are classified.
Whereas no character set conversion is performed on those parts which
appear to be binary data,
the character set being used must be declared within the MIME header of
an outgoing text part if it contains characters that do not conform to
the set of characters that are allowed by the email standards.
Permissible values for character sets can be declared using the
.Va sendcharsets
variable, which is expected to contain a (comma-separated list of)
character set (names), and the
.Va charset-8bit
variable, which is used as a catch-all last-resort fallback.
.Pp
All the specified character sets are tried in order unless the
conversion of the part or attachment succeeds.
If none of the tried (8 bit) character sets is capable to represent the
content of the part or attachment,
then the message will not be sent and its text will be saved to
.Va DEAD .
Note that some character set conversions will never fail, even if the
result is incorrect; e.g., `ISO-8859-1' is capable to represent any
8 bit message.
.Pp
In general, if the message `Cannot convert from a to b' appears, either
some characters are not appropriate for the currently selected
(terminal) character set,
or the needed conversion is not supported by the system.
In the first case, it is necessary to set an appropriate `LC_CTYPE'
locale and/or the variable
.Va ttycharset .
.Pp
The best results are usually achieved when \*(UA is run in a UTF-8
locale on a UTF-8 capable terminal,
in which case the full Unicode spectrum of characters is available.
In this setup characters from various countries can be displayed,
while it is still possible to use more simple character sets for sending
to retain maximum compatibility with older mail clients.
.\"
.\" --  >8  --  8<  --
.Ss "Command line editor"
\*(OP \*(UA can be configured to support a command line editor and
command history lists which are saved in between sessions.
One may link against fully-fledged external libraries
.Ns ( Ns Xr readline 3 ,
.Xr editline 3 Ns
) or use the \*(UA command line editor instead, which should work in all
environments which comply to ISO C (ISO/IEC 9899:1990/Amendment 1:1995).
When an external library is used, interactive behaviour of \*(UA relies
on that library and may not correspond one-to-one to what is described
in this manual.
.Pp
Regardless of the actually used command line editor history entries
will be created for lines entered in command mode only, and creation of
such an entry can be forcefully suppressed by starting the line with
a space character.
Note that history handling is by itself an optional feature and may
therefore not be available.
For more information see the documentation of the options
.Va emptystart ,
.Va line-editor-disable ,
.Va NAIL_HISTFILE
and
.Va NAIL_HISTSIZE .
.Pp
The builtin \*(UA command line editor supports the following operations;
the notation `^-character' stands for the combination of the `control'
key plus the mentioned character, e.g., `^A' means "hold control key
while adding an A key on top of it":
.Bl -tag -width "^M^"
.It ^A
Go to the start of the line.
.It ^B
Move the cursor backward one character.
.It ^D
Forward delete the character under the cursor;
quits \*(UA if used on the empty line, unless the
.Va ignoreeof
option is set.
.It ^E
Go to the end of the line.
.It ^F
Move the cursor forward one character.
.It ^G
Cancel current operation, full reset.
If there is an active history search or tabulator expansion then this
command will first reset that, reverting to the former line content;
thus a second reset is needed for a full reset in this case.
In all cases \*(UA will reset a possibly used multibyte character input
state machine.
.It ^H
The same as `backspace': backward delete one character.
.It ^I
\*(OP The same as `horizontal tabulator': try to expand the "word"
before the cursor.
Here "expansion" refers to the \*(UA expansion, as documented for
.Ic folder ,
and thus includes shell word expansion (as a last step).
I.e., this is \*(UA "expansion", not what one usually expects from
"tab-completion".
.It ^J
The same as `ENTER': complete this line of input.
.It ^K
Delete all characters from the cursor to the end of the line.
.It ^L
Repaint the line.
.It ^N
\*(OP Go to the next history entry.
.It ^P
\*(OP Go to the previous history entry.
.It ^R
\*(OP Complete the current line from (the remaining older) history entries.
.It ^U
The same as `^A' followed by `^K'.
.It ^W
Delete the characters from the one preceding the cursor to the preceding
word boundary.
.It ^X
Move the cursor forward one word boundary.
.It ^Y
Move the cursor backward one word boundary.
.El
.Pp
If problems with commands that are based upon rightwise movement are
encountered, adjustments of the option
.Va line-editor-cursor-right
may solve the problem, as documented for it.
.\"
.\" --  >8  --  8<  --
.Ss "Coloured message display"
\*(OP \*(UA can be configured to support coloured message display.
Colours are used only when the
.Va TERM
environment variable is set and the terminal type can be found in
.Va colour-terms .
Beyond that, if a command requires to output through the
.Va PAGER
(also see
.Va crt )
then the used
.Va PAGER
must be mentioned in the variable
.Va colour-pagers ,
otherwise no colours will be used regardless of the actual terminal type.
.Pp
"Coloured message display" can be configured through font attributes
(`ft=' \(en `bold', `invers' and `underline'), foreground (`fg=') and
background (`bg=') colours (`black', `blue', `green', `red', `brown',
`magenta', `cyan' and `white').
Multiple specifications can be joined in a comma separated list, as in
.Pp
.Dl set colour-msginfo="ft=bold,fg=magenta,bg=cyan"
.Pp
Options to be set are
.Va colour-msginfo ,
.Va colour-partinfo ,
.Va colour-from_ ,
.Va colour-header
and
.Va colour-uheader ,
as well as
.Va colour-user-headers ,
which is a list of headers to be colourized via
.Va colour-uheader
instead of the default
.Va colour-header .
To forcefully disable colours, set
.Va colour-disable .
.\"
.\" --  >8  --  8<  --
.Ss "Commands"
Each command is typed on a line by itself,
and may take arguments following the command word.
The command need not be typed in its entirety \(en
the first command which matches the typed prefix is used.
(The command
.Ic list
prints a sorted list of available commands, and the command
.Ic ? ,
when given an argument, will show a documentation string for the
expansion, as in
.Ns ` Ns Ic ? Ns Ar unc Ns ' ;
documentation strings are however \*(OP.)
.Pp
For commands which take message lists as arguments,
if no message list is given,
then the next message forward which satisfies the command's requirements
is used.
If there are no messages forward of the current message,
the search proceeds backwards,
and if there are no good messages at all,
\*(UA types `no applicable messages' and aborts the command.
If the command begins with a `#' (number sign) character,
the line is ignored.
.Pp
The arguments to commands can be quoted, using the following methods:
.Bl -bullet -offset indent
.It
An argument can be enclosed between paired double-quotes `"argument"' or
single-quotes `'argument'';
any white space, shell word expansion, or backslash characters (except
as described next) within the quotes are treated literally as part of
the argument.
A double-quote will be treated literally within single-quotes and vice
versa.
Inside such a quoted string the actually used quote character can be
used nonetheless by escaping it with a backslash `\\', as in
`"y\\"ou"'.
.It
An argument that is not enclosed in quotes, as above, can usually still
contain space characters if those spaces are backslash-escaped.
.It
A backslash outside of the enclosing quotes is discarded
and the following character is treated literally as part of the argument.
.It
An unquoted backslash at the end of a command line is discarded and the
next line continues the command.
.El
.Pp
Filenames, where expected, are subsequently subjected to the following
transformations, in sequence:
.Bl -bullet -offset indent
.It
If the filename begins with an unquoted plus sign, and the
.Va folder
variable is defined,
the plus sign will be replaced by the value of the
.Va folder
variable followed by a slash.
If the
.Va folder
variable is unset or is set to null, the filename will be unchanged.
.It
Shell word expansions are applied to the filename.
If more than a single pathname results from this expansion and the
command is expecting one file, an error results.
.El
.\"
.Pp
The following commands are provided:
.Bl -tag -width ".Ic account"
.It Ic ~
Interprets the remainder of the word as a macro name and passes it
through to the
.Ic call
command; e.g.,
.Ns ` Ns Ic ~ Ns Ar mymacro Ns '
is a shorter synonym for
.Ns ` Ns Ic call Ar mymacro Ns ' .
.It Ic -
Print out the preceding message.
If given a numeric argument n,
goes to the n'th previous message and prints it.
.It Ic \&?
Prints a brief summary of commands.
\*(OP Given an argument a synopsis for the command in question is
printed instead.
.It Ic \&!
Executes the shell (see
.Xr sh 1
and
.Xr csh 1 Ns
) command which follows.
.It Ic \&|
A synonym for the
.Ic pipe
command.
.It Ic account
(ac) Creates, selects or lists an email account.
An account is formed by a group of commands,
primarily of those to set variables.
With two arguments,
of which the second is a `{',
the first argument gives an account name,
and the following lines create a group of commands for that account
until a line containing a single `}' appears.
With one argument the previously created group of commands for the
account name is executed, and a
.Ic folder
command is executed for the system mailbox or inbox of that account.
Without arguments the list of accounts and their contents are printed.
As an example,
.Bd -literal -offset indent
   account myisp {
      set folder=imaps://mylogin@imap.myisp.example
      set record=+Sent
      set from="myname@myisp.example (My Name)"
      set smtp=smtp.myisp.example
   }
.Ed
.Pp
creates an account named `myisp' which can later be selected by
specifying `account myisp'.
The special account `null' (case-insensitive) always exists.
.It Ic alias
(a) With no arguments, prints out all currently-defined aliases.
With one argument, prints out that alias.
With more than one argument,
creates a new alias or changes an old one.
.It Ic alternates
(alt) The alternates command is useful if the user has accounts on
several machines.
It can be used to inform \*(UA that the listed addresses all belong to
the invoking user.
When replying to messages \*(UA will not send a copy of the message
to any of the addresses listed on the alternates list.
If the alternates command is given with no argument,
the current set of alternate names is displayed.
.It Ic answered
(ans) Takes a message list and marks each message as having been
answered.
This mark has no technical meaning in the mail system;
it just causes messages to be marked in the header summary,
and makes them specially addressable.
.It Ic cache
\*(OP Only applicable to cached IMAP mailboxes;
takes a message list and reads the specified messages into the IMAP
cache.
.It Ic call
Calls a macro (see the
.Ic define
command).
.It Ic cd
Same as
.Ic chdir .
.It Ic certsave
\*(OP Only applicable to S/MIME signed messages.
Takes a message list and a file name and saves the certificates
contained within the message signatures to the named file in both
human-readable and PEM format.
The certificates can later be used to send encrypted messages to the
respective message senders by setting
.Va smime-encrypt-user@host
variables.
.It Ic chdir
(ch) Changes the user's working directory to the specified one,
or to the user's login directory, if none was given.
.It Ic collapse
(coll)
Only applicable to threaded mode.
Takes a message list and makes all replies to these messages invisible
in header summaries,
unless they are in state `new'.
.It Ic connect
\*(OP (conn) If operating in disconnected mode on an IMAP mailbox,
switch to online mode and connect to the mail server while retaining the
mailbox status.
See the description of the
.Va disconnected
variable for more information.
.It Ic copy
(c) The copy command does the same thing that
.Ic save
does except that it does not mark the given messages for deletion when
the user quits.
Compressed files and IMAP mailboxes are handled as described for the
.Ic folder
command.
.It Ic Copy
(C) Similar to
.Ic copy ,
but saves the messages in a file named after the local part of the
sender address of the first message.
.It Ic cwd
Print the current working directory.
.It Ic decrypt
\*(OP (dec) For unencrypted messages,
this command is identical to
.Ic copy .
Encrypted messages are first decrypted, if possible, and then copied.
.It Ic Decrypt
\*OP (Dec) Similar to
.Ic decrypt ,
but saves the messages in a file named after the local part of the
sender address of the first message.
.It Ic define
(def) Defines a macro.
A macro definition is a sequence of commands in the following form:
.Bd -literal -offset indent
   define name {
      command1
      command2
      ...
      commandN
   }
.Ed
.Pp
A defined macro can be explicitly invoked using
.Ic call
or
.Ic ~ ,
or it can be implicitly invoked by setting the
.Va folder-hook
or
.Va folder-hook-fullname
variables.
.It Ic defines
Prints the currently defined macros including their contents.
.It Ic delete
(d) Takes a list of messages as argument and marks them all as deleted.
Deleted messages will not be saved in `mbox',
nor will they be available for most other commands.
.It Ic discard
Same as
.Ic ignore .
.It Ic disconnect
\*(OP (disco) If operating in online mode on an IMAP mailbox,
switch to disconnected mode while retaining the mailbox status.
See the description of the
.Va disconnected
variable for more.
A list of messages may optionally be given as argument;
the respective messages are then read into the cache before the
connection is closed.
Thus `disco *' makes the entire mailbox available for disconnected use.
.It Ic dp Ns \ or Ic dt
Deletes the current message and prints the next message.
If there is no next message, \*(UA says `at EOF'.
.It Ic draft
Takes a message list and marks each given message as a draft.
This mark has no technical meaning in the mail system;
it just causes messages to be marked in the header summary,
and makes them specially addressable.
.It Ic echo
Echoes its arguments,
resolving special names as documented for the command
.Ic folder .
The escape sequences `\ea', `\eb', `\ec', `\ef', `\en', `\er', `\et',
`\ev', `\e\e', and `\e0octal-num\fR' are interpreted just as they are by
.Xr printf 1
(proper quoting provided).
.It Ic edit
(e) Point the text editor at each message from the given list in turn.
Modified contents are discarded unless the
.Va writebackedited
variable is set.
.It Ic else
Marks the end of the then-part of an if statement and the beginning of
the part to take effect if the condition of the if statement is false.
.It Ic endif
Marks the end of an if statement.
.It Ic exit
(ex or x) Effects an immediate return to the Shell without modifying the
user's system mailbox, his `mbox' file, or his edit file in
.Fl f ,
as well as a possibly tracked command line editor history file.
.It Ic features
Print the list of features that have been compiled into \*(UA.
.It Ic file
(fi) The same as
.Ic folder .
.It Ic flag
(fl) Takes a message list and marks the messages as `flagged' for
urgent/special attention.
This mark has no technical meaning in the mail system;
it just causes messages to be highlighted in the header summary,
and makes them specially addressable.
.It Ic folder
(fold) The folder command switches to a new mail file or folder.
With no arguments, it tells the user which file he is currently reading.
If an argument is given, it will write out changes (such as deletions)
the user has made in the current file and read in the new file.
Some special conventions are recognized for the
.Ar name
argument:
.Bl -tag -offset indent -width ".Ar %:filespec"
.It Ar #
(number sign) means the previous file,
.It Ar %
(percent sign) means the invoking user's system mailbox
(or the value of
.Va folder
for IMAP folders),
.It Ar %user
means the system mailbox of `user'
(and never the value of
.Va folder ,
regardless of its actual setting),
.It Ar &
(ampersand) means the invoking user's `mbox' file (see
.Va MBOX Ns
) and
.It Ar +file
means a `file' in the
.Va folder
directory.
.It Ar %:filespec
expands to the same value as `filespec',
but the file is handled as a system mailbox by, e.g., the
.Ic mbox
and
.Ic save
commands.
.El
.Pp
If the name matches one of the strings defined with the command
.Ic shortcut ,
it is replaced by its long form and expanded.
If the name ends with `.gz', `.bz2' or `.xz' it is treated as being
compressed with
.Xr gzip 1 ,
.Xr bzip2 1
or
.Xr xz 1 ,
respectively.
If `name' refers to a directory with the subdirectories `tmp', `new',
and `cur', then it is treated as a folder in `maildir' format.
A name of the form
.Pp
.Dl protocol://[user@]host[:port][/file]
.Pp
is taken as an Internet mailbox specification.
The (optionally) supported protocols are `imap' (IMAP v4r1), `imaps'
(IMAP with SSL/TLS encrypted transport), `pop3' (POP3) and `pop3s' (POP3
with SSL/TLS encrypted transport).
If `user' contains special characters, in particular `/' or `%',
they must be escaped in URL notation, as `%2F' or `%25'.
The optional `file' part applies to IMAP only;
if it is omitted, the default `INBOX' is used.
.Pp
If \*(UA is connected to an IMAP server,
a name of the form `@mailbox' refers to the `mailbox' on that server,
but otherwise a `@' prefix has no special meaning.
.It Ic folders
With no arguments, list the names of the folders in the folder directory.
With an existing folder as an argument,
lists the names of folders below the named folder;
e.\|g. the command `folders @' lists the folders on the base level of
the current IMAP server.
See also the variable
.Va imap-list-depth .
.It Ic Followup
(F) Similar to
.Ic Respond ,
but saves the message in a file named after the local part of the first
recipient's address.
.It Ic followup
(fo) Similar to
.Ic respond ,
but saves the message in a file named after the local part of the first
recipient's address.
.It Ic followupall
Similar to
.Ic followup ,
but responds to all recipients regardless of the
.Va flipr
and
.Va Replyall
variables.
.It Ic followupsender
Similar to
.Ic Followup ,
but responds to the sender only regardless of the
.Va flipr
and
.Va Replyall
variables.
.It Ic forward
(fwd) Takes a message and the address of a recipient
and forwards the message to him.
The text of the original message is included in the new one,
with the value of the
.Va fwdheading
variable printed before.
The
.Ic fwdignore
and
.Ic fwdretain
commands specify which header fields are included in the new message.
Only the first part of a multipart message is included unless the
.Va forward-as-attachment
option is set.
.It Ic Forward
(Fwd) Similar to
.Ic forward ,
but saves the message in a file named after the local part of the
recipient's address.
.It Ic from
(f) Takes a list of messages and prints their message headers,
piped through the pager if the output does not fit on the screen.
.It Ic fwdignore
Specifies which header fields are to be ignored with the command
.Ic forward .
This command has no effect when the
.Va forward-as-attachment
option is set.
.It Ic fwdretain
Specifies which header fields are to be retained with the command
.Ic forward .
.Ic fwdretain
overrides
.Ic fwdignore .
This command has no effect when the
.Va forward-as-attachment
option is set.
.It Ic ghost
Without arguments it lists all currently defined command aliases,
so-called ghosts.
With two arguments it defines a new command alias: the first argument is
the name under which the second should be accessible.
The content of the second argument can be just about anything.
A ghost can be used everywhere a normal command can be used, but always
takes precedence; any arguments that are given to the command alias are
joined onto the alias content, and the resulting string forms the
command line that is, in effect, executed.
Also see
.Ic unghost .
.Pp
.Dl ? ghost ls '!ls -latro'
.Dl ? ls /usr/local
.It Ic headers
(h) Lists the current range of headers, which is an 18-message group.
If a `+' argument is given the next 18-message group is printed,
likewise the previous is printed if the argument was `-'.
.It Ic help
A synonym for `?'.
.It Ic history
\*(OP Either
.Ar show
or
.Ar clear
the list of history entries;
a decimal
.Ar NUMBER
argument selects and shows the respective history entry \(en
press `ENTER' to accept it, and the history entry will become the new
history top.
The default mode if no arguments are given is
.Ar show .
.It Ic hold
(ho, also preserve) Takes a message list and marks each message therein
to be saved in the user's system mailbox instead of in `mbox'.
Does not override the
.Ic delete
command.
\*(UA deviates from the POSIX standard with this command,
as a
.Ic next
command issued after
.Ic hold
will display the following message, not the current one.
.It Ic if
Commands in \*(UA's startup files can be executed conditionally by
testing conditions via the nestable command `if', as in:
.Bd -literal -offset indent
   if receive
      commands ...
   else
      commands ...
   endif
.Ed
.Pp
Note that the only allowed conditions are `[Rr]eceive', `[Ss]end',
`[Tt]erm' (execute if standard input is a tty), as well as `0' (never
execute) and `1' (always execute).
In addition it is possible to conditionalize upon wether an option is set,
or set to a specific value, by using the `$' conditional trigger, e.g.:
.Bd -literal -offset indent
   if $debug
      commands ...
   endif
   if $encoding == "UTF-8"
      commands ...
   endif
   if $encoding != "UTF-8"
      commands ...
   endif
.Ed
.Pp
The first form simply checks wether an option is set, the other two also
perform value content comparison (equality and non-equality,
respectively); an unset value is treated as the empty string, then.
.It Ic ignore
Add the list of header fields named to the ignored list.
Header fields in the ignore list are not printed on the terminal when
a message is printed.
This command is very handy for suppression of certain machine-generated
header fields.
The
.Ic Type
and
.Ic Print
commands can be used to print a message in its entirety, including
ignored fields.
It lists the current set of ignored fields if no arguments were given.
.It Ic imap
\*(OP Sends command strings directly to the current IMAP server.
\*(UA operates always in IMAP `selected state' on the current mailbox;
commands that change this will produce undesirable results and should be
avoided.
Useful IMAP commands are:
.Bl -tag -offset indent -width ".Ic getquotearoot"
.It create
Takes the name of an IMAP mailbox as an argument and creates it.
.It getquotaroot
(RFC 2087) Takes the name of an IMAP mailbox as an argument
and prints the quotas that apply to the mailbox.
Not all IMAP servers support this command.
.It namespace
(RFC 2342) Takes no arguments and prints the Personal Namespaces,
the Other User's Namespaces and the Shared Namespaces.
Each namespace type is printed in parentheses;
if there are multiple namespaces of the same type,
inner parentheses separate them.
For each namespace a prefix and a hierarchy separator is listed.
Not all IMAP servers support this command.
.El
.It Ic inc
Same as
.Ic newmail .
.It Ic list
Prints the names of all available commands, alphabetically sorted.
.It Ic localopts
Can only be used inside of a macro definition block introduced by
.Ic account
or
.Ic define ,
and is interpreted as a boolean (value `0' means false, everything
else true).
Any option that had been set while `localopts' was in effect will be
reverted to its former value once the block is left / the `account'
is switched.
.Bd -literal -offset indent
define temporary_settings {
        set global_option1
        localopts 1
        set local_option1
        set local_option2
        localopts 0
        set global_option2
}
.Ed
.Pp
Note that these options stack upon each other, i.e., if macro1 sets
`localopts' and calls macro2, which explicitly resets `localopts', then
any values set within macro2 will still be cleaned up by macro1.
.It Ic Mail
(M) Similar to
.Ic mail ,
but saves the message in a file named after the local part of the first
recipient's address.
.It Ic mail
(m) Takes a (list of) recipient address(es) as (an) argument(s),
or asks on standard input if none were given;
then collects the remaining mail content and sends it out.
.It Ic mbox
The given message list is to be sent to `mbox' when \*(UA is quit.
This is the default action unless the
.Va hold
option is set.
\*(UA deviates from the POSIX standard with this command,
as a
.Ic next
command issued after
.Ic mbox
will display the following message, not the current one.
.It Ic mimetypes
Either
.Ns ( Ar show
or)
.Ar clear
the
.Xr mime.types 5
cache.
In the former case all sources are loaded first as necessary.
The
.Va mimetypes-load-control
option can be used to fine-tune which sources are loaded.
.It Ic move
(mv) Acts like
.Ic copy
but marks the messages for deletion if they were transferred
successfully.
.It Ic more
Takes a message list and invokes the
.Va PAGER
on that list, printing a form-feed (`\\f') in between messages.
.It Ic More
Like
.Ic more ,
but also prints ignored header fields and all MIME parts.
.It Ic Move
(Mv) Similar to
.Ic move ,
but moves the messages to a file named after the local part of the
sender address of the first message.
.It Ic newmail
Checks for new mail in the current folder without committing any changes
before.
If new mail is present, a message is printed.
If the
.Va header
variable is set,
the headers of each new message are also printed.
.It Ic next
(n) (like `+' or `ENTER') Goes to the next message in sequence
and types it.
With an argument list, types the next matching message.
.It Ic New
Same as
.Ic unread .
.It Ic new
Same as
.Ic unread .
.It Ic online
Same as
.Ic connect .
.It Ic noop
If the current folder is located on an IMAP or POP3 server,
a `NOOP' command is sent.
Otherwise, no operation is performed.
.It Ic Pipe
(Pi) Like
.Ic pipe
but also pipes ignored header fields and all parts of MIME
`multipart/alternative' messages.
.It Ic pipe
(pi) Takes a message list and a shell command
and pipes the messages through the command.
Without an argument the current message is piped through the command
given by the
.Va cmd
variable.
If the
.Va page
variable is set,
every message is followed by a formfeed character.
.It Ic preserve
(pre) A synonym for
.Ic hold .
.It Ic Print
(P) Like
.Ic print
but also prints out ignored header fields and all parts of MIME
`multipart/alternative' messages.
See also
.Ic print ,
.Ic ignore
and
.Ic retain .
.It Ic print
(p) Takes a message list and types out each message on the user's
terminal.
If the message is a MIME multipart message,
all parts with a content type of `text' or `message' are shown,
the other are hidden except for their headers.
Messages are decrypted and converted to the terminal character set
if necessary.
.It Ic quit
(q) Terminates the session, saving all undeleted, unsaved messages in
the current `mbox', preserving all messages marked with
.Ic hold
or
.Ic preserve
or never referenced in his system mailbox,
and removing all other messages from his system mailbox.
If new mail has arrived during the session,
the message `You have new mail' is given.
If given while editing a mailbox file with the command line flag
.Fl f ,
then the edit file is rewritten.
A return to the shell is effected,
unless the rewrite of edit file fails,
in which case the user can escape with the exit command.
.It Ic redirect
(red) Same as
.Ic resend .
.It Ic Redirect
(Red) Same as
.Ic Resend .
.It Ic remove
(rem) Removes the named folders.
The user is asked for confirmation in interactive mode.
.It Ic rename
(ren) Takes the name of an existing folder
and the name for the new folder
and renames the first to the second one.
Both folders must be of the same type
and must be located on the current server for IMAP.
.It Ic Reply
(R) Reply to originator.
Does not reply to other recipients of the original message.
.It Ic reply
(r) Takes a message list and sends mail to the sender and all recipients
of the specified messages.
The default message must not be deleted.
.It Ic replyall
Similar to
.Ic reply ,
but responds to all recipients regardless of the
.Va flipr
and
.Va Replyall
variables.
.It Ic replysender
Similar to
.Ic Reply ,
but responds to the sender only regardless of the
.Va flipr
and
.Va Replyall
variables.
.It Ic Resend
Like
.Ic resend ,
but does not add any header lines.
This is not a way to hide the sender's identity,
but useful for sending a message again to the same recipients.
.It Ic resend
Takes a list of messages and a user name
and sends each message to the named user.
`Resent-From:' and related header fields are prepended to the new copy
of the message.
.It Ic Respond
Same as
.Ic Reply .
.It Ic respond
Same as
.Ic reply .
.It Ic respondall
Same as
.Ic replyall .
.It Ic respondsender
Same as
.Ic replysender .
.It Ic retain
Add the list of header fields named to the retained list.
Only the header fields in the retain list are shown on the terminal when
a message is printed, all other header fields are suppressed.
The
.Ic Type
and
.Ic Print
commands can be used to print a message in its entirety.
The current set of retained fields is shown if
.Ic retain
is used without arguments.
.It Ic Save
(S) Similar to
.Ic save,
but saves the messages in a file named after the local part of the
sender of the first message instead of taking a filename argument.
.It Ic save
(s) Takes a message list and a filename and appends each message in turn
to the end of the file.
If no filename is given, the `mbox' file is used.
The filename in quotes, followed by the line count and character count
is echoed on the user's terminal.
If editing a system mailbox the messages are marked for deletion.
Compressed files and IMAP mailboxes are handled as described for the
.Fl f
command line option above.
.It Ic savediscard
Same as
.Ic saveignore .
.It Ic saveignore
Is to
.Ic save
what
.Ic ignore
is to
.Ic print
and
.Ic type .
Header fields thus marked are filtered out when saving a message by
.Ic save
or when automatically saving to `mbox'.
This command should only be applied to header fields that do not contain
information needed to decode the message,
as MIME content fields do.
If saving messages on an IMAP account ignoring fields makes it
impossible to copy the data directly on the server,
thus operation usually becomes much slower.
.It Ic saveretain
Is to
.Ic save
what
.Ic retain
is to
.Ic print
and
.Ic type .
Header fields thus marked are the only ones saved with a message when
saving by
.Ic save
or when automatically saving to `mbox'.
.Ic saveretain
overrides
.Ic saveignore .
The use of this command is strongly discouraged since it may strip
header fields that are needed to decode the message correctly.
.It Ic set
(se) With no arguments, prints all variable values.
Otherwise, sets an option.
Arguments are of the form `option=value' (no space before or after `='),
or plain `option' if there is no value.
Quotation marks may be placed around any part of the assignment
statement to quote blanks or tabs, e.g.,
.Pp
.Dl set indentprefix="->"
.Pp
If an argument begins with `no', as in `set nosave',
the effect is the same as invoking the
.Ic unset
command with the remaining part of the variable (`unset save').
.It Ic seen
Takes a message list and marks all messages as having been read.
.It Ic shell
(sh) Invokes an interactive version of the shell.
.It Ic shortcut
Defines a shortcut name and its string for expansion,
as described for the
.Ic folder
command.
If used without arguments the currently defined shortcuts are printed.
.It Ic show
(Sh) Like
.Ic print ,
but performs neither MIME decoding nor decryption so that the raw
message text is shown.
.It Ic size
Print the size in characters of each message of the given message-list.
.It Ic sort
Create a sorted representation of the current folder,
and change the
.Ic next
command and the addressing modes such that they refer to messages in the
sorted order.
Message numbers are the same as in regular mode.
If the
.Va header
variable is set,
a header summary in the new order is also printed.
Possible sorting criteria are:
.Bl -tag -offset indent -width "subject"
.It date
Sort the messages by their `Date:' field,
that is by the time they were sent.
.It from
Sort messages by the value of their `From:' field,
that is by the address of the sender.
If the
.Va showname
variable is set,
the sender's real name (if any) is used.
.It size
Sort the messages by their size.
.It spam
\*(OP Sort the message by their spam score, as has been classified via
the command
.Ic spamrate .
.It status
Sort the messages by their message status (new, read, old, etc.).
.It subject
Sort the messages by their subject.
.It thread
Create a threaded order,
as with the command
.Ic thread .
.It to
Sort messages by the value of their `To:' field,
that is by the address of the recipient.
If the
.Va showname
variable is set,
the recipient's real name (if any) is used.
.El
.Pp
If no argument is given,
the current sorting criterion is printed.
.It Ic source
The source command reads commands from a file.
.It Ic spamclear
\*(OP Takes a list of messages and clears their `is-spam' flag.
.It Ic spamforget
\*(OP Takes a list of messages and forces the spam detector to forget it
has ever used them to train its Bayesian filter, wether as `ham' or
`spam'.
.It Ic spamham
\*(OP Takes a list of messages and teaches them to the spam detector as
being `ham'.
This also clears the `is-spam' flag of the messages in question.
.It Ic spamrate
\*(OP Takes a list of messages and rates them using the configured spam
detector, setting their `is-spam' flag as appropriate.
Note that the messages are not modified, and due to that the rating will
get lost once the mailbox is left.
Refer to the manual section
.Sx "Handling spam"
for the complete picture of spam handling in \*(UA.
.It Ic spamset
\*(OP Takes a list of messages and sets their `is-spam' flag.
.It Ic spamspam
\*(OP Takes a list of messages and teaches them to the spam detector as
being `spam'.
This also sets the `is-spam' flag of the messages in question.
.It Ic thread
(th) Create a threaded representation of the current folder,
i.\|e. indent messages that are replies to other messages in the header
display and change the
.Ic next
command and the addressing modes such that they refer to messages in the
threaded order.
Message numbers are the same as in unthreaded mode.
If the
.Va header
variable is set,
a header summary in threaded order is also printed.
.It Ic top
Takes a message list and prints the top few lines of each.
The number of lines printed is controlled by the variable
.Va toplines
and defaults to five.
.It Ic touch
Takes a message list and marks the messages for saving in `mbox'.
\*(UA deviates from the POSIX standard with this command,
as a
.Ic next
command issued after `mbox' will display the following message instead
of the current one.
.It Ic Type
(T) Identical to the
.Ic Print
command.
.It Ic type
(t) A synonym for
.Ic print .
.It Ic unalias
Takes a list of names defined by alias commands
and discards the remembered groups of users.
.It Ic unanswered
Takes a message list and marks each message as not having been answered.
.It Ic uncollapse
(unc) Only applicable to threaded mode.
Takes a message list and makes the message and all replies to it visible
in header summaries again.
When a message becomes the current message,
it is automatically made visible.
Also when a message with collapsed replies is printed,
all of these are automatically uncollapsed.
.It Ic undef
Undefines each of the named macros.
It is not an error to use a name that does not belong to
one of the currently defined macros.
.It Ic undelete
(u) Takes a message list and marks each message as not being deleted.
.It Ic undraft
Takes a message list and
.Ns un Ns Ic draft Ns
s each message.
.It Ic unflag
Takes a message list and marks each message as not being
.Ic flag Ns ged .
.It Ic unfwdignore
Removes the header field names from the list of ignored fields for the
.Ic forward
command.
.It Ic unfwdretain
Removes the header field names from the list of retained fields for the
.Ic forward
command.
.It Ic unghost
Remove an existing command
.Ic ghost .
.It Ic unignore
Removes the header field names from the list of ignored fields.
.It Ic Unread
Same as
.Ic unread .
.It Ic unread
(U) Takes a message list and marks each message as not having been read.
.It Ic unretain
Removes the header field names from the list of retained fields.
.It Ic unsaveignore
Removes the header field names from the list of ignored fields for
saving.
.It Ic unsaveretain
Removes the header field names from the list of retained fields for
saving.
.It Ic unset
Takes a list of option names and discards their remembered values;
the inverse of
.Ic set .
.It Ic unshortcut
Deletes the shortcut names given as arguments.
.It Ic unsort
Disable sorted or threaded mode
(see the
.Ic sort
and
.Ic thread
commands),
return to normal message order and,
if the
.Va header
variable is set,
print a header summary.
.It Ic unthread
(unth) Same as
.Ic unsort .
.It Ic var-inspect
Show information about all given options.
.It Ic verify
\*(OP (verif) Takes a message list and verifies each message.
If a message is not an S/MIME signed message,
verification will fail for it.
The verification process checks if the message was signed using a valid
certificate,
if the message sender's email address matches one of those contained
within the certificate,
and if the message content has been altered.
.It Ic visual
(v) Takes a message list and invokes the display editor on each message.
Modified contents are discarded unless the
.Va writebackedited
variable is set.
.It Ic write
(w) For conventional messages the body without all headers is written.
The output is decrypted and converted to its native format as necessary.
If the output file exists, the text is appended.
If a message is in MIME multipart format its first part is written to
the specified file as for conventional messages,
and the user is asked for a filename to save each other part.
For convience saving of each part may be skipped by giving an empty value;
the same result can also be achieved by writing it to
.Pa /dev/null .
For the second and subsequent parts a leading `|' character causes the
part to be piped to the remainder of the user input interpreted as
a shell command;
otherwise the user input is expanded as usually for folders,
e.g., tilde expansion is performed.
In non-interactive mode, only the parts of the multipart message
that have a filename given in the part header are written,
the others are discarded.
The original message is never marked for deletion in the originating
mail folder.
For attachments,
the contents of the destination file are overwritten if the file
previously existed.
No special handling of compressed files is performed.
.It Ic xit
(x) A synonym for
.Ic exit .
.It Ic z
\*(UA presents message headers in windowfuls as described under the
.Ic headers
command.
This command scrolls to the next window of messages.
If an argument is given,
it specifies the window to use.
A number prefixed by `+' or `\-' indicates
that the window is calculated in relation to the current position.
A number without a prefix specifies an absolute window number,
and a `$' lets \*(UA scroll to the last window of messages.
.It Ic Z
Similar to
.Ic z ,
but scrolls to the next or previous window that contains at least one
new or `flagged' message.
.El
.\"
.\" --  >8  --  8<  --
.Ss "Tilde escapes"
Here is a summary of the tilde escapes,
which are used to perform special functions when composing messages.
Tilde escapes are only recognized at the beginning of lines.
The name `tilde escape' is somewhat of a misnomer since the actual
escape character can be set by the option
.Va escape .
.Bl -tag -width ".Ic ~< filename"
.It Ic ~~ Ar string
Insert the string of text in the message prefaced by a single `~'.
(If the escape character has been changed,
that character must be doubled
in order to send it at the beginning of a line.)
.It Ic ~! Ar command
Execute the indicated shell
.Ar command ,
then return to the message.
.It Ic ~.
Same effect as typing the end-of-file character.
.It Ic ~: Ar \*(UA-command Ns \ or Ic ~_ Ar \*(UA-command
Execute the given \*(UA command.
Not all commands, however, are allowed.
.It Ic ~?
Write a summary of command escapes.
.It Ic ~< Ar filename
Identical to
.Ic ~r .
.It Ic ~<! Ar command
.Ar command
is executed using the shell.
Its standard output is inserted into the message.
.It Ic ~@ Op Ar filename...
With no arguments, edit the attachment list interactively.
If an attachment's file name is left empty,
that attachment is deleted from the list.
When the end of the attachment list is reached,
\*(UA will ask for further attachments until an empty name is given.
If a given file name solely consists of the number sign `#' followed
by a valid message number of the currently active mailbox, the given
message is attached as a MIME `message/rfc822' and the rest of this
section does not apply.
.Pp
If character set conversion has been compiled into \*(UA, then this mode
gives the user the option to specify input and output character sets,
unless the file extension indicates binary content, in which case \*(UA
asks wether this step shall be skipped for the attachment in question.
If not skipped, then the charset that succeeds to represent the
attachment data will be used in the `charset=' MIME parameter of the
mail message.
.Bl -bullet
.It
If input and output character sets are specified, then the conversion is
performed on the fly.
The user will be asked repeatedly until the desired conversion succeeds.
.It
If only an output character set is specified, then the input is assumed
to be in the
.Va ttycharset
charset and will be converted to the given output charset on the fly.
The user will be asked repeatedly until the desired conversion succeeds.
.It
If no character sets are specified at all then the algorithm that is
documented in the section
.Sx "Character sets"
is applied, but directly and on the fly.
The user will be asked repeatedly until the desired conversion succeeds.
.It
Finally, if an input-, but no output character set is specified, then no
conversion is ever performed, but the `charset=' MIME parameter will
still be set to the user input.
.El
.Pp
Without character set conversion support, \*(UA will ask for the input
character set only, and it'll set the `charset=' MIME parameter to the
given input, if any;
if no user input is seen then the
.Va ttycharset
character set will be used for the `charset=' parameter instead.
Note that the file extension check isn't performed in this mode, since
no conversion will take place anyway.
.Pp
Note that in non-interactive mode, for reproduceabilities sake, there
will always be two questions for each attachment, regardless of wether
character set conversion is available and what the file extension is.
The first asks for the filename, and the second asks for the input
character set to be passed through to the `charset=' MIME parameter;
no conversion will be tried if there is input to the latter question,
otherwise the usual conversion algorithm, as above, is applied.
For message attachments, the answer to the second question is completely
ignored.
.Pp
If
.Ar filename
arguments are specified,
they are treated as a comma separated list of files,
which are all expanded and appended to the end of the attachment list.
(Filenames with commas, or with leading or trailing whitespace can only
be added via the command line or the first method.
Message attachments can only be added via the first method;
filenames which clash with message numbers can only be added via the
command line or the second method.)
In this mode the (text) attachments are assumed to be in
.Va ttycharset
encoding, and will be evaluated as documented in the section
.Sx "Character sets" .
.It Ic ~A
Inserts the string contained in the
.Va Sign
variable (same as `~i Sign').
The escape sequences `\et' (tabulator) and `\en' (newline) are understood.
.It Ic ~a
Inserts the string contained in the
.Va sign
variable (same as `~i sign').
The escape sequences `\et' (tabulator) and `\en' (newline) are understood.
.It Ic ~b Ar name ...
Add the given names to the list of blind carbon copy recipients.
.It Ic ~c Ar name ...
Add the given names to the list of carbon copy recipients.
.It Ic ~d
Read the file specified by the
.Va DEAD
variable into the message.
.It Ic ~e
Invoke the text editor on the message collected so far.
After the editing session is finished,
the user may continue appending text to the message.
.It Ic ~f Ar messages
Read the named messages into the message being sent.
If no messages are specified,
read in the current message.
Message headers currently being ignored (by the
.Ic ignore
or
.Ic retain
command) are not included.
For MIME multipart messages,
only the first printable part is included.
.It Ic ~F Ar messages
Identical to `~f', except that all message headers and MIME parts are
included.
.It Ic ~h
Edit the message header fields `To:', `Cc:', `Bcc:', and `Subject:' by
typing each one in turn and allowing the user to edit the field.
.It Ic ~H
Edit the message header fields `From:', `Reply-To:', `Sender:' and
`Organization:' in the same manner as described for
.Ic ~h .
The default values for these fields originate from the
.Va from ,
.Va replyto ,
.Va sender
and
.Va ORGANIZATION
variables.
.It Ic ~i Ar variable
Insert the value of the specified variable into the message,
adding a newline character at the end.
The message remains unaltered if the variable is unset or empty.
The escape sequences `\et' (tabulator) and `\en' (newline) are understood.
.It Ic ~m Ar messages
Read the named messages into the message being sent,
indented by a tab or by the value of
.Va indentprefix .
If no messages are specified,
read the current message.
Message headers currently being ignored (by the
.Ic ignore
or
.Ic retain
commands) are not included.
For MIME multipart messages,
only the first printable part is included.
.It Ic ~M Ar messages
Identical to `~m', except that all message headers and MIME parts are
included.
.It Ic ~p
Print out the message collected so far,
prefaced by the message header fields
and followed by the attachment list, if any.
.It Ic ~q
Abort the message being sent,
copying it to the file specified by the
.Va DEAD
variable if
.Va save
is set.
.It Ic ~r Ar filename
Read the named file into the message.
.It Ic ~s Ar string
Cause the named string to become the current subject field.
.It Ic ~t Ar name ...
Add the given name(s) to the direct recipient list.
.It Ic ~u Ar messages
Like `~f', but exclude all message headers.
.It Ic ~U Ar messages
Like `~m', but exclude all message headers.
.It Ic ~v
Invoke an alternate editor (defined by the
.Va VISUAL
option) on the message collected so far.
Usually, the alternate editor will be a screen editor.
After the editor is quit,
the user may resume appending text to the end of the message.
.It Ic ~w Ar filename
Write the message onto the named file.
If the file exists,
the message is appended to it.
.It Ic ~x
Same as `~q', except that the message is not saved at all.
.It Ic ~| Ar command
Pipe the message through the specified filter command.
If the command gives no output or terminates abnormally,
retain the original text of the message.
E.g., the command
.Xr fmt 1
is often used as a rejustifying filter.
.El
.\"
.\" --  >8  --  8<  --
.Ss "Variable options"
Options are controlled via
.Ic set
and
.Ic unset
commands, see the corresponding entries for a syntax description.
An option is also set if it is passed to \*(UA as part of the program
environment (this is not restricted to specific variables as in the
POSIX standard).
A value given in a startup file overrides a value imported from the
environment.
Options may be either binary, in which case it is only significant to
see whether they are set or not;
or string, in which case the actual value is of interest.
.\"
.\" --  >8  --  8<  --
.Ss "Binary options"
The binary options include the following:
.Bl -tag -width ".Va autoprint"
.It Va add-file-recipients
When file or pipe recipients have been specified,
mention them in the corresponding address fields of the message instead
of silently stripping them from their recipient list.
By default such addressees are not mentioned.
.It Va allnet
Causes only the local part to be evaluated
when comparing addresses.
.It Va append
Causes messages saved in mbox to be appended to the end rather than
prepended.
This should always be set.
.It Va ask Ns \ or Va asksub
Causes \*(UA to prompt for the subject of each message sent.
If the user responds with simply a newline,
no subject field will be sent.
.It Va askatend
Causes the prompts for `Cc:' and `Bcc:' lists to appear after the
message has been edited.
.It Va askattach
If set, \*(UA asks for files to attach at the end of each message.
An empty line finalizes the list.
.It Va askcc
Causes the user to be prompted for additional carbon copy recipients (at
the end of each message if
.Va askatend
or
.Va bsdcompat
are set).
An empty line finalizes the list.
.It Va askbcc
Causes the user to be prompted for additional blind carbon copy
recipients (at the end of each message if
.Va askatend
or
.Va bsdcompat
are set).
An empty line finalizes the list.
.It Va asksign
\*(OP Causes the user to be prompted if the message is to be signed at
the end of each message.
The
.Va smime-sign
variable is ignored when this variable is set.
.It Va autocollapse
Causes threads to be collapsed automatically when threaded mode is
entered (see the
.Ic collapse
command).
.It Va autoprint
Causes the delete command to behave like `dp -';
thus, after deleting a message the next one will be typed automatically.
.It Va autothread
Causes threaded mode (see the
.Ic thread
command) to be entered automatically when a folder is opened.
.It Va bang
Enables the substitution of `!' by the contents of the last command line
in shell escapes.
.It Va batch-exit-on-error
If the batch mode has been enabled via the
.Fl #
command line option, then this variable will be consulted whenever \*(UA
completes one operation (returns to the command prompt); if it is set
then \*(UA will terminate if the last operation generated an error.
.It Va bsdannounce
Causes automatic display of a header summary after executing a
.Ic folder
command.
.It Va bsdcompat
Sets some cosmetical features to traditional BSD style;
has the same affect as setting
.Va askatend
and all other variables prefixed with `bsd';
it also changes the meaning of the \*(UA specific `\\&'
.Va prompt
escape sequence.
.It Va bsdflags
Changes the letters printed in the first column of a header summary
to traditional BSD style.
.It Va bsdheadline
Changes the display of columns in a header summary to traditional BSD
style.
.It Va bsdmsgs
Changes some informational messages to traditional BSD style.
.It Va bsdorder
Causes the `Subject:' field to appear immediately after the `To:' field
in message headers and with the `~h' tilde command.
.It Va bsdset
Changes the output format of the
.Ic set
command to traditional BSD style.
.It Va colour-disable
\*(OP Forcefully disable usage of colours.
Also see the section
.Sx "Coloured message display" .
.It Va debug
Prints debugging messages and disables the actual delivery of messages.
Unlike
.Va verbose ,
this option is intended for \*(UA development only.
.It Va disconnected
\*(OP When an IMAP mailbox is selected and this variable is set,
no connection to the server is initiated.
Instead, data is obtained from the local cache (see
.Va imap-cache Ns
).
Mailboxes that are not present in the cache
and messages that have not yet entirely been fetched from the server
are not available;
to fetch all messages in a mailbox at once,
the command
.Ns ` Ns Li copy * /dev/null Ns '
can be used while still in
.Va online
mode.
Changes that are made to IMAP mailboxes in disconnected mode are queued
and committed later when a connection to that server is opened in online
mode.
This procedure is not completely reliable since it cannot be guaranteed
that the IMAP unique identifiers (UIDs) on the server still match the
ones in the cache at that time.
Data is saved to
.Va DEAD
when this problem occurs.
.It Va disconnected-user@host
The specified account is handled as described for the
.Va disconnected
variable above,
but other accounts are not affected.
.It Va dot
The binary option dot causes \*(UA to interpret a period alone on a line
as the terminator of a message the user is sending.
.It Va editalong
If this variable is set then the editor is started automatically when
composing a message in an interactive mode,
as if the `~e' tilde command had been specified.
The
.Va editheaders
variable is implied for this automatically spawned editor session.
.It Va editheaders
When a message is edited while being composed,
its header is included in the editable text.
The `To:', `Cc:', `Bcc:', `Subject:', `From:', `Reply-To:', `Sender:',
and 'Organization:' fields are accepted within the header,
other fields are ignored.
.It Va emptybox
If set, an empty mailbox file is not removed.
This may improve the interoperability with other mail user agents
when using a common folder directory.
.It Va emptystart
If the mailbox is empty \*(UA normally prints `No mail for user' and
exits immediately.
If this option is set \*(UA starts even with an empty mailbox.
.It Va flipr
Exchanges the
.Ic Respond
with the
.Ic respond
commands and vice-versa.
.It Va forward-as-attachment
Original messages are normally sent as inline text with the
.Ic forward
command,
and only the first part of a multipart message is included.
With this option messages are sent as MIME `message/rfc822' attachments
with all of their parts included.
The
.Va fwdignore
and
.Va fwdretain
options are ignored when the
.Va forward-as-attachment
option is set.
.It Va fullnames
When replying to a message \*(UA normally removes the comment parts of
email addresses,
which by convention contain the full names of the recipients.
If this variable is set such stripping is not performed,
and comments are retained.
.It Va header
Causes the header summary to be written at startup and after commands
that affect the number of messages or the order of messages in the
current folder; enabled by default.
.It Va hold
This option is used to hold messages in the system mailbox by default.
.It Va idna-disable
\*(OP Can be used to turn off the automatic conversion of domain names
according to the rules of IDNA (internationalized domain names for
applications).
Since the IDNA code assumes domain names are specified with the
.Va ttycharset
character set, an UTF-8 locale charset is required to represent
all possible international domain names (before conversion, that is).
.It Va ignore
Causes interrupt signals from the terminal to be ignored
and echoed as `@'s.
.It Va ignoreeof
An option related to
.Va dot
is
.Va ignoreeof ,
which makes \*(UA refuse to accept a `control-D' as the end of a message.
This option also applies to \*(UA command mode.
.It Va imap-use-starttls
\*(OP Causes \*(UA to issue a `STARTTLS' command to make an unencrypted
IMAP session SSL/TLS encrypted.
This functionality is not supported by all servers,
and is not used if the session is already encrypted by the IMAPS method.
.It Va imap-use-starttls-user@host
Activates
.Va imap-use-starttls
for a specific account.
.It Va keep
This option causes \*(UA to truncate the user's system mailbox instead
of deleting it when it is empty.
This should always be set since it prevents malicious users from
creating fake mail folders in a world-writable spool directory.
.It Va keepsave
When a message is saved it is usually discarded from the originating
folder when \*(UA is quit.
Setting this option causes all saved message to be retained.
.It Va line-editor-disable
Turn off any enhanced command line editing capabilities (see
.Sx "Command line editor"
for more).
.It Va markanswered
When a message is replied to and this variable is set,
it is marked as having been answered.
This mark has no technical meaning in the mail system;
it just causes messages to be marked in the header summary,
and makes them specially addressable.
.It Va message-id-disable
By setting this option the generation of `Message-ID:' can be completely
suppressed, effectively leaving this task up to the mail-transfer-agent
(MTA) or the SMTP server.
(According to RFC 5321 your SMTP server is not required to add this
field by itself, so you should ensure that it accepts messages without
a `Message-ID'.)
.It Va metoo
Usually, when a group is expanded that contains the sender,
the sender is removed from the expansion.
Setting this option causes the sender to be included in the group.
.It Va mime-allow-text-controls
When sending messages, each part of the message is MIME-inspected in
order to classify the `Content-Type:' and `Content-Transfer-Encoding:'
that is required to send this part over mail transport, i.e.,
a computation rather similar to what the
.Xr file 1
command produces when used with the
.Fl -mime
option.
.Pp
This classification however treats text files which are encoded in
UTF-16 (often found for HTML files) and similar character sets as binary
octet-streams, forcefully changing any `text/plain' or `text/html'
specification to `application/octet-stream';
if that actually happens, then a yet unset charset MIME parameter is set
to `binary', effectively making it impossible for the receiving MUA to
automatically interpret the contents of the part.
.Pp
If this option is set, and the data was unambiguously identified as text
data at first glance (by a `.txt' or `.html' file extension), then the
original `Content-Type:' will not be overwritten.
.It Va mime-counter-evidence
Normally the `Content-Type:' field is used to decide how to treat
a messages MIME part.
Some MUAs however don't use
.Xr mime.types 5
or a similar mechanism to correctly classify content,
but simply specify `application/octet-stream',
even for plain text attachments like `text/diff'.
If this variable is set then \*(UA will use the file extension of
attachments to classify such MIME message parts, if possible.
.It Va noheader
Setting this option is the same as using the command line option
.Fl N .
.It Va outfolder
Causes the filename given in the
.Va record
variable
and the sender-based filenames for the
.Ic Copy
and
.Ic Save
commands to be interpreted relative to the directory given in the
.Va folder
variable rather than to the current directory,
unless it is set to an absolute pathname.
.It Va page
If set, each message the
.Ic pipe
command prints out is followed by a formfeed character.
.It Va piperaw
Send messages to the
.Ic pipe
command without performing MIME and character set conversions.
.It Va pop3-bulk-load
\*(OP When accessing a POP3 server \*(UA loads the headers of the
messages, and only requests the message bodies on user request.
For the POP3 protocol this means that the message headers will be
downloaded twice.
If this option is set then \*(UA will download only complete messages
from POP3 servers instead.
It may be useful to
.Ic define
a macro that temporarily sets this option, then accesses a POP3 account
that is known to only get small text messages, and then unsets this
variable again.
.It Va pop3-no-apop
\*(OP Unless this variable is set the `APOP' authentication method
will be used when connecting to a POP3 server that advertises support.
The advantage of APOP over `USER/PASS' authentication is that the
password is not sent in clear text over the wire and that only a single
packet is sent for the user/password tuple.
.It Va pop3-no-apop-user@host
Disables usage of the `APOP' authentication method (see
.Va pop3-no-apop )
for a specific account.
.It Va pop3-use-starttls
\*(OP Causes \*(UA to issue a `STLS' command to make an unencrypted POP3
session SSL/TLS encrypted.
This functionality is not supported by all servers,
and is not used if the session is already encrypted by the POP3S method.
.It Va pop3-use-starttls-user@host
Activates
.Va pop3-use-starttls
for a specific account.
.It Va print-all-chars
This option causes all characters to be considered printable.
It is only effective if given in a startup file.
With this option set some character sequences in messages may put the
user's terminal in an undefined state when printed;
it should only be used as a last resort if no working system locale can
be found.
.It Va print-alternatives
When a MIME message part of type `multipart/alternative' is displayed
and it contains a subpart of type `text/plain',
other parts are normally discarded.
Setting this variable causes all subparts to be displayed,
just as if the surrounding part was of type `multipart/mixed'.
.It Va quiet
Suppresses the printing of the version when first invoked.
.It Va quote-as-attachment
If this is set, then the original message is added in its entirety
as a `message/rfc822' MIME attachment when replying to a message.
Note this works regardless of the setting of
.Va quote .
.It Va recipients-in-cc
On group replies, specify only the sender of the original mail in `To:'
and mention it's other recipients in the secondary `Cc:'.
.It Va record-resent
If both this variable and the
.Va record
variable are set,
the
.Ic resend
and
.Ic Resend
commands save messages to the
.Va record
folder as it is normally only done for newly composed messages.
.It Va reply-in-same-charset
If this variable is set \*(UA first tries to use the same character set
of the original message for replies.
If this fails, the mechanism described in
.Sx "Character sets"
is evaluated as usual.
.It Va Replyall
Reverses the sense of
.Ic reply
and
.Ic Reply
commands.
.It Va rfc822-body-from_
This variable can be used to force the display of a so-called `From_'
line for messages that are embedded into an envelope mail via the
`message/rfc822' MIME mechanism.
.It Va save
When the user aborts a message with two `RUBOUT' (interrupt) characters,
\*(UA will copy the partial letter to the file
.Va DEAD .
This option is set by default.
.It Va searchheaders
Expand message-list specifiers in the form `/x:y' to all messages
containing the substring `y' in the header field `x'.
The string search is case insensitive.
.It Va sendcharsets-else-ttycharset
\*(OP If this variable is set, but
.Va sendcharsets
is not, then \*(UA acts as if
.Va sendcharsets
had been set to the value of the variable
.Va ttycharset .
In effect this combination passes through the message data in the
character set of the current locale (given that
.Va ttycharset
hasn't been set manually), i.e., without converting it to the
.Va charset-8bit
fallback character set.
Thus, mail message text will be in `ISO-8859-1' encoding when send from
within a `ISO-8859-1' locale, and in `UTF-8' encoding when send from
within an `UTF-8' locale.
.It Va sendwait
When sending a message wait until the MTA exits before accepting further
commands.
If the MTA returns a non-zero exit status,
the exit status of \*(ua will also be non-zero.
.It Va showlast
Setting this option causes \*(UA to start at the last message instead of
the first one when opening a mail folder.
.It Va showname
Causes \*(UA to use the sender's real name instead of the plain address
in the header field summary and in message specifications.
.It Va showto
Causes the recipient of the message to be shown in the header summary
if the message was sent by the user.
.It Va skipemptybody
If an outgoing message does not contain any text in its first or only
message part,
do not send it but discard it silently (see also the command line option
.Fl E Ns
).
.It Va smime-force-encryption
\*(OP Causes \*(UA to refuse sending unencrypted messages.
.It Va smime-sign
\*(OP S/MIME sign outgoing messages with the user's private key.
Signing a message enables a recipient to verify that the sender used
a valid certificate,
that the email addresses in the certificate match those in the message
header and that the message content has not been altered.
It does not change the message text,
and people will be able to read the message as usual.
.It Va smime-no-default-ca
\*(OP Don't load default CA locations when verifying S/MIME signed
messages.
.It Va smtp-use-starttls
\*(OP Causes \*(UA to issue a `STARTTLS' command to make an SMTP session
SSL/TLS encrypted.
Not all servers support this command \(en because of common
implementation defects it can't be automatically determined whether
a server supports it or not.
.It Va ssl-no-default-ca
\*(OP Don't load default CA locations to verify SSL/TLS server
certificates.
.It Va ssl-v2-allow
\*(OP Accept SSLv2 connections.
These are normally not allowed because this protocol version is insecure.
.It Va keep-content-length
When (editing messages and) writing MBOX mailbox files \*(UA can be told
to keep the `Content-Length:' and `Lines:' header fields that some MUAs
generate by setting this variable.
Since \*(UA does neither use nor update these non-standardized header
fields (which in itself shows one of their conceptual problems),
stripping them should increase interoperability in between MUAs that
work with with same mailbox files.
Note that, if this is not set but
.Va writebackedited ,
as below, is, a possibly performed automatic stripping of these header
fields already marks the message as being modified.
.It Va verbose
Setting the option verbose is the same as using the command line option
.Fl v .
When \*(UA runs in verbose mode details of the actual message delivery
and protocol conversations for IMAP, POP3, and SMTP,
as well as of other internal processes,
are displayed on the user's terminal.
This is sometimes useful to debug problems.
\*(UA prints all data that is sent to remote servers in clear texts,
including passwords,
so care should be taken that no unauthorized option can view the screen
if this option is enabled.
.It Va writebackedited
If this variable is set messages modified using the
.Ic edit
or
.Ic visual
commands are written back to the current folder when it is quit;
it is only honoured for writable folders in `mbox' format, though.
Note that the editor will be pointed to the raw message content in that
case, i.e., neither MIME decoding nor decryption will have been
performed,
and proper RFC 4155 `From ' quoting of newly added or edited content is
also left as an excercise to the user.
.El
.\"
.\" --  >8  --  8<  --
.Ss "Value options"
The value options include the following:
.Bl -tag -width ".Va autoprint"
.It Va attrlist
A sequence of characters to print in the `attribute' column of a header
summary,
each for one type of messages in the following order:
new (N), unread but old (U), new but read (R), read and old (O), saved
(S), preserved (P), mboxed (M), flagged (F), answered (A), draft (T),
start of a collapsed thread (+), collapsed (\-), classified as spam ($).
The default is `NUROSPMFAT+\-$',
or `NU\ \ *HMFAT+\-$' if
.Va bsdflags
or the
.Va SYSV3
environment variable are set.
.It Va autobcc
Specifies a list of recipients to which a blind carbon copy of each
outgoing message will be sent automatically.
.It Va autocc
Specifies a list of recipients to which a carbon copy of each outgoing
message will be sent automatically.
.It Va autosort
Causes sorted mode (see the
.Ic sort
command) to be entered automatically with the value of this option as
sorting method when a folder is opened.
.It Va charset-7bit
The value that should appear in the `charset=' parameter of
`Content-Type:' MIME header fields when no character set conversion of
the message data was performed.
This defaults to `US-ASCII', and the chosen character set should be
`US-ASCII' compatible.
.It Va charset-8bit
\*(OP The default 8 bit character set that is used if
.Va sendcharsets
is not set or no character set therein was capable to represent the
content of a message.
Defaults to `UTF-8'.
If no character set conversion capabilities are available in \*(UA then
the only supported character set is
.Va ttycharset .
Refer to the section
.Sx "Character sets"
for the complete picture of character set conversion in \*(UA.
.It Va cmd
The default value for the
.Ic pipe
command.
.It Va colour-from_
\*(OP The colour specification for so-called `From_' lines.
See the section
.Sx "Coloured message display"
for the format of the value.
.It Va colour-header
\*(OP The colour specification for header lines.
See the section
.Sx "Coloured message display"
for the format of the value.
.It Va colour-msginfo
\*(OP The colour specification for the introductional message info line.
See the section
.Sx "Coloured message display"
for the format of the value.
.It Va colour-pagers
\*(OP A comma-separated list of
.Va PAGER Ns
s for which coloured message display can be used.
Note that only a substring comparison is performed, meaning that the
string `lesser' will match the string `less'.
See the section
.Sx "Coloured message display"
for more on this.
The default is set to the sole string `less'.
.It Va colour-partinfo
\*(OP The colour specification for MIME part info lines.
See the section
.Sx "Coloured message display"
for the format of the value.
.It Va colour-terms
\*(OP A comma-separated list of
.Va TERM Ns
inals for which coloured message display can be used.
The default is
.Pp
.Dl cons25,linux,rxvt,rxvt-unicode,\:screen,\:sun,\:vt100,\:vt220,\:\
wsvt25,\:xterm,\:xterm-color
.It Va colour-uheader
\*(OP The colour specification for those header lines that have been
placed in the
.Va colour-user-headers
list.
See the section
.Sx "Coloured message display"
for the format of the value.
.It Va colour-user-headers
A comma separated list of (case-insensitive) header names which should
be colourized with the alternative
.Va colour-uheader
colours.
The default value is `from,subject'.
.It Va crt
The valued option crt is used as a threshold to determine how long
a message must be before
.Va PAGER
is used to read it.
If
.Va crt
is set without a value then the height of the terminal screen stored in
the system is used to compute the threshold (see
.Va LINES
and
.Xr stty 1 Ns
).
.It Va DEAD
The name of the file to use for saving aborted messages.
This defaults to `dead.letter' in the user's home directory.
.It Va datefield
The date in a header summary is normally the date of the mailbox `From\ '
line of the message.
If this variable is set, then the date as given in the `Date:' field is
used, converted to local time.
It is possible to control the display of the date by assigning a value,
in which case the
.Xr strftime 3
function will be used to format the date accordingly.
Please read your system manual for the available formats.
Note that the `%n' format should not be used, because \*(UA doesn't
take embedded newlines into account when calculating how many lines fit
onto the screen.
.It Va datefield-markout-older
This option, when set in addition to
.Va datefield ,
modifies the display of messages that are not really current in a way
that is rather comparable to the
.Fl l
option of the POSIX
.Xr ls 1
command.
The interpretation of the value is identical to what has been described
for
.Va datefield .
.It Va EDITOR
Pathname of the text editor to use in the
.Ic edit
command and
.Ic ~e
tilde escape.
A default editor is used if this value is not defined.
.It Va encoding
The default MIME encoding to use in outgoing text messages and message
parts.
Valid values are the default `quoted-printable', `8bit' and `base64'.
`8bit' may cause problems with mail transfers that are not ESMTP
compliant.
If there is no need to encode a message,
`7bit' transfer mode is always used regardless of this variable.
Binary data is always encoded as `base64'.
.It Va escape
If defined, the first character of this option
gives the character to use in place of `~' to denote tilde escapes.
.It Va folder
The name of the directory to use for storing folders of messages.
All folder names that begin with `+' refer to files below it.
The same special conventions as documented for the
.Ic folder
command may be used when specifying a new value for
.Va folder ,
but be aware that the expansion is fully performed immediately.
E.g., if the expanded name refers to an IMAP account, all names that
begin with `+' refer to IMAP mailboxes below the
.Va folder
target box.
.Pp
Note: some IMAP servers do not accept the creation of mailboxes in
the hierarchy base, but require that they are created as subfolders of
`INBOX' \(en with such servers a folder name of the form
.Pp
.Dl imaps://mylogin@imap.myisp.example/INBOX.
.Pp
should be used (the last character is the server's hierarchy delimiter).
Folder names prefixed by `+' will then refer to folders below `INBOX',
while folder names prefixed by `@' refer to folders below the hierarchy
base.
See the
.Ic imap
namespace command for a method to detect the appropriate prefix and
delimiter.
.It Va folder-hook
When a folder is opened and this variable is set,
the macro corresponding to the value of this variable is executed.
The macro is also invoked when new mail arrives,
but message lists for commands executed from the macro
only include newly arrived messages then.
.It Va folder-hook-fullname
When a folder named `fullname' is opened,
the macro corresponding to the value of this variable is executed.
Unlike other folder specifications,
the fully expanded name of a folder, without metacharacters,
is used to avoid ambiguities.
The macro specified with
.Va folder-hook
is not executed if this variable is effective for a folder
(but it can be
.Ic call Ns
ed from within the actually executed macro).
.It Va from
The address (or a list of addresses) to put into the `From:' field of
the message header.
If replying to messages these addresses are handled as if they were in
the
.Ic alternates
list.
If the machine's hostname is not valid at the Internet (for example at
a dialup machine), then either this variable or
.Va hostname
have to be set.
If
.Va from
contains more than one address,
the
.Va sender
variable must also be set.
.It Va fwdheading
The string to print before the text of a message with the
.Ic forward
command
(unless the
.Va forward-as-attachment
variable is set).
Defaults to `-------- Original Message --------' if unset.
No heading is printed if it is set to the empty string.
.It Va headline
A format string to use for the header summary,
similar to
.Xr printf 3
formats.
A `%' character introduces a format specifier.
It may be followed by a number indicating the field width.
If the (possibly implicitly implied) field width is negative, the field
is to be left-aligned.
Valid format specifiers are:
.Bl -tag -offset indent -width "%%"
.It %a
Message attributes.
.It %d
The date when the message was received.
.It %e
The indenting level in threaded mode.
.It %f
The address of the message sender.
.It %i
The message thread structure.
(Note that this format doesn't support a field width.)
.It %l
The number of lines of the message.
.It %m
Message number.
.It %o
The number of octets (bytes) in the message.
.It %s
Message subject (if any).
.It %S
Message subject (if any) in double quotes.
.It %t
The position in threaded/sorted order.
.It %>
A `>' for the current message, otherwise ` '.
.It %<
A `<' for the current message, otherwise ` '.
.It %$
The spam score of the message, as has been classified via the command
.Ic spamrate .
.It %%
A `%' character.
.El
.Pp
The default is `%>\&%a\&%m\ %-18f\ %16d\ %4l/%\-5o\ %i%-s',
or `%>\&%a\&%m\ %20-f\ \ %16d\ %3l/%\-5o\ %i%-S' if
.Va bsdcompat
is set.
.It Va hostname
Use this string as hostname when expanding local addresses instead of
the value obtained from
.Xr uname 2
and
.Xr getaddrinfo 3 ,
i.e., in `Message-ID:' and `From:' fields.
Note that when
.Va smtp
transport is not used then it is normally the responsibility of the MTA
to create these fields; you should produce some test messages with the
desired combination of
.Va hostname ,
and/or
.Va from ,
.Va sender
etc. first.
.It Va imap-auth
\*(OP Sets the IMAP authentication method.
Valid values are `login' for the usual password-based authentication
(the default),
`cram-md5', which is a password-based authentication that does not send
the password over the network in clear text,
and `gssapi' for GSSAPI-based authentication.
.It Va imap-auth-user@host
Sets the IMAP authentication method for a specific account.
.It Va imap-cache
\*(OP Enables caching of IMAP mailboxes.
The value of this variable must point to a directory that is either
existent or can be created by \*(UA.
All contents of the cache can be deleted by \*(UA at any time;
it is not safe to make assumptions about them.
.It Va imap-keepalive
\*(OP IMAP servers may close the connection after a period of
inactivity; the standard requires this to be at least 30 minutes,
but practical experience may vary.
Setting this variable to a numeric `value' greater than 0 causes
a `NOOP' command to be sent each `value' seconds if no other operation
is performed.
.It Va imap-list-depth
\*(OP When retrieving the list of folders on an IMAP server, the
.Ic folders
command stops after it has reached a certain depth to avoid possible
infinite loops.
The value of this variable sets the maximum depth allowed.
The default is 2.
If the folder separator on the current IMAP server is a slash `/',
this variable has no effect and the
.Ic folders
command does not descend to subfolders.
.It Va indentprefix
String used by the `~m' and `~M' tilde escapes and by the
.Va quote
option for indenting messages,
in place of the normal tab character (`^I').
Be sure to quote the value if it contains spaces or tabs.
.It Va LISTER
Pathname of the directory lister to use in the
.Ic folders
command when operating on local mailboxes.
Default is
.Pa /bin/ls .
.It Va line-editor-cursor-right
\*(OP If the builtin command line editor is used, actions which are
based on rightwise movement may not work on some terminals.
If you encounter such problems, set this variable to the terminal
control sequence that is necessary to move the cursor one column to the
right.
The default is `\\033[C', which should work for most terminals.
Less often occur `\\033OC' and `\\014'.
Note that `ESCAPE' and other control character have to be written as
shell-style escape sequences, e.g., `\\033' for `ESCAPE'.
.It Va MAIL
Is used as the user's mailbox, if set.
Otherwise, a system-dependent default is used.
Supports a logical subset of the special conventions that are documented
for the
.Ic folder
command and the
.Va folder
option.
.It Va MBOX
The name of the mbox file.
Supports a logical subset of the special conventions that are documented
for the
.Ic folder
command and the
.Va folder
option.
The fallback default is `mbox' in the user's home directory.
.It Va mimetypes-load-control
This option can be used to control which of the
.Xr mime.types 5
MIME type databases are loaded by \*(UA.
If the letter `u' (or `U') is part of this options value, then the
user's personal
.Pa ~/.mime.types
file will be loaded (if it exists);
likewise the letter `s' (or `S') controls loading of the system wide
.Pa /etc/mime.types .
If this option is not set \*(UA will try to load both files instead.
Incorporation of the MIME types that are compiled into \*(UA cannot be
suppressed.
.It Va NAIL_EXTRA_RC
The name of an optional startup file to be read after \*(ur.
This variable is ignored if it is imported from the environment;
it has an effect only if it is set in \*(UR or \*(ur to allow bypassing
the configuration with, e.g., `MAILRC=/dev/null'.
Use this file for commands that are not understood by other \*(UA
implementations.
.It Va NAIL_HEAD
A string to put at the beginning of each new message.
The escape sequences `\et' (tabulator) and `\en' (newline) are understood.
.It Va NAIL_HISTFILE
\*(OP If a command line editor is available then this can be set to
name the (expandable) path of the location of a permanent history file.
.It Va NAIL_HISTSIZE
\*(OP If a command line editor is available this value restricts the
amount of history entries that are saved into a set and valid
.Va NAIL_HISTFILE .
A value of less than 0 disables this feature;
note that loading and incorporation of
.Va NAIL_HISTFILE
upon program startup can also be suppressed by doing this.
An unset or invalid value, or 0, causes a default value to be used.
Dependent on the available command line editor this will also define the
number of history entries in memory;
it is also editor-specific wether runtime updates of this value will be
honoured.
.It Va NAIL_TAIL
A string to put at the end of each new message.
The escape sequences `\et' (tabulator) and `\en' (newline) are understood.
.It Va newfolders
If this variable has the value `maildir',
newly created local folders will be in `maildir' format.
.It Va newmail
Checks for new mail in the current folder each time the prompt is
printed.
For IMAP mailboxes the server is then polled for new mail,
which may result in delayed operation if the connection to the server is
slow.
A `maildir' folder must be re-scanned to determine if new mail has
arrived.
.Pp
If this variable is set to the special value `nopoll' an IMAP server is
not actively asked for new mail,
but new mail may still be detected and announced with any other IMAP
command that is sent to the server.
A `maildir' folder is not scanned, then.
.Pp
In either case the IMAP server may send notifications about messages
that have been deleted on the server by another process or client.
In this case, `Expunged X messages' is printed regardless of this
variable,
and message numbers may have changed.
.It Va ORGANIZATION
The value to put into the `Organization:' field of the message header.
.It Va PAGER
Pathname of the program to use in the more command or when the
.Va crt
variable is set.
The default paginator is
.Xr more 1 .
.It Va password-user@host
Set the password for `user' when connecting to `host'.
If no such variable is defined for a host,
the user will be asked for a password on standard input.
Specifying passwords in a startup file is generally a security risk;
the file should be readable by the invoking user only.
.It Va pipe-content/subcontent
When a MIME message part of `content/subcontent' type is displayed or
is replied to,
its text is filtered through the value of this variable interpreted as
a shell command.
.Pp
The special value `@' can be used to force interpretation of the message
part as plain text, e.g., `set pipe-application/pgp-signature=@' will
henceforth treat signatures as plain text and display them "as is".
.Pp
Also, if a normal shell command is prefixed with `@', then the command
will only be used to prepare the MIME message part if the message is
displayed by itself, but not when multiple messages are displayed at
once.
.Pp
Finally, if a normal shell command is prefixed with `@&', then, in
addition to what has been described for the plain `@' shell command
prefix, the command will be run asynchronously, i.e., without blocking
\*(UA, which may be a handy way to display a, e.g., PDF file while also
continuing to read the mail message.
.Pp
Special care must be taken when using such commands as mail viruses may
be distributed by this method;
if messages of type `application/x-sh' were filtered through the shell,
for example,
a message sender could easily execute arbitrary code on the system \*(UA
is running on.
.It Va pop3-keepalive
\*(OP POP3 servers close the connection after a period of inactivity;
the standard requires this to be at least 10 minutes,
but practical experience may vary.
Setting this variable to a numeric `value' greater than 0 causes
a `NOOP' command to be sent each `value' seconds if no other operation
is performed.
.It Va prompt
The string printed when a command is accepted.
Prompting may be prevented by either setting this to the null string
or by setting
.Va noprompt .
The same XSI escape sequences that are understood by the
.Ic echo
command may be used within
.Va prompt .
.Pp
In addition, the following \*(UA specific additional sequences are
understood:
`\\&', which expands to `?' unless
.Va bsdcompat
is set, in which case it expands to `&';
note that "\\& " is the default value for
.Va prompt .
`\\?', which will expand to `1' if the last command failed, and to `0'
otherwise,
`\\$', which will expand to the name of the currently active
.Ic account ,
if any, and to the empty string otherwise,
and `\\@', which will expand to the name of the currently active mailbox.
(Note that the prompt buffer is size-limited, excess is cut off.)
.Pp
When a newer version of the
.Xr editline 3
.Sx "Command line editor"
is used, any escape sequence must itself be encapsulated with another
escape character for usage with the
.Va EL_PROMPT_ESC
mechanism: \*(UA configures the control character `\\01' for this.
.It Va quote
If set, \*(UA starts a replying message with the original message
prefixed by the value of the variable
.Va indentprefix .
Normally, a heading consisting of `Fromheaderfield wrote:' is printed
before the quotation.
If the string `noheading' is assigned to the
.Va quote
variable, this heading is omitted.
If the string `headers' is assigned, the headers selected by the
.Ic ignore Ns / Ns Ic retain
commands are printed above the message body,
thus
.Va quote
acts like an automatic `~m' tilde escape command, then.
If the string `allheaders' is assigned, all headers are printed above
the message body and all MIME parts are included,
making
.Va quote
act like an automatic `~M' command.
Also see
.Va quote-as-attachment .
.It Va quote-fold
\*(OP Can be set in addition to
.Va indentprefix .
Setting this turns on a more fancy quotation algorithm in that leading
quotation characters are compressed and overlong lines are folded.
.Va quote-fold
can be set to either one or two (space separated) numeric values,
which are interpreted as the maximum (goal) and the minimum line length,
respectively, in a spirit rather equal to the
.Xr fmt 1
program, but line-, not paragraph-based.
If not set explicitly the minimum will reflect the goal algorithmically.
The goal can't be smaller than the length of
.Va indentprefix
plus some additional pad.
Necessary adjustments take place silently.
.It Va record
If defined, gives the pathname of the folder used to record all outgoing
mail.
If not defined, then outgoing mail is not saved.
When saving to this folder fails the message is not sent,
but instead saved to
.Va DEAD .
.It Va replyto
A list of addresses to put into the `Reply-To:' field of the message
header.
Members of this list are handled as if they were in the
.Ic alternates
list.
.It Va screen
When \*(UA initially prints the message headers it determines the number
to print by looking at the speed of the terminal.
The faster the terminal, the more it prints.
This option overrides this calculation and specifies how many message
headers are printed.
This number is also used for scrolling with the
.Ic z
command.
.It Va sendcharsets
\*(OP A comma-separated list of character set names that can be used in
outgoing Internet mail.
If no character set conversion capabilities are compiled into \*(UA then
the only supported charset is
.Va ttycharset .
Also see
.Va sendcharsets-else-ttycharset
and refer to the section
.Sx "Character sets"
for the complete picture of character set conversion in \*(UA.
.It Va sender
An address that is put into the `Sender:' field of outgoing messages.
This field needs not normally be present.
It is, however, required if the `From:' field contains more than one
address.
It can also be used to indicate that a message was sent on behalf of
someone else \(en in this case, `From:' should contain the address
of the person that took responsibility for the message,
and `Sender:' should contain the address of the person that actually
sent the message.
The
.Va sender
address is handled as if it were in the
.Ic alternates
list.
.It Va sendmail
To use an alternate mail delivery system,
set this option to the full pathname of the program to use.
It may be necessary to set
.Va sendmail-progname
in addition.
.It Va sendmail-progname
Many systems use a so-called
.Xr mailwrapper 8
environment to ensure compatibility with
.Xr sendmail 1 .
This works by inspecting the name that was used to invoke the mail
delivery system.
If this variable is set then the mailwrapper (the program that is
actually executed when calling `sendmail') will treat its contents as
that name.
The default is `sendmail'.
.It Va SHELL
Pathname of the shell to use in the
.Ic !
command and the `~!' tilde escape.
A default shell is used if this option is not defined.
.It Va Sign
A string for use with the `~A' tilde escape.
.It Va sign
A string for use with the `~a' tilde escape.
.It Va signature
Must correspond to the name of a readable file if set.
The file's content is then appended to each singlepart message
and to the first part of each multipart message.
Be warned that there is no possibility to edit the signature for an
individual message.
.It Va smime-ca-dir
\*(OP Specifies a directory with CA certificates in PEM (Privacy
Enhanced Mail) format for verification of S/MIME signed messages.
.It Va smime-ca-file
\*(OP Specifies a file with CA certificates in PEM format for
verification of S/MIME signed messages.
.It Va smime-cipher-user@host
\*(OP Specifies a cipher to use when generating S/MIME encrypted
messages for `user@host'.
RFC 5751 mandates a default of `aes-128' (AES-128 CBC).
.Pp
The actually available cipher algorithms depend on the cryptographic
library that \*(UA uses; possible values are, in decreasing cipher
strength:
`aes-256' (AES-256 CBC), `aes-192' (AES-192 CBC), `aes-128' (AES-128 CBC),
`des3' (DES EDE3 CBC, 168 bits; default if `aes-128' isn't available)
and `des' (DES CBC, 56 bits).
.Pp
The following ciphers have been obsoleted and are no longer mentioned by
the S/MIME specification (RFC 5751), but may be selected if available:
`rc2-64' (RC2 CBC, 64 bits) and `rc2-40' (RC2 CBC, 40 bits).
.It Va smime-crl-file
\*(OP Specifies a file that contains a CRL in PEM format to use when
verifying S/MIME messages.
.It Va smime-crl-dir
\*(OP Specifies a directory that contains files with CRLs in PEM format
to use when verifying S/MIME messages.
.It Va smime-encrypt-user@host
\*(OP If this variable is set, messages to `user@host' are encrypted
before sending.
The value of the variable must be set to the name of a file that
contains a certificate in PEM format.
.Pp
If a message is sent to multiple recipients,
each of them for whom a corresponding variable is set will receive an
individually encrypted message;
other recipients will continue to receive the message in plain text
unless the
.Va smime-force-encryption
variable is set.
It is recommended to sign encrypted messages, i.e., to also set the
.Va smime-sign
variable.
.It Va smime-sign-cert
\*(OP Points to a file in PEM format that contains the user's private
key as well as his certificate.
Both are used with S/MIME for signing and decrypting messages.
.It Va smime-sign-cert-user@host
Overrides
.Va smime-sign-cert
for the specific addresses.
When signing messages and the value of the
.Va from
variable is set to `user@host', the specific file is used.
When decrypting messages,
their recipient fields (`To:' and `Cc:') are searched for addresses
for which such a variable is set.
\*(UA always uses the first address that matches,
so if the same message is sent to more than one of the user's addresses
using different encryption keys, decryption might fail.
.It Va smime-sign-include-certs
\*(OP If used, this must be set to a comma-separated list of files,
each of which containing a single certificate in PEM format to be
included in the S/MIME message in addition to the
.Va smime-sign-cert
certificate.
This is most useful for long certificate chains if it is desired to aid
the receiving party's verification process.
.It Va smime-sign-include-certs-user@host
Overrides
.Va smime-sign-include-certs
for the specific addresses.
Refer to the discussion of
.Va smime-sign-cert-user@host
for more on this topic.
.It Va smtp
\*(OP Normally \*(UA invokes
.Xr sendmail 1
directly to transfer messages.
If the
.Va smtp
variable is set, a SMTP connection to the server specified by the value
of this variable is used instead.
If the SMTP server does not use the standard port, a value of
`server:port' can be given, with `port' as a name or as a number.
.Pp
There are two possible methods to get SSL/TLS encrypted SMTP sessions:
First, the `STARTTLS' command can be used to encrypt a session after it
has been initiated,
but before any user-related data has been sent; see
.Va smtp-use-starttls
above.
Second, some servers accept sessions that are encrypted from begin on.
This mode is configured by assigning `smtps://server[:port]' to the
.Va smtp
variable.
.Pp
The SMTP transfer is executed in a child process, which runs
asynchronously unless either the
.Va sendwait
or the
.Va verbose
variable is set.
If it receives a TERM signal, it will abort and save the message to
.Va DEAD .
.It Va smtp-auth
\*(OP Sets the SMTP authentication method.
If set to `login', or if unset and
.Va smtp-auth-user
is set, `AUTH LOGIN' is used.
If set to `cram-md5', `AUTH CRAM-MD5' is used;
if set to `plain', `AUTH PLAIN' is used.
Otherwise, no SMTP authentication is performed.
.It Va smtp-auth-user@host
Overrides
.Va smtp-auth
for specific values of sender addresses, dependend upon the variable
.Va from .
.It Va smtp-auth-password
\*(OP Sets the global password for `SMTP AUTH'.
Both user and password have to be given for `AUTH LOGIN' and
`AUTH CRAM-MD5'.
.It Va smtp-auth-password-user@host
Overrides
.Va smtp-auth-password
for specific values of sender addresses, dependent upon the variable
.Va from .
.It Va smtp-auth-user
\*(OP Sets the global user name for `SMTP AUTH'.
Both user and password have to be given for `AUTH LOGIN' and
`AUTH CRAM-MD5'.
If this variable is set but neither
.Va smtp-auth-password
nor a matching
.Va smtp-auth-password-user@host
can be found,
\*(UA will ask for a password on the user's terminal.
.It Va smtp-auth-user-user@host
Overrides
.Va smtp-auth-user
for specific values of sender addresses, dependent upon the variable
.Va from .
.It Va spam-command
\*(OP The path to the spam detector.
Note that the path is not expanded, but used "as is".
A fallback path will have been compiled into the \*(UA binary if the
.Xr spamc 1
executable had been found during compilation.
.It Va spam-host
\*(OP Can be used to specify the host on which
.Xr spamd 1
listens for connections; if not set, defaults to `localhost'.
.It Va spam-maxsize
\*(OP Spam detectors like
.Xr spamc 1
decline to work with messages which exceed a specific size;
if this variable is set then \*(UA won't even try to pass messages which
exceed the given limit.
The default is 420000 bytes.
.It Va spam-port
\*(OP Can be used to explicitly specify the port on which
.Xr spamd 1
listens for connections.
.It Va spam-socket
\*(OP If the spam detector listens on a path-based UNIX domain socket,
then setting this variable to the fully qualified path will force its
usage for communication.
.It Va spam-user
\*(OP This can be used to support multiple, per-used configuration files
of the spam detector.
Note that \*(UA doesn't automatically set this to reflect a possibly set
.Fl u
option.
.It Va ssl-ca-dir
\*(OP Specifies a directory with CA certificates in PEM (Pricacy
Enhanced Mail) for verification of of SSL/TLS server certificates.
See
.Xr SSL_CTX_load_verify_locations 3
for more information.
.It Va ssl-ca-file
\*(OP Specifies a file with CA certificates in PEM format for
verification of SSL/TLS server certificates.
See
.Xr SSL_CTX_load_verify_locations 3
for more information.
.It Va ssl-cert
\*(OP Sets the file name for a SSL/TLS client certificate required by
some servers.
.It Va ssl-cert-user@host
Sets an account-specific file name for a SSL/TLS client certificate
required by some servers.
Overrides
.Va ssl-cert
for the specified account.
.It Va ssl-cipher-list
\*(OP Specifies a list of ciphers for SSL/TLS connections.
See
.Xr ciphers 1
for more information.
.It Va ssl-crl-file
\*(OP Specifies a file that contains a CRL in PEM format to use when
verifying SSL/TLS server certificates.
.It Va ssl-crl-dir
\*(OP Specifies a directory that contains files with CRLs in PEM format
to use when verifying SSL/TLS server certificates.
.It Va ssl-key
\*(OP Sets the file name for the private key of a SSL/TLS client
certificate.
If unset, the name of the certificate file is used.
The file is expected to be in PEM format.
.It Va ssl-key-user@host
Sets an account-specific file name for the private key of a SSL/TLS
client certificate.
Overrides
.Va ssl-key
for the specified account.
.It Va ssl-method
\*(OP Selects the used TLS/SSL protocol version.
The actually available protocol versions depend on the TLS/SSL
library that \*(UA uses; possible values are, from newest to oldest:
`tls1.2', `tls1.1', `tls1', `ssl3' and `ssl2'.
.Pp
Setting
.Va ssl-method
to any of these values will fixate the used protocol, which means that
connections will fail if the server doesn't support it.
The value `auto', which is the default, chooses a compatibility method
that automatically uses the newest protocol version that the server
is capable to understand.
.Pp
It has to be noted that `auto' is used as a fallback method if
the actual setting of
.Va ssl-method
isn't supported by the used TLS/SSL library \(em in this case an error
message will be printed first, however.
.It Va ssl-method-user@host
Overrides
.Va ssl-method
for a specific account.
.It Va ssl-rand-egd
\*(OP Gives the pathname to an entropy daemon socket, see
.Xr RAND_egd 3 .
.It Va ssl-rand-file
\*(OP Gives the pathname to a file with entropy data, see
.Xr RAND_load_file 3 .
If the file is a regular file writable by the invoking user,
new data is written to it after it has been loaded.
.It Va ssl-verify
\*(OP Sets the action to be performed if an error occurs during SSL/TLS
server certificate validation.
Valid values are
`strict' (fail and close connection immediately),
`ask' (ask whether to continue on standard input),
`warn' (print a warning and continue),
`ignore' (do not perform validation).
The default is `ask'.
.It Va ssl-verify-user@host
Overrides
.Va ssl-verify
for a specific account.
.It Va stealthmua
If only set without an assigned value, then this option inhibits the
generation of the `Message-Id:' and `User-Agent:' header fields that
include obvious references to \*(UA.
There are two pitfalls associated with this:
First, the message id of outgoing messages is not known anymore.
Second, an expert may still use the remaining information in the header
to track down the originating mail user agent.
If set to the value `noagent', then the mentioned `Message-Id:'
suppression doesn't occur.
.It Va toplines
If defined, gives the number of lines of a message to be printed out
with the top command;
normally, the first five lines are printed.
.It Va ttycharset
The character set of the terminal \*(UA operates on,
and the one and only supported character set that \*(UA can use if no
character set conversion capabilities have been compiled into it,
in which case it defaults to `ISO-8859-1' unless it can deduce a value
from the `LC_CTYPE' locale environment.
Refer to the section
.Sx "Character sets"
for the complete picture about character sets.
.It Va VISUAL
Pathname of the text editor to use in the
.Ic visual
command and `~v' tilde escape.
.El
.\"
.\" --  >8  --  8<  --
.\"
.Sh ENVIRONMENT
Besides the variables described above,
\*(UA uses the following environment variables:
.Bl -tag -width ".It Va MAILRC"
.It Va COLUMNS
The user's preferred width in column positions for the terminal screen
or window (only used during startup).
.It Va HOME
The user's home directory.
.It Va LANG , Va LC_ALL , Va LC_COLLATE , Va LC_CTYPE , Va LC_MESSAGES
See
.Xr locale 7 .
.It Va LESS
\*(OP When a pager is started, this variable is set to the string
`FRXi' unless it already exists in the environment, in which case it is
left alone.
.It Va LINES
The user's preferred number of lines on a page or the vertical screen or
window size in lines (only used during startup).
.It Va MAILRC
Is used as a startup file instead of \*(ur if set.
When \*(UA scripts are invoked on behalf of other users,
this variable should be set to
.Pa /dev/null
to avoid side-effects from reading their configuration files.
.It Va NAILRC
If this variable is set and
.Va MAILRC
is not, it is treated as a startup configuration file and read.
.It Va NAIL_NO_SYSTEM_RC
If this variable is set then reading of \*(UR at startup is inhibited,
i.e., the same effect is achieved as if \*(UA had been started up with
the option
.Fl n .
.It Va SYSV3
Changes the letters printed in the first column of a header summary.
.It Va TERM
\*(OP The terminal type for which output is to be prepared.
.It Va TMPDIR
Used as directory for temporary files instead of
.Pa /tmp ,
if set.
.It Va USER
Can be used to force identification as
.Va USER ,
i.e., identical to the
.Fl u
command line option.
.El
.\"
.\" --  >8  --  8<  --
.\"
.Sh FILES
.Bl -tag -width ".It Pa /etc/mime.types"
.It Pa \*(ur
File giving initial commands.
.It Pa \*(UR
System wide initialization file.
.It Pa ~/.mime.types
Personal MIME types.
.It Pa /etc/mime.types
System wide MIME types.
.El
.\"
.\" --  >8  --  8<  --
.\"
.Sh EXAMPLES
.\"
.\" --  >8  --  8<  --
.Ss "Getting started"
The \*(UA command has two distinct usages, according to whether one
wants to send or receive mail.
Sending mail is simple: to send a message to a user whose email address
is, say, `<bill@host.example>', use the shell command:
.Pp
.Dl $ \*(ua bill@host.example
.Pp
then type your message.
\*(UA will prompt you for a message `Subject:' first;
after that, lines typed by you form the body of the message.
When you reach the end of the message,
type an EOT (`control\-D') at the beginning of a line,
which will cause \*(UA to echo `EOT' and return you to the shell.
.Pp
If, while you are composing the message you decide that you do not wish
to send it after all, you can abort the letter by typing two `RUBOUT'
(interrupt) characters.
Typing a single `RUBOUT' causes \*(UA to print
.Ns ` Ns Li (Interrupt -- one more to kill letter) Ns '.
Typing a second `RUBOUT' causes \*(UA to save your partial letter on the
file
.Va DEAD
and abort the letter.
Once you have sent mail to someone, there is no way to undo the act, so
be careful.
.Pp
If you want to send the same message to several other people,
you can list their email addresses on the command line.
.Bd -literal -offset indent
$ \*(ua sam@workstation.example bob@server.example
Subject: Fees
Tuition fees are due next Friday.  Don't forget!
<control\-D>
EOT
$
.Ed
.Pp
will sendout to `<sam@workstation.example>' and `<bob@server.example>'.
To read your mail, simply type
.Pp
.Dl $ \*(ua
.Pp
\*(UA will respond by typing its version number and date and then
listing the messages you have waiting.
Then it will type a prompt and await your command.
The messages are assigned numbers starting with 1 \(en you refer to the
messages with these numbers.
\*(UA keeps track of which messages are `new' (have been sent since you
last read your mail) and `read' (have been read by you).
New messages have an `N' next to them in the header listing and old,
but unread messages have a `U' next to them.
\*(UA keeps track of new/old and read/unread messages by putting a
header field called `Status' into your messages.
.Pp
To look at a specific message, use the
.Ic type
command, which may be abbreviated to simply `t'.
For example, if you had the following messages:
.Bd -literal -offset indent
O 1 drfoo@myhost.example Wed Sep  1 19:52   5/421 "Fees"
O 2 sam@friends.example  Thu Sep  2 00:08  30/895
.Ed
.Pp
you could examine the first message by giving the command:
.Pp
.Dl type 1
.Pp
which might cause \*(UA to respond with, for example:
.Bd -literal -offset indent
[-- Message  1 -- 5 lines, 421 bytes --]:
From drfoo@myhost.example Wed Sep  1 19:52:25 2004
Subject: Fees
Status: R

Tuition fees are due next Wednesday.  Don't forget!
.Ed
.Pp
Many \*(UA commands that operate on messages take a message number as an
argument, just as the shown
.Ic type
command.
For these commands, there is a notion of a current message.
When you enter the \*(UA program,
the current message is initially the first (or the first recent) one.
Thus, you can often omit the message number and use, for example, `t` to
type the current message.
As a further shorthand, you can type a message by simply giving its
message number \(en hence `1` would type the first message.
.Pp
Frequently, it is useful to read the messages in your mailbox in order,
one after another.
You can read the next message in \*(UA by simply typing a newline.
As a special case, you can type a newline as your first command to
\*(UA to type the first message.
.Pp
If, after typing a message, you wish to immediately send a reply,
you can do so with the command
.Ic reply .
This command, like
.Ic type ,
takes a message number as an argument.
\*(UA then begins a message addressed to the user who sent you the
message and let you type in your letter in reply, followed by
a `<control-D>' at the beginning of a line, as before.
.Pp
Note that \*(UA copies the subject header from the original message.
This is useful in that correspondence about a particular matter will
tend to retain the same subject heading, making it easy to recognize.
If there are other header fields in the message, like `Cc:',
the information found will also be used.
.Pp
Sometimes you will receive a message that has been sent to several
people and wish to reply only to the person who sent it.
.Ic Reply
(with a capital `R') replies to a message, but sends a copy to the
sender only.
.Pp
If you wish, while reading your mail, to send a message to someone,
but not as a reply to one of your messages, you can send the message
directly with the
.Ic mail
command, which takes as arguments the names of the recipients you wish
to send to.
For example, to send a message to `<frank@machine.example>':
.Pp
.Dl mail frank@machine.example
.Pp
To delete a message from the mail folder, you can use the command
.Ic delete .
In addition to not saving deleted messages,
\*(UA will not let you type them, either.
The effect is to make the message disappear altogether, along with its
number.
.Pp
Many features of \*(UA can be tailored to your liking with the
.Ic set
command; it has two forms, depending on whether you are setting
a `binary' or a `valued' option.
Binary options are either on or off \(en for example, the
.Va askcc
option informs \*(UA that each time you send a message, you want it to
prompt you for a `Cc:' header to be included in the message.
To set the
.Va askcc
option, you would type
.Pp
.Dl set askcc
.Pp
Valued options are values which \*(UA uses to adapt to your tastes.
For example, the
.Va record
option tells \*(UA where to save messages sent by you,
and is specified by, e.g.,
.Pp
.Dl set record=Sent
.Pp
Note that no spaces are allowed in `set record=Sent'.
.Pp
\*(UA includes a simple facility for maintaining groups of messages
together in folders.
To use the folder facility, you must tell \*(UA where you wish to keep
your folders.
Each folder of messages will be a single file.
For convenience, all of your folders are kept in a single directory of
your choosing.
To tell \*(UA where your folder directory is, put a line of the form
.Pp
.Dl set folder=letters
.Pp
in your \*(ur file.
If, as in the example above, your folder directory does not begin with
a `/', \*(UA will assume that your folder directory is to be found
starting from your home directory.
.Pp
Anywhere a file name is expected, you can use a folder name, preceded
with `+'.
For example, to put a message into a folder with the
.Ic save
command, you can use:
.Pp
.Dl save +classwork
.Pp
to save the current message in the `classwork' folder.
If the `classwork' folder does not yet exist, it will be created.
Note that messages which are saved with the
.Ic save
command are automatically removed from your system mailbox.
.Pp
In order to make a copy of a message in a folder without causing
that message to be removed from your system mailbox, use the
.Ic copy
command, which is identical in all other respects to the
.Ic save
command.
.Pp
The
.Ic folder
command
can be used to direct \*(UA to the contents of a different folder.
For example,
.Pp
.Dl folder +classwork
.Pp
directs \*(UA to read the contents of the `classwork' folder.
All of the commands that you can use on your system mailbox are also
applicable to folders, including
.Ic type ,
.Ic delete ,
and
.Ic reply .
To inquire which folder you are currently editing, use `folder' without
arguments.
And to list your current set of folders, use the
.Ic folders
command.
.Pp
Finally, the
.Ic help
command is available to print out a brief summary of the most important
\*(UA commands.
.Pp
While typing in a message to be sent to others it is often useful to be
able to invoke the text editor on the partial message, print the
message, execute a shell command, or do some other auxiliary function.
\*(UA provides these capabilities through `tilde escapes',
which consist of a tilde (`~') at the beginning of a line, followed by
a single character which indicates the function to be performed.
For example, to print the text of the message so far, use:
.Pp
.Dl ~p
.Pp
which will print a line of dashes, the recipients of your message, and
the text of the message so far.
A list of the most important tilde escapes is available with `~?'.
.\"
.\" --  >8  --  8<  --
.Ss "IMAP or POP3 client setup"
\*(OP First you need the following data from your ISP:
the host name of the IMAP or POP3 server,
user name and password for this server,
and a notice whether the server uses SSL/TLS encryption.
Assuming the SSL/TLS secured host name of your IMAP account is
`server.myisp.example' and your user name for that server is `mylogin',
you could refer to this account using the
.Ic folder
command or the
.Fl f
command line option with
.Pp
.Dl imaps://mylogin@server.myisp.example
.Pp
(This string is not necessarily the same as your Internet mail address.)
Even if the server does not accept IMAPS or POP3S connections,
it is possible that it supports the `STARTTLS' method of upgrading
already connected, but not yet authenticated sessions to use SSL/TLS
encryption.
The only reliable method to see if this works is to try it; enter one of
.Pp
.Dl set imap-use-starttls
.Dl set pop3-use-starttls
.Pp
before you initiate the connection, dependent on the actual protocol.
.Pp
As you probably want messages to be deleted from this account
after saving them, prefix it with `%:'.
The
.Ic shortcut
command can be used to avoid typing that many characters every time you
want to connect:
.Pp
.Dl shortcut myisp %:imaps://mylogin@server.myisp.example
.Pp
You might want to put this string into a startup file.
.Ic shortcut
is one of those commands that are specific to \*(UA and will thus
confuse other implementations of POSIX
.Xr mailx 1 ,
so it should possibly not be placed in \*(ur.
Instead, put
.Pp
.Dl set NAIL_EXTRA_RC=.\*(uarc
.Pp
in \*(ur and create a file
.Pa ~/.\*(uarc
containing all the commands that are specific to \*(UA.
You can then access your remote mailbox by invoking
.Pp
.Dl \*(ua \-f myisp
.Pp
on the command line, or by executing
.Pp
.Dl fi myisp
.Pp
within \*(UA.
If you want to use more than one IMAP mailbox on a server,
or if you want to use the IMAP server for mail storage too, the
.Ic account
command (which is also \*(UA-specific) is possibly more appropriate.
You can put the following in
.Pa ~/.\*(uarc :
.Bd -literal -offset indent
account myisp {
   set folder=imaps://mylogin@server.myisp.example
   set record=+Sent MBOX=+mbox outfolder
}
.Ed
.Pp
and can then access incoming mail for this account by invoking
`\*(ua \-A myisp' on the command line or by executing `ac myisp' within
\*(UA.
After that, a command like `copy 1 +otherfolder' will refer to
`otherfolder' on the IMAP server.
In particular, `fi &' will change to the `mbox' folder,
and `fi +Sent' will show your recorded sent mail,
with both folders located on the IMAP server.
.Pp
\*(UA will ask you for a password string each time you connect to
a remote account.
If you can reasonably trust the security of your workstation,
you can give this password in the startup file as
.Pp
.Dl set password-mylogin@server.myisp.example="SECRET"
.Pp
You should change the permissions of this file to 0600, see
.Xr chmod 1 .
.Pp
\*(UA supports different authentication methods for both IMAP and POP3.
If Kerberos is used at your location,
you can try to activate (the optional) GSSAPI-based authentication via
.Pp
.Dl set imap-auth=gssapi
.Pp
The advantage of this method is that \*(UA doesn't need to know your
password at all, nor does it have to send sensitive data over the network.
If that isn't possible, try to use authentication methods that at least
avoid sending the password in clear over the wire, which is especially
important if SSL/TLS cannot be used, e.g.,
.Pp
.Dl set imap-auth=cram-md5
.Pp
For POP3 \*(UA will try to use the `APOP' mechanism automatically unless
explicitly disabled.
If the server does not offer any such authentication methods,
conventional user/password based authentication must be used.
It is sometimes helpful, especially when setting up an account or when
there are authentification problems, to enable verbosity by setting the
.Va verbose
option \(en \*(UA will display all data sent to the server in clear text
on the screen when this option is set.
(Because this may also include passwords you should take care that no
unauthorized person can look at your terminal when this option is set.)
.Pp
If you regularly use the same workstation to access IMAP accounts,
you can greatly enhance performance by enabling local caching of IMAP
messages.
For any message that has been fully or partially fetched from the server,
a local copy is made and is used when the message is accessed again,
so most data is transferred over the network once only.
To enable the IMAP cache, select a local directory name and put
.Pp
.Dl set imap-cache=~/localdirectory
.Pp
in the (\*(UA-specific) startup file.
All files within that directory can be overwritten or deleted by \*(UA
at any time,
so you should not use the directory to store other information.
.Pp
Once the cache contains some messages,
it is not strictly necessary anymore to open a connection to the IMAP
server to access them.
When \*(UA is invoked with the option
.Fl D ,
or when the
.Va disconnected
variable is set,
only cached data is used for any folder you open.
Messages that have not yet been completely cached are not available
then, but all other messages can be handled as usual.
Changes made to IMAP mailboxes in
.Va disconnected
mode are committed to the IMAP server next time it is used in
.Va online
mode.
Synchronizing the local status with the status on the server is thus
partially within your responsibility;
if you forget to initiate a connection to the server again before you
leave your location,
changes made on one workstation are not available on others.
Also if you alter IMAP mailboxes from a workstation while uncommitted
changes are still pending on another,
the latter data may become invalid.
The same might also happen because of internal server status changes.
You should thus carefully evaluate this feature in your environment
before you rely on it.
.Pp
Many servers will close the connection after a short period of
inactivity \(en use one of
.Pp
.Dl set pop3-keepalive=30
.Dl set imap-keepalive=240
.Pp
to send a keepalive message each 30 seconds for POP3,
or each 4 minutes for IMAP.
.Pp
If you encounter problems connecting to a SSL/TLS server,
try the
.Va ssl-rand-egd
and
.Va ssl-rand-file
variables (see the OpenSSL FAQ for more information) or specify the
protocol version with
.Va ssl-method .
Contact your ISP if you need a client certificate or if verification of
the server certificate fails.
If the failed certificate is indeed valid,
fetch its CA certificate by executing the shell command
.Pp
.Dl $ </dev/null openssl s_client \-showcerts \-connect \e
.Dl \ \ \ \ \ \ server.myisp.example:imaps 2>&1 | tee log.txt
.Pp
(see
.Xr s_client 1 Ns
) and put it into the file specified with
.Va ssl-ca-file .
The data you need is located at the end of the certificate chain
within (and including) the `BEGIN CERTIFICATE'
and `END CERTIFICATE' lines.
Note that the example above is \fBinsecure\fR!
One should use the `-verify' and `-CAfile' options of
.Xr s_client 1
to be "on the safe side" regarding the fetched certificates.
.\"
.\" --  >8  --  8<  --
.Ss "Reading HTML mail"
You need either the
.Xr elinks 1
or
.Xr lynx 1
utility or another command-line web browser that can write plain text to
standard output.
.Pp
.Dl set pipe-text/html="elinks -force-html -dump 1"
.Dl set pipe-text/html="lynx -stdin -dump -force_html"
.Pp
will cause HTML message parts to be converted into a more friendly form.
.\"
.\" --  >8  --  8<  --
.Ss "Viewing PDF attachments"
Most PDF viewers do not accept input directly from a pipe.
It is thus necessary to store the attachment in a temporary file first:
.Pp
.Dl set pipe-application/pdf="@&cat >/tmp/\*(ua$$.pdf; \e
.Dl \ \ \ \ \ \ acroread /tmp/\*(ua$$.pdf; rm /tmp/\*(ua$$.pdf"
.Pp
Note that security defects are discovered in PDF viewers from time to
time.
Automatical command execution like this can compromise your system
security,
in particular if you stay not always informed about such issues.
.\"
.\" --  >8  --  8<  --
.Ss "Signed and encrypted messages with S/MIME"
\*(OP S/MIME provides two central mechanisms:
message signing and message encryption.
A signed message contains some data in addition to the regular text.
The data can be used to verify that the message was sent using a valid
certificate, that the sender's address in the message header matches
that in the certificate, and that the message text has not been altered.
Signing a message does not change its regular text;
it can be read regardless of whether the recipient's software is able to
handle S/MIME.
It is thus usually possible to sign all outgoing messages if so desired.
Encryption, in contrast, makes the message text invisible for all people
except those who have access to the secret decryption key.
To encrypt a message, the specific recipient's public encryption key
must be known.
It is thus not possible to send encrypted mail to people unless their
key has been retrieved from either previous communication or public key
directories.
A message should always be signed before it is encrypted.
Otherwise, it is still possible that the encrypted message text is
altered.
.Pp
A central concept to S/MIME is that of the certification authority (CA).
A CA is a trusted institution that issues certificates.
For each of these certificates it can be verified that it really
originates from the CA, provided that the CA's own certificate is
previously known.
A set of CA certificates is usually delivered with OpenSSL and installed
on your system.
If you trust the source of your OpenSSL software installation,
this offers reasonable security for S/MIME on the Internet.
In general, a certificate cannot be more secure than the method its CA
certificate has been retrieved with, though.
Thus if you download a CA certificate from the Internet,
you can only trust the messages you verify using that certificate as
much as you trust the download process.
.Pp
The first thing you need for participating in S/MIME message exchange is
your personal certificate, including a private key.
The certificate contains public information, in particular your name and
your email address, and the public key that is used by others to encrypt
messages for you,
and to verify signed messages they supposedly received from you.
The certificate is included in each signed message you send.
The private key must be kept secret.
It is used to decrypt messages that were previously encrypted with your
public key, and to sign messages.
.Pp
For personal use it is recommended that you get a S/MIME certificate
from one of the major CAs on the Internet using your WWW browser.
(Many CAs offer such certificates for free.)
You will usually receive a combined certificate and private key in
PKCS#12 format which \*(UA does not directly accept.
To convert it to PEM format, use the following shell command:
.Pp
.Dl $ openssl pkcs12 \-in cert.p12 \-out cert.pem \-clcerts \-nodes
.Pp
If you omit the `\-nodes' parameter, you can specifiy an additional `PEM
pass phrase' for protecting the private key.
\*(UA will then ask you for that pass phrase each time it signs or
decrypts a message.
You can then use
.Pp
.Dl set smime-sign-cert-myname@myisp.example=cert.pem
.Pp
to make this private key and certificate known to \*(UA.
You can now sign outgoing messages.
Just use
.Pp
.Dl set smime-sign
.Pp
to do so.
From each signed message you send,
the recipient can fetch your certificate and use it to send encrypted
mail back to you.
Accordingly if somebody sends you a signed message, you can do the same.
First use the
.Ic verify
command to check the validity of the certificate.
After that, retrieve the certificate and tell \*(UA that it should use
it for encryption:
.Pp
.Dl certsave filename
.Dl set smime-encrypt-user@host=filename
.Pp
You should carefully consider if you prefer to store encrypted messages
in decrypted form.
If you do, anybody who has access to your mail folders can read them,
but if you do not, you might be unable to read them yourself later if
you happen to lose your private key.
The
.Ic decrypt
command saves messages in decrypted form, while the
.Ic save ,
.Ic copy ,
and
.Ic move
commands leave them encrypted.
.Pp
Note that neither S/MIME signing nor encryption applies to message
subjects or other header fields.
Thus they may not contain sensitive information for encrypted messages,
and cannot be trusted even if the message content has been verified.
When sending signed messages,
it is recommended to repeat any important header information in the
message text.
.\"
.\" --  >8  --  8<  --
.Ss "Using CRLs with S/MIME or SSL/TLS"
\*(OP Certification authorities (CAs) issue certificate revocation
lists (CRLs) on a regular basis.
These lists contain the serial numbers of certificates that have been
declared invalid after they have been issued.
Such usually happens because the private key for the certificate has
been compromised,
because the owner of the certificate has left the organization that is
mentioned in the certificate, etc.
To seriously use S/MIME or SSL/TLS verification,
an up-to-date CRL is required for each trusted CA.
There is otherwise no method to distinguish between valid and
invalidated certificates.
\*(UA currently offers no mechanism to fetch CRLs, nor to access them on
the Internet, so you have to retrieve them by some external mechanism.
.Pp
\*(UA accepts CRLs in PEM format only;
CRLs in DER format must be converted, like, e.\|g.:
.Pp
.Dl $ openssl crl \-inform DER \-in crl.der \-out crl.pem
.Pp
To tell \*(UA about the CRLs, a directory that contains all CRL files
(and no other files) must be created.
The
.Va smime-crl-dir
or
.Va ssl-crl-dir
variables, respectively, must then be set to point to that directory.
After that, \*(UA requires a CRL to be present for each CA that is used
to verify a certificate.
.\"
.\" --  >8  --  8<  --
.Ss "Handling spam"
\*(OP \*(UA can make use of spam detection and learning facilities \(en
more precisely, SpamAssassin (\%<http://spamassassin.apache.org>).
A very comprehensive documentation of
.Xr spamassassin 1
can be found at the O'Reilly Commons
(\%<http://commons.oreilly.com/wiki/index.php/SpamAssassin>).
.Pp
Currently \*(UA supports interaction with
.Xr spamassassin 1
only via its daemonized
.Xr spamd 1 /
.Xr spamc 1
server / client pair, which means that, in order to detect and work
with spam through \*(UA, an instance of the
.Xr spamd 1
daemon must be running (the examples are equivalent):
.Bd -literal -offset indent
$ spamd -i localhost:2142 -i /tmp/.spamsock -d [-L] [-l]
$ spamd --listen=localhost:2142 --listen=/tmp/.spamsock \\
    --daemonize [--local] [--allow-tell]
.Ed
.Pp
Note that if
.Xr spamd 1
should only listen on a local, path-based UNIX domain socket instead of
offering its service over the network, it maybe necessary to use
a single
.Li --socketpath
option instead of the shown
.Li --listen .
In order to support training of the Bayesian classifier through \*(UA,
.Xr spamd 1
must have been started with the
.Li --allow-tell
option.
.Pp
Once
.Xr spamd 1
is running \*(UA can classify messages by using the client side program,
.Xr spamc 1 ,
as in:
.Bd -literal -offset indent
$ \*(ua -Sspam-command=/usr/local/bin/spamc \\
    -Sspam-socket=/tmp/.spamsock -Sspam-maxsize=500000
.Ed
.Pp
The commands offered are
.Ic spamclear
and
.Ic spamset ,
which simply set an `is-spam' flag that can be used for, e.g., message
selection,
.Ic spamrate ,
which passes messages through to the spam detector in order to gain
a spam score and conditionally set the `is-spam' flag accordingly,
as well as the Bayesian filter related
.Ic spamforget ,
.Ic spamham
and
.Ic spamspam .
.Pp
Because messages must exist on local storage in order to be scored (or
used for Bayesian filter training), it is possibly a good idea to
perform the local spam check last:
.Bd -literal -offset indent
define spamdelhook {
        # Server side DCC
        spamset (header x-dcc-brand-metrics "bulk")
        # Server-side spamassassin(1)
        spamset (header x-spam-flag "YES")
        del :s # TODO we HAVE to be able to do `spamrate :u ! :s'
        # And finally the local spamc(1)
        spamrate :u
        del :s
}
set folder-hook-FOLDER=spamdelhook
.Ed
.Pp
See also the documentation for the variables
.Va spam-command ,
.Va spam-host ,
.Va spam-port ,
.Va spam-socket ,
.Va spam-user
and
.Va spam-maxsize .
.\"
.\" --  >8  --  8<  --
.Ss "Sending mail from scripts"
If you want to send mail from scripts, you must be aware that \*(UA
reads the user's configuration files by default.
So unless your script is only intended for your own personal use
(as, e.g., a cron job), you need to circumvent this:
.Pp
.Dl MAILRC=/dev/null \*(ua \-n
.Pp
You then need to create a script-local configuration for \*(UA.
This can be done by either pointing the
.Va MAILRC
variable to a custom configuration file,
by passing the configuration in environment variables,
or by using the
.Fl S
command line option to specify options.
Since many configuration options are not valid shell variables, the
.Xr env 1
command is useful if the approach via environment variables is used:
.Bd -literal -offset indent
env MAILRC=/dev/null from=scriptreply@domain smtp=host \e
    smtp-auth-user=login smtp-auth-password=secret \e
    smtp-auth=login \*(ua \-n \-s "subject" \e
    \-a attachment_file recipient@domain < content_file
.Ed
.\"
.\" --  >8  --  8<  --
.\"
.Sh "SEE ALSO"
.Xr bzip2 1 ,
.Xr file 1 ,
.Xr fmt 1 ,
.Xr gzip 1 ,
.Xr less 1 ,
.Xr more 1 ,
.Xr newaliases 1 ,
.Xr openssl 1 ,
.Xr printf 1 ,
.Xr sendmail 1 ,
.Xr sh 1,
.Xr spamassassin 1 ,
.Xr spamc 1 ,
.Xr spamd 1 ,
.Xr vacation 1 ,
.Xr xz 1 ,
.Xr editline 3 ,
.Xr iconv 3 ,
.Xr readline 3 ,
.Xr setlocale 3 ,
.Xr ssl 3 ,
.Xr aliases 5 ,
.Xr locale 7 ,
.Xr mailaddr 7 ,
.Xr re_format 7 ,
.Xr mailwrapper 8
.\"
.\" --  >8  --  8<  --
.\"
.Sh "IMPLEMENTATION NOTES"
The character set conversion uses and relies upon the
.Xr iconv 3
function.
Its functionality differs widely between the various system environments
\*(UA runs on.
.Pp
Limitations with IMAP mailboxes are:
It is not possible to edit messages, but it is possible to append them.
Thus to edit a message, create a local copy of it, edit it, append it,
and delete the original.
The line count for the header display is only appropriate if the entire
message has been downloaded from the server.
The marking of messages as `new' is performed by the IMAP server;
use of the
.Ic exit
command instead of
.Ic quit
will not cause it to be reset, and if the
.Va newmail
variable is unset, messages that arrived during a session will not be
in state `new' anymore when the folder is opened again.
Also if commands queued in disconnected mode are committed,
the IMAP server will delete the `new' flag for all messages in the
changed folder,
and new messages will appear as unread when it is selected for viewing
later.
The `flagged', `answered', and `draft' attributes are usually permanent,
but some IMAP servers are known to drop them without notification.
Message numbers may change with IMAP every time before the prompt is
printed if \*(UA is notified by the server that messages have been
deleted by some other client or process.
In this case, `Expunged n messages' is printed, and message numbers may
have changed.
.Pp
Limitations with POP3 mailboxes are:
It is not possible to edit messages, they can only be copied and deleted.
The line count for the header display is only appropriate if the entire
message has been downloaded from the server.
The status field of a message is maintained by the server between
connections; some servers do not update it at all, and with a server
that does, the `exit' command will not cause the message status to be
reset.
The `newmail' command and the `newmail' variable have no effect.
It is not possible to rename or to remove POP3 mailboxes.
.Pp
If a `RUBOUT' (interrupt) is typed while an IMAP or POP3 operation is in
progress, \*(UA will wait until the operation can be safely aborted, and
will then return to the command loop and print the prompt again.
When a second `RUBOUT' is typed while \*(UA is waiting for the operation
to complete, the operation itself will be cancelled.
In this case, data that has not been fetched yet will have to be fetched
before the next command can be performed.
If the cancelled operation was using an SSL/TLS encrypted channel,
an error in the SSL transport will very likely result and render the
connection unusable.
.Pp
As \*(UA is a mail user agent, it provides only basic SMTP services.
If it fails to contact its upstream SMTP server, it will not make
further attempts to transfer the message at a later time,
and it does not leave other information about this condition than an
error message on the terminal and an entry in
.Va DEAD .
This is usually not a problem if the SMTP server is located in the same
local network as the computer on which \*(UA is run.
However, care should be taken when using a remote server of an ISP;
it might be better to set up a local SMTP server then which just acts as
a proxy.
.Pp
\*(UA immediately contacts the SMTP server (or
.Xr sendmail 1 Ns
) even when operating in
.Va disconnected
mode.
It would not make much sense for \*(UA to defer outgoing mail since SMTP
servers usually provide much more elaborated delay handling than \*(UA
could perform as a client.
Thus the recommended setup for sending mail in
.Va disconnected
mode is to configure a local SMTP server such that it sends outgoing
mail as soon as an external network connection is available again,
i.e., to advise it to do that from a network startup script.
.\"
.\" --  >8  --  8<  --
.\"
.Sh HISTORY
A \fImail\fR command appeared in Version 1 AT&T Unix.
Berkeley Mail was written in 1978 by Kurt Shoens.
This man page is derived from from The Mail Reference Manual originally
written by Kurt Shoens.
"Heirloom Mailx" enhancements are maintained and documented by Gunnar
Ritter.
"S-nail" is maintained and documented by Steffen (Daode) Nurpmeso.
.Pp
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
\(en Operating System Interface (POSIX), The Open Group Base
Specifications Issue 6, Copyright \(co 2001-2003 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
In the event of any discrepancy between this version and the original
IEEE and The Open Group Standard, the original IEEE and The Open Group
Standard is the referee document.
The original Standard can be obtained online at
\%<http://www.opengroup.org/unix/online.html>.
Redistribution of this material is permitted so long as this notice
remains intact.
.\"
.\" --  >8  --  8<  --
.\"
.Sh AUTHORS
.An "Kurt Shoens" ,
.An "Christos Zoulas" ,
.An "Gunnar Ritter" ,
.An Steffen Po Daode Pc Nurpmeso Aq s-nail-users@lists.sourceforge.net
.\"
.\" --  >8  --  8<  --
.\"
.Sh BUGS
Variables in the environment passed to \*(UA cannot be unset.
The codebase in inherently broken in respect to non-local code jumps
and loss of opened mail folders; expect this to remain until the v16
series has passed.
Thank you.