1 .\"@ nail.1 - S-nail(1) reference manual.
3 .\" Copyright (c) 2000-2008 Gunnar Ritter, Freiburg i. Br., Germany.
4 .\" Copyright (c) 2012 - 2015 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
6 .\" Copyright (c) 1980, 1990, 1993
7 .\" The Regents of the University of California. All rights reserved.
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\" notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\" notice, this list of conditions and the following disclaimer in the
16 .\" documentation and/or other materials provided with the distribution.
17 .\" 3. Neither the name of the University nor the names of its contributors
18 .\" may be used to endorse or promote products derived from this software
19 .\" without specific prior written permission.
21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 .\" S-nail(1): v14.8.10 / 2016-08-20
46 .\" If not ~/.mailrc, it breaks POSIX compatibility. And adjust main.c.
51 .ds OU [no v15-compat]
52 .ds ID [v15 behaviour may differ]
53 .ds NQ [Only new quoting rules]
64 .Nd send and receive Internet mail
70 .\" Keep in SYNC: ./nail.1:"SYNOPSIS, main()
78 .Op Fl a Ar attachment
81 .Op Fl M Ar type | Fl m Ar file | Fl q Ar file | Fl t
83 .Op Fl S Ar var Ns Op Ns = Ns Ar value
88 .Op Fl Fl \~ Ns Ar mta-option ...
97 .Op Fl S Ar var Ns Op Ns = Ns Ar value
100 .Op Fl Fl \~ Ns Ar mta-option ...
108 .Op Fl L Ar spec-list
109 .Op Fl r Ar from-addr
110 .Op Fl S Ar var Ns Op Ns = Ns Ar value
113 .Op Fl Fl \~ Ns Ar mta-option ...
118 .Mx -toc -tree html pdf ps xhtml
121 .\" .Sh DESCRIPTION {{{
124 .Bd -filled -compact -offset indent
125 .Sy Compatibility note:
126 S-nail (\*(UA) will wrap up into \%S-mailx in v15.0 (circa 2018).
127 Backward incompatibility has to be expected \(en
131 -style argument quoting rules, for example.
132 New and old behaviour is flagged \*(IN and \*(OU, and setting
135 .Sx "INTERNAL VARIABLES" ,
136 will choose new behaviour when applicable.
137 \*(OB flags what will vanish, and enabling
141 enables obsoletion warnings.
145 \*(UA is a mail processing system with a command syntax reminiscent of
147 with lines replaced by messages.
148 It is intended to provide the functionality of the POSIX
150 command, but is MIME capable and optionally offers extensions for
151 line editing, S/MIME, SMTP and POP3 among others.
152 It is usable as a mail batch language.
154 .\" .Ss "Options" {{{
157 .Bl -tag -width ".Fl _ Ar _ddr"
160 Explicitly control which of the
162 shall be loaded: if the letter
164 is (case-insensitively) part of the
168 is loaded, likewise the letter
170 controls loading of the user's personal
172 file, whereas the letters
176 explicitly forbid loading of any resource files.
177 This option should be used by scripts: to avoid environmental noise they
180 from any configuration files and create a script-local environment,
181 explicitly setting any of the desired
182 .Sx "INTERNAL VARIABLES"
185 This option overrides
192 command for the given user email
194 after program startup is complete.
195 Being a special incarnation of
197 macros for the purpose of bundling longer-lived settings, activating
198 such an email account also switches to the accounts
204 Attach the given file to the message.
205 The same filename conventions as described in the section
207 apply: shell word expansion is restricted to the tilde
211 not be accessible but contain a
213 character, then anything after the
215 is assumed to specify the input character set and anything before
217 the filename: this is the only option to specify the input character set
218 (and don't perform any character set conversion) for text attachments
219 from the command line, not using the
221 tilde escape command.
225 Make standard input and standard output line-buffered.
229 Send a blind carbon copy to
232 May be used multiple times, but it is also possible to give
233 a comma-separated list of receivers in a single argument, proper quoting
235 .Ql -b """qrec1 , rec2,rec3, Ex <am@ple>""" .
237 .Sx "On sending mail, and non-interactive mode" .
241 Send carbon copies to the given receiver(s).
242 May be used multiple times.
248 variable which enables debug messages and disables message delivery,
249 among others; effectively turns almost any operation into a dry-run.
255 variable and thus discard messages with an empty message part body.
256 This is useful for sending messages from scripts.
260 Just check if mail is present (in the specified or system
262 box): if yes, return an exit status of zero, a non-zero value otherwise.
263 To restrict the set of mails to consider in this evaluation a message
264 specification can be added with the option
269 Save the message to send in a file named after the local part of the
270 first recipient's address (instead of in
275 Read in the contents of the user's
277 (or the specified file) for processing;
278 when \*(UA is quit, it writes undeleted messages back to this file
282 Some special conventions are recognized for the optional
284 argument which are documented for the
289 is not a argument to the flag
291 but is instead taken from the command line after option processing has
295 that starts with a hyphen, prefix it with a (relative) path, as in
296 .Ql ./-hyphenbox.mbox .
300 Display a summary of the
302 of all messages in the specified or system
305 A configurable summary view is available via the
311 Show a short usage summary.
312 Because of widespread use a
314 argument will have the same effect.
320 variable to ignore tty interrupt signals.
323 .It Fl L Ar spec-list
324 Display a summary of all
326 of only those messages in the specified or system
328 box that match the given
332 .Sx "Specifying messages"
339 option has been given in addition no header summary is produced,
340 but \*(UA will instead indicate via its exit status whether
346 note that any verbose output is suppressed in this mode and must instead
347 be enabled explicitly (e.g., by using the option
352 Special send mode that will flag standard input with the MIME
356 and use it as the main message body.
357 \*(ID Using this option will bypass processing of
358 .Va message-inject-head ,
361 .Va message-inject-tail .
367 Special send mode that will MIME classify the specified
369 and use it as the main message body.
370 \*(ID Using this option will bypass processing of
371 .Va message-inject-head ,
374 .Va message-inject-tail .
382 variable and thus inhibit initial display of message headers when
383 reading mail or editing a mail folder.
387 Standard flag that inhibits reading the system wide
392 allows more control over the startup sequence; also see
393 .Sx "Resource files" .
397 Special send mode that will initialize the message body with the
398 contents of the specified
400 which may be standard input
402 only in non-interactive context.
408 Any folder opened will be in read-only mode.
411 .It Fl r Ar from-addr
414 is a valid address then it specifies the envelope sender address to be
415 passed to a file-based
417 (Mail-Transfer-Agent) as
419 when a message is send.
422 include a user name, then the address components will be separated and
423 the name part will be passed to file-based
429 will also be assigned to the
432 .Ql -Sfrom=from-addr ) ,
433 therefore affecting possible SMTP
435 data transfer; note this assignment does not cause value fixation.
437 If instead an empty string is passed as
439 then the content of the variable
441 will be evaluated and used for this purpose whenever the
444 Note that \*(UA by default, without
446 that is, neither passes
450 flags to a file-based MTA by itself.
453 .It Fl S Ar var Ns Op = Ns value
456 iable and, in case of a value variable, assigns
459 Even though variables (see
460 .Sx "INTERNAL VARIABLES" )
464 may be overwritten from within resource files,
465 the command line setting will be reestablished after all resource files
470 Specify the subject of the to-be-sent message.
474 The message given (on standard input) is expected to contain, separated
475 from the message body by an empty line, a message header with
480 fields giving its recipients, which will be added to any recipients
481 specified on the command line.
482 If a message subject is specified via
484 then it'll be used in favour of one given on the command line.
502 .Ql Mail-Followup-To: ,
503 by default created automatically dependent on message context, will
504 be used if specified (a special address massage will however still occur
506 Any other (even custom) header field is passed through entirely
507 unchanged, and in conjunction with the option
509 it is even possible to embed
516 Initially read the primary system mailbox of
518 appropriate privileges presumed; effectively identical to
523 Show \*(UA's version and exit.
529 variable enables display of some informational context messages.
530 Using it twice increases the level of verbosity.
536 to the list of commands to be executed before normal operation starts.
540 .Va batch-exit-on-error ;
541 the only possibility to execute commands in non-interactive mode when
542 reading startup files is actively prohibited.
548 even if not in interactive mode.
549 This can be used to, e.g., automatically format the composed message
550 text before sending the message:
551 .Bd -literal -offset indent
552 $ ( echo 'line one. Word. Word2.'; \e
553 echo '~| /usr/bin/fmt -tuw66' ) |\e
554 LC_ALL=C \*(uA -:/ -d~ bob@exam.ple
560 In batch mode the full set of commands is available, just like in
561 interactive mode, and diverse variable settings and internal states are
562 adjusted for batch necessities, e.g., it sets
575 is enabled in compose mode.
576 The following prepares an email message in a batched dry run:
577 .Bd -literal -offset indent
578 $ LC_ALL=C printf 'm bob\en~s ubject\enText\en~.\enx\en' | \e
579 LC_ALL=C \*(uA -:/ -d# -X'alias bob bob@exam.ple'
584 This flag forces termination of option processing in order to prevent
587 It also forcefully puts \*(UA into send mode, see
588 .Sx "On sending mail, and non-interactive mode" .
592 In the above list of supported command line options,
596 are implemented by means of setting the respective option, as via
599 .Op Ar mta-option ...
601 arguments that are given at the end of the command line after a
603 separator will be passed through to a file-based
605 (Mail-Transfer-Agent) and persist for an entire (interactive) session
606 \(en if the setting of
608 allows their recognition; no such constraints apply to the variable
612 .\" .Ss "A starter" {{{
615 \*(UA is a direct descendant of
617 Mail, a successor of the Research
620 .Dq was there from the start
625 Mail reference manual begins with the following words:
627 .Bd -ragged -offset indent
628 Mail provides a simple and friendly environment for sending and
630 It divides incoming mail into its constituent messages and allows the
631 user to deal with them in any order.
632 In addition, it provides a set of
634 -like commands for manipulating messages and sending mail.
635 Mail offers the user simple editing capabilities to ease the composition
636 of outgoing messages, as well as providing the ability to define and
637 send to names which address groups of users.
641 \*(UA is thus the user side of the
643 mail system, whereas the system side (Mail-Transfer-Agent, MTA) was
644 traditionally taken by
646 and most MTAs provide a binary of this name for compatibility purposes.
651 of \*(UA then the system side is not a mandatory precondition for mail
655 Because \*(UA strives for compliance with POSIX
657 it is likely that some configuration settings have to be adjusted before
658 using it is a smooth experience.
661 file already bends those standard imposed settings a bit towards more
662 user friendliness and safety, e.g., it sets the
666 variables in order to suppress the automatic moving of messages to
668 that would otherwise occur (see
669 .Sx "Message states" )
672 to not remove empty files in order not to mangle file permissions when
673 files eventually get recreated (\*(UA actively manages the file mode
676 upon program startup).
680 .Sx "INTERNAL VARIABLES" ,
681 isn't set by default so that file grouping (via the
683 prefix as documented for
685 is not functional by default.
688 contains some suggestions.
691 .\" .Ss "On sending mail, and non-interactive mode" {{{
692 .Ss "On sending mail, and non-interactive mode"
694 To send a message to one or more people, using a local or a builtin
696 (Mail-Transfer-Agent) transport to actually deliver the generated mail
697 message, \*(UA can be invoked with arguments which are the names of
698 people to whom the mail will be sent, and the command line options
702 can be used to add (blind) carbon copy receivers:
704 .Bd -literal -offset indent
705 $ \*(uA -s ubject -a ttach.txt bill@exam.ple
706 # But... try it in an isolated dry-run mode first
707 $ LC_ALL=C \*(uA -:/ -d -vv -Ssendwait \e
708 -b bcc@exam.ple -c cc@exam.ple -. \e
709 '(Lovely) Bob <bob@exam.ple>' eric@exam.ple
711 $ LC_ALL=C \*(uA -:/ -d -vv -Sv15-compat -Ssendwait \e
712 -S 'mta=smtps://mylogin@exam.ple:465' -Ssmtp-auth=login \e
713 -S 'from=scriptreply@exam.ple' \e
719 If standard input is a terminal rather than the message to be sent,
720 the user is expected to type in the message contents.
721 In this compose mode \*(UA treats lines beginning with the character
723 special \(en these are so-called
725 which can be used to read in files, process shell commands, add and edit
726 attachments and more; e.g., the tilde escape
728 will start the text editor to revise the message in it's current state,
730 allows editing of the most important message headers and
732 gives an overview of available tilde escapes.
736 at the beginning of an empty line leaves compose mode and causes the
737 message to be sent, whereas typing
740 twice will abort the current letter (saving its contents in the file
746 Messages are sent asynchronously, without supervision, unless the variable
748 is set, therefore send errors are not recognizable until then.
754 .Sx "INTERNAL VARIABLES"
755 can be used to alter default behavior; e.g.,
760 will automatically startup a text editor when compose mode is entered,
762 will cause the user to be prompted actively for carbon-copy recipients
765 option will allow leaving compose mode by writing a line consisting
771 hook macros may be set to automatically adjust some settings dependent
772 on receiver, sender or subject contexts.
775 Especially for using public mail provider accounts with the SMTP
777 it is often necessary to set
779 and saving a copy of sent messages in a
781 may be desirable \(en as for most mailbox file targets some special
782 syntax conventions are recognized (see the
784 command for more on that).
787 for the purpose of arranging a complete environment of settings that can
788 be switched to with a single command or command line option may be
791 contains example configurations for sending messages via some of the
792 well-known public mail providers and also gives a compact overview on
793 how to setup a secure SSL/TLS environment).
798 sandbox dry-run tests first will prove correctness.
802 .Sx "On URL syntax and credential lookup"
803 will spread light on the different ways of how to specify user email
804 account credentials, the
806 variable chains, and accessing protocol-specific resources,
809 goes into the details of character encoding and how to use them for
810 representing messages and MIME part contents by specifying them in
812 and reading the section
813 .Sx "The mime.types files"
814 should help to understand how the MIME-type of outgoing attachments are
815 classified, and what can be done for fine-tuning.
818 Message recipients (as specified on the command line or defined in
823 may not only be email addressees but can also be names of mailboxes and
824 even complete shell command pipe specifications.
827 is not set then only network addresses (see
829 for a description of mail addresses) and plain user names (including MTA
830 aliases) may be used, other types will be filtered out, giving a warning
833 .\" When changing any of the following adjust any RECIPIENTADDRSPEC;
834 .\" grep the latter for the complete picture
838 is set then extended recipient addresses will optionally be accepted:
839 Any name which starts with a vertical bar
841 character specifies a command pipe \(en the command string following the
843 is executed and the message is sent to its standard input;
844 Likewise, any name that starts with the character solidus
846 or the character sequence dot solidus
848 is treated as a file, regardless of the remaining content.
849 Any other name which contains an at sign
851 character is treated as a network address;
852 Any other name which starts with a plus sign
854 character specifies a mailbox name;
855 Any other name which contains a solidus
857 character but no exclamation mark
861 character before also specifies a mailbox name;
862 What remains is treated as a network address.
864 .Bd -literal -offset indent
865 $ echo bla | \*(uA -Sexpandaddr -s test ./mbox.mbox
866 $ echo bla | \*(uA -Sexpandaddr -s test '|cat >> ./mbox.mbox'
867 $ echo safe | LC_ALL=C \e
868 \*(uA -:/ -Sv15-compat -Ssendwait -Snosave \e
869 -Sexpandaddr=fail,-all,+addr -s test \e
874 It is possible to create personal distribution lists via the
876 command, so that, for instance, the user can send mail to
878 and have it go to a group of people.
879 These aliases have nothing in common with the system wide aliases that
880 may be used by the MTA, which are subject to the
884 and are often tracked in a file
890 Personal aliases will be expanded by \*(UA before the message is sent,
891 and are thus a convenient alternative to specifying each addressee by
895 .Dl alias cohorts bill jkf mark kridle@ucbcory ~/mail/cohorts.mbox
898 To avoid environmental noise scripts should
900 \*(UA from any configuration files and create a script-local
901 environment, ideally with the command line options
903 to disable any configuration file in conjunction with repetitions of
905 to specify variables:
907 .Bd -literal -offset indent
909 \*(uA -:/ -Sv15-compat -Ssendwait -Snosave \e
910 -Sexpandaddr=fail,-all,+addr \e
911 -S 'mta=smtps://mylogin@exam.ple:465' -Ssmtp-auth=login \e
912 -S 'from=scriptreply@exam.ple' \e
913 -s 'subject' -a attachment_file \e
914 -. "Recipient 1 <rec1@exam.ple>" rec2@exam.ple \e
919 In interactive mode, which is introduced in the next section, messages
920 can be sent by calling the
922 command with a list of recipient addresses \(em the semantics are
923 completely identical to non-interactive message sending:
925 .Bd -literal -offset indent
926 $ \*(uA -d -Squiet -Semptystart
927 "/var/spool/mail/user": 0 messages
928 ? mail "Recipient 1 <rec1@exam.ple>", rec2@exam.ple
929 ? # Will do the right thing (tm)
930 ? m rec1@exam.ple rec2@exam.ple
934 .\" .Ss "On reading mail, and interactive mode" {{{
935 .Ss "On reading mail, and interactive mode"
937 When invoked without addressees \*(UA enters interactive mode in which
939 When used like that the user's system
943 for an in-depth description of the different mailbox types that exist)
944 is read in and a one line header of each message therein is displayed.
945 The visual style of this summary of
947 can be adjusted through the variable
949 and the possible sorting criterion via
951 If the initially opened mailbox is empty \*(UA will instead exit
952 immediately (after displaying a message) unless the variable
961 will give a listing of all available commands and
963 will give a summary of some common ones.
964 If the \*(OPal documentation strings are available one can type
966 and see the actual expansion of
968 and what it's purpose is, i.e., commands can be abbreviated
969 (note that POSIX defines some abbreviations, so that the alphabetical
970 order of commands doesn't necessarily relate to the abbreviations; it is
971 possible to define overwrites with the
976 Messages are given numbers (starting at 1) which uniquely identify
977 messages; the current message \(en the
979 \(en will either be the first new message, or the first unread message,
980 or the first message of the mailbox; the option
982 will instead cause usage of the last message for this purpose.
987 ful of header summaries containing the
991 will display only the summaries of the given messages, defaulting to the
995 Message content can be displayed on the users' terminal with the
999 If instead the command
1001 is used, only the first
1003 of a message will be shown.
1004 By default the current message
1006 is displayed, but like with many other commands it is possible to give
1007 a fancy message specification (see
1008 .Sx "Specifying messages" ) ,
1011 will display all unread messages,
1016 will type the messages 1 and 5,
1018 will type the messages 1 through 5, and
1022 will display the last and the next message, respectively.
1025 (a more substantial alias of the standard command
1027 will display a header summary of the given message specification list
1028 instead of their content, e.g., the following will search for subjects:
1031 .Dl from "'@Some subject to search for'"
1034 In the default setup all header fields of a message will be
1036 d, but this can be changed: either by blacklisting a list of fields via
1038 or by whitelisting only a given list with the
1041 .Ql Ic \:retain Ns \0from_ date from to cc subject .
1042 In order to display all header fields of a message regardless of
1043 currently active ignore or retain lists, use the commands
1049 controls whether and when \*(UA will use the configured
1051 for display instead of directly writing to the user terminal
1053 (generally speaking).
1054 Note that historically the global
1056 not only adjusts the list of displayed headers, but also sets
1060 Dependent upon the configuration a line editor (see the section
1061 .Sx "On terminal control and line editor" )
1062 aims at making user experience with the many
1065 When reading the system
1071 specified a mailbox explicitly prefixed with the special
1073 modifier (propagating the mailbox to a primary one) then messages which
1074 have been read will be moved to a secondary mailbox, the user's
1076 file, automatically when the mailbox is left, either by changing the
1077 active mailbox or by quitting \*(UA (also see
1078 .Sx "Message states" )
1079 \(en this automatic moving from a system or primary to the secondary
1080 mailbox is not performed when the variable
1085 After examining a message the user can also
1089 to the sender and all recipients or
1091 exclusively to the sender(s).
1092 Messages can also be
1094 ed (shorter alias is
1096 Note that when replying to or forwarding a message recipient addresses
1097 will be stripped from comments and names unless the option
1100 Deletion causes \*(UA to forget about the message;
1101 This is not irreversible, though, one can
1103 the message by giving its number,
1104 or the \*(UA session can be ended by giving the
1109 To end a mail processing session one may either issue
1111 to cause a full program exit, which possibly includes
1112 automatic moving of read messages to
1114 as well as updating the \*(OPal line editor
1118 instead in order to prevent any of these actions.
1121 .\" .Ss "HTML mail and MIME attachments" {{{
1122 .Ss "HTML mail and MIME attachments"
1124 Messages which are HTML-only get more and more common and of course many
1125 messages come bundled with a bouquet of MIME attachments.
1126 Whereas \*(UA \*(OPally supports a simple HTML-to-text converter to deal
1127 with HTML messages (see
1128 .Sx "The mime.types files" ) ,
1129 it normally can't deal with any of these itself, but instead programs
1130 need to become registered to deal with specific MIME types or file
1132 These programs may either prepare plain text versions of their input
1133 in order to enable \*(UA to display the content on the terminal,
1134 or display the content themselves, for example in a graphical window.
1137 To install an external handler program for a specific MIME type set an
1139 .Va pipe-TYPE/SUBTYPE
1140 variable; to instead define a handler for a specific file extension set
1143 variable \(en these handlers take precedence.
1144 \*(OPally \*(UA supports mail user agent configuration as defined in
1145 RFC 1524; this mechanism, documented in the section
1146 .Sx "The Mailcap files" ,
1147 will be queried for display or quote handlers if none of the former two
1148 .\" TODO v15-compat "will be" -> "is"
1149 did; it will be the sole source for handlers of other purpose.
1150 A last source for handlers may be the MIME type definition itself, if
1151 the \*(UA specific type-marker extension was used when defining the type
1154 (Many of the builtin MIME types do so by default.)
1158 .Va mime-counter-evidence
1159 can be set to improve dealing with faulty MIME part declarations as are
1160 often seen in real-life messages.
1161 E.g., to display a HTML message inline (that is, converted to a more
1162 fancy plain text representation than the builtin converter is capable to
1163 produce) with either of the text-mode browsers
1167 teach \*(UA about MathML documents and make it display them as plain
1168 text, and to open PDF attachments in an external PDF viewer,
1169 asynchronously and with some other magic attached:
1171 .Bd -literal -offset indent
1172 if $features !@ +html-filter
1173 #set pipe-text/html='elinks -force-html -dump 1'
1174 set pipe-text/html='lynx -stdin -dump -force_html'
1175 # Display HTML as plain text instead
1176 #set pipe-text/html=@
1178 mimetype '@ application/mathml+xml mathml'
1179 wysh set pipe-application/pdf='@&=@ \e
1180 trap "rm -f \e"${NAIL_FILENAME_TEMPORARY}\e"" EXIT;\e
1181 trap "trap \e"\e" INT QUIT TERM; exit 1" INT QUIT TERM;\e
1182 mupdf "${NAIL_FILENAME_TEMPORARY}"'
1186 Note: special care must be taken when using such commands as mail
1187 viruses may be distributed by this method: if messages of type
1188 .Ql application/x-sh
1189 or files with the extension
1191 were blindly filtered through the shell, for example, a message sender
1192 could easily execute arbitrary code on the system \*(UA is running on.
1193 For more on MIME, also in respect to sending of messages, see the
1195 .Sx "The mime.types files" ,
1196 .Sx "The Mailcap files"
1201 .\" .Ss "Mailing lists" {{{
1204 \*(UA offers some support to ease handling of mailing lists.
1207 promotes all given arguments to known mailing lists, and
1209 sets their subscription attribute, creating them first as necessary.
1214 automatically, but only resets the subscription attribute.)
1215 Using the commands without arguments will show (a subset of) all
1216 currently defined mailing lists.
1221 can be used to mark out messages with configured list addresses
1222 in the header display.
1225 \*(OPally mailing lists may also be specified as (extended) regular
1226 expressions, which allows matching of many addresses with a single
1228 However, all fully qualified list addresses are matched via a fast
1229 dictionary, whereas expressions are placed in (a) list(s) which is
1230 (are) matched sequentially.
1232 .Bd -literal -offset indent
1233 set followup-to followup-to-honour=ask-yes reply-to-honour=ask-yes
1234 wysh mlist a1@b1.c1 a2@b2.c2 '.*@lists\e.c3$'
1235 mlsubscribe a4@b4.c4 exact@lists.c3
1240 .Va followup-to-honour
1242 .Ql Mail-\:Followup-\:To:
1243 header is honoured when the message is being replied to (via
1249 controls whether this header is created when sending mails; it will be
1250 created automatically for a couple of reasons, too, like when the
1252 .Dq mailing list specific
1257 is used to respond to a message with its
1258 .Ql Mail-Followup-To:
1262 A difference in between the handling of known and subscribed lists is
1263 that the address of the sender is usually not part of a generated
1264 .Ql Mail-Followup-To:
1265 when addressing the latter, whereas it is for the former kind of lists.
1266 Usually because there are exceptions: say, if multiple lists are
1267 addressed and not all of them are subscribed lists.
1269 For convenience \*(UA will, temporarily, automatically add a list
1270 address that is presented in the
1272 header of a message that is being responded to to the list of known
1274 Shall that header have existed \*(UA will instead, dependent on the
1276 .Va reply-to-honour ,
1279 for this purpose in order to accept a list administrators' wish that
1280 is supposed to have been manifested like that (but only if it provides
1281 a single address which resides on the same domain as what is stated in
1285 .\" .Ss "Resource files" {{{
1286 .Ss "Resource files"
1288 Upon startup \*(UA reads in several resource files:
1290 .Bl -tag -width ".It Pa _AIL_EXTRA_R_"
1293 System wide initialization file.
1294 Reading of this file can be suppressed, either by using the
1298 command line options, or by setting the
1301 .Ev NAIL_NO_SYSTEM_RC .
1305 File giving initial commands.
1306 A different file can be chosen by setting the
1310 Reading of this file can be suppressed with the
1312 command line option.
1314 .It Va NAIL_EXTRA_RC
1315 Can be used to define an optional startup file to be read after all
1316 other resource files.
1317 It can be used to specify settings that are not understood by other
1319 implementations, for example.
1320 This variable is only honoured when defined in a resource file, e.g.,
1322 .Sx "INTERNAL VARIABLES" .
1326 The content of these files is interpreted as follows:
1329 .Bl -bullet -compact
1331 A lines' leading whitespace is removed.
1333 Empty lines are ignored.
1335 Any other line is interpreted as a command.
1336 It may be spread over multiple input lines if the newline character is
1338 by placing a reverse solidus character
1340 as the last character of the line; whereas any leading whitespace of
1341 follow lines is ignored, trailing whitespace before a escaped newline
1342 remains in the input.
1344 If the line (content) starts with the number sign
1346 then it is a comment-command \(en a real command! \(en and also ignored.
1347 This command is the only form of comment that is understood.
1351 Unless \*(UA is about to enter interactive mode syntax errors that occur
1352 while loading these files are treated as errors and cause program exit.
1353 More files with syntactically equal content can be
1355 The following, saved in a file, would be an examplary content:
1357 .Bd -literal -offset indent
1358 # This line is a comment command. And y\e
1359 es, it is really continued here.
1366 .\" .Ss "Character sets" {{{
1367 .Ss "Character sets"
1369 \*(OP \*(UA detects the character set of the terminal by using
1370 mechanisms that are controlled by the
1375 should give an overview); the \*(UA internal variable
1377 will be set to the detected terminal character set accordingly
1378 and will thus show up in the output of the commands
1384 However, a user supplied
1386 value is not overwritten by this detection mechanism: this
1388 must be used if the detection doesn't work properly,
1389 and it may be used to adjust the name of the locale character set.
1390 E.g., on BSD systems one may use a locale with the character set
1391 ISO8859-1, which is not a valid name for this character set; to be on
1392 the safe side, one may set
1394 to the correct name, which is ISO-8859-1.
1397 Note that changing the value doesn't mean much beside that,
1398 since several aspects of the real character set are implied by the
1399 locale environment of the system,
1400 and that stays unaffected by the content of an overwritten
1403 (This is mostly an issue when interactively using \*(UA, though.
1404 It is actually possible to send mail in a completely
1406 locale environment, an option that \*(UA's test-suite uses excessively.)
1409 If no character set conversion capabilities have been compiled into
1412 doesn't include the term
1416 will be the only supported character set,
1417 it is simply assumed that it can be used to exchange 8-bit messages,
1418 and the rest of this section does not apply;
1419 it may however still be necessary to explicitly set it if automatic
1420 detection fails, since in that case it defaults to the mentioned
1421 .\" (Keep in SYNC: ./nail.1:"Character sets", ./nail.h:CHARSET_*!)
1425 When reading messages, their text is converted into
1427 as necessary in order to display them on the users terminal.
1428 Unprintable characters and invalid byte sequences are detected
1429 and replaced by proper substitution characters (unless the variable
1431 was set once \*(UA was started).
1433 .Va charset-unknown-8bit
1434 to deal with another hairy aspect of message interpretation.
1437 When sending messages all their parts and attachments are classified.
1438 Whereas no character set conversion is performed on those parts which
1439 appear to be binary data,
1440 the character set being used must be declared within the MIME header of
1441 an outgoing text part if it contains characters that do not conform to
1442 the set of characters that are allowed by the email standards.
1443 Permissible values for character sets can be declared using the
1447 which defines a catch-all last-resort fallback character set that is
1448 implicitly appended to the list of character-sets in
1452 When replying to a message and the variable
1453 .Va reply-in-same-charset
1454 is set then the character set of the message being replied to is tried
1456 And it is also possible to make \*(UA work even more closely related to
1457 the current locale setting automatically by using the variable
1458 .Va sendcharsets-else-ttycharset ,
1459 please see there for more information.
1462 All the specified character sets are tried in order unless the
1463 conversion of the part or attachment succeeds.
1464 If none of the tried (8-bit) character sets is capable to represent the
1465 content of the part or attachment,
1466 then the message will not be sent and its text will optionally be
1470 In general, if the message
1471 .Dq Cannot convert from a to b
1472 appears, either some characters are not appropriate for the currently
1473 selected (terminal) character set,
1474 or the needed conversion is not supported by the system.
1475 In the first case, it is necessary to set an appropriate
1477 locale and/or the variable
1481 The best results are usually achieved when \*(UA is run in a UTF-8
1482 locale on a UTF-8 capable terminal, in which case the full Unicode
1483 spectrum of characters is available.
1484 In this setup characters from various countries can be displayed,
1485 while it is still possible to use more simple character sets for sending
1486 to retain maximum compatibility with older mail clients.
1489 On the other hand the POSIX standard defines a locale-independent 7-bit
1490 .Dq portable character set
1491 that should be used when overall portability is an issue, the even more
1492 restricted subset named
1493 .Dq portable filename character set
1494 consisting of A-Z, a-z, 0-9, period
1503 .\" .Ss "Message states" {{{
1504 .Ss "Message states"
1506 \*(UA differentiates in between several different message states;
1507 the current state will be reflected in header summary displays if
1509 is configured to do so (via the internal variable
1511 and messages can also be selected and be acted upon depending on their
1513 .Sx "Specifying messages" ) .
1514 When operating on the system
1516 box or in primary mailboxes opened with the special prefix
1520 special actions, like the automatic moving of messages to the secondary
1522 mailbox may be applied when the mailbox is left (also implicitly via
1523 a successful exit of \*(UA, but not if the special command
1525 is used) \(en however, because this may be irritating to users which
1528 mail-user-agents, the default global
1534 variables in order to suppress this behaviour.
1536 .Bl -tag -width ".It Ql _reserved"
1538 Message has neither been viewed nor moved to any other state.
1539 Such messages are retained even in the primary system mailbox.
1542 Message has neither been viewed nor moved to any other state, but the
1543 message was present already when the mailbox has been opened last:
1544 Such messages are retained even in the primary system mailbox.
1547 The message has been processed by one of the following commands:
1567 commands may also cause the next message to be marked as read, depending
1573 command is used, messages that are in the primary system mailbox or in
1574 mailboxes which were opened with the special
1578 state when the mailbox is left will be saved in
1585 The message has been processed by one of the following commands:
1591 can be used to access such messages.
1594 The message has been processed by a
1596 command and it will be retained in its current location.
1599 The message has been processed by one of the following commands:
1605 command is used, messages that are in the primary system mailbox or in
1606 mailboxes which were opened with the special
1610 state when the mailbox is left will be deleted; they will be saved in
1618 .\" .Ss "Specifying messages" {{{
1619 .Ss "Specifying messages"
1626 can be given a list of message numbers as arguments to apply to a number
1627 of messages at once.
1630 deletes messages 1 and 2,
1633 will delete the messages 1 through 5.
1634 In sorted or threaded mode (see the
1638 will delete the messages that are located between (and including)
1639 messages 1 through 5 in the sorted/threaded order, as shown in the
1642 Multiple colon modifiers can be joined into one, e.g.,
1644 The following special message names exist:
1646 .Bl -tag -width ".It Ar _n_u"
1652 All old messages (any not in state
1677 All answered messages
1682 All messages marked as draft.
1684 \*(OP All messages classified as spam.
1686 \*(OP All messages with unsure spam classification.
1688 The current message, the so-called
1691 The message that was previously the current message.
1693 The parent message of the current message,
1694 that is the message with the Message-ID given in the
1696 field or the last entry of the
1698 field of the current message.
1700 The next previous undeleted message,
1701 or the next previous deleted message for the
1704 In sorted/threaded mode,
1705 the next previous such message in the sorted/threaded order.
1707 The next undeleted message,
1708 or the next deleted message for the
1711 In sorted/threaded mode,
1712 the next such message in the sorted/threaded order.
1714 The first undeleted message,
1715 or the first deleted message for the
1718 In sorted/threaded mode,
1719 the first such message in the sorted/threaded order.
1722 In sorted/threaded mode,
1723 the last message in the sorted/threaded order.
1727 selects the message addressed with
1731 is any other message specification,
1732 and all messages from the thread that begins at it.
1733 Otherwise it is identical to
1738 the thread beginning with the current message is selected.
1743 All messages that were included in the message list for the previous
1746 .It Ar / Ns Ar string
1747 All messages that contain
1749 in the subject field (case ignored).
1756 the string from the previous specification of that type is used again.
1758 .It Xo Op Ar @ Ns Ar name-list Ns
1761 All messages that contain the given case-insensitive search
1763 ession; if the \*(OPal regular expression (see
1765 support is available
1767 will be interpreted as (an extended) one if any of the
1769 (extended) regular expression characters is seen.
1771 .Ar @ Ns Ar name-list
1772 part is missing, the search is restricted to the subject field body,
1775 specifies a comma-separated list of header fields to search, as in
1777 .Dl '@to,from,cc@Someone i ought to know'
1779 In order to search for a string that includes a
1781 (commercial at) character the
1783 is effectively non-optional, but may be given as the empty string.
1784 Some special header fields may be abbreviated:
1798 respectively and case-insensitively.
1803 can be used to search in (all of) the header(s) of the message, and the
1812 can be used to perform full text searches \(en whereas the former
1813 searches only the body, the latter also searches the message header.
1815 This message specification performs full text comparison, but even with
1816 regular expression support it is almost impossible to write a search
1817 expression that savely matches only a specific address domain.
1818 To request that the content of the header is treated as a list of
1819 addresses, and to strip those down to the plain email address which the
1820 search expression is to be matched against, prefix the header name
1821 (abbreviation) with a tilde
1824 .Dl @~f@@a\e.safe\e.domain\e.match$
1828 .Dq any substring matches
1831 header, which will match addresses (too) even if
1833 is set (and POSIX says
1834 .Dq any address as shown in a header summary shall be matchable in this form ) ;
1837 variable is set, only the local part of the address is evaluated
1838 for the comparison, not ignoring case, and the setting of
1840 is completely ignored.
1841 For finer control and match boundaries use the
1843 search expression; the \*(OPal IMAP-style
1845 expression can also be used if substring matches are desired.
1849 \*(OP IMAP-style SEARCH expressions may also be used.
1850 This addressing mode is available with all types of folders;
1851 \*(UA will perform the search locally as necessary.
1852 Strings must be enclosed by double quotes
1854 in their entirety if they contain white space or parentheses;
1855 within the quotes, only reverse solidus
1857 is recognized as an escape character.
1858 All string searches are case-insensitive.
1859 When the description indicates that the
1861 representation of an address field is used,
1862 this means that the search string is checked against both a list
1865 .Bd -literal -offset indent
1866 (\*qname\*q \*qsource\*q \*qlocal-part\*q \*qdomain-part\*q)
1871 and the addresses without real names from the respective header field.
1872 These search expressions can be nested using parentheses, see below for
1876 .Bl -tag -compact -width ".It Ar _n_u"
1877 .It Ar ( criterion )
1878 All messages that satisfy the given
1880 .It Ar ( criterion1 criterion2 ... criterionN )
1881 All messages that satisfy all of the given criteria.
1883 .It Ar ( or criterion1 criterion2 )
1884 All messages that satisfy either
1889 To connect more than two criteria using
1891 specifications have to be nested using additional parentheses,
1893 .Ql (or a (or b c)) ,
1897 .Ql ((a or b) and c) .
1900 operation of independent criteria on the lowest nesting level,
1901 it is possible to achieve similar effects by using three separate
1905 .It Ar ( not criterion )
1906 All messages that do not satisfy
1908 .It Ar ( bcc \*q Ns Ar string Ns Ar \*q )
1909 All messages that contain
1911 in the envelope representation of the
1914 .It Ar ( cc \*q Ns Ar string Ns Ar \*q )
1915 All messages that contain
1917 in the envelope representation of the
1920 .It Ar ( from \*q Ns Ar string Ns Ar \*q )
1921 All messages that contain
1923 in the envelope representation of the
1926 .It Ar ( subject \*q Ns Ar string Ns Ar \*q )
1927 All messages that contain
1932 .It Ar ( to \*q Ns Ar string Ns Ar \*q )
1933 All messages that contain
1935 in the envelope representation of the
1938 .It Ar ( header name \*q Ns Ar string Ns Ar \*q )
1939 All messages that contain
1944 .It Ar ( body \*q Ns Ar string Ns Ar \*q )
1945 All messages that contain
1948 .It Ar ( text \*q Ns Ar string Ns Ar \*q )
1949 All messages that contain
1951 in their header or body.
1952 .It Ar ( larger size )
1953 All messages that are larger than
1956 .It Ar ( smaller size )
1957 All messages that are smaller than
1961 .It Ar ( before date )
1962 All messages that were received before
1964 which must be in the form
1968 denotes the day of the month as one or two digits,
1970 is the name of the month \(en one of
1971 .Ql Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec ,
1974 is the year as four digits, e.g.,
1978 All messages that were received on the specified date.
1979 .It Ar ( since date )
1980 All messages that were received since the specified date.
1981 .It Ar ( sentbefore date )
1982 All messages that were sent on the specified date.
1983 .It Ar ( senton date )
1984 All messages that were sent on the specified date.
1985 .It Ar ( sentsince date )
1986 All messages that were sent since the specified date.
1988 The same criterion as for the previous search.
1989 This specification cannot be used as part of another criterion.
1990 If the previous command line contained more than one independent
1991 criterion then the last of those criteria is used.
1995 .\" .Ss "On URL syntax and credential lookup" {{{
1996 .Ss "On URL syntax and credential lookup"
1998 \*(IN For accessing protocol-specific resources usage of Uniform
1999 Resource Locators (URL, RFC 1738) has become omnipresent.
2000 \*(UA expects and understands URLs in the following form;
2003 denote optional parts, optional either because there also exist other
2004 ways to define the information in question or because support of the
2005 part is protocol-specific (e.g.,
2007 is used by the IMAP protocol but not by POP3);
2012 are specified they must be given in URL percent encoded form (RFC 3986;
2020 .Dl PROTOCOL://[USER[:PASSWORD]@]server[:port][/path]
2023 Note that these \*(UA URLs most often don't conform to any real
2024 standard, but instead represent a normalized variant of RFC 1738 \(en
2025 they are not used in data exchange but only meant as a compact,
2026 easy-to-use way of defining and representing information in
2027 a well-known notation.
2030 Many internal variables of \*(UA exist in multiple versions, called
2031 variable chains for the rest of this document: the plain
2036 .Ql variable-USER@HOST .
2043 had been specified in the respective URL, otherwise it refers to the plain
2049 that had been found when doing the user chain lookup as is described
2052 will never be in URL percent encoded form, whether it came from an URL
2053 or not; i.e., values of
2054 .Sx "INTERNAL VARIABLES"
2055 must not be URL percent encoded.
2058 For example, whether an hypothetical URL
2059 .Ql smtp://hey%3Ayou@our.house
2060 had been given that includes a user, or whether the URL was
2061 .Ql smtp://our.house
2062 and the user had been found differently, to lookup the variable chain
2063 .Va smtp-use-starttls
2064 \*(UA first looks for whether
2065 .Ql smtp-\:use-\:starttls-\:hey:you@our.house
2066 is defined, then whether
2067 .Ql smtp-\:use-\:starttls-\:our.house
2068 exists before finally ending up looking at the plain variable itself.
2071 \*(UA obeys the following logic scheme when dealing with the
2072 necessary credential information of an account:
2078 has been given in the URL the variables
2082 are looked up; if no such variable(s) can be found then \*(UA will,
2083 when enforced by the \*(OPal variables
2084 .Va netrc-lookup-HOST
2091 specific entry which provides a
2093 name: this lookup will only succeed if unambiguous (one possible matching
2096 It is possible to load encrypted
2101 If there is still no
2103 then \*(UA will fall back to the user who is supposed to run \*(UA,
2104 the identity of which has been fixated during \*(UA startup and is
2105 known to be a valid user on the current host.
2108 Authentication: unless otherwise noted this will lookup the
2109 .Va PROTOCOL-auth-USER@HOST , PROTOCOL-auth-HOST , PROTOCOL-auth
2110 variable chain, falling back to a protocol-specific default should this
2116 has been given in the URL, then if the
2118 has been found through the \*(OPal
2120 that may have already provided the password, too.
2121 Otherwise the variable chain
2122 .Va password-USER@HOST , password-HOST , password
2123 is looked up and used if existent.
2125 Afterwards the complete \*(OPal variable chain
2126 .Va netrc-lookup-USER@HOST , netrc-lookup-HOST , netrc-lookup
2130 cache is searched for a password only (multiple user accounts for
2131 a single machine may exist as well as a fallback entry without user
2132 but with a password).
2134 If at that point there is still no password available, but the
2135 (protocols') chosen authentication type requires a password, then in
2136 interactive mode the user will be prompted on the terminal.
2141 S/MIME verification works relative to the values found in the
2145 header field(s), which means that the values of
2146 .Va smime-sign , smime-sign-cert , smime-sign-include-certs
2148 .Va smime-sign-message-digest
2149 will not be looked up using the
2153 chains from above but instead use the corresponding values from the
2154 message that is being worked on.
2155 In unusual cases multiple and different
2159 combinations may therefore be involved \(en on the other hand those
2160 unusual cases become possible.
2161 The usual case is as short as:
2164 .Dl set mta=smtp://USER:PASS@HOST smtp-use-starttls \e
2165 .Dl \ \ \ \ smime-sign smime-sign-cert=+smime.pair
2170 contains complete example configurations.
2173 .\" .Ss "On terminal control and line editor" {{{
2174 .Ss "On terminal control and line editor"
2176 \*(OP \*(UA can be configured to support a line editor,
2177 history lists that can be saved in between sessions,
2178 and terminal control to improve interactive usage experience.
2179 For the former one may either link against an external library
2180 .Pf ( Xr readline 3 ;
2181 behaviour of \*(UA may differ slightly),
2182 or enable the builtin Mailx-Line-Editor (MLE).
2183 Prevent usage of a line editor in interactive mode by setting the
2185 .Va line-editor-disable .
2188 \*(OP Terminal control will be realized through one of the standard
2190 libraries, either the
2192 or, alternatively, the
2194 both of which will be initialized to work with the environment variable
2196 Terminal control will enhance or enable interactive usage aspects, e.g.,
2197 .Sx "Coloured display" ,
2198 and extend behaviour of the MLE, which may learn the byte-sequences of
2199 keys like the cursor and function keys, and which will automatically
2202 alternative screen shall the terminal support it.
2203 The internal variable
2205 can be used to overwrite settings or to learn (correct(ed)) keycodes.
2206 Actual interaction with the chosen library can be disabled completely by
2207 setting the internal variable
2208 .Va termcap-disable ;
2210 will be queried regardless, even if the \*(OPal support for the
2211 libraries has not been enabled at configuration time.
2216 feature is available then input from line editor prompts will be saved
2217 in a history list that can be searched in and be expanded from.
2218 Such saving can be prevented by prefixing input with any amount of
2220 Aspects of history, like allowed content, maximum size etc., can be
2221 configured with the variables
2224 .Va history-gabby-persist
2229 \*(OP The builtin \*(UA line editor MLE should work in all environments
2230 which comply to the ISO C standard
2232 and will support wide glyphs if possible (the necessary functionality
2233 had been removed from ISO C, but was included in
2235 Especially if the \*(OPal terminal control support is missing setting
2236 entries in the internal variable
2238 will help shall the MLE misbehave, see there for more.
2239 The MLE can support a little bit of
2243 The MLE supports a set of editing and control commands.
2244 By default (as) many (as possible) of these will be assigned to a set of
2245 single-letter control codes, which should work on any terminal.
2248 command is available then the MLE commands can also be accessed freely
2249 by assigning the command name, which is shown in parenthesis in the list
2250 below, to any desired key-sequence, and the MLE will instead and also use
2252 to establish its builtin key bindings
2253 (more of them if the \*(OPal terminal control is available),
2254 an action which can then be suppressed completely by setting
2255 .Va line-editor-no-defaults .
2256 The following uses the
2258 ell-style quote notation that is documented in the introductional
2261 combinations not mentioned either cause job control signals or don't
2262 generate a (unique) keycode:
2266 .Bl -tag -compact -width "Ql _M"
2268 Go to the start of the line
2269 .Pf ( Cd mle-go-home ) .
2272 Move the cursor backward one character
2273 .Pf ( Cd mle-go-bwd ) .
2276 Forward delete the character under the cursor;
2277 quits \*(UA if used on the empty line unless the
2280 .Pf ( Cd mle-del-fwd ) .
2283 Go to the end of the line
2284 .Pf ( Cd mle-go-end ) .
2287 Move the cursor forward one character
2288 .Pf ( Cd mle-go-fwd ) .
2291 Cancel current operation, full reset.
2292 If there is an active history search or tabulator expansion then this
2293 command will first reset that, reverting to the former line content;
2294 thus a second reset is needed for a full reset in this case
2295 .Pf ( Cd mle-reset ) .
2298 Backspace: backward delete one character
2299 .Pf ( Cd mle-del-bwd ) .
2303 Horizontal tabulator:
2304 try to expand the word before the cursor, also supporting \*(UA
2307 .Pf ( Cd mle-complete ) .
2309 .Cd mle-quote-rndtrip .
2313 commit the current line
2314 .Pf ( Cd mle-commit ) .
2317 Cut all characters from the cursor to the end of the line
2318 .Pf ( Cd mle-snarf-end ) .
2322 .Pf ( Cd mle-repaint ) .
2325 \*(OP Go to the next history entry
2326 .Pf ( Cd mle-hist-fwd ) .
2333 \*(OP Go to the previous history entry
2334 .Pf ( Cd mle-hist-bwd ) .
2337 Toggle roundtrip mode shell quotes, where produced,
2339 .Pf ( Cd mle-quote-rndtrip ) .
2340 This setting is temporary, and will be forgotten once the command line
2344 \*(OP Complete the current line from (the remaining) older history entries
2345 .Pf ( Cd mle-hist-srch-bwd ) .
2348 \*(OP Complete the current line from (the remaining) newer history entries
2349 .Pf ( Cd mle-hist-srch-fwd ) .
2352 Paste the snarf buffer
2353 .Pf ( Cd mle-paste ) .
2360 .Pf ( Cd mle-snarf-line ) .
2363 Prompts for a Unicode character (its hexadecimal number) to be inserted
2364 .Pf ( Cd mle-prompt-char ) .
2365 Note this command needs to be assigned to a single-letter control code
2366 in order to become recognized and executed during input of
2367 a key-sequence (only four single-letter control codes can be used for
2368 that shortcut purpose); this control code is special-treated and can't
2369 be part of any other sequence, because any occurrence will perform the
2371 function immediately.
2374 Cut the characters from the one preceding the cursor to the preceding
2376 .Pf ( Cd mle-snarf-word-bwd ) .
2379 Move the cursor forward one word boundary
2380 .Pf ( Cd mle-go-word-fwd ) .
2383 Move the cursor backward one word boundary
2384 .Pf ( Cd mle-go-word-bwd ) .
2387 Escape: reset a possibly used multibyte character input state machine
2388 and \*(OPally a lingering, incomplete key binding
2389 .Pf ( Cd mle-cancel ) .
2390 This command needs to be assigned to a single-letter control code in
2391 order to become recognized and executed during input of a key-sequence
2392 (only four single-letter control codes can be used for that shortcut
2394 This control code may also be part of a multi-byte sequence, but if
2395 a sequence is active and the very control code is currently also an
2396 expected input, then it will first be consumed by the active sequence.
2411 Cut the characters from the one after the cursor to the succeeding word
2413 .Pf ( Cd mle-snarf-word-fwd ) .
2423 this will immediately reset a possibly active search etc.
2427 ring the audible bell.
2431 .\" .Ss "Coloured display" {{{
2432 .Ss "Coloured display"
2434 \*(OP \*(UA can be configured to support a coloured display and font
2435 attributes by emitting ANSI / ISO 6429 SGR (select graphic rendition)
2437 Usage of colours and font attributes solely depends upon the
2438 capability of the detected terminal type that is defined by the
2439 environment variable
2441 and which can be fine-tuned by the user via the internal variable
2445 On top of what \*(UA knows about the terminal the boolean variable
2447 defines whether the actually applicable colour and font attribute
2448 sequences should also be generated when output is going to be paged
2449 through the external program defined by the environment variable
2454 This is not enabled by default because different pager programs need
2455 different command line switches or other configuration in order to
2456 support those sequences.
2457 \*(UA however knows about some widely used pagers and in a clean
2458 environment it is often enough to simply set
2460 please refer to that variable for more on this topic.
2465 is set then any active usage of colour and font attribute sequences
2466 is suppressed, but without affecting possibly established
2471 To define and control colours and font attributes a single multiplexer
2472 command family exists:
2474 shows or defines colour mappings for the given colour type (e.g.,
2477 can be used to remove mappings of a given colour type.
2478 Since colours are only available in interactive mode, it may make
2479 sense to conditionalize the colour setup by encapsulating it with
2482 .Bd -literal -offset indent
2483 if terminal && $features =@ +colour
2484 colour iso view-msginfo ft=bold,fg=green
2485 colour iso view-header ft=bold,fg=red "from,subject"
2486 colour iso view-header fg=red
2488 uncolour iso view-header from,subject
2489 colour iso view-header ft=bold,fg=magenta,bg=cyan
2490 colour 256 view-header ft=bold,fg=208,bg=230 subject,from
2491 colour mono view-header ft=bold
2492 colour mono view-header ft=bold,ft=reverse subject,from
2496 .\" }}} (DESCRIPTION)
2499 .\" .Sh COMMANDS {{{
2502 Each command is typed on a line by itself,
2503 and may take arguments following the command word.
2504 Command names may be abbreviated, in which case the first command that
2505 matches the given prefix will be used.
2508 can be used to show the list of all commands, either alphabetically
2509 sorted or in prefix search order (these don't match, also because the
2510 POSIX standard prescribes a set of abbreviations); a more verbose
2511 listing will be produced if either of
2516 \*(OPally the command
2520 when given an argument, will show a documentation string for the
2521 command matching the expanded argument, as in
2523 which should be a shorthand of
2527 For commands which take message lists as arguments, the next message
2528 forward that satisfies the command's requirements will be used shall no
2529 explicit message list have been specified.
2530 If there are no messages forward of the current message,
2531 the search proceeds backwards,
2532 and if there are no good messages at all,
2533 \*(UA shows an error message and aborts the command.
2534 \*(ID Non-message-list arguments can be quoted using the following methods:
2537 .Bl -bullet -compact -offset indent
2539 An argument can be enclosed between paired double-quotes
2544 any white space, shell word expansion, or reverse solidus characters
2545 (except as described next) within the quotes are treated literally as
2546 part of the argument.
2547 A double-quote will be treated literally within single-quotes and vice
2549 Inside such a quoted string the actually used quote character can be
2550 used nonetheless by escaping it with a reverse solidus
2556 An argument that is not enclosed in quotes, as above, can usually still
2557 contain space characters if those spaces are reverse solidus escaped, as in
2561 A reverse solidus outside of the enclosing quotes is discarded
2562 and the following character is treated literally as part of the argument.
2567 Some commands which don't take message-list arguments can also be
2568 prefixed with the special keyword
2570 to choose \*(INible behaviour, and some new commands support only the
2571 new quoting style (without that keyword) and are flagged \*(NQ.
2572 In the future \*(UA will (mostly) use
2574 compatible argument parsing:
2575 Non-message-list arguments can be quoted using the following shell-style
2576 mechanisms: the escape character, single-quotes, double-quotes and
2577 dollar-single-quotes; any unquoted number sign
2579 starts a comment that ends argument processing.
2580 The overall granularity of error reporting and diagnostics, also
2581 regarding function arguments and their content, will improve.
2585 .Bl -bullet -compact -offset indent
2587 The literal value of any character can be preserved by preceding it
2588 with the escape character reverse solidus
2592 will cause variable expansion of the given name: \*(UA
2593 .Sx "INTERNAL VARIABLES"
2596 (shell) variables can be accessed through this mechanism, brace
2597 enclosing the name is supported.
2600 Arguments which are enclosed in
2601 .Ql 'single-\:quotes'
2602 retain their literal value.
2603 A single-quote cannot occur within single-quotes.
2606 The literal value of all characters enclosed in
2607 .Ql \(dqdouble-\:quotes\(dq
2608 is retained, with the exception of dollar
2610 which will cause variable expansion, as above, backquote (grave accent)
2612 (which not yet means anything special), reverse solidus
2614 which will escape any of the characters dollar
2616 (to prevent variable expansion), backquote (grave accent)
2620 (to prevent ending the quote) and reverse solidus
2622 (to prevent escaping, i.e., to embed a reverse solidus character as-is),
2623 but has no special meaning otherwise.
2626 Arguments enclosed in
2627 .Ql $'dollar-\:single-\:quotes'
2628 extend normal single quotes in that reverse solidus escape sequences are
2629 expanded as follows:
2631 .Bl -tag -compact -width "Ql \eNNN"
2637 an escape character.
2639 an escape character.
2651 emits a reverse solidus character.
2655 double quote (escaping is optional).
2657 eight-bit byte with the octal value
2659 (one to three octal digits), optionally with an additional
2662 A 0 byte will suppress further output for the quoted argument.
2664 eight-bit byte with the hexadecimal value
2666 (one or two hexadecimal characters).
2667 A 0 byte will suppress further output for the quoted argument.
2669 the Unicode / ISO-10646 character with the hexadecimal codepoint value
2671 (one to eight hexadecimal digits) \(em note that Unicode defines the
2672 maximum code to be ever supported as
2677 This escape is only supported in locales which support Unicode (see
2678 .Sx "Character sets" ) ,
2679 in other cases the sequence will remain unexpanded unless the given code
2680 point is ASCII compatible.
2681 The character NUL will suppress further output for the quoted argument.
2685 except it takes only one to four hexadecimal digits.
2690 This is a mechanism that allows usage of the non-printable (ASCII and
2691 compatible) control codes 0 to 31: to be able to create a printable
2692 representation the numeric value 64 is added to the control code of
2693 desire, and the resulting ASCII character set code point is then
2694 printed, e.g., BEL is
2695 .Ql 7 + 64 = 71 = G .
2696 Often circumflex notation is used for the visualization purpose, e.g,
2698 but the reverse solid notation has been standardized:
2700 The control code NUL
2702 ends argument processing without producing further output.
2704 Non-standard extension: expand the given variable name, as above.
2705 Brace enclosing the name is supported.
2707 Not yet supported, just to raise awareness: Non-standard extension.
2713 .Sy Compatibility notes:
2714 \*(ID Note these are new mechanisms which are not supported by all
2716 Round-tripping (feeding in things shown in list modes again) are not yet
2717 stable or possible at all.
2718 On new-style command lines it is wise to quote semicolon
2722 characters in order to ensure upward compatibility: the author would
2723 like to see things like
2724 .Ql ? echo $'trouble\etahead' | cat >> in_the_shell.txt
2726 .Ql ? top 2 5 10; type 3 22
2728 Before \*(UA will switch entirely to shell-style argument parsing there
2729 will be a transition phase where using
2731 will emit obsoletion warnings.
2732 E.g., the following are equivalent:
2734 .Bd -literal -offset indent
2735 mlist @any\e\e.where\e\e.example\e\e.com
2736 wysh mlist '@any\e.where\e.example\e.com' # This is a comment
2737 wysh mlist $'@any\e\e\ex2Ewhere\e\e.example\e\e\e56com' # A comment
2738 wysh mlist "@any\e.where\e.example\e.com"
2742 In any event an unquoted reverse solidus at the end of a command line is
2743 discarded and the next line continues the command.
2744 \*(ID Note that line continuation is handled before the above parsing is
2745 applied, i.e., the parsers documented above will see merged lines.
2746 Filenames, where expected, are subsequently subjected to the following
2747 transformations, in sequence:
2750 .Bl -bullet -compact -offset indent
2752 If the filename begins with an unquoted plus sign, and the
2754 variable is defined,
2755 the plus sign will be replaced by the value of the
2757 variable followed by a solidus.
2760 variable is unset or is set to null, the filename will be unchanged.
2763 Meta expansions are applied to the filename: a leading tilde
2765 character will be replaced by the expansion of
2767 except when followed by a valid user name, in which case the home
2768 directory of the given user is used instead.
2773 will be replaced by the expansion of the variable, if possible; \*(UA
2774 .Sx "INTERNAL VARIABLES"
2777 (shell) variables can be accessed through this mechanism, and the usual
2778 escape mechanism has to be applied to prevent interpretation.
2779 If the fully expanded filename results in multiple pathnames and the
2780 command is expecting only one file, an error results.
2782 In interactive context, in order to allow simple value acceptance (via
2784 arguments will usually be displayed in a properly quoted form, e.g., a file
2785 .Ql diet\e is \ecurd.txt
2787 .Ql 'diet\e is \ecurd.txt' .
2791 The following commands are available:
2793 .Bl -tag -width ".Ic _ccount"
2800 ) command which follows.
2804 The comment-command causes the entire line to be ignored.
2806 this really is a normal command which' purpose is to discard its
2809 indicating special character, which means that, e.g., trailing comments
2810 on a line are not possible.
2814 Goes to the next message in sequence and types it
2820 Display the preceding message, or the n'th previous message if given
2821 a numeric argument n.
2825 Show the current message number (the
2830 Show a brief summary of commands.
2831 \*(OP Given an argument a synopsis for the command in question is
2832 shown instead; commands can be abbreviated in general and this command
2833 can be used to see the full expansion of an abbreviation including the
2834 synopsis, try, e.g.,
2839 and see how the output changes.
2849 Interprets the remainder of the word as a macro name and passes it
2854 is a shorter synonym for
2855 .Ql call Ar mymacro .
2859 (ac) Creates, selects or lists (an) account(s).
2860 Accounts are special incarnations of
2862 macros and group commands and variable settings which together usually
2863 arrange the environment for the purpose of creating an email account.
2864 Different to normal macros settings which are covered by
2866 \(en here by default enabled! \(en will not be reverted before the
2871 (case-insensitive) always exists, and all but it can be deleted via
2874 Without arguments a listing of all defined accounts is shown.
2875 With one argument the given account is activated: the system
2877 box of that account will be activated (as via
2879 and a possibly installed
2882 The two argument form is identical to defining a macro as via
2884 .Bd -literal -offset indent
2886 set folder=~/mail MAIL=+syste.mbox record=+sent.mbox
2887 set from='myname@myisp.example (My Name)'
2888 set mta=smtp://mylogin@smtp.myisp.example
2894 (a) With no arguments, shows all currently-defined aliases.
2895 With one argument, shows that alias.
2896 With more than one argument,
2897 creates a new alias or appends to an existing one.
2899 can be used to delete aliases.
2903 (alt) Manage a list of alternate addresses / names of the active user,
2904 members of which will be removed from recipient lists when replying to
2907 variable is not set).
2908 If arguments are given the set of alternate names is replaced by them,
2909 without arguments the current set is displayed.
2913 Takes a message list and marks each message as having been answered.
2914 This mark has no technical meaning in the mail system;
2915 it just causes messages to be marked in the header summary,
2916 and makes them specially addressable.
2921 \*(OP\*(NQ The bind command extends the MLE (see
2922 .Sx "On terminal control and line editor" )
2923 with freely configurable key bindings.
2924 With one argument all bindings for the given context are shown,
2925 specifying an asterisk
2927 will show the bindings of all contexts; a more verbose listing will be
2928 produced if either of
2933 With two or more arguments a binding is (re)established:
2934 the first argument is the context to which the binding shall apply,
2935 the second argument is a comma-separated list of the
2937 which form the binding, and any remaining arguments form the expansion.
2938 To indicate that a binding shall not be auto-committed, but that the
2939 expansion shall instead be furtherly editable by the user, an at-sign
2941 (that will be removed) can be placed last in the expansion, from which
2942 leading and trailing whitespace will finally be removed.
2945 Contexts define when a binding applies, i.e., a binding won't be seen
2946 unless the context for which it is defined for is currently active.
2947 This is not true for the binding
2949 which always applies, but which will be searched secondarily to a more
2950 specialized context and may thus have some or all of its key bindings
2951 transparently replaced by equal bindings of more specialized contexts.
2952 The available contexts are
2954 which always applies, and
2956 which applies to compose-mode.
2960 which form the binding are specified as a comma-separated list of
2961 byte-sequences, where each list entry corresponds to one key(press).
2962 \*(OPally a list entry may, indicated by a leading colon character
2964 also refer to the name of a terminal capability;
2965 several dozen names will be compiled into \*(UA and may be specified
2968 or, if existing, by their
2970 name, regardless of the actually used terminal control library.
2971 It is however possible to use any capability, as long as the name is
2972 resolvable by the control library or defined in the internal variable
2974 Input sequences are not case-normalized, so that an exact match is
2975 required to update or remove a binding.
2978 .Bd -literal -offset indent
2979 bind base $'\eE',d mle-snarf-word-fwd # Esc(ape)
2980 bind base $'\eE',$'\ec?' mle-snarf-word-bwd # Esc, Delete
2981 bind compose :kf1 ~e
2982 bind base $'\ecA',:khome,w 'echo An editable binding@'
2983 bind base a,b,c rm -rf / @ # Another editable binding
2987 Note that the entire comma-separated list is first parsed (over) as a
2988 shell-token with whitespace as the field separator, before being parsed
2989 and expanded for real with comma as the field separator, therefore
2990 whitespace needs to be properly quoted:
2991 shell-style quoting is documented in the introductional section of
2993 Using Unicode reverse solidus escape sequences renders a binding
2994 defunctional if the locale doesn't support Unicode (see
2995 .Sx "Character sets" ) ,
2996 and using terminal capabilities does so if no terminal control support
2997 is (currently) available.
3000 The following terminal capability names are builtin and can be used in
3002 or (if available) the two-letter
3004 notation regardless of the actually used library.
3005 See the respective manual for a list of capabilities.
3008 can be used to show all the capabilities of
3010 or the given terminal type;
3013 flag will also show supported (non-standard) extensions.
3016 .Bl -tag -compact -width kcuuf_or_kcuuf
3017 .It Cd kbs Ns \0or Cd kb
3019 .It Cd kdch1 Ns \0or Cd kD
3021 .It Cd kDC Ns \0or Cd *4
3022 \(em shifted variant.
3023 .It Cd kel Ns \0or Cd kE
3024 Clear to end of line.
3025 .It Cd kext Ns \0or Cd @9
3027 .It Cd kich1 Ns \0or Cd kI
3029 .It Cd kIC Ns \0or Cd #3
3030 \(em shifted variant.
3031 .It Cd khome Ns \0or Cd kh
3033 .It Cd kHOM Ns \0or Cd #2
3034 \(em shifted variant.
3035 .It Cd kend Ns \0or Cd @7
3037 .It Cd knp Ns \0or Cd kN
3039 .It Cd kpp Ns \0or Cd kP
3041 .It Cd kcub1 Ns \0or Cd kl
3042 Left cursor (with more modifiers: see below).
3043 .It Cd kLFT Ns \0or Cd #4
3044 \(em shifted variant.
3045 .It Cd kcuf1 Ns \0or Cd kr
3046 Right cursor (ditto).
3047 .It Cd kRIT Ns \0or Cd %i
3048 \(em shifted variant.
3049 .It Cd kcud1 Ns \0or Cd kd
3050 Down cursor (ditto).
3052 \(em shifted variant (only terminfo).
3053 .It Cd kcuu1 Ns \0or Cd ku
3056 \(em shifted variant (only terminfo).
3057 .It Cd kf0 Ns \0or Cd k0
3059 Add one for each function key up to
3064 .It Cd kf10 Ns \0or Cd k;
3066 .It Cd kf11 Ns \0or Cd F1
3068 Add one for each function key up to
3076 Some terminals support key-modifier combination extensions, e.g.,
3078 For example, the delete key,
3080 in its shifted variant, the name is mutated to
3082 then a number is appended for the states
3094 .Ql Shift+Alt+Control
3096 The same for the left cursor key,
3098 .Cd KLFT , KLFT3 , KLFT4 , KLFT5 , KLFT6 , KLFT7 , KLFT8 .
3101 Key bindings can be removed with the command
3103 It is advisable to use an initial escape or other control character (e.g.,
3105 for bindings which describe user key combinations (as opposed to purely
3106 terminal capability based ones), in order to avoid ambiguities whether
3107 input belongs to key sequences or not; it also reduces search time.
3110 may help shall keys and sequences be falsely recognized.
3115 Calls a macro that has been created via
3120 (ch) Change the working directory to
3122 or the given argument.
3128 \*(OP Only applicable to S/MIME signed messages.
3129 Takes a message list and a file name and saves the certificates
3130 contained within the message signatures to the named file in both
3131 human-readable and PEM format.
3132 The certificates can later be used to send encrypted messages to the
3133 respective message senders by setting
3134 .Va smime-encrypt-USER@HOST
3139 (ch) Change the working directory to
3141 or the given argument.
3147 Only applicable to threaded mode.
3148 Takes a message list and makes all replies to these messages invisible
3149 in header summaries, unless they are in state
3155 \*(OP\*(NQ Manage colour mappings for the type of colour given as the
3156 (case-insensitive) first argument, which must be one of
3158 for 256-colour terminals,
3163 for the standard 8-colour ANSI / ISO 6429 color palette and
3167 for monochrome terminals.
3168 Monochrome terminals cannot deal with colours, but only (some) font
3172 Without further arguments the list of all currently defined mappings
3173 for the given colour type is shown (as a special case giving
3177 will iterate over all types in order).
3178 Otherwise the second argument defines the mappable slot, the third
3179 argument a (comma-separated list of) colour and font attribute
3180 specification(s), and the optional fourth argument can be used to
3181 specify a precondition: if conditioned mappings exist they are tested in
3182 (creation) order unless a (case-insensitive) match has been found, and
3183 the default mapping (if any has been established) will only be chosen as
3185 The types of precondition available depend on the mappable slot, the
3186 following of which exist:
3189 Mappings prefixed with
3191 are used for the \*(OPal builtin Mailx-Line-Editor (MLE, see
3192 .Sx "On terminal control and line editor" )
3193 and don't support preconditions.
3195 .Bl -tag -compact -width view-partinfo
3197 This mapping is used for the position indicator that is visible when
3198 a line cannot be fully displayed on the screen.
3205 Mappings prefixed with
3207 are used in header summaries, and they all understand the preconditions
3209 (the current message) and
3211 for elder messages (only honoured in conjunction with
3212 .Va datefield-markout-older ) .
3214 .Bl -tag -compact -width view-partinfo
3216 This mapping is used for the
3218 that can be created with the
3222 formats of the variable
3225 For the complete header summary line except the
3227 and the thread structure.
3229 For the thread structure which can be created with the
3231 format of the variable
3236 Mappings prefixed with
3238 are used when displaying messages.
3240 .Bl -tag -compact -width view-partinfo
3242 This mapping is used for so-called
3244 lines, which are MBOX file format specific header lines.
3247 A comma-separated list of headers to which the mapping applies may be
3248 given as a precondition; if the \*(OPal regular expression support is
3249 available then if any of the
3251 (extended) regular expression characters is seen the precondition will
3252 be evaluated as (an extended) one.
3254 For the introductional message info line.
3255 .It Cd view-partinfo
3256 For MIME part info lines.
3260 The following (case-insensitive) colour definitions and font attributes
3261 are understood, multiple of which can be specified in a comma-separated
3271 It is possible (and often applicable) to specify multiple font
3272 attributes for a single mapping.
3275 foreground colour attribute:
3285 To specify a 256-color mode a decimal number colour specification in
3286 the range 0 to 255, inclusive, is supported, and interpreted as follows:
3288 .Bl -tag -compact -width "999 - 999"
3290 the standard ISO 6429 colors, as above.
3292 high intensity variants of the standard colors.
3294 216 colors in tuples of 6.
3296 grayscale from black to white in 24 steps.
3298 .Bd -literal -offset indent
3300 fg() { printf "\e033[38;5;${1}m($1)"; }
3301 bg() { printf "\e033[48;5;${1}m($1)"; }
3303 while [ $i -lt 256 ]; do fg $i; i=$(($i + 1)); done
3304 printf "\e033[0m\en"
3306 while [ $i -lt 256 ]; do bg $i; i=$(($i + 1)); done
3307 printf "\e033[0m\en"
3311 background colour attribute (see
3313 for possible values).
3317 Mappings may be removed with the command
3319 For a generic overview see the section
3320 .Sx "Coloured display" .
3325 (C) Copy messages to files whose names are derived from the author of
3326 the respective message and don't mark them as being saved;
3327 otherwise identical to
3332 (c) Copy messages to the named file and don't mark them as being saved;
3333 otherwise identical to
3338 \*(NQ With no arguments, shows all currently-defined custom headers.
3339 With one argument, shows that custom header.
3340 With more than one argument, creates a new or replaces an existing
3341 custom header with the name given as the first argument, the content of
3342 which being defined by the concatenated remaining arguments.
3344 can be used to delete custom headers.
3345 \*(ID Overwriting of automatically managed headers is neither supported
3347 Defined custom headers will be injected into newly composed or forwarded
3350 .Dl customhdr OpenPGP id=12345678; url=http://www.YYY.ZZ
3354 may also be used to inject custom headers; it is covered by
3359 Show the name of the current working directory.
3363 \*(OP For unencrypted messages this command is identical to
3365 Encrypted messages are first decrypted, if possible, and then copied.
3369 \*(OP For unencrypted messages this command is identical to
3371 Encrypted messages are first decrypted, if possible, and then copied.
3375 Without arguments the current list of macros, including their content,
3376 is shown, otherwise a macro is defined.
3377 A macro definition is a sequence of commands in the following form:
3378 .Bd -literal -offset indent
3387 A defined macro can be invoked explicitly by using the
3391 commands, or implicitly if a macro hook is triggered, e.g., a
3393 Note that interpretation of
3395 depends on how (i.e.,
3397 normal macro, folder hook, hook, account switch) the macro is invoked.
3398 Macros can be deleted via
3402 Macro behaviour, including option localization, will change in v15.
3403 Please be aware of that and possibly embed a version check in a resource
3408 (d) Marks the given message list as
3410 Deleted messages will neither be saved in
3412 nor will they be available for most other commands.
3424 Deletes the current message and displays the next message.
3425 If there is no next message, \*(UA says
3432 up or down by one message when given
3436 argument, respectively.
3440 Takes a message list and marks each given message as a draft.
3441 This mark has no technical meaning in the mail system;
3442 it just causes messages to be marked in the header summary,
3443 and makes them specially addressable.
3447 (ec) Echoes its arguments after applying
3449 expansions and filename transformations, as documented for
3454 (e) Point the text editor (as defined in
3456 at each message from the given list in turn.
3457 Modified contents are discarded unless the
3464 .Ic if Ns / Ns Ic elif Ns / Ns Ic else Ns / Ns Ic endif
3465 conditional \(em if the condition of a preceding
3467 was false, check the following condition and execute the following block
3468 if it evaluates true.
3473 .Ic if Ns / Ns Ic elif Ns / Ns Ic else Ns / Ns Ic endif
3474 conditional \(em if none of the conditions of the preceding
3478 commands was true, the
3484 (en) Marks the end of an
3485 .Ic if Ns / Ns Ic elif Ns / Ns Ic else Ns / Ns Ic endif
3486 conditional execution block.
3491 \*(NQ \*(UA has a strict notion about which variables are
3492 .Sx "INTERNAL VARIABLES"
3493 and which are managed in the program
3495 Since some of the latter are a vivid part of \*(UAs functioning,
3496 however, they are transparently integrated into the normal handling of
3497 internal variables via
3501 To integrate other environment variables of choice into this
3502 transparent handling, and also to export internal variables into the
3503 process environment where they normally are not, a
3505 needs to become established with this command, as in, e.g.,
3508 .Dl environ link PERL5LIB from TZ
3511 Afterwards changing such variables with
3513 will cause automatic updates of the program environment, and therefore
3514 be inherited by newly created child processes.
3515 Sufficient system support provided (it was in BSD as early as 1987, and
3516 is standardized since Y2K) removing such variables with
3518 will remove them also from the program environment, but in any way
3519 the knowledge they ever have been
3522 Note this implies that
3524 may cause loss of links.
3529 will remove an existing link, but leaves the variables as such intact.
3530 Additionally the subcommands
3534 are provided, which work exactly the same as the documented commands
3538 but (additionally) link the variable(s) with the program environment and
3539 thus immediately export them to, or remove them from (if possible),
3540 respectively, the program environment.
3545 \*(OP Since \*(UA uses the console as a user interface it can happen
3546 that messages scroll by too fast to become recognized.
3547 Optionally an error message ring queue is available which stores
3548 duplicates of any error message and notifies the user in interactive
3549 sessions whenever a new error has occurred.
3550 The queue is finite: if its maximum size is reached any new message
3551 replaces the eldest.
3554 can be used to manage this message queue: if given
3556 or no argument the queue will be displayed and cleared,
3558 will only clear all messages from the queue.
3562 (ex or x) Exit from \*(UA without changing the active mailbox and skip
3563 any saving of messages in
3565 as well as a possibly tracked line editor history file.
3569 Show the list of features that have been compiled into \*(UA.
3570 (Outputs the contents of the variable
3577 but open the mailbox readonly.
3581 (fi) The file command switches to a new mailbox.
3582 Without arguments it shows status information of the current mailbox.
3583 If an argument is given, it will write out changes (such as deletions)
3584 the user has made and open a new mailbox.
3585 Some special conventions are recognized for the
3589 .Bl -tag -compact -offset indent -width ".Ar %:__lespec"
3591 (number sign) means the previous file,
3593 (percent sign) means the invoking user's system
3597 means the primary system mailbox of
3599 (and never the value of
3601 regardless of its actual setting),
3603 (ampersand) means the invoking user's
3613 expands to the same value as
3615 but the file is handled as a primary system mailbox by, e.g., the
3619 commands, meaning that messages that have been read in the current
3620 session will be moved to the
3622 mailbox instead of simply being flagged as read.
3625 If the name matches one of the strings defined with the command
3627 it is replaced by its long form and expanded.
3628 If the name ends with
3633 it is treated as being compressed with
3638 respectively, and transparently handled through an intermediate
3639 (un)compression step (using a temporary file) with the according
3640 facility, sufficient support provided.
3641 Likewise, if the named file doesn't exist, but a file with one of the
3642 mentioned compression extensions does, then the name is automatically
3643 expanded and the compressed file is used.
3645 Otherwise, if the name ends with an extension for which
3646 .Va file-hook-load-EXTENSION
3648 .Va file-hook-save-EXTENSION
3649 variables are set, then the given hooks will be used to load and save
3651 and \*(UA will work with an intermediate temporary file.
3653 MBOX files (flat file-based mailboxes) are generally locked during file
3654 operations in order to avoid inconsistencies due to concurrent
3656 \*(OPal Mailbox files which \*(UA treats as system
3658 boxes or primary mailboxes will also be protected by so-called dotlock
3659 files, the traditional way of mail spool file locking: for any file
3663 will be created for the duration of the synchronization \(em
3664 as necessary a privilege-separated dotlock child process will be used
3665 to accommodate for necessary privilege adjustments in order to create
3666 the dotlock file in the same directory
3667 and with the same user and group identities as the file of interest.
3670 for fine-tuning the handling of MBOX files.
3674 refers to a directory with the subdirectories
3679 then it is treated as a folder in
3681 format; \*(ID the variable
3683 can be used to control the format of yet non-existent folders.
3686 .Dl \*(IN protocol://[user[:password]@]host[:port][/path]
3687 .Dl \*(OU protocol://[user@]host[:port][/path]
3689 is taken as an Internet mailbox specification.
3690 The \*(OPally supported protocols are
3694 (POP3 with SSL/TLS encrypted transport).
3697 part is valid only for IMAP; there it defaults to
3699 Also see the section
3700 .Sx "On URL syntax and credential lookup" .
3704 contains special characters, in particular
3708 they must be escaped in URL notation \(en the command
3710 can be used to show the necessary conversion.
3714 Takes a message list and marks the messages as
3716 ged for urgent/special attention.
3717 This mark has no technical meaning in the mail system;
3718 it just causes messages to be highlighted in the header summary,
3719 and makes them specially addressable.
3728 With no arguments, list the names of the folders in the folder directory.
3729 With an existing folder as an argument,
3730 lists the names of folders below the named folder.
3736 but saves the message in a file named after the local part of the first
3737 recipient's address (instead of in
3744 but saves the message in a file named after the local part of the first
3745 recipient's address (instead of in
3752 but responds to all recipients regardless of the
3757 .It Ic followupsender
3760 but responds to the sender only regardless of the
3776 (f) Takes a list of message specifications and displays a summary of
3777 their message headers, exactly as via
3779 An alias of this command is
3782 .Sx "Specifying messages" .
3788 but saves the message in a file named after the local part of the
3789 recipient's address (instead of in
3794 Takes a message and the address of a recipient
3795 and forwards the message to him.
3796 The text of the original message is included in the new one,
3797 with the value of the
3799 variable preceding it.
3804 commands specify which header fields are included in the new message.
3805 Only the first part of a multipart message is included unless the
3806 .Va forward-as-attachment
3810 is set recipient addresses will be stripped from comments, names etc.
3814 Specifies which header fields are to be ignored with the command
3816 This command has no effect when the
3817 .Va forward-as-attachment
3822 Specifies which header fields are to be retained with the command
3827 This command has no effect when the
3828 .Va forward-as-attachment
3833 Define or list command aliases, so-called ghosts.
3834 Without arguments a list of all currently known aliases is shown.
3835 With one argument the expansion of the given alias is shown.
3836 With two or more arguments a command alias is defined or updated: the
3837 first argument is the name under which the remaining command line should
3838 be accessible, the content of which can be just about anything.
3839 A ghost can be used everywhere a normal command can be used, but always
3840 takes precedence; any arguments that are given to the command alias are
3841 joined onto the alias content, and the resulting string forms the
3842 command line that is, in effect, executed.
3845 .Bd -literal -offset indent
3847 `ghost': no such alias: "xx"
3850 ghost xx "echo hello,"
3859 (h) Show the current group of headers, the size of which depends on
3862 and the style of which can be adjusted with the variable
3864 If a message-specification is given the group of headers containing the
3865 first message therein is shown and the message at the top of the screen
3880 the list of history entries;
3883 argument selects and shows the respective history entry \(en
3886 to accept it, and the history entry will become the new history top.
3887 The default mode if no arguments are given is
3894 Takes a message list and marks each message therein to be saved in the
3899 Does not override the
3902 \*(UA deviates from the POSIX standard with this command, because a
3904 command issued after
3906 will display the following message, not the current one.
3911 (i) Part of the nestable
3912 .Ic if Ns / Ns Ic elif Ns / Ns Ic else Ns / Ns Ic endif
3913 conditional execution construct \(em if the given condition is true then
3914 the encapsulated block is executed.
3915 POSIX only supports the (case-insensitive) conditions
3920 end, all remaining conditions are non-portable extensions; note that
3921 falsely specified conditions cause the execution of the entire
3922 conditional construct until the (matching) closing
3924 command to be suppressed.
3925 The syntax of the nestable
3927 conditional execution construct requires that each condition and syntax
3928 element is surrounded by whitespace.
3930 .Bd -literal -offset indent
3939 The (case-insensitive) condition
3941 erminal will evaluate to true if the standard input is a terminal, i.e.,
3942 in interactive sessions.
3943 Another condition can be any boolean value (see the section
3944 .Sx "INTERNAL VARIABLES"
3945 for textual boolean representations) to mark an enwrapped block as
3948 .Dq always execute .
3949 It is possible to check
3950 .Sx "INTERNAL VARIABLES"
3953 variables for existence or compare their expansion against a user given
3954 value or another variable by using the
3956 .Pf ( Dq variable next )
3957 conditional trigger character;
3958 a variable on the right hand side may be signalled using the same
3960 The variable names may be enclosed in a pair of matching braces.
3963 The available comparison operators are
3967 (less than or equal to),
3973 (greater than or equal to),
3977 (is substring of) and
3979 (is not substring of).
3980 The values of the left and right hand side are treated as strings and
3981 are compared 8-bit byte-wise, ignoring case according to the rules of
3982 the US-ASCII encoding (therefore, dependent on the active locale,
3983 possibly producing false results for strings in the locale encoding).
3984 Except for the substring checks the comparison will instead be performed
3985 arithmetically if both, the user given value as well as the variable
3986 content, can be parsed as numbers (integers).
3987 An unset variable is treated as the empty string.
3990 When the \*(OPal regular expression support is available, the additional
3996 They treat the right hand side as an extended regular expression that is
3997 matched case-insensitively and according to the active
3999 locale, meaning that strings in the locale encoding should be matched
4003 Conditions can be joined via AND-OR lists (where the AND operator is
4005 and the OR operator is
4007 which have equal precedence and will be evaluated with left
4008 associativity, thus using the same syntax that is known for the
4010 It is also possible to form groups of conditions and lists by enclosing
4011 them in pairs of brackets
4012 .Ql [\ \&.\&.\&.\ ] ,
4013 which may be interlocked within each other, and also be joined via
4017 The results of individual conditions and entire groups may be modified
4018 via unary operators: the unary operator
4020 will reverse the result.
4022 .Bd -literal -offset indent
4026 if $ttycharset == "UTF-8"
4027 echo *ttycharset* is set to UTF-8, case-insensitively
4031 echo These two variables are equal
4033 if $version-major >= 15
4034 echo Running a new version..
4035 if $features =@ +regex
4036 if $TERM =~ "^xterm\&.*"
4037 echo ..in an X terminal
4040 if [ [ true ] && [ [ ${debug} ] || [ $verbose ] ] ]
4043 if true && $debug || ${verbose}
4044 echo Left associativity, as is known from the shell
4046 if ! ! true && ! [ ! $debug && ! $verbose ]
4047 echo Unary operator support
4055 Without arguments the list of ignored header fields is shown,
4056 otherwise the given list of header fields is added to the ignore list:
4057 Header fields in the ignore list are not shown on the terminal when
4058 a message is displayed.
4059 To display a message in its entirety, use the commands
4070 Shows the names of all available commands, alphabetically sorted.
4071 If given any non-whitespace argument the list will be shown in the order
4072 in which command prefixes are searched.
4075 output is available.
4079 This command can be used to localize changes to variables, meaning that
4080 their state will be reverted to the former one once the covered scope
4082 It can only be used inside of macro definition blocks introduced by
4086 and is interpreted as a boolean (string, see
4087 .Sx "INTERNAL VARIABLES" ) ;
4090 of an account is left once it is switched off again.
4091 .Bd -literal -offset indent
4092 define temporary_settings {
4107 enables change localization and calls
4109 which explicitly resets localization, then any value changes within
4111 will still be reverted by
4113 \*(ID Once the outermost level, the one which enabled localization
4114 first, is left, but no earlier, all adjustments will be unrolled.
4118 Reply to messages that come in via known
4121 .Pf ( Ic mlsubscribe )
4122 mailing lists, or pretend to do so (see
4123 .Sx "Mailing lists" ) :
4126 functionality this will actively resort and even remove message
4127 recipients in order to generate a message that is supposed to be sent to
4129 For example it will also implicitly generate a
4130 .Ql Mail-Followup-To:
4131 header if that seems useful, regardless of the setting of the variable
4138 but saves the message in a file named after the local part of the first
4139 recipient's address (instead of in
4144 (m) Takes a (list of) recipient address(es) as (an) argument(s),
4145 or asks on standard input if none were given;
4146 then collects the remaining mail content and sends it out.
4150 (mb) The given message list is to be sent to
4152 when \*(UA is quit; this is the default action unless the
4155 \*(ID This command can only be used in a primary system mailbox (see
4160 Without any arguments the content of the MIME type cache will displayed.
4161 Otherwise each argument defines a complete MIME type specification of
4162 a type that shall be added (prepended) to the cache.
4163 In any event MIME type sources are loaded first as necessary \(en
4164 .Va mimetypes-load-control
4165 can be used to fine-tune which sources are actually loaded.
4166 Refer to the section on
4167 .Sx "The mime.types files"
4168 for more on MIME type specifications and this topic in general.
4169 MIME type unregistration and cache resets can be triggered with
4174 Without arguments the list of all currently defined mailing lists
4175 (and their attributes, if any) is shown; a more verbose listing will be
4176 produced if either of
4181 Otherwise all given arguments (which need not be quoted except for
4182 whitespace) will be added and henceforth be recognized as mailing lists.
4183 Mailing lists may be removed via the command
4186 If the \*(OPal regular expression support is available then mailing
4187 lists may also be specified as (extended) regular expressions (see
4193 Without arguments the list of all currently defined mailing lists which
4194 have a subscription attribute is shown; a more verbose listing will be
4195 produced if either of
4200 Otherwise this attribute will be set for all given mailing lists,
4201 newly creating them as necessary (as via
4203 Subscription attributes may be removed via the command
4212 but moves the messages to a file named after the local part of the
4213 sender address of the first message (instead of in
4220 but marks the messages for deletion if they were transferred
4227 but also displays ignored header fields and all MIME parts.
4235 on the given messages, even in non-interactive mode and as long as the
4236 standard output is a terminal.
4242 \*(OP When used without arguments or if
4244 has been given the content of the
4246 cache is shown, loading it first as necessary.
4249 then the cache will only be initialized and
4251 will remove its contents.
4252 Note that \*(UA will try to load the file only once, use
4253 .Ql Ic \&\&netrc Ns \:\0\:clear
4254 to unlock further attempts.
4259 .Sx "On URL syntax and credential lookup" ;
4261 .Sx "The .netrc file"
4262 documents the file format in detail.
4266 Checks for new mail in the current folder without committing any changes
4268 If new mail is present, a message is shown.
4272 the headers of each new message are also shown.
4273 This command is not available for all mailbox types.
4281 Goes to the next message in sequence and types it.
4282 With an argument list, types the next matching message.
4296 If the current folder is accessed via a network connection, a
4298 command is sent, otherwise no operation is performed.
4304 but also displays ignored header fields and all MIME parts.
4312 on the given messages, even in non-interactive mode and as long as the
4313 standard output is a terminal.
4321 but also pipes ignored header fields and all parts of MIME
4322 .Ql multipart/alternative
4327 (pi) Takes a message list and a shell command
4328 and pipes the messages through the command.
4329 Without an argument the current message is piped through the command
4336 every message is followed by a formfeed character.
4357 (q) Terminates the session, saving all undeleted, unsaved messages in
4360 preserving all messages marked with
4364 or never referenced in the system
4366 box, and removing all other messages from the primary system mailbox.
4367 If new mail has arrived during the session,
4369 .Dq You have new mail
4371 If given while editing a mailbox file with the command line flag
4373 then the edit file is rewritten.
4374 A return to the shell is effected,
4375 unless the rewrite of edit file fails,
4376 in which case the user can escape with the exit command.
4390 Removes the named files or directories.
4391 If a name refer to a mailbox, e.g., a Maildir mailbox, then a mailbox
4392 type specific removal will be performed, deleting the complete mailbox.
4393 The user is asked for confirmation in interactive mode.
4397 Takes the name of an existing folder
4398 and the name for the new folder
4399 and renames the first to the second one.
4400 Both folders must be of the same type.
4404 (R) Reply to originator.
4405 Does not reply to other recipients of the original message.
4407 will exchange this command with
4411 is set the recipient address will be stripped from comments, names etc.
4415 (r) Take a message and group-responds to it by addressing the sender
4418 .Va followup-to-honour ,
4421 .Va recipients-in-cc
4422 influence response behaviour.
4425 offers special support for replying to mailing lists.
4428 is set recipient addresses will be stripped from comments, names etc.
4441 but initiates a group-reply regardless of the value of
4448 but responds to the sender only regardless of the value of
4455 but does not add any header lines.
4456 This is not a way to hide the sender's identity,
4457 but useful for sending a message again to the same recipients.
4461 Takes a list of messages and a user name
4462 and sends each message to the named user.
4464 and related header fields are prepended to the new copy of the message.
4482 .It Ic respondsender
4488 (ret) Without arguments the list of retained header fields is shown,
4489 otherwise the given list of header fields is added to the retain list:
4490 Header fields in the retain list are shown on the terminal when
4491 a message is displayed, all other header fields are suppressed.
4492 To display a message in its entirety, use the commands
4501 takes precedence over the mentioned.
4507 but saves the messages in a file named after the local part of the
4508 sender of the first message instead of (in
4510 and) taking a filename argument.
4514 (s) Takes a message list and a filename and appends each message in turn
4515 to the end of the file.
4516 If no filename is given, the
4519 The filename in quotes, followed by the generated character count
4520 is echoed on the user's terminal.
4521 If editing a primary system mailbox the messages are marked for deletion.
4522 Filename interpretation as described for the
4524 command is performed.
4541 Header fields thus marked are filtered out when saving a message by
4543 or when automatically saving to
4545 This command should only be applied to header fields that do not contain
4546 information needed to decode the message,
4547 as MIME content fields do.
4559 Header fields thus marked are the only ones saved with a message when
4562 or when automatically saving to
4567 The use of this command is strongly discouraged since it may strip
4568 header fields that are needed to decode the message correctly.
4572 Takes a message specification (list) and displays a header summary of
4573 all matching messages, as via
4575 This command is an alias of
4578 .Sx "Specifying messages" .
4582 Takes a message list and marks all messages as having been read.
4586 (se) Without arguments this command shows all internal variables which
4587 are currently known to \*(UA (they have been set).
4588 A more verbose listing will be produced if either of
4592 are set, in which case variables may be preceded with a comment line
4593 that gives some context of what \*(UA knows about the given variable.
4595 Otherwise the given variables (and arguments) are set or adjusted.
4596 Arguments are of the form
4598 (no space before or after
4602 if there is no value, i.e., a boolean variable.
4603 Quotation marks may be placed around any part of the assignment
4604 statement to quote blanks or tabs, e.g.,
4606 .Dl set indentprefix='->'
4608 If an argument begins with
4612 the effect is the same as invoking the
4614 command with the remaining part of the variable
4615 .Pf ( Ql unset save ) .
4619 that is known to map to an environment variable will automatically cause
4620 updates in the program environment (unsetting a variable in the
4621 environment requires corresponding system support).
4622 Please use the command
4624 for further environmental control.
4629 .Sx "INTERNAL VARIABLES"
4635 (sh) Invokes an interactive version of the shell.
4639 Without arguments the list of all currently defined shortcuts is
4641 Otherwise all given arguments (which need not be quoted except for
4642 whitespace) are treated as pairs of shortcuts and their expansions,
4643 creating new or changing already existing shortcuts, as necessary.
4644 Shortcuts may be removed via the command
4646 The expansion strings should be in the syntax that has been described
4655 but performs neither MIME decoding nor decryption, so that the raw
4656 message text is shown.
4660 (si) Shows the size in characters of each message of the given
4665 Shows the current sorting criterion when used without an argument.
4666 Otherwise creates a sorted representation of the current folder,
4669 command and the addressing modes such that they refer to messages in
4671 Message numbers are the same as in regular mode.
4675 a header summary in the new order is also displayed.
4676 Automatic folder sorting can be enabled by setting the
4678 variable, as in, e.g.,
4679 .Ql set autosort=thread .
4680 Possible sorting criterions are:
4682 .Bl -tag -compact -offset indent -width "subject"
4684 Sort the messages by their
4686 field, that is by the time they were sent.
4688 Sort messages by the value of their
4690 field, that is by the address of the sender.
4693 variable is set, the sender's real name (if any) is used.
4695 Sort the messages by their size.
4697 \*(OP Sort the message by their spam score, as has been classified by
4700 Sort the messages by their message status.
4702 Sort the messages by their subject.
4704 Create a threaded display.
4706 Sort messages by the value of their
4708 field, that is by the address of the recipient.
4711 variable is set, the recipient's real name (if any) is used.
4716 (so) The source command reads commands from the given file, which is
4717 subject to the usual filename expansions (see introductional words of
4719 If the given argument ends with a vertical bar
4721 then the argument will instead be interpreted as a shell command and
4722 \*(UA will read the output generated by it.
4725 cannot be used from within macros that execute as
4726 .Va folder-hook Ns s
4729 i.e., it can only be called from macros that were
4736 (beside not supporting pipe syntax aka shell command input) is that
4737 this command will not generate an error if the given file argument
4738 cannot be opened successfully.
4739 This can matter in, e.g., resource files, since loading of those is
4740 stopped when an error is encountered.
4744 \*(OP Takes a list of messages and clears their
4750 \*(OP Takes a list of messages and causes the
4752 to forget it has ever used them to train its Bayesian filter.
4753 Unless otherwise noted the
4755 flag of the message is inspected to chose whether a message shall be
4763 \*(OP Takes a list of messages and informs the Bayesian filter of the
4767 This also clears the
4769 flag of the messages in question.
4773 \*(OP Takes a list of messages and rates them using the configured
4774 .Va spam-interface ,
4775 without modifying the messages, but setting their
4777 flag as appropriate; because the spam rating headers are lost the rate
4778 will be forgotten once the mailbox is left.
4779 Refer to the manual section
4781 for the complete picture of spam handling in \*(UA.
4785 \*(OP Takes a list of messages and sets their
4791 \*(OP Takes a list of messages and informs the Bayesian filter of the
4797 flag of the messages in question.
4806 Create a threaded representation of the current folder,
4807 i.\|e. indent messages that are replies to other messages in the header
4808 display and change the
4810 command and the addressing modes such that they refer to messages in the
4812 Message numbers are the same as in unthreaded mode.
4816 a header summary in threaded order is also displayed.
4830 (to) Takes a message list and types out the first
4832 lines of each message on the users' terminal.
4833 The only header fields that are displayed are
4840 will instead honour configured lists).
4841 It is possible to apply compression to what is displayed by setting
4843 Messages are decrypted and converted to the terminal character set
4848 (tou) Takes a message list and marks the messages for saving in
4850 \*(UA deviates from the POSIX standard with this command,
4853 command will display the following message instead of the current one.
4859 but also displays out ignored header fields and all parts of MIME
4860 .Ql multipart/alternative
4865 (t) Takes a message list and types out each message on the users'
4871 For MIME multipart messages, all parts with a content type of
4875 are shown, the other are hidden except for their headers.
4876 Messages are decrypted and converted to the terminal character set
4881 Delete all given accounts.
4882 An error message is shown if a given account is not defined.
4885 will discard all existing accounts.
4889 (una) Takes a list of names defined by alias commands
4890 and discards the remembered groups of users.
4893 will discard all existing aliases.
4897 Takes a message list and marks each message as not having been answered.
4903 ing, specified by its context and input sequence, both of which may be
4904 specified as a wildcard (asterisk,
4908 will remove all bindings of all contexts.
4912 Only applicable to threaded mode.
4913 Takes a message list and makes the message and all replies to it visible
4914 in header summaries again.
4915 When a message becomes the current message,
4916 it is automatically made visible.
4917 Also when a message with collapsed replies is displayed,
4918 all of these are automatically uncollapsed.
4924 mapping for the given colour type (see
4926 for a list of types) and mapping; if the optional precondition argument
4927 is used then only the exact tuple of mapping and precondition is removed.
4930 will remove all mappings (no precondition allowed).
4932 .Sx "Coloured display"
4933 for the general picture.
4937 Deletes the custom headers given as arguments.
4940 will remove all custom headers.
4944 Undefine all given macros.
4945 An error message is shown if a given macro is not defined.
4948 will discard all existing macros.
4952 (u) Takes a message list and marks each message as not being deleted.
4956 Takes a message list and
4962 Takes a message list and marks each message as not being
4967 Removes the header field names from the list of ignored fields for the
4972 will remove all fields.
4976 Removes the header field names from the list of retained fields for the
4981 will remove all fields.
4985 Remove all the given command
4989 will remove all ghosts.
4993 Removes the header field names from the list of ignored fields.
4996 will remove all fields.
5000 Delete all given MIME types, e.g.,
5001 .Ql unmimetype text/plain
5002 will remove all registered specifications for the MIME type
5006 will discard all existing MIME types, just as will
5008 but which also reenables cache initialization via
5009 .Va mimetypes-load-control .
5013 Forget about all the given mailing lists.
5016 will remove all lists.
5021 .It Ic unmlsubscribe
5022 Remove the subscription attribute from all given mailing lists.
5025 will clear the attribute from all lists which have it set.
5036 Takes a message list and marks each message as not having been read.
5040 Removes the header field names from the list of retained fields.
5043 will remove all fields.
5047 Removes the header field names from the list of ignored fields for
5051 will remove all fields.
5055 Removes the header field names from the list of retained fields for
5059 will remove all fields.
5063 (uns) Takes a list of internal variable names and discards their
5064 remembered values; the reverse of
5071 Deletes the shortcut names given as arguments.
5074 will remove all shortcuts.
5078 Disable sorted or threaded mode
5084 return to normal message order and,
5088 displays a header summary.
5098 Decode the given URL-encoded string arguments and show the results.
5099 Note the resulting strings may not be valid in the current locale, see
5104 URL-encode the given arguments and show the results.
5105 Because the arguments effectively are in the character set of the
5106 current locale the results will vary accordingly unless the input solely
5107 consists of characters in the portable character set, see
5108 .Sx "Character sets" .
5112 Edit the values of or create the given variable(s) in the
5114 Boolean variables cannot be edited.
5118 This command produces the same output as the listing mode of
5122 ity adjustments, but only for the given variables.
5126 \*(OP Takes a message list and verifies each message.
5127 If a message is not a S/MIME signed message,
5128 verification will fail for it.
5129 The verification process checks if the message was signed using a valid
5131 if the message sender's email address matches one of those contained
5132 within the certificate,
5133 and if the message content has been altered.
5137 (v) Takes a message list and invokes the display editor on each message.
5138 Modified contents are discarded unless the
5144 (w) For conventional messages the body without all headers is written.
5145 The output is decrypted and converted to its native format as necessary.
5146 If the output file exists, the text is appended.
5147 If a message is in MIME multipart format its first part is written to
5148 the specified file as for conventional messages,
5149 and the user is asked for a filename to save each other part.
5150 For convience saving of each part may be skipped by giving an empty value;
5151 the same result can also be achieved by writing it to
5153 For the second and subsequent parts a leading
5155 character causes the part to be piped to the remainder of the user input
5156 interpreted as a shell command;
5157 otherwise the user input is expanded as usually for folders,
5158 e.g., tilde expansion is performed.
5159 In non-interactive mode, only the parts of the multipart message
5160 that have a filename given in the part header are written,
5161 the others are discarded.
5162 The original message is never marked for deletion in the originating
5165 the contents of the destination file are overwritten if the file
5167 No special handling of compressed files is performed.
5176 \*(UA presents message headers in windowfuls as described under the
5179 This command scrolls to the next window of messages.
5180 If an argument is given, it specifies the window to use.
5181 A number prefixed by
5185 indicates that the window is calculated in relation to the current position.
5186 A number without a prefix specifies an absolute window number,
5189 lets \*(UA scroll to the last window of messages.
5195 but scrolls to the next or previous window that contains at least one
5204 .\" .Sh TILDE ESCAPES {{{
5207 Here is a summary of the tilde escapes,
5208 which are used to perform special functions when composing messages.
5209 Tilde escapes are only recognized at the beginning of lines.
5212 is somewhat of a misnomer since the actual escape character can be
5213 changed by adjusting the option
5216 .Bl -tag -width ".Ic __ filename"
5219 Insert the string of text in the message prefaced by a single
5221 (If the escape character has been changed,
5222 that character must be doubled
5223 in order to send it at the beginning of a line.)
5226 .It Ic ~! Ar command
5227 Execute the indicated shell
5229 then return to the message.
5233 Same effect as typing the end-of-file character.
5236 .It Ic ~: Ar \*(UA-command Ns \0or Ic ~_ Ar \*(UA-command
5237 Execute the given \*(UA command.
5238 Not all commands, however, are allowed.
5242 Write a summary of command escapes.
5245 .It Ic ~< Ar filename
5250 .It Ic ~<! Ar command
5252 is executed using the shell.
5253 Its standard output is inserted into the message.
5256 .It Ic ~@ Op Ar filename...
5257 With no arguments, edit the attachment list interactively.
5258 If an attachment's file name is left empty,
5259 that attachment is deleted from the list.
5260 When the end of the attachment list is reached,
5261 \*(UA will ask for further attachments until an empty name is given.
5262 If a given file name solely consists of the number sign
5264 followed by a valid message number of the currently active mailbox, then
5265 the given message is attached as a MIME
5267 and the rest of this section does not apply.
5269 If character set conversion has been compiled into \*(UA, then this mode
5270 gives the user the option to specify input and output character sets,
5271 unless the file extension indicates binary content, in which case \*(UA
5272 asks whether this step shall be skipped for the attachment in question.
5273 If not skipped, then the charset that succeeds to represent the
5274 attachment data will be used in the
5276 MIME parameter of the mail message:
5278 .Bl -bullet -compact
5280 If input and output character sets are specified, then the conversion is
5281 performed on the fly.
5282 The user will be asked repeatedly until the desired conversion succeeds.
5284 If only an output character set is specified, then the input is assumed
5287 charset and will be converted to the given output charset on the fly.
5288 The user will be asked repeatedly until the desired conversion succeeds.
5290 If no character sets are specified at all then the algorithm that is
5291 documented in the section
5292 .Sx "Character sets"
5293 is applied, but directly and on the fly.
5294 The user will be asked repeatedly until the desired conversion succeeds.
5296 Finally, if an input-, but no output character set is specified, then no
5297 conversion is ever performed, but the
5299 MIME parameter value will still be set to the user input.
5301 The character set selection loop can be left by typing
5303 i.e., causing an interrupt.
5304 .\" \*(OU next sentence
5305 Note that before \*(UA version 15.0 this terminates the entire
5306 current attachment selection, not only the character set selection.
5309 Without character set conversion support, \*(UA will ask for the input
5310 character set only, and it'll set the
5312 MIME parameter value to the given input, if any;
5313 if no user input is seen then the
5315 character set will be used for the parameter value instead.
5316 Note that the file extension check isn't performed in this mode, since
5317 no conversion will take place anyway.
5319 Note that in non-interactive mode, for reproduceabilities sake, there
5320 will always be two questions for each attachment, regardless of whether
5321 character set conversion is available and what the file extension is.
5322 The first asks for the filename, and the second asks for the input
5323 character set to be passed through to the corresponding MIME parameter;
5324 no conversion will be tried if there is input to the latter question,
5325 otherwise the usual conversion algorithm, as above, is applied.
5326 For message attachments, the answer to the second question is completely
5331 arguments are specified for the
5333 command they are treated as a file list of
5335 -style quoted arguments, optionally also separated by commas, which are
5336 expanded and then appended to the existing list of message attachments.
5337 Message attachments can only be added via the first method.
5338 In this mode the (text) attachments are assumed to be in
5340 encoding, and will be evaluated as documented in the section
5341 .Sx "Character sets" .
5345 Inserts the string contained in the
5348 .Ql Ic ~i Ns \0Sign ) .
5349 The escape sequences tabulator
5357 Inserts the string contained in the
5360 .Ql Ic ~i Ns \0sign ) .
5361 The escape sequences tabulator
5368 .It Ic ~b Ar name ...
5369 Add the given names to the list of blind carbon copy recipients.
5372 .It Ic ~c Ar name ...
5373 Add the given names to the list of carbon copy recipients.
5377 Read the file specified by the
5379 variable into the message.
5383 Invoke the text editor on the message collected so far.
5384 After the editing session is finished,
5385 the user may continue appending text to the message.
5388 .It Ic ~F Ar messages
5389 Read the named messages into the message being sent, including all
5390 message headers and MIME parts.
5391 If no messages are specified, read in the current message.
5394 .It Ic ~f Ar messages
5395 Read the named messages into the message being sent.
5396 If no messages are specified, read in the current message.
5400 lists are used to modify the message headers.
5401 For MIME multipart messages,
5402 only the first displayable part is included.
5406 Edit the message header fields
5411 by typing each one in turn and allowing the user to edit the field.
5412 The default values for these fields originate from the
5420 Edit the message header fields
5426 by typing each one in turn and allowing the user to edit the field.
5429 .It Ic ~i Ar variable
5430 Insert the value of the specified variable into the message,
5431 adding a newline character at the end.
5432 The message remains unaltered if the variable is unset or empty.
5433 The escape sequences tabulator
5440 .It Ic ~M Ar messages
5441 Read the named messages into the message being sent,
5444 If no messages are specified, read the current message.
5447 .It Ic ~m Ar messages
5448 Read the named messages into the message being sent,
5451 If no messages are specified, read the current message.
5455 lists are used to modify the message headers.
5456 For MIME multipart messages,
5457 only the first displayable part is included.
5461 Display the message collected so far,
5462 prefaced by the message header fields
5463 and followed by the attachment list, if any.
5467 Abort the message being sent,
5468 copying it to the file specified by the
5475 .It Ic ~R Ar filename
5476 Read the named file into the message, indented by
5480 .It Ic ~r Ar filename
5481 Read the named file into the message.
5485 Cause the named string to become the current subject field.
5488 .It Ic ~t Ar name ...
5489 Add the given name(s) to the direct recipient list.
5492 .It Ic ~U Ar messages
5493 Read in the given / current message(s) excluding all headers, indented by
5497 .It Ic ~u Ar messages
5498 Read in the given / current message(s), excluding all headers.
5502 Invoke an alternate editor (defined by the
5504 option) on the message collected so far.
5505 Usually, the alternate editor will be a screen editor.
5506 After the editor is quit,
5507 the user may resume appending text to the end of the message.
5510 .It Ic ~w Ar filename
5511 Write the message onto the named file.
5513 the message is appended to it.
5519 except that the message is not saved at all.
5522 .It Ic ~| Ar command
5523 Pipe the message through the specified filter command.
5524 If the command gives no output or terminates abnormally,
5525 retain the original text of the message.
5528 is often used as a rejustifying filter.
5533 .\" .Sh INTERNAL VARIABLES {{{
5534 .Sh "INTERNAL VARIABLES"
5536 Internal \*(UA variables are controlled via the
5540 commands; prefixing a variable name with the string
5544 has the same effect as using
5550 Creation or editing of variables can be performed in the
5555 will give more insight on the given variable(s), and
5557 when called without arguments, will show a listing of all variables.
5558 Some well-known variables will also become inherited from the
5561 implicitly, others can be explicitly imported with the command
5563 and henceforth share the said properties.
5566 Two different kind of internal variables exist.
5567 There are boolean variables, which can only be in one of the two states
5571 and value variables with a(n optional) string value.
5572 For the latter proper quoting is necessary upon assignment time, the
5573 introduction of the section
5575 documents the supported quoting rules.
5577 .Bd -literal -offset indent
5578 wysh set one=val\e 1 two="val 2" \e
5579 three='val "3"' four=$'val \e'4\e''
5580 varshow one two three four
5581 unset one two three four
5585 Dependent upon the actual option the string values will be interpreted
5586 as numbers, colour names, normal text etc., but there also exists
5587 a special kind of string value, the
5588 .Dq boolean string ,
5589 which must either be a decimal integer (in which case
5593 and any other value is true) or any of the (case-insensitive) strings
5598 for a false boolean and
5603 for a true boolean; a special kind of boolean string is the
5605 which is a boolean string that can optionally be prefixed with the
5606 (case-insensitive) term
5610 which causes prompting of the user in interactive mode, with the given
5611 boolean as the default value.
5613 .\" .Ss "Initial settings" {{{
5614 .\" (Keep in SYNC: ./nail.h:okeys, ./nail.rc, ./nail.1:"Initial settings")
5615 .Ss "Initial Settings"
5617 The standard POSIX 2008/Cor 1-2013 mandates the following initial
5623 .Pf no Va autoprint ,
5637 .Pf no Va ignoreeof ,
5639 .Pf no Va keepsave ,
5641 .Pf no Va outfolder ,
5646 (note that \*(UA deviates from the standard by using
5650 special prompt escape results in
5658 .Pf no Va sendwait ,
5667 Notes: \*(UA doesn't support the
5669 variable \(en use command line options or
5671 to pass options through to a
5673 And the default global
5675 file (which is loaded unless the
5677 command line flag has been used or the
5678 .Ev NAIL_NO_SYSTEM_RC
5679 environment variable is set) bends those initial settings a bit, e.g.,
5680 it sets the variables
5685 to name a few, calls
5687 etc., and should thus be taken into account.
5690 .\" .Ss "Variables" {{{
5693 .Bl -tag -width ".It Va _utoprin_"
5695 .It Va add-file-recipients
5696 \*(BO When file or pipe recipients have been specified,
5697 mention them in the corresponding address fields of the message instead
5698 of silently stripping them from their recipient list.
5699 By default such addressees are not mentioned.
5703 \*(BO Causes only the local part to be evaluated
5704 when comparing addresses.
5708 \*(BO Causes messages saved in
5710 to be appended to the end rather than prepended.
5711 This should always be set.
5715 \*(BO Causes \*(UA to prompt for the subject of each message sent.
5716 If the user responds with simply a newline,
5717 no subject field will be sent.
5721 \*(BO Causes the prompts for
5725 lists to appear after the message has been edited.
5729 \*(BO If set, \*(UA asks for files to attach at the end of each message,
5730 shall the list be found empty at that time.
5731 An empty line finalizes the list.
5735 \*(BO Causes the user to be prompted for carbon copy recipients
5736 (at the end of each message if
5740 are set) shall the list be found empty (at that time).
5741 An empty line finalizes the list.
5745 \*(BO Causes the user to be prompted for blind carbon copy
5746 recipients (at the end of each message if
5750 are set) shall the list be found empty (at that time).
5751 An empty line finalizes the list.
5755 \*(BO\*(OP Causes the user to be prompted if the message is to be
5756 signed at the end of each message.
5759 variable is ignored when this variable is set.
5763 \*(BO Alternative name for
5770 .It Va attachment-ask-content-description , \
5771 attachment-ask-content-disposition , \
5772 attachment-ask-content-id , \
5773 attachment-ask-content-type
5774 \*(BO If set then the user will be prompted for some attachment
5775 information when editing the attachment list.
5776 It is advisable to not use these but for the first of the variables;
5777 even for that it has to be noted that the data is used
5783 A sequence of characters to display in the
5787 as shown in the display of
5789 each for one type of messages (see
5790 .Sx "Message states" ) ,
5791 with the default being
5794 .Ql NU\ \ *HMFAT+\-$~
5797 variable is set, in the following order:
5799 .Bl -tag -compact -offset indent -width ".It Ql _"
5821 start of a collapsed thread.
5823 an uncollapsed thread (TODO ignored for now).
5827 classified as possible spam.
5833 Specifies a list of recipients to which a blind carbon copy of each
5834 outgoing message will be sent automatically.
5838 Specifies a list of recipients to which a carbon copy of each outgoing
5839 message will be sent automatically.
5843 \*(BO Causes threads to be collapsed automatically when threaded mode
5850 \*(BO Causes the delete command to behave like
5852 thus, after deleting a message the next one will be typed automatically.
5856 \*(BO\*(OB Causes threaded mode (see the
5858 command) to be entered automatically when a folder is opened.
5860 .Ql autosort=thread .
5864 Causes sorted mode (see the
5866 command) to be entered automatically with the value of this option as
5867 sorting method when a folder is opened, e.g.,
5868 .Ql set autosort=thread .
5872 \*(BO Enables the substitution of
5874 by the contents of the last command line in shell escapes.
5877 .It Va batch-exit-on-error
5878 \*(BO If the batch mode has been enabled via the
5880 command line option, then this variable will be consulted whenever \*(UA
5881 completes one operation (returns to the command prompt); if it is set
5882 then \*(UA will terminate if the last operation generated an error.
5886 \*(OP Terminals generate multi-byte sequences for certain forms of
5887 input, for example for function and other special keys.
5888 Some terminals however do not write these multi-byte sequences as
5889 a whole, but byte-by-byte, and the latter is what \*(UA actually reads.
5890 This variable specifies the timeout in milliseconds that the MLE (see
5891 .Sx "On terminal control and line editor" )
5892 waits for more bytes to arrive unless it considers a sequence
5898 \*(BO Causes automatic display of a header summary after executing a
5900 command, and thus complements the standard variable
5902 which controls header summary display on program startup.
5903 It is only meaningful if
5909 \*(BO Sets some cosmetical features to traditional BSD style;
5910 has the same affect as setting
5912 and all other variables prefixed with
5914 it also changes the meaning of the \*(UA specific
5917 escape sequence and changes behaviour of
5919 (which doesn't exist in BSD).
5923 \*(BO Changes the letters shown in the first column of a header
5924 summary to traditional BSD style.
5928 \*(BO Changes the display of columns in a header summary to traditional
5933 \*(BO Changes some informational messages to traditional BSD style.
5939 field to appear immediately after the
5941 field in message headers and with the
5943 .Sx "TILDE ESCAPES" .
5947 The value that should appear in the
5951 MIME header fields when no character set conversion of the message data
5953 This defaults to US-ASCII, and the chosen character set should be
5954 US-ASCII compatible.
5958 \*(OP The default 8-bit character set that is used as an implicit last
5959 member of the variable
5961 This defaults to UTF-8.
5962 If no character set conversion capabilities are available in \*(UA then
5963 the only supported character set is
5965 Refer to the section
5966 .Sx "Character sets"
5967 for the complete picture of character set conversion in \*(UA.
5970 .It Va charset-unknown-8bit
5971 \*(OP RFC 1428 specifies conditions when internet mail gateways shall
5973 the content of a mail message by using a character set with the name
5975 Because of the unclassified nature of this character set \*(UA will not
5976 be capable to convert this character set to any other character set.
5977 If this variable is set any message part which uses the character set
5979 is assumed to really be in the character set given in the value,
5980 otherwise the (final) value of
5982 is used for this purpose.
5984 This variable will also be taken into account if a MIME type (see
5985 .Sx "The mime.types files" )
5986 of a MIME message part that uses the
5988 character set is forcefully treated as text.
5992 The default value for the
5997 .It Va colour-disable
5998 \*(BO\*(OP Forcefully disable usage of colours.
5999 Also see the section
6000 .Sx "Coloured display" .
6004 \*(BO\*(OP Whether colour shall be used for output that is paged through
6006 Note that pagers may need special flags, e.g.,
6014 in order to support colours.
6015 Often doing manual adjustments is unnecessary since \*(UA may perform
6016 adjustments dependend on the value of the environment variable
6018 (see there for more).
6022 In a(n interactive) terminal session, then if this valued option is set
6023 it'll be used as a threshold to determine how many lines the given
6024 output has to span before it will be displayed via the configured
6028 can be forced by setting this to the value
6030 setting it without a value will deduce the current height of the
6031 terminal screen to compute the treshold (see
6039 \*(OB A variable counterpart of the
6041 command (see there for documentation), interpreted as a comma-separated
6042 list of custom headers to be injected, to include commas in the header
6043 bodies escape them with reverse solidus, e.g.:
6045 .Dl set customhdr='Hdr1: Body1-1\e, Body1-2, Hdr2: Body2'
6051 the message date, if any is to be displayed according to the format of
6053 is by default taken from the
6055 line of the message.
6056 If this variable is set the date as given in the
6058 header field is used instead, converted to local time.
6059 To control the display format of the date assign a valid
6064 format should not be used, because \*(UA doesn't take embedded newlines
6065 into account when calculating how many lines fit onto the screen.)
6067 .Va datefield-markout-older .
6070 .It Va datefield-markout-older
6071 This option, when set in addition to
6075 messages (concept is rather comparable to the
6077 option of the POSIX utility
6079 The content interpretation is identical to
6084 \*(BO Enables debug messages and obsoletion warnings, disables the
6085 actual delivery of messages and also implies
6091 .It Va disposition-notification-send
6093 .Ql Disposition-Notification-To:
6094 header (RFC 3798) with the message.
6098 .\" TODO .It Va disposition-notification-send-HOST
6100 .\".Va disposition-notification-send
6101 .\" for SMTP accounts on a specific host.
6102 .\" TODO .It Va disposition-notification-send-USER@HOST
6104 .\".Va disposition-notification-send
6105 .\"for a specific account.
6109 \*(BO When dot is set, a period
6111 on a line by itself during message input in (interactive) compose mode
6112 will be treated as end-of-message (in addition to the normal end-of-file
6121 .It Va dotlock-ignore-error
6122 \*(BO\*(OP Synchronization of mailboxes which \*(UA treats as system
6123 mailboxes (see the command
6125 will be protected with so-called dotlock files\(emthe traditional mail
6126 spool file locking method\(emin addition to system file locking.
6127 Because \*(UA ships with a privilege-separated dotlock creation program
6128 that should always be able to create such a dotlock file there is no
6129 good reason to ignore dotlock file creation errors, and thus these are
6130 fatal unless this variable is set.
6134 \*(BO If this variable is set then the editor is started automatically
6135 when a message is composed in interactive mode, as if the
6141 variable is implied for this automatically spawned editor session.
6145 \*(BO When a message is edited while being composed,
6146 its header is included in the editable text.
6156 fields are accepted within the header, other fields are ignored.
6160 \*(BO When entering interactive mode \*(UA normally writes
6161 .Dq \&No mail for user
6162 and exits immediately if a mailbox is empty or doesn't exist.
6163 If this option is set \*(UA starts even with an empty or nonexistent
6164 mailbox (the latter behaviour furtherly depends upon
6170 Suggestion for the MIME encoding to use in outgoing text messages
6172 Valid values are the default
6173 .Ql quoted-printable ,
6178 may cause problems when transferring mail messages over channels that
6179 are not ESMTP (RFC 1869) compliant.
6180 If there is no need to encode a message,
6182 transfer mode is always used regardless of this variable.
6183 Binary data is always encoded as
6188 If defined, the first character of this option
6189 gives the character to use in place of
6192 .Sx "TILDE ESCAPES" .
6196 If not set then file and command pipeline targets are not allowed,
6197 and any such address will be filtered out, giving a warning message.
6198 If set without a value then all possible recipient address
6199 specifications will be accepted \(en see the section
6200 .Sx "On sending mail, and non-interactive mode"
6202 To accept them, but only in interactive mode, or when tilde commands
6203 were enabled explicitly by using one of the command line options
6207 set this to the (case-insensitive) value
6209 (note right now this is actually like setting
6210 .Ql restrict,-all,+name,+addr ) .
6212 In fact the value is interpreted as a comma-separated list of values.
6215 then the existence of disallowed specifications is treated as a hard
6216 send error instead of only filtering them out.
6217 The remaining values specify whether a specific type of recipient
6218 address specification is allowed (optionally indicated by a plus sign
6220 prefix) or disallowed (prefixed with a hyphen
6224 addresses all possible address specifications,
6228 command pipeline targets,
6230 plain user names and (MTA) aliases (\*(OB
6232 may be used as an alternative syntax to
6237 These kind of values are interpreted in the given order, so that
6238 .Ql restrict,\:fail,\:+file,\:-all,\:+addr
6239 will cause hard errors for any non-network address recipient address
6240 unless \*(UA is in interactive mode or has been started with the
6244 command line option; in the latter case(s) any address may be used, then.
6248 Unless this variable is set additional
6250 (Mail-Transfer-Agent)
6251 arguments from the command line, as can be given after a
6253 separator, are ignored due to safety reasons.
6254 However, if set to the special (case-insensitive) value
6256 then the presence of additional MTA arguments is treated as a hard
6257 error that causes \*(UA to exit with failure status.
6258 A lesser strict variant is the otherwise identical
6260 which does accept such arguments in interactive mode, or if tilde
6261 commands were enabled explicitly by using one of the command line options
6268 \*(RO Information on the features compiled into \*(UA \(en the content
6269 of this variable is identical to the output of the command
6274 \*(BO This option reverses the meanings of a set of reply commands,
6275 turning the lowercase variants, which by default address all recipients
6276 included in the header of a message
6277 .Pf ( Ic reply , respond , followup )
6278 into the uppercase variants, which by default address the sender only
6279 .Pf ( Ic Reply , Respond , Followup )
6282 .Ic replysender , respondsender , followupsender
6284 .Ic replyall , respondall , followupall
6285 are not affected by the current setting of
6290 .It Va file-hook-load-EXTENSION , file-hook-save-EXTENSION
6291 It is possible to install file hooks which will be used by the
6293 command in order to be able to transparently handle (through an
6294 intermediate temporary file) files with specific
6296 s: the variable values can include shell snippets and are expected to
6297 write data to standard output / read data from standard input,
6299 \*(ID The variables may not be changed while there is a mailbox
6301 .Bd -literal -offset indent
6302 set file-hook-load-xy='echo >&2 XY-LOAD; gzip -cd' \e
6303 file-hook-save-xy='echo >&2 XY-SAVE; gzip -c' \e
6304 record=+null-sent.xy
6309 The default path under which mailboxes are to be saved:
6310 file names that begin with the plus-sign
6312 will be expanded by prefixing them with the value of this variable.
6313 The same special syntax conventions as documented for the
6315 command may be used; if the non-empty value doesn't start with a solidus
6319 will be prefixed automatically.
6320 If unset or the empty string any
6322 prefixing file names will remain unexpanded.
6326 This variable can be set to the name of a
6328 macro which will be called whenever a
6331 The macro will also be invoked when new mail arrives,
6332 but message lists for commands executed from the macro
6333 only include newly arrived messages then.
6335 are activated by default in a folder hook, causing the covered settings
6336 to be reverted once the folder is left again.
6339 Macro behaviour, including option localization, will change in v15.
6340 Please be aware of that and possibly embed a version check in a resource
6344 .It Va folder-hook-FOLDER
6349 Unlike other folder specifications, the fully expanded name of a folder,
6350 without metacharacters, is used to avoid ambiguities.
6351 However, if the mailbox resides under
6355 specification is tried in addition, e.g., if
6359 (and thus relative to the user's home directory) then
6360 .Pa /home/usr1/mail/sent
6362 .Ql folder-hook-/home/usr1/mail/sent
6363 first, but then followed by
6364 .Ql folder-hook-+sent .
6368 \*(BO Controls whether a
6369 .Ql Mail-Followup-To:
6370 header is generated when sending messages to known mailing lists.
6372 .Va followup-to-honour
6374 .Ic mlist , mlsubscribe , reply
6379 .It Va followup-to-honour
6381 .Ql Mail-Followup-To:
6382 header is honoured when group-replying to a message via
6386 This is a quadoption; if set without a value it defaults to
6396 .It Va forward-as-attachment
6397 \*(BO Original messages are normally sent as inline text with the
6400 and only the first part of a multipart message is included.
6401 With this option messages are sent as unmodified MIME
6403 attachments with all of their parts included.
6407 The address (or a list of addresses) to put into the
6409 field of the message header, quoting RFC 5322:
6410 the author(s) of the message, that is, the mailbox(es) of the person(s)
6411 or system(s) responsible for the writing of the message.
6414 ing to messages these addresses are handled as if they were in the
6418 If the machine's hostname is not valid at the Internet (for example at
6419 a dialup machine) then either this variable or
6421 (\*(IN and with a defined SMTP protocol in
6424 adds even more fine-tuning capabilities),
6428 contains more than one address,
6431 variable is required (according to the standard RFC 5322).
6435 \*(BO When replying to or forwarding a message \*(UA normally removes
6436 the comment and name parts of email addresses.
6437 If this variable is set such stripping is not performed,
6438 and comments, names etc. are retained.
6442 The string to put before the text of a message with the
6446 .Va forward-as-attachment
6449 .Dq -------- Original Message --------
6450 if unset; No heading is put if it is set to the empty string.
6454 \*(BO Causes the header summary to be written at startup and after
6455 commands that affect the number of messages or the order of messages in
6456 the current folder; enabled by default.
6457 The command line option
6463 complements this and controls header summary display on folder changes.
6468 A format string to use for the summary of
6470 similar to the ones used for
6473 Format specifiers in the given string start with a percent character
6475 and may be followed by an optional decimal number indicating the field
6476 width \(em if that is negative, the field is to be left-aligned.
6477 Valid format specifiers are:
6480 .Bl -tag -compact -offset indent -width "_%%_"
6482 A plain percent character.
6485 a space character but for the current message
6487 for which it expands to
6491 a space character but for the current message
6493 for which it expands to
6496 \*(OP The spam score of the message, as has been classified via the
6499 Shows only a replacement character if there is no spam support.
6501 Message attribute character (status flag); the actual content can be
6505 The date when the message was received, or the date found in the
6509 variable is set (optionally to a date display format string).
6511 The indenting level in threaded mode.
6513 The address of the message sender.
6515 The message thread tree structure.
6516 (Note that this format doesn't support a field width.)
6518 The number of lines of the message, if available.
6522 The number of octets (bytes) in the message, if available.
6524 Message subject (if any).
6526 Message subject (if any) in double quotes.
6528 Message recipient flags: is the addressee of the message a known or
6529 subscribed mailing list \(en see
6534 The position in threaded/sorted order.
6538 .Ql %>\&%a\&%m\ %-18f\ %16d\ %4l/%\-5o\ %i%-s ,
6540 .Ql %>\&%a\&%m\ %20-f\ \ %16d\ %3l/%\-5o\ %i%-S
6551 .It Va headline-bidi
6552 Bidirectional text requires special treatment when displaying headers,
6553 because numbers (in dates or for file sizes etc.) will not affect the
6554 current text direction, in effect resulting in ugly line layouts when
6555 arabic or other right-to-left text is to be displayed.
6556 On the other hand only a minority of terminals is capable to correctly
6557 handle direction changes, so that user interaction is necessary for
6559 Note that extended host system support is required nonetheless, e.g.,
6560 detection of the terminal character set is one precondition;
6561 and this feature only works in an Unicode (i.e., UTF-8) locale.
6563 In general setting this variable will cause \*(UA to encapsulate text
6564 fields that may occur when displaying
6566 (and some other fields, like dynamic expansions in
6568 with special Unicode control sequences;
6569 it is possible to fine-tune the terminal support level by assigning
6571 no value (or any value other than
6576 will make \*(UA assume that the terminal is capable to properly deal
6577 with Unicode version 6.3, in which case text is embedded in a pair of
6578 U+2068 (FIRST STRONG ISOLATE) and U+2069 (POP DIRECTIONAL ISOLATE)
6580 In addition no space on the line is reserved for these characters.
6582 Weaker support is chosen by using the value
6584 (Unicode 6.3, but reserve the room of two spaces for writing the control
6585 sequences onto the line).
6590 select Unicode 1.1 support (U+200E, LEFT-TO-RIGHT MARK); the latter
6591 again reserves room for two spaces in addition.
6595 \*(OP If a line editor is available then this can be set to
6596 name the (expandable) path of the location of a permanent history file.
6599 .It Va history-gabby
6600 \*(BO\*(OP Add more entries to the history as is normally done.
6603 .It Va history-gabby-persist
6604 \*(BO\*(OP \*(UA's own MLE will not save the additional
6606 entries in persistent storage unless this variable is set.
6607 On the other hand it will not loose the knowledge of whether
6608 a persistent entry was gabby or not.
6614 \*(OP If a line editor is available this value restricts the
6615 amount of history entries that are saved into a set and valid
6617 A value of less than 0 disables this feature;
6618 note that loading and incorporation of
6620 upon program startup can also be suppressed by doing this.
6621 If unset or 0, a default value will be used.
6622 Dependent on the available line editor this will also define the
6623 number of history entries in memory;
6624 it is also editor-specific whether runtime updates of this value will
6629 \*(BO This option is used to hold messages in the system
6631 box, and it is set by default.
6635 Use this string as hostname when expanding local addresses instead of
6636 the value obtained from
6645 Note that when SMTP transport is not used (via
6647 then it is normally the responsibility of the MTA to create these
6648 fields, \*(IN in conjunction with SMTP however
6650 also influences the results:
6651 you should produce some test messages with the desired combination of
6660 \*(BO\*(OP Can be used to turn off the automatic conversion of domain
6661 names according to the rules of IDNA (internationalized domain names
6663 Since the IDNA code assumes that domain names are specified with the
6665 character set, an UTF-8 locale charset is required to represent all
6666 possible international domain names (before conversion, that is).
6670 \*(BO Ignore interrupt signals from the terminal while entering
6671 messages; instead echo them as
6673 characters and discard the current line.
6677 \*(BO Ignore end-of-file conditions
6678 .Pf ( Ql control-D )
6679 in compose mode on message input and in interactive command input.
6680 If set an interactive command input session can only be left by
6681 explicitly using one of the commands
6685 and message input in compose mode can only be terminated by entering
6688 on a line by itself or by using the
6690 .Sx "TILDE ESCAPES" ;
6692 overrides a setting of
6704 option for indenting messages,
6705 in place of the normal tabulator character
6707 which is the default.
6708 Be sure to quote the value if it contains spaces or tabs.
6712 \*(BO If set, an empty mailbox file is not removed.
6713 This may improve the interoperability with other mail user agents
6714 when using a common folder directory, and prevents malicious users
6715 from creating fake mailboxes in a world-writable spool directory.
6716 Note this only applies to local regular (MBOX) files, other mailbox
6717 types will never be removed.
6720 .It Va keep-content-length
6721 \*(BO When (editing messages and) writing
6723 mailbox files \*(UA can be told to keep the
6727 header fields that some MUAs generate by setting this variable.
6728 Since \*(UA does neither use nor update these non-standardized header
6729 fields (which in itself shows one of their conceptual problems),
6730 stripping them should increase interoperability in between MUAs that
6731 work with with same mailbox files.
6732 Note that, if this is not set but
6733 .Va writebackedited ,
6734 as below, is, a possibly performed automatic stripping of these header
6735 fields already marks the message as being modified.
6739 \*(BO When a message is saved it is usually discarded from the
6740 originating folder when \*(UA is quit.
6741 Setting this option causes all saved message to be retained.
6744 .It Va line-editor-disable
6745 \*(BO Turn off any enhanced line editing capabilities (see
6746 .Sx "On terminal control and line editor"
6750 .It Va line-editor-no-defaults
6751 \*(BO\*(OP Do not establish any default key binding.
6755 \*(BO When a message is replied to and this variable is set,
6756 it is marked as having been answered.
6757 This mark has no technical meaning in the mail system;
6758 it just causes messages to be marked in the header summary,
6759 and makes them specially addressable.
6763 \*(BO \*(UA generates and expects RFC 4155 compliant MBOX text
6765 (With the restriction that RFC 4155 defines seven-bit clean data
6766 storage, but which can be overwritten by a contrary setting of
6768 Messages which are fetched over the network or from within already
6769 existing Maildir (or any non-MBOX) mailboxes may require so-called
6771 quoting (insertion of additional
6773 characters to prevent line content misinterpretation) to be applied in
6774 order to be storable in MBOX mailboxes, however, dependent on the
6775 circumspection of the message producer.
6776 E.g., \*(UA itself will, when newly generating messages, choose a
6777 .Pf Content-Transfer- Va encoding
6778 that prevents the necessity for such quoting \(en a necessary
6779 precondition to ensure message checksums won't change.
6781 By default \*(UA will perform this
6783 quoting in a way that results in a MBOX file that is compatible with
6784 the POSIX MBOX layout, which means that, in order not to exceed the
6785 capabilities of simple applications, many more
6787 lines get quoted (thus modified) than necessary according to RFC 4155.
6788 Set this option to instead generate MBOX files which comply to RFC 4155.
6792 \*(BO Internal development variable.
6795 .It Va message-id-disable
6796 \*(BO By setting this option the generation of
6798 can be completely suppressed, effectively leaving this task up to the
6800 (Mail-Transfer-Agent) or the SMTP server.
6801 (According to RFC 5321 your SMTP server is not required to add this
6802 field by itself, so you should ensure that it accepts messages without a
6806 .It Va message-inject-head
6807 A string to put at the beginning of each new message.
6808 The escape sequences tabulator
6815 .It Va message-inject-tail
6816 A string to put at the end of each new message.
6817 The escape sequences tabulator
6825 \*(BO Usually, when an
6827 expansion contains the sender, the sender is removed from the expansion.
6828 Setting this option suppresses these removals.
6833 option to be passed through to the
6835 (Mail-Transfer-Agent); though most of the modern MTAs no longer document
6836 this flag, no MTA is known which doesn't support it (for historical
6840 .It Va mime-allow-text-controls
6841 \*(BO When sending messages, each part of the message is MIME-inspected
6842 in order to classify the
6845 .Ql Content-Transfer-Encoding:
6848 that is required to send this part over mail transport, i.e.,
6849 a computation rather similar to what the
6851 command produces when used with the
6855 This classification however treats text files which are encoded in
6856 UTF-16 (seen for HTML files) and similar character sets as binary
6857 octet-streams, forcefully changing any
6862 .Ql application/octet-stream :
6863 If that actually happens a yet unset charset MIME parameter is set to
6865 effectively making it impossible for the receiving MUA to automatically
6866 interpret the contents of the part.
6868 If this option is set, and the data was unambiguously identified as text
6869 data at first glance (by a
6873 file extension), then the original
6875 will not be overwritten.
6878 .It Va mime-alternative-favour-rich
6879 \*(BO If this variable is set then rich MIME alternative parts (e.g.,
6880 HTML) will be preferred in favour of included plain text versions when
6881 displaying messages, provided that a handler exists which produces
6882 output that can be (re)integrated into \*(UA's normal visual display.
6883 (E.g., at the time of this writing some newsletters ship their full
6884 content only in the rich HTML part, whereas the plain text part only
6885 contains topic subjects.)
6888 .It Va mime-counter-evidence
6891 field is used to decide how to handle MIME parts.
6892 Some MUAs however don't use
6894 or a similar mechanism to correctly classify content, but simply specify
6895 .Ql application/octet-stream ,
6896 even for plain text attachments like
6898 If this variable is set then \*(UA will try to classify such MIME
6899 message parts on its own, if possible, for example via a possibly
6900 existent attachment filename.
6901 A non-empty value may also be given, in which case a number is expected,
6902 actually a carrier of bits.
6903 Creating the bit-carrying number is a simple addition:
6904 .Bd -literal -offset indent
6905 ? !echo Value should be set to $((2 + 4 + 8))
6906 Value should be set to 14
6909 .Bl -bullet -compact
6911 If bit two is set (2) then the detected
6913 content-type will be carried along with the message and be used for
6915 .Va pipe-TYPE/SUBTYPE
6916 is responsible for the MIME part, shall that question arise;
6917 when displaying such a MIME part the part-info will indicate the
6918 overridden content-type by showing a plus-sign
6921 If bit three is set (4) then the counter-evidence is always produced
6922 and a positive result will be used as the MIME type, even forcefully
6923 overriding the parts given MIME type.
6925 If bit four is set (8) then as a last resort the actual content of
6926 .Ql application/octet-stream
6927 parts will be inspected, so that data which looks like plain text can be
6932 .It Va mimetypes-load-control
6933 This option can be used to control which of the
6935 databases are loaded by \*(UA, as furtherly described in the section
6936 .Sx "The mime.types files" .
6939 is part of the option value, then the user's personal
6941 file will be loaded (if it exists); likewise the letter
6943 controls loading of the system wide
6944 .Pa /etc/mime.types ;
6945 directives found in the user file take precedence, letter matching is
6947 If this option is not set \*(UA will try to load both files.
6948 Incorporation of the \*(UA-builtin MIME types cannot be suppressed,
6949 but they will be matched last.
6951 More sources can be specified by using a different syntax: if the
6952 value string contains an equals sign
6954 then it is instead parsed as a comma-separated list of the described
6957 pairs; the given filenames will be expanded and loaded, and their
6958 content may use the extended syntax that is described in the section
6959 .Sx "The mime.types files" .
6960 Directives found in such files always take precedence (are prepended to
6961 the MIME type cache).
6966 To choose an alternate Mail-Transfer-Agent, set this option to either
6967 the full pathname of an executable (optionally prefixed with a
6969 protocol indicator), or \*(OPally a SMTP protocol URL, e.g., \*(IN
6971 .Dl smtps?://[user[:password]@]server[:port]
6974 .Ql [smtp://]server[:port] . )
6975 The default has been chosen at compie time.
6976 All supported data transfers are executed in child processes, which
6977 run asynchronously, and without supervision, unless either the
6982 If such a child receives a TERM signal, it will abort and
6989 For a file-based MTA it may be necessary to set
6991 in in order to choose the right target of a modern
6994 It will be passed command line arguments from several possible sources:
6997 if set, from the command line if given and the variable
7000 Argument processing of the MTA will be terminated with a
7005 The otherwise occurring implicit usage of the following MTA command
7006 line arguments can be disabled by setting the boolean option
7007 .Va mta-no-default-arguments
7008 (which will also disable passing
7012 (for not treating a line with only a dot
7014 character as the end of input),
7022 option is set); in conjunction with the
7024 command line option \*(UA will also pass
7030 \*(OP \*(UA can send mail over SMTP network connections to a single
7031 defined SMTP smarthost, the access URL of which has to be assigned to
7033 To use this mode it is helpful to read
7034 .Sx "On URL syntax and credential lookup" .
7035 It may be necessary to set the
7037 variable in order to use a specific combination of
7042 with some mail providers.
7045 .Bl -bullet -compact
7047 The plain SMTP protocol (RFC 5321) that normally lives on the
7048 server port 25 and requires setting the
7049 .Va smtp-use-starttls
7050 variable to enter a SSL/TLS encrypted session state.
7051 Assign a value like \*(IN
7052 .Ql smtp://[user[:password]@]server[:port]
7054 .Ql smtp://server[:port] )
7055 to choose this protocol.
7057 The so-called SMTPS which is supposed to live on server port 465
7058 and is automatically SSL/TLS secured.
7059 Unfortunately it never became a standardized protocol and may thus not
7060 be supported by your hosts network service database
7061 \(en in fact the port number has already been reassigned to other
7064 SMTPS is nonetheless a commonly offered protocol and thus can be
7065 chosen by assigning a value like \*(IN
7066 .Ql smtps://[user[:password]@]server[:port]
7068 .Ql smtps://server[:port] ) ;
7069 due to the mentioned problems it is usually necessary to explicitly
7074 Finally there is the SUBMISSION protocol (RFC 6409), which usually
7075 lives on server port 587 and is practically identically to the SMTP
7076 protocol from \*(UA's point of view beside that; it requires setting the
7077 .Va smtp-use-starttls
7078 variable to enter a SSL/TLS secured session state.
7079 Assign a value like \*(IN
7080 .Ql submission://[user[:password]@]server[:port]
7082 .Ql submission://server[:port] ) .
7087 .It Va mta-arguments
7088 Arguments to pass through to a file-based
7090 can be given via this variable, the content of which will be split up in
7091 a vector of arguments, to be joined onto other possible MTA options:
7093 .Dl set mta-arguments='-t -X \&"/tmp/my log\&"'
7096 .It Va mta-no-default-arguments
7097 \*(BO Unless this option is set \*(UA will pass some well known
7098 standard command line options to a file-based
7100 (Mail-Transfer-Agent), see there for more.
7104 Many systems use a so-called
7106 environment to ensure compatibility with
7108 This works by inspecting the name that was used to invoke the mail
7110 If this variable is set then the mailwrapper (the program that is
7111 actually executed when calling the file-based
7113 will treat its contents as that name.
7118 .It Va NAIL_EXTRA_RC
7119 The name of an optional startup file to be read last.
7120 This variable has an effect only if it is set in any of the
7121 .Sx "Resource files" ,
7122 it is not imported from the environment.
7123 Use this file for commands that are not understood by other POSIX
7128 .It Va netrc-lookup-USER@HOST , netrc-lookup-HOST , netrc-lookup
7129 \*(BO\*(IN\*(OP Used to control usage of the users
7131 file for lookup of account credentials, as documented in the section
7132 .Sx "On URL syntax and credential lookup"
7136 .Sx "The .netrc file"
7137 documents the file format.
7149 then \*(UA will read the output of a shell pipe instead of the users
7151 file if this variable is set (to the desired shell command).
7152 This can be used to, e.g., store
7156 .Dl set netrc-pipe='gpg -qd ~/.netrc.pgp'
7160 If this variable has the value
7162 newly created local folders will be in Maildir format.
7166 Checks for new mail in the current folder each time the prompt is shown.
7167 A Maildir folder must be re-scanned to determine if new mail has arrived.
7168 If this variable is set to the special value
7170 then a Maildir folder will not be rescanned completely, but only
7171 timestamp changes are detected.
7175 .It Va on-compose-enter , on-compose-leave
7176 \*(ID Macro hooks which will be executed before compose mode is
7177 entered, and after composing has been finished, respectively.
7178 Please note that this interface is very likely to change in v15, and
7179 should therefore possibly even be seen as experimental.
7181 are by default enabled for these hooks, causing any setting to be
7182 forgotten after the message has been sent.
7183 The following variables will be set temporarily during execution of the
7186 .Bl -tag -compact -width ".It Va compose_subject"
7189 .It Va compose-sender
7191 .It Va compose-to , compose-cc , compose-bcc
7192 The list of receiver addresses as a space-separated list.
7193 .It Va compose-subject
7199 \*(BO Causes the filename given in the
7202 and the sender-based filenames for the
7206 commands to be interpreted relative to the directory given in the
7208 variable rather than to the current directory,
7209 unless it is set to an absolute pathname.
7213 \*(BO If set, each message feed through the command given for
7215 is followed by a formfeed character
7219 .It Va password-USER@HOST , password-HOST , password
7220 \*(IN Variable chain that sets a password, which is used in case none has
7221 been given in the protocol and account-specific URL;
7222 as a last resort \*(UA will ask for a password on the user's terminal if
7223 the authentication method requires a password.
7224 Specifying passwords in a startup file is generally a security risk;
7225 the file should be readable by the invoking user only.
7227 .It Va password-USER@HOST
7228 \*(OU (see the chain above for \*(IN)
7229 Set the password for
7233 If no such variable is defined for a host,
7234 the user will be asked for a password on standard input.
7235 Specifying passwords in a startup file is generally a security risk;
7236 the file should be readable by the invoking user only.
7240 \*(BO Send messages to the
7242 command without performing MIME and character set conversions.
7246 .It Va pipe-TYPE/SUBTYPE
7247 When a MIME message part of type
7249 (case-insensitive) is displayed or quoted,
7250 its text is filtered through the value of this variable interpreted as
7254 forces interpretation of the message part as plain text, e.g.,
7255 .Ql set pipe-application/xml=@
7256 will henceforth display XML
7258 (The same could also be achieved by adding a MIME type marker with the
7261 And \*(OPally MIME type handlers may be defined via
7262 .Sx "The Mailcap files"
7263 \(em corresponding flag strings are shown in parenthesis below.)
7268 can in fact be used to adjust usage and behaviour of a following shell
7269 command specification by appending trigger characters to it, e.g., the
7270 following hypothetical command specification could be used:
7271 .Bd -literal -offset indent
7272 set pipe-X/Y='@*!++=@vim ${NAIL_FILENAME_TEMPORARY}'
7276 .Bl -tag -compact -width ".It Ql __"
7278 Simply by using the special
7280 prefix the MIME type (shell command) handler will only be invoked to
7281 display or convert the MIME part if the message is addressed directly
7282 and alone by itself.
7283 Use this trigger to disable this and always invoke the handler
7284 .Pf ( Cd x-mailx-always ) .
7287 If set the handler will not be invoked when a message is to be quoted,
7288 but only when it will be displayed
7289 .Pf ( Cd x-mailx-noquote ) .
7292 The command will be run asynchronously, i.e., without blocking \*(UA,
7293 which may be a handy way to display a, e.g., PDF file while also
7294 continuing to read the mail message
7295 .Pf ( Cd x-mailx-async ) .
7296 Asynchronous execution implies
7300 The command must be run on an interactive terminal, \*(UA will
7301 temporarily release the terminal to it
7302 .Pf ( Cd needsterminal ) .
7303 This flag is mutual exclusive with
7305 will only be used in interactive mode and implies
7309 Request creation of a zero-sized temporary file, the absolute pathname
7310 of which will be made accessible via the environment variable
7311 .Ev NAIL_FILENAME_TEMPORARY
7312 .Pf ( Cd x-mailx-tmpfile ) .
7313 If this trigger is given twice then the file will be unlinked
7314 automatically by \*(UA when the command loop is entered again at latest
7315 .Pf ( Cd x-mailx-tmpfile-unlink ) .
7316 (Don't use this for asynchronous handlers.)
7319 Normally the MIME part content is passed to the handler via standard
7320 input; if this flag is set then the data will instead be written into
7321 .Ev NAIL_FILENAME_TEMPORARY
7322 .Pf ( Cd x-mailx-tmpfile-fill ) ,
7323 the creation of which is implied; note however that in order to cause
7324 deletion of the temporary file you still have to use two plus signs
7329 To avoid ambiguities with normal shell command content you can use
7330 another at-sign to forcefully terminate interpretation of remaining
7332 (Any character not in this list will have the same effect.)
7336 Some information about the MIME part to be displayed is embedded into
7337 the environment of the shell command:
7340 .Bl -tag -compact -width ".It Ev _AIL__ILENAME__ENERATED"
7343 The MIME content-type of the part, if known, the empty string otherwise.
7346 .It Ev NAIL_CONTENT_EVIDENCE
7348 .Va mime-counter-evidence
7349 includes the carry-around-bit (2), then this will be set to the detected
7350 MIME content-type; not only then identical to
7351 .Ev \&\&NAIL_CONTENT
7355 .It Ev NAIL_FILENAME
7356 The filename, if any is set, the empty string otherwise.
7359 .It Ev NAIL_FILENAME_GENERATED
7363 .It Ev NAIL_FILENAME_TEMPORARY
7364 If temporary file creation has been requested through the command prefix
7365 this variable will be set and contain the absolute pathname of the
7370 The temporary directory that \*(UA uses.
7371 Usually identical to
7373 but guaranteed to be set and usable by child processes;
7374 to ensure the latter condition for
7381 .It Va pipe-EXTENSION
7382 This is identical to
7383 .Va pipe-TYPE/SUBTYPE
7386 (normalized to lowercase using character mappings of the ASCII charset)
7387 names a file extension, e.g.,
7389 Handlers registered using this method take precedence.
7392 .It Va pop3-auth-USER@HOST , pop3-auth-HOST , pop3-auth
7393 \*(OP\*(IN Variable chain that sets the POP3 authentication method.
7394 The only possible value as of now is
7396 which is thus the default.
7399 .Mx Va pop3-bulk-load
7400 .It Va pop3-bulk-load-USER@HOST , pop3-bulk-load-HOST , pop3-bulk-load
7401 \*(BO\*(OP When accessing a POP3 server \*(UA loads the headers of
7402 the messages, and only requests the message bodies on user request.
7403 For the POP3 protocol this means that the message headers will be
7405 If this option is set then \*(UA will download only complete messages
7406 from the given POP3 server(s) instead.
7408 .Mx Va pop3-keepalive
7409 .It Va pop3-keepalive-USER@HOST , pop3-keepalive-HOST , pop3-keepalive
7410 \*(OP POP3 servers close the connection after a period of inactivity;
7411 the standard requires this to be at least 10 minutes,
7412 but practical experience may vary.
7413 Setting this variable to a numeric value greater than
7417 command to be sent each value seconds if no other operation is performed.
7420 .It Va pop3-no-apop-USER@HOST , pop3-no-apop-HOST , pop3-no-apop
7421 \*(BO\*(OP Unless this variable is set the
7423 authentication method will be used when connecting to a POP3 server that
7427 is that the password is not sent in clear text over the wire and that
7428 only a single packet is sent for the user/password tuple.
7430 .Va pop3-no-apop-HOST
7433 .Mx Va pop3-use-starttls
7434 .It Va pop3-use-starttls-USER@HOST , pop3-use-starttls-HOST , pop3-use-starttls
7435 \*(BO\*(OP Causes \*(UA to issue a
7437 command to make an unencrypted POP3 session SSL/TLS encrypted.
7438 This functionality is not supported by all servers,
7439 and is not used if the session is already encrypted by the POP3S method.
7441 .Va pop3-use-starttls-HOST
7445 .It Va print-alternatives
7446 \*(BO When a MIME message part of type
7447 .Ql multipart/alternative
7448 is displayed and it contains a subpart of type
7450 other parts are normally discarded.
7451 Setting this variable causes all subparts to be displayed,
7452 just as if the surrounding part was of type
7453 .Ql multipart/mixed .
7457 The string shown when a command is accepted.
7458 Prompting may be prevented by setting this to the null string
7460 .Pf no Va prompt ) .
7461 If a value is assigned the following \*(UA specific additional sequences
7468 is set, in which case it expands to
7472 is the default value of
7475 which will expand to
7477 if the last command failed and to
7481 which will expand to the name of the currently active
7483 if any, and to the empty string otherwise, and
7485 which will expand to the name of the currently active mailbox.
7486 (Note that the prompt buffer is size-limited, excess is cut off.)
7492 to encapsulate the expansions of the
7496 escape sequences as necessary to correctly display bidirectional text,
7497 this is not true for the final string that makes up
7499 as such, i.e., real BIDI handling is not supported.
7503 \*(BO Suppresses the printing of the version when first invoked.
7507 If set, \*(UA starts a replying message with the original message
7508 prefixed by the value of the variable
7510 Normally, a heading consisting of
7511 .Dq Fromheaderfield wrote:
7512 is put before the quotation.
7517 variable, this heading is omitted.
7520 is assigned, the headers selected by the
7521 .Ic ignore Ns / Ns Ic retain
7522 commands are put above the message body,
7525 acts like an automatic
7531 is assigned, all headers are put above the message body and all MIME
7532 parts are included, making
7534 act like an automatic
7537 .Va quote-as-attachment .
7540 .It Va quote-as-attachment
7541 \*(BO Add the original message in its entirety as a
7543 MIME attachment when replying to a message.
7544 Note this works regardless of the setting of
7549 \*(OP Can be set in addition to
7551 Setting this turns on a more fancy quotation algorithm in that leading
7552 quotation characters are compressed and overlong lines are folded.
7554 can be set to either one or two (space separated) numeric values,
7555 which are interpreted as the maximum (goal) and the minimum line length,
7556 respectively, in a spirit rather equal to the
7558 program, but line-, not paragraph-based.
7559 If not set explicitly the minimum will reflect the goal algorithmically.
7560 The goal can't be smaller than the length of
7562 plus some additional pad.
7563 Necessary adjustments take place silently.
7566 .It Va recipients-in-cc
7567 \*(BO On group replies, specify only the sender of the original mail in
7569 and mention the other recipients in the secondary
7571 By default all recipients of the original mail will be addressed via
7576 If defined, gives the pathname of the folder used to record all outgoing
7578 If not defined, then outgoing mail is not saved.
7579 When saving to this folder fails the message is not sent,
7580 but instead saved to
7584 .It Va record-resent
7585 \*(BO If both this variable and the
7592 commands save messages to the
7594 folder as it is normally only done for newly composed messages.
7597 .It Va reply-in-same-charset
7598 \*(BO If this variable is set \*(UA first tries to use the same
7599 character set of the original message for replies.
7600 If this fails, the mechanism described in
7601 .Sx "Character sets"
7602 is evaluated as usual.
7605 .It Va reply_strings
7606 Can be set to a comma-separated list of (case-insensitive according to
7607 ASCII rules) strings which shall be recognized in addition to the
7610 reply message indicators \(en builtin are
7612 which is mandated by RFC 5322, as well as the german
7617 A list of addresses to put into the
7619 field of the message header.
7620 Members of this list are handled as if they were in the
7625 .It Va reply-to-honour
7628 header is honoured when replying to a message via
7632 This is a quadoption; if set without a value it defaults to
7636 .It Va rfc822-body-from_
7637 \*(BO This variable can be used to force displaying a so-called
7639 line for messages that are embedded into an envelope mail via the
7641 MIME mechanism, for more visual convenience.
7645 \*(BO Enable saving of (partial) messages in
7647 upon interrupt or delivery error.
7651 The number of lines that represents a
7660 line display and scrolling via
7662 If this variable is not set \*(UA falls back to a calculation based upon
7663 the detected terminal window size and the baud rate: the faster the
7664 terminal, the more will be shown.
7665 Overall screen dimensions and pager usage is influenced by the
7666 environment variables
7674 .It Va searchheaders
7675 \*(BO Expand message-list specifiers in the form
7677 to all messages containing the substring
7681 The string search is case insensitive.
7685 \*(OP A comma-separated list of character set names that can be used in
7686 outgoing internet mail.
7687 The value of the variable
7689 is automatically appended to this list of character-sets.
7690 If no character set conversion capabilities are compiled into \*(UA then
7691 the only supported charset is
7694 .Va sendcharsets-else-ttycharset
7695 and refer to the section
7696 .Sx "Character sets"
7697 for the complete picture of character set conversion in \*(UA.
7700 .It Va sendcharsets-else-ttycharset
7701 \*(BO\*(OP If this variable is set, but
7703 is not, then \*(UA acts as if
7705 had been set to the value of the variable
7707 In effect this combination passes through the message data in the
7708 character set of the current locale (given that
7710 hasn't been set manually), i.e., without converting it to the
7712 fallback character set.
7713 Thus, mail message text will be in ISO-8859-1 encoding when send from
7714 within a ISO-8859-1 locale, and in UTF-8 encoding when send from within
7716 If no character set conversion capabilities are available in \*(UA then
7717 the only supported character set is
7722 An address that is put into the
7724 field of outgoing messages, quoting RFC 5322: the mailbox of the agent
7725 responsible for the actual transmission of the message.
7726 This field should normally not be used unless the
7728 field contains more than one address, on which case it is required.
7731 address is handled as if it were in the
7737 \*(OB Predecessor of
7741 .It Va sendmail-arguments
7742 \*(OB Predecessor of
7746 .It Va sendmail-no-default-arguments
7747 \*(OB\*(BO Predecessor of
7748 .Va mta-no-default-arguments .
7751 .It Va sendmail-progname
7752 \*(OB Predecessor of
7757 \*(BO When sending a message wait until the
7759 (including the builtin SMTP one) exits before accepting further commands.
7761 with this variable set errors reported by the MTA will be recognizable!
7762 If the MTA returns a non-zero exit status,
7763 the exit status of \*(UA will also be non-zero.
7767 \*(BO Setting this option causes \*(UA to start at the last message
7768 instead of the first one when opening a mail folder.
7772 \*(BO Causes \*(UA to use the sender's real name instead of the plain
7773 address in the header field summary and in message specifications.
7777 \*(BO Causes the recipient of the message to be shown in the header
7778 summary if the message was sent by the user.
7782 A string for use with the
7788 A string for use with the
7794 Must correspond to the name of a readable file if set.
7795 The file's content is then appended to each singlepart message
7796 and to the first part of each multipart message.
7797 Be warned that there is no possibility to edit the signature for an
7801 .It Va skipemptybody
7802 \*(BO If an outgoing message does not contain any text in its first or
7803 only message part, do not send it but discard it silently (see also the
7809 \*(OP Specifies a directory with CA certificates in PEM (Privacy
7810 Enhanced Mail) format for verification of S/MIME signed messages.
7813 .It Va smime-ca-file
7814 \*(OP Specifies a file with CA certificates in PEM format for
7815 verification of S/MIME signed messages.
7818 .It Va smime-cipher-USER@HOST , smime-cipher
7819 \*(OP Specifies the cipher to use when generating S/MIME encrypted
7820 messages (for the specified account).
7821 RFC 5751 mandates a default of
7824 Possible values are (case-insensitive and) in decreasing cipher strength:
7832 (DES EDE3 CBC, 168 bits; default if
7834 isn't available) and
7838 The actually available cipher algorithms depend on the cryptographic
7839 library that \*(UA uses.
7840 \*(OP Support for more cipher algorithms may be available through
7841 dynamic loading via, e.g.,
7842 .Xr EVP_get_cipherbyname 3
7843 (OpenSSL) if \*(UA has been compiled to support this.
7846 .It Va smime-crl-dir
7847 \*(OP Specifies a directory that contains files with CRLs in PEM format
7848 to use when verifying S/MIME messages.
7851 .It Va smime-crl-file
7852 \*(OP Specifies a file that contains a CRL in PEM format to use when
7853 verifying S/MIME messages.
7856 .It Va smime-encrypt-USER@HOST
7857 \*(OP If this variable is set, messages send to the given receiver are
7858 encrypted before sending.
7859 The value of the variable must be set to the name of a file that
7860 contains a certificate in PEM format.
7862 If a message is sent to multiple recipients,
7863 each of them for whom a corresponding variable is set will receive an
7864 individually encrypted message;
7865 other recipients will continue to receive the message in plain text
7867 .Va smime-force-encryption
7869 It is recommended to sign encrypted messages, i.e., to also set the
7874 .It Va smime-force-encryption
7875 \*(BO\*(OP Causes \*(UA to refuse sending unencrypted messages.
7878 .It Va smime-no-default-ca
7879 \*(BO\*(OP Don't load default CA locations when verifying S/MIME signed
7884 \*(BO\*(OP S/MIME sign outgoing messages with the user's private key
7885 and include the user's certificate as a MIME attachment.
7886 Signing a message enables a recipient to verify that the sender used
7887 a valid certificate,
7888 that the email addresses in the certificate match those in the message
7889 header and that the message content has not been altered.
7890 It does not change the message text,
7891 and people will be able to read the message as usual.
7893 .Va smime-sign-cert , smime-sign-include-certs
7895 .Va smime-sign-message-digest .
7897 .Mx Va smime-sign-cert
7898 .It Va smime-sign-cert-USER@HOST , smime-sign-cert
7899 \*(OP Points to a file in PEM format.
7900 For the purpose of signing and decryption this file needs to contain the
7901 user's private key as well as his certificate.
7905 is always derived from the value of
7907 (or, if that contains multiple addresses,
7909 For the purpose of encryption the recipient's public encryption key
7910 (certificate) is expected; the command
7912 can be used to save certificates of signed messages (the section
7913 .Sx "Signed and encrypted messages with S/MIME"
7914 gives some details).
7915 This mode of operation is usually driven by the specialized form.
7917 When decrypting messages the account is derived from the recipient
7922 of the message, which are searched for addresses for which such
7924 \*(UA always uses the first address that matches,
7925 so if the same message is sent to more than one of the user's addresses
7926 using different encryption keys, decryption might fail.
7928 .Mx Va smime-sign-include-certs
7929 .It Va smime-sign-include-certs-USER@HOST , smime-sign-include-certs
7930 \*(OP If used, this is supposed to a consist of a comma-separated list
7931 of files, each of which containing a single certificate in PEM format to
7932 be included in the S/MIME message in addition to the
7935 This is most useful for long certificate chains if it is desired to aid
7936 the receiving party's verification process.
7937 Note that top level certificates may also be included in the chain but
7938 don't play a role for verification.
7940 .Va smime-sign-cert .
7941 Remember that for this
7943 refers to the variable
7945 (or, if that contains multiple addresses,
7948 .Mx Va smime-sign-message-digest
7949 .It Va smime-sign-message-digest-USER@HOST , smime-sign-message-digest
7950 \*(OP Specifies the message digest to use when signing S/MIME messages.
7951 RFC 5751 mandates a default of
7953 Possible values are (case-insensitive and) in decreasing cipher strength:
7961 The actually available message digest algorithms depend on the
7962 cryptographic library that \*(UA uses.
7963 \*(OP Support for more message digest algorithms may be available
7964 through dynamic loading via, e.g.,
7965 .Xr EVP_get_digestbyname 3
7966 (OpenSSL) if \*(UA has been compiled to support this.
7967 Remember that for this
7969 refers to the variable
7971 (or, if that contains multiple addresses,
7976 \*(OB\*(OP To use the builtin SMTP transport, specify a SMTP URL in
7978 \*(ID For compatibility reasons a set
7980 is used in preference of
7984 .It Va smtp-auth-USER@HOST , smtp-auth-HOST , smtp-auth
7985 \*(OP Variable chain that controls the SMTP
7987 authentication method, possible values are
7993 as well as the \*(OPal methods
7999 method doesn't need any user credentials,
8001 requires a user name and all other methods require a user name and
8009 .Va smtp-auth-password
8011 .Va smtp-auth-user ) .
8016 .Va smtp-auth-USER@HOST :
8017 may override dependent on sender address in the variable
8020 .It Va smtp-auth-password
8021 \*(OP\*(OU Sets the global fallback password for SMTP authentication.
8022 If the authentication method requires a password, but neither
8023 .Va smtp-auth-password
8025 .Va smtp-auth-password-USER@HOST
8027 \*(UA will ask for a password on the user's terminal.
8029 .It Va smtp-auth-password-USER@HOST
8031 .Va smtp-auth-password
8032 for specific values of sender addresses, dependent upon the variable
8035 .It Va smtp-auth-user
8036 \*(OP\*(OU Sets the global fallback user name for SMTP authentication.
8037 If the authentication method requires a user name, but neither
8040 .Va smtp-auth-user-USER@HOST
8042 \*(UA will ask for a user name on the user's terminal.
8044 .It Va smtp-auth-user-USER@HOST
8047 for specific values of sender addresses, dependent upon the variable
8051 .It Va smtp-hostname
8052 \*(OP\*(IN Normally \*(UA uses the variable
8054 to derive the necessary
8056 information in order to issue a
8063 can be used to use the
8065 from the SMTP account
8072 from the content of this variable (or, if that is the empty string,
8074 or the local hostname as a last resort).
8075 This often allows using an address that is itself valid but hosted by
8076 a provider other than which (in
8078 is about to send the message.
8079 Setting this variable also influences the generated
8082 .Mx Va smtp-use-starttls
8083 .It Va smtp-use-starttls-USER@HOST , smtp-use-starttls-HOST , smtp-use-starttls
8084 \*(BO\*(OP Causes \*(UA to issue a
8086 command to make an SMTP
8088 session SSL/TLS encrypted, i.e., to enable transport layer security.
8092 .It Va spam-interface
8093 \*(OP In order to use any of the spam-related commands (like, e.g.,
8095 the desired spam interface must be defined by setting this variable.
8096 Please refer to the manual section
8098 for the complete picture of spam handling in \*(UA.
8099 All or none of the following interfaces may be available:
8101 .Bl -tag -width ".It Ql _ilte_"
8107 .Pf ( Lk http://spamassassin.apache.org SpamAssassin )
8109 Different to the generic filter interface \*(UA will automatically add
8110 the correct arguments for a given command and has the necessary
8111 knowledge to parse the program's output.
8114 will have been compiled into the \*(UA binary if
8119 Shall it be necessary to define a specific connection type (rather than
8120 using a configuration file for that), the variable
8122 can be used as in, e.g.,
8123 .Ql -d server.example.com -p 783 .
8124 It is also possible to specify a per-user configuration via
8126 Note that this interface doesn't inspect the
8128 flag of a message for the command
8132 \*(UA will directly communicate with the
8138 stream socket as specified in
8140 It is possible to specify a per-user configuration via
8144 generic spam filter support via freely configurable hooks.
8145 This interface is meant for programs like
8147 and requires according behaviour in respect to the hooks' exit
8148 status for at least the command
8151 meaning a message is spam,
8155 for unsure and any other return value indicating a hard error);
8156 since the hooks can include shell code snippets diverting behaviour
8157 can be intercepted as necessary.
8159 .Va spamfilter-ham , spamfilter-noham , spamfilter-nospam , \
8162 .Va spamfilter-spam ;
8165 contains examples for some programs.
8166 The process environment of the hooks will have the variables
8167 .Ev NAIL_TMPDIR , TMPDIR
8169 .Ev NAIL_FILENAME_GENERATED
8171 Note that spam score support for
8173 isn't supported unless the \*(OPtional regular expression support is
8175 .Va spamfilter-rate-scanscore
8182 \*(OP Messages that exceed this size won't be passed through to the
8184 .Va spam-interface .
8185 If unset or 0, the default of 420000 bytes is used.
8188 .It Va spamc-command
8189 \*(OP The path to the
8193 .Va spam-interface .
8194 Note that the path is not expanded, but used
8196 A fallback path will have been compiled into the \*(UA binary if the
8197 executable had been found during compilation.
8200 .It Va spamc-arguments
8201 \*(OP Even though \*(UA deals with most arguments for the
8204 automatically, it may at least sometimes be desirable to specify
8205 connection-related ones via this variable, e.g.,
8206 .Ql -d server.example.com -p 783 .
8210 \*(OP Specify a username for per-user configuration files for the
8212 .Va spam-interface .
8213 If this is set to the empty string then \*(UA will use the name of the
8219 \*(OP Specify the path of the
8221 domain socket on which
8223 listens for connections for the
8225 .Va spam-interface .
8226 Note that the path is not expanded, but used
8231 \*(OP Specify a username for per-user configuration files for the
8233 .Va spam-interface .
8234 If this is set to the empty string then \*(UA will use the name of the
8243 .It Va spamfilter-ham , spamfilter-noham , \
8244 spamfilter-nospam , spamfilter-rate , spamfilter-spam
8245 \*(OP Command and argument hooks for the
8247 .Va spam-interface .
8250 contains examples for some programs.
8253 .It Va spamfilter-rate-scanscore
8254 \*(OP Because of the generic nature of the
8257 spam scores are not supported for it by default, but if the \*(OPtional
8258 regular expression support is available then setting this variable can
8259 be used to overcome this restriction.
8260 It is interpreted as follows: first a number (digits) is parsed that
8261 must be followed by a semicolon
8263 and an extended regular expression.
8264 Then the latter is used to parse the first output line of the
8266 hook, and, in case the evaluation is successful, the group that has been
8267 specified via the number is interpreted as a floating point scan score.
8271 \*(OP Specifies a directory with CA certificates in PEM (Pricacy
8272 Enhanced Mail) for verification of of SSL/TLS server certificates.
8274 .Xr SSL_CTX_load_verify_locations 3
8275 for more information.
8279 \*(OP Specifies a file with CA certificates in PEM format for
8280 verification of SSL/TLS server certificates.
8282 .Xr SSL_CTX_load_verify_locations 3
8283 for more information.
8286 .It Va ssl-cert-USER@HOST , ssl-cert-HOST , ssl-cert
8287 \*(OP Variable chain that sets the file name for a SSL/TLS client
8288 certificate required by some servers.
8289 This is a direct interface to the
8293 function of the OpenSSL library, if available.
8295 .Mx Va ssl-cipher-list
8296 .It Va ssl-cipher-list-USER@HOST , ssl-cipher-list-HOST , ssl-cipher-list
8297 \*(OP Specifies a list of ciphers for SSL/TLS connections.
8298 This is a direct interface to the
8302 function of the OpenSSL library, if available; see
8304 for more information.
8305 By default \*(UA doesn't set a list of ciphers, which in effect will use a
8307 specific cipher (protocol standards ship with a list of acceptable
8308 ciphers), possibly cramped to what the actually used SSL/TLS library
8309 supports \(en the manual section
8310 .Sx "An example configuration"
8311 also contains a SSL/TLS use case.
8314 .It Va ssl-config-file
8315 \*(OP If this variable is set \*(UA will call
8316 .Xr CONF_modules_load_file 3
8317 to allow OpenSSL to be configured according to the host system wide
8319 If a non-empty value is given then this will be used to specify the
8320 configuration file to be used instead of the global OpenSSL default;
8321 note that in this case it is an error if the file cannot be loaded.
8322 The application name will always be passed as
8327 \*(OP Specifies a file that contains a CRL in PEM format to use when
8328 verifying SSL/TLS server certificates.
8332 \*(OP Specifies a directory that contains files with CRLs in PEM format
8333 to use when verifying SSL/TLS server certificates.
8336 .It Va ssl-key-USER@HOST , ssl-key-HOST , ssl-key
8337 \*(OP Variable chain that sets the file name for the private key of
8338 a SSL/TLS client certificate.
8339 If unset, the name of the certificate file is used.
8340 The file is expected to be in PEM format.
8341 This is a direct interface to the
8345 function of the OpenSSL library, if available.
8348 .It Va ssl-method-USER@HOST , ssl-method-HOST , ssl-method
8349 \*(OB\*(OP Please use the newer and more flexible
8351 instead: if both values are set,
8353 will take precedence!
8354 Can be set to the following values, the actually used
8356 specification to which it is mapped is shown in parenthesis:
8358 .Pf ( Ql -ALL, TLSv1.2 ) ,
8360 .Pf ( Ql -ALL, TLSv1.1 ) ,
8362 .Pf ( Ql -ALL, TLSv1 )
8365 .Pf ( Ql -ALL, SSLv3 ) ;
8370 and thus includes the SSLv3 protocol.
8371 Note that SSLv2 is no longer supported at all.
8374 .It Va ssl-no-default-ca
8375 \*(BO\*(OP Don't load default CA locations to verify SSL/TLS server
8379 .It Va ssl-protocol-USER@HOST , ssl-protocol-HOST , ssl-protocol
8380 \*(OP Specify the used SSL/TLS protocol.
8381 This is a direct interface to the
8385 function of the OpenSSL library, if available;
8386 otherwise an \*(UA internal parser is used which understands the
8387 following subset of (case-insensitive) command strings:
8393 as well as the special value
8395 Multiple specifications may be given via a comma-separated list which
8396 ignores any whitespace.
8399 plus prefix will enable a protocol, a
8401 minus prefix will disable it, so that
8403 will enable only the TLSv1.2 protocol.
8405 It depends upon the used TLS/SSL library which protocols are actually
8406 supported and which protocols are used if
8408 is not set, but note that SSLv2 is no longer supported at all and
8410 Especially for older protocols explicitly securing
8412 may be worthwile, see
8413 .Sx "An example configuration" .
8417 \*(OP Gives the pathname to an entropy daemon socket, see
8419 Not all SSL/TLS libraries support this.
8422 .It Va ssl-rand-file
8423 \*(OP Gives the filename to a file with random entropy data, see
8424 .Xr RAND_load_file 3 .
8425 If this variable is not set, or set to the empty string, or if the
8426 filename expansion failed, then
8427 .Xr RAND_file_name 3
8428 will be used to create the filename if, and only if,
8430 documents that the SSL PRNG is not yet sufficiently seeded.
8431 If \*(UA successfully seeded the SSL PRNG then it'll update the file via
8432 .Xr RAND_write_file 3 .
8433 This variable is only used if
8435 is not set (or not supported by the SSL/TLS library).
8438 .It Va ssl-verify-USER@HOST , ssl-verify-HOST , ssl-verify
8439 \*(OP Variable chain that sets the action to be performed if an error
8440 occurs during SSL/TLS server certificate validation.
8441 Valid (case-insensitive) values are
8443 (fail and close connection immediately),
8445 (ask whether to continue on standard input),
8447 (show a warning and continue),
8449 (do not perform validation).
8455 If only set without an assigned value, then this option inhibits the
8460 header fields that include obvious references to \*(UA.
8461 There are two pitfalls associated with this:
8462 First, the message id of outgoing messages is not known anymore.
8463 Second, an expert may still use the remaining information in the header
8464 to track down the originating mail user agent.
8469 suppression doesn't occur.
8474 (\*(OP) This specifies a comma-separated list of
8479 .Sx "On terminal control and line editor" ,
8480 escape commas with reverse solidus) to be used to overwrite or define
8482 Note that this variable will only be queried once at program startup and
8483 can thus only be specified in resource files or on the command line.
8486 String capabilities form
8488 pairs and are expected unless noted otherwise.
8489 Numerics have to be notated as
8491 where the number is expected in normal decimal notation.
8492 Finally, booleans don't have any value but indicate a true or false
8493 state simply by being defined or not; this indeed means that \*(UA
8494 doesn't support undefining an existing boolean.
8495 String capability values will undergo some expansions before use:
8496 for one notations like
8499 .Ql control-LETTER ,
8500 and for clarification purposes
8502 can be used to specify
8504 (the control notation
8506 could lead to misreadings when a left bracket follows, which it does for
8507 the standard CSI sequence);
8508 finally three letter octal sequences, as in
8511 To specify that a terminal supports 256-colours, and to define sequences
8512 that home the cursor and produce an audible bell, one might write:
8514 .Bd -literal -offset indent
8515 set termcap='Co#256,home=\eE[H,bel=^G'
8519 The following terminal capabilities are or may be meaningful for the
8520 operation of the builtin line editor or \*(UA in general:
8523 .Bl -tag -compact -width yay
8525 .It Cd colors Ns \0or Cd Co
8527 numeric capability specifying the maximum number of colours.
8528 Note that \*(UA doesn't actually care about the terminal beside that,
8529 but always emits ANSI / ISO 6429 escape sequences.
8532 .It Cd rmcup Ns \0or Cd te Ns \0/ Cd smcup Ns \0or Cd ti
8536 respectively: exit and enter the alternative screen
8538 effectively turning \*(UA into a fullscreen application.
8539 To disable that, set (at least) one to the empty string.
8541 .It Cd smkx Ns \0or Cd ks Ns \0/ Cd rmkx Ns \0or Cd ke
8545 respectively: enable and disable the keypad.
8546 This is always enabled if available, because it seems even keyboards
8547 without keypads generate other key codes for, e.g., cursor keys in that
8548 case, and only if enabled we see the codes that we are interested in.
8550 .It Cd ed Ns \0or Cd cd
8554 .It Cd clear Ns \0or Cd cl
8556 clear the screen and home cursor.
8557 (Will be simulated via
8562 .It Cd home Ns \0or Cd ho
8567 .It Cd el Ns \0or Cd ce
8569 clear to the end of line.
8570 (Will be simulated via
8572 plus repetitions of space characters.)
8574 .It Cd hpa Ns \0or Cd ch
8575 .Cd column_address :
8576 move the cursor (to the given column parameter) in the current row.
8577 (Will be simulated via
8583 .Cd carriage_return :
8584 move to the first column in the current row.
8585 The default builtin fallback is
8588 .It Cd cub1 Ns \0or Cd le
8590 move the cursor left one space (non-destructively).
8591 The default builtin fallback is
8594 .It Cd cuf1 Ns \0or Cd nd
8596 move the cursor right one space (non-destructively).
8597 The default builtin fallback is
8599 which is used by most terminals.
8607 Many more capabilities which describe key-sequences are documented for
8611 .It Va termcap-disable
8612 \*(OP Disable any interaction with a terminal control library.
8613 If set only some generic fallback builtins and possibly the content of
8615 describe the terminal to \*(UA.
8617 that this variable will only be queried once at program startup and can
8618 thus only be specified in resource files or on the command line.
8622 If defined, gives the number of lines of a message to be displayed
8625 if unset, the first five lines are printed, if set to 0 the variable
8628 If the value is negative then its absolute value will be used for right
8631 height; (shifting bitwise is like dividing algorithmically, but since
8632 it takes away bits the value decreases pretty fast).
8636 \*(BO If set then the
8638 command series will strip adjacent empty lines and quotations.
8642 The character set of the terminal \*(UA operates on,
8643 and the one and only supported character set that \*(UA can use if no
8644 character set conversion capabilities have been compiled into it,
8645 in which case it defaults to ISO-8859-1 unless it can deduce a value
8649 Refer to the section
8650 .Sx "Character sets"
8651 for the complete picture about character sets.
8655 For a safety-by-default policy \*(UA sets its process
8659 but this variable can be used to override that:
8660 set it to an empty value to don't change the (current) setting,
8661 otherwise the process file mode creation mask is updated to the new value.
8662 Child processes inherit the process file mode creation mask.
8665 .It Va user-HOST , user
8666 \*(IN Variable chain that sets a global fallback user name, which is
8667 used in case none has been given in the protocol and account-specific
8669 This variable defaults to the name of the user who runs \*(UA.
8673 \*(BO Setting this option enables upward compatibility with \*(UA
8674 version 15.0 in respect to which configuration options are available and
8675 how they are handled.
8676 This manual uses \*(IN and \*(OU to refer to the new and the old way of
8677 doing things, respectively.
8681 \*(BO Setting this option, also controllable via the command line option
8683 causes \*(UA to be more verbose, e.g., it will display obsoletion
8684 warnings and SSL/TLS certificate chains.
8685 Even though marked \*(BO this option may be set twice in order to
8686 increase the level of verbosity even more, in which case even details of
8687 the actual message delivery and protocol conversations are shown.
8690 is sufficient to disable verbosity as such.
8696 .It Va version , version-major , version-minor , version-update
8697 \*(RO \*(UA version information: the first variable contains a string
8698 containing the complete version identification \(en this is identical to
8699 the output of the command
8701 The latter three contain only digits: the major, minor and update
8705 .It Va writebackedited
8706 If this variable is set messages modified using the
8710 commands are written back to the current folder when it is quit;
8711 it is only honoured for writable folders in MBOX format, though.
8712 Note that the editor will be pointed to the raw message content in that
8713 case, i.e., neither MIME decoding nor decryption will have been
8714 performed, and proper RFC 4155
8716 quoting of newly added or edited content is also left as an excercise to
8720 .\" }}} (INTERNAL VARIABLES)
8723 .\" .Sh ENVIRONMENT {{{
8727 .Dq environment variable
8728 should be considered an indication that these variables are either
8729 standardized as vivid parts of process environments, or that they are
8730 commonly found in there.
8731 The process environment is inherited from the
8733 once \*(UA is started, and unless otherwise explicitly noted handling of
8734 the following variables transparently integrates into that of the
8735 .Sx "INTERNAL VARIABLES"
8736 from \*(UA's point of view.
8737 This means that, e.g., they can be managed via
8741 causing automatic program environment updates (to be inherited by
8742 newly created child processes).
8745 In order to transparently integrate other environment variables equally
8746 they need to be imported (linked) with the command
8748 This command can also be used to set and unset non-integrated
8749 environment variables from scratch, sufficient system support provided.
8750 The following example, applicable to a POSIX shell, sets the
8752 environment variable for \*(UA only, and beforehand exports the
8754 in order to affect any further processing in the running shell:
8756 .Bd -literal -offset indent
8757 $ EDITOR="vim -u ${HOME}/.vimrc"
8759 $ COLUMNS=80 \*(uA -R
8762 .Bl -tag -width ".It Ev _AILR_"
8765 The user's preferred width in column positions for the terminal screen
8767 Queried and used once on program startup, actively managed for child
8768 processes and the MLE (see
8769 .Sx "On terminal control and line editor" )
8770 in interactive mode thereafter.
8774 The name of the (mailbox)
8776 to use for saving aborted messages if
8778 is set; this defaults to
8785 is set no output will be generated, otherwise the contents of the file
8790 Pathname of the text editor to use in the
8794 .Sx "TILDE ESCAPES" .
8795 A default editor is used if this value is not defined.
8799 The user's home directory.
8800 This variable is only used when it resides in the process environment.
8807 .It Ev LANG , LC_ALL , LC_COLLATE , LC_CTYPE , LC_MESSAGES
8811 .Sx "Character sets" .
8812 (Only recognized by the system in the process environment.)
8816 The user's preferred number of lines on a page or the vertical screen
8817 or window size in lines.
8818 Queried and used once on program startup, actively managed for child
8819 processes in interactive mode thereafter.
8823 Pathname of the directory lister to use in the
8825 command when operating on local mailboxes.
8828 (path search through
8833 Upon startup \*(UA will actively ensure that this variable refers to the
8834 name of the user who runs \*(UA, in order to be able to pass a verified
8835 name to any newly created child process.
8839 Is used as the user's primary system mailbox, if set.
8840 Otherwise, a system-dependent default is used.
8841 Supports the special syntax conventions that are documented for the
8847 \*(OP Overrides the default path search for
8848 .Sx "The Mailcap files" ,
8849 which is defined in the standard RFC 1524 as
8850 .Ql ~/.mailcap:\:/etc/mailcap:\:/usr/etc/mailcap:\:/usr/local/etc/mailcap .
8851 .\" TODO we should have a mailcaps-default virtual RDONLY option!
8852 (\*(UA makes it a configuration option, however.)
8853 Note this is not a search path, but a path search.
8857 Is used as a startup file instead of
8860 When \*(UA scripts are invoked on behalf of other users,
8861 either this variable should be set to
8865 command line option should be used in order to avoid side-effects from
8866 reading their configuration files.
8867 This variable is only used when it resides in the process environment.
8871 The name of the user's mbox file.
8872 A logical subset of the special conventions that are documented for the
8877 The fallback default is
8882 Traditionally this secondary mailbox is used as the file to save
8883 messages from the primary system mailbox that have been read.
8885 .Sx "Message states" .
8888 .It Ev NAIL_NO_SYSTEM_RC
8889 If this variable is set then reading of
8891 at startup is inhibited, i.e., the same effect is achieved as if \*(UA
8892 had been started up with the option
8894 This variable is only used when it resides in the process environment.
8898 \*(IN\*(OP This variable overrides the default location of the user's
8904 Pathname of the program to use for backing the command
8908 variable enforces usage of a pager for output.
8909 The default paginator is
8911 (path search through
8914 \*(UA inspects the contents of this variable: if its contains the string
8916 then a non-existing environment variable
8923 dependent on whether terminal control support is available and whether
8924 that supports full (alternative) screen mode or not (also see
8925 .Sx "On terminal control and line editor" ) .
8929 will optionally be set to
8936 A list of directories that is searched by the shell when looking for
8937 commands (as such only recognized in the process environment).
8941 The shell to use for the commands
8947 and when starting subprocesses.
8948 A default shell is used if this option is not defined.
8951 .It Ev SOURCE_DATE_EPOCH
8952 If set, this specifies a time in seconds since the Unix epoch
8953 (1970-01-01) to be used in place of the current time.
8954 This is for the sake of reproduceability of tests, to be used during
8955 development or by software packagers.
8959 \*(OP The terminal type for which output is to be prepared.
8960 For extended colour and font control please refer to
8961 .Sx "Coloured display" ,
8962 and for terminal management in general to
8963 .Sx "On terminal control and line editor" .
8967 Used as directory for temporary files instead of
8970 This variable is only used when it resides in the process environment.
8976 (see there), but this variable is not standardized, should therefore not
8977 be used, and is only corrected if already set.
8981 Pathname of the text editor to use in the
8985 .Sx "TILDE ESCAPES" .
8993 .Bl -tag -width ".It Pa _etc/mime.type_"
8995 File giving initial commands.
8998 System wide initialization file.
9002 \*(OP Personal MIME type handler definition file, see
9003 .Sx "The Mailcap files" .
9004 (RFC 1524 location, the actual path is a configuration option.)
9008 \*(OP System wide MIME type handler definition file, see
9009 .Sx "The Mailcap files" .
9010 (RFC 1524 location, the actual path is a configuration option.)
9013 .It Pa ~/.mime.types
9014 Personal MIME types, see
9015 .Sx "The mime.types files" .
9018 .It Pa /etc/mime.types
9019 System wide MIME types, see
9020 .Sx "The mime.types files" .
9024 \*(IN\*(OP The default location of the users
9026 file \(en the section
9027 .Sx "The .netrc file"
9028 documents the file format.
9031 .\" .Ss "The mime.types files" {{{
9032 .Ss "The mime.types files"
9034 When sending messages \*(UA tries to determine the content type of all
9036 When displaying message content or attachments \*(UA uses the content
9037 type to decide whether it can directly display data or whether it needs
9038 to deal with content handlers.
9039 It learns about MIME types and how to treat them by reading
9041 files, the loading of which can be controlled by setting the variable
9042 .Va mimetypes-load-control .
9045 can also be used to deal with MIME types.)
9047 files have the following syntax:
9050 .Dl type/subtype extension [extension ...]
9055 are strings describing the file contents, and one or multiple
9057 s, separated by whitespace, name the part of a filename starting after
9058 the last dot (of interest).
9059 Comments may be introduced anywhere on a line with a number sign
9061 causing the remaining line to be discarded.
9063 \*(UA also supports an extended, non-portable syntax in specially
9064 crafted files, which can be loaded via the alternative value syntax of
9065 .Va mimetypes-load-control
9066 and prepends an optional
9070 .Dl [type-marker ]type/subtype extension [extension ...]
9073 The following type markers are supported:
9076 .Bl -tag -compact -offset indent -width ".It Ar _n_u"
9078 Treat message parts with this content as plain text.
9083 Treat message parts with this content as HTML tagsoup.
9084 If the \*(OPal HTML-tagsoup-to-text converter is not available treat
9085 the content as plain text instead.
9089 but instead of falling back to plain text require an explicit content
9090 handler to be defined.
9095 for sending messages:
9097 .Va mime-allow-text-controls ,
9098 .Va mimetypes-load-control .
9099 For reading etc. messages:
9100 .Sx "HTML mail and MIME attachments" ,
9101 .Sx "The Mailcap files" ,
9103 .Va mime-counter-evidence ,
9104 .Va mimetypes-load-control ,
9105 .Va pipe-TYPE/SUBTYPE ,
9106 .Va pipe-EXTENSION .
9109 .\" .Ss "The Mailcap files" {{{
9110 .Ss "The Mailcap files"
9113 .Dq User Agent Configuration Mechanism
9114 which \*(UA \*(OPally supports.
9115 It defines a file format to be used to inform mail user agent programs
9116 about the locally-installed facilities for handling various data
9117 formats, i.e., about commands and how they can be used to display, edit
9118 etc. MIME part contents, as well as a default path search that includes
9119 multiple possible locations of
9123 environment variable that can be used to overwrite that (repeating here
9124 that it is not a search path, but instead a path search specification).
9125 Any existing files will be loaded in sequence, appending any content to
9126 the list of MIME type handler directives.
9130 files consist of a set of newline separated entries.
9131 Comment lines start with a number sign
9133 (in the first column!) and are ignored.
9134 Empty lines are also ignored.
9135 All other lines form individual entries that must adhere to the syntax
9137 To extend a single entry (not comment) its line can be continued on
9138 follow lines if newline characters are
9140 by preceding them with the reverse solidus character
9142 The standard doesn't specify how leading whitespace of follow lines is
9143 to be treated, therefore \*(UA retains it.
9147 entries consist of a number of semicolon
9149 separated fields, and the reverse solidus
9151 character can be used to escape any following character including
9152 semicolon and itself.
9153 The first two fields are mandatory and must occur in the specified
9154 order, the remaining fields are optional and may appear in any order.
9155 Leading and trailing whitespace of content is ignored (removed).
9158 The first field defines the MIME
9160 the entry is about to handle (case-insensitively, and no reverse solidus
9161 escaping is possible in this field).
9162 If the subtype is specified as an asterisk
9164 the entry is meant to match all subtypes of the named type, e.g.,
9166 would match any audio type.
9167 The second field defines the shell command which shall be used to
9169 MIME parts of the given type; it is implicitly called the
9176 shell commands message (MIME part) data is passed via standard input
9177 unless the given shell command includes one or more instances of the
9180 in which case these instances will be replaced with a temporary filename
9181 and the data will have been stored in the file that is being pointed to.
9184 shell commands data is assumed to be generated on standard output unless
9185 the given command includes (one ore multiple)
9187 In any case any given
9189 format is replaced with a(n already) properly quoted filename.
9190 Note that when a command makes use of a temporary file via
9192 then \*(UA will remove it again, as if the
9193 .Cd x-mailx-tmpfile ,
9194 .Cd x-mailx-tmpfile-fill
9196 .Cd x-mailx-tmpfile-unlink
9197 flags had been set; see below for more.
9200 The optional fields either define a shell command or an attribute (flag)
9201 value, the latter being a single word and the former being a keyword
9202 naming the field followed by an equals sign
9204 succeeded by a shell command, and as usual for any
9206 content any whitespace surrounding the equals sign will be removed, too.
9207 Optional fields include the following:
9210 .Bl -tag -width textualnewlines
9212 A program that can be used to compose a new body or body part in the
9219 field, but is to be used when the composing program needs to specify the
9221 header field to be applied to the composed data.
9225 A program that can be used to edit a body or body part in the given
9230 A program that can be used to print a message or body part in the given
9235 Specifies a program to be run to test some condition, e.g., the machine
9236 architecture, or the window system in use, to determine whether or not
9237 this mailcap entry applies.
9238 If the test fails, a subsequent mailcap entry should be sought; also see
9239 .Cd x-mailx-test-once .
9241 .It Cd needsterminal
9242 This flag field indicates that the given shell command must be run on
9243 an interactive terminal.
9244 \*(UA will temporarily release the terminal to the given command in
9245 interactive mode, in non-interactive mode this entry will be entirely
9246 ignored; this flag implies
9247 .Cd x-mailx-noquote .
9249 .It Cd copiousoutput
9250 A flag field which indicates that the output of the
9252 command will be an extended stream of textual output that can be
9253 (re)integrated into \*(UA's normal visual display.
9254 It is mutually exclusive with
9257 .Cd x-mailx-always .
9259 .It Cd textualnewlines
9260 A flag field which indicates that this type of data is line-oriented and
9263 all newlines should be converted to canonical form (CRLF) before
9264 encoding, and will be in that form after decoding.
9268 This field gives a file name format, in which
9270 will be replaced by a random string, the joined combination of which
9271 will be used as the filename denoted by
9272 .Ev NAIL_FILENAME_TEMPORARY .
9273 One could specify that a GIF file being passed to an image viewer should
9274 have a name ending in
9277 .Ql nametemplate=%s.gif .
9278 Note that \*(UA ignores the name template unless that solely specifies
9279 a filename suffix that consists of (ASCII) alphabetic and numeric
9280 characters, the underscore and dot only.
9283 Names a file, in X11 bitmap (xbm) format, which points to an appropriate
9284 icon to be used to visually denote the presence of this kind of data.
9285 This field is not used by \*(UA.
9288 A textual description that describes this type of data.
9290 .It Cd x-mailx-always
9291 Extension flag field that denotes that the given
9293 command shall be executed even if multiple messages will be displayed
9295 Normally messages which require external viewers that produce output
9296 which doesn't integrate into \*(UA's visual display (i.e., don't have
9298 set) have to be addressed directly and individually.
9299 (To avoid cases where, e.g., a thousand PDF viewer instances are spawned
9302 .It Cd x-mailx-even-if-not-interactive
9303 An extension flag test field \(em by default handlers without
9305 are entirely ignored in non-interactive mode, but if this flag is set
9306 then their use will be considered.
9307 It is an error if this flag is set for commands that use the flag
9310 .It Cd x-mailx-noquote
9311 An extension flag field that indicates that even a
9314 command shall not be used to generate message quotes
9315 (as it would be by default).
9317 .It Cd x-mailx-async
9318 Extension flag field that denotes that the given
9320 command shall be executed asynchronously, without blocking \*(UA.
9321 Cannot be used in conjunction with
9324 .It Cd x-mailx-test-once
9325 Extension flag which denotes whether the given
9327 command shall be evaluated once only and the (boolean) result be cached.
9328 This is handy if some global unchanging condition is to be queried, like
9329 .Dq running under the X Window System .
9331 .It Cd x-mailx-tmpfile
9332 Extension flag field that requests creation of a zero-sized temporary
9333 file, the name of which is to be placed in the environment variable
9334 .Ev NAIL_FILENAME_TEMPORARY .
9335 It is an error to use this flag with commands that include a
9339 .It Cd x-mailx-tmpfile-fill
9340 Normally the MIME part content is passed to the handler via standard
9341 input; if this flag is set then the data will instead be written into
9343 .Cd x-mailx-tmpfile .
9344 In order to cause deletion of the temporary file you will have to set
9345 .Cd x-mailx-tmpfile-unlink
9347 It is an error to use this flag with commands that include a
9351 .It Cd x-mailx-tmpfile-unlink
9352 Extension flag field that requests that the temporary file shall be
9353 deleted automatically when the command loop is entered again at latest.
9354 (Don't use this for asynchronous handlers.)
9355 It is an error to use this flag with commands that include a
9357 format, or without also setting
9360 .Cd x-mailx-tmpfile-fill .
9362 .It Cd x-mailx-tmpfile-keep
9365 implies the three tmpfile related flags above, but if you want, e.g.,
9367 and deal with the temporary file yourself, you can add in this flag to
9369 .Cd x-mailx-tmpfile-unlink .
9374 The standard includes the possibility to define any number of additional
9375 entry fields, prefixed by
9377 Flag fields apply to the entire
9379 entry \(em in some unusual cases, this may not be desirable, but
9380 differentiation can be accomplished via separate entries, taking
9381 advantage of the fact that subsequent entries are searched if an earlier
9382 one does not provide enough information.
9385 command needs to specify the
9389 command shall not, the following will help out the latter (with enabled
9393 level \*(UA will show information about handler evaluation):
9395 .Bd -literal -offset indent
9396 application/postscript; ps-to-terminal %s; needsterminal
9397 application/postscript; ps-to-terminal %s; compose=idraw %s
9401 In fields any occurrence of the format string
9403 will be replaced by the
9406 Named parameters from the
9408 field may be placed in the command execution line using
9410 followed by the parameter name and a closing
9413 The entire parameter should appear as a single command line argument,
9414 regardless of embedded spaces; thus:
9416 .Bd -literal -offset indent
9418 Content-type: multipart/mixed; boundary=42
9421 multipart/*; /usr/local/bin/showmulti \e
9422 %t %{boundary} ; composetyped = /usr/local/bin/makemulti
9424 # Executed shell command
9425 /usr/local/bin/showmulti multipart/mixed 42
9429 .\" TODO v15: Mailcap: %n,%F
9430 Note that \*(UA doesn't support handlers for multipart MIME parts as
9431 shown in this example (as of today).
9432 \*(UA doesn't support the additional formats
9436 An example file, also showing how to properly deal with the expansion of
9438 which includes any quotes that are necessary to make it a valid shell
9439 argument by itself and thus will cause undesired behaviour when placed
9440 in additional user-provided quotes:
9442 .Bd -literal -offset indent
9444 text/richtext; richtext %s; copiousoutput
9446 text/x-perl; perl -cWT %s
9450 trap "rm -f ${infile}" EXIT\e; \e
9451 trap "exit 75" INT QUIT TERM\e; \e
9453 x-mailx-async; x-mailx-tmpfile-keep
9455 application/*; echo "This is \e"%t\e" but \e
9456 is 50 \e% Greek to me" \e; < %s head -c 1024 | cat -vET; \e
9457 copiousoutput; x-mailx-noquote
9462 .Sx "HTML mail and MIME attachments" ,
9463 .Sx "The mime.types files" ,
9466 .Va mime-counter-evidence ,
9467 .Va pipe-TYPE/SUBTYPE ,
9468 .Va pipe-EXTENSION .
9471 .\" .Ss "The .netrc file" {{{
9472 .Ss "The .netrc file"
9476 file contains user credentials for machine accounts.
9477 The default location in the user's
9479 directory may be overridden by the
9481 environment variable.
9482 The file consists of space, tabulator or newline separated tokens.
9483 \*(UA implements a parser that supports a superset of the original BSD
9484 syntax, but users should nonetheless be aware of portability glitches
9485 of that file format, shall their
9487 be usable across multiple programs and platforms:
9490 .Bl -bullet -compact
9492 BSD doesn't support single, but only double quotation marks, e.g.,
9493 .Ql password="pass with spaces" .
9495 BSD (only?) supports escaping of single characters via a reverse solidus
9496 (e.g., a space can be escaped via
9498 in- as well as outside of a quoted string.
9500 BSD doesn't require the final quotation mark of the final user input token.
9502 The original BSD (Berknet) parser also supported a format which allowed
9503 tokens to be separated with commas \(en whereas at least Hewlett-Packard
9504 still seems to support this syntax, \*(UA does not!
9506 As a non-portable extension some widely-used programs support
9507 shell-style comments: if an input line starts, after any amount of
9508 whitespace, with a number sign
9510 then the rest of the line is ignored.
9512 Whereas other programs may require that the
9514 file is accessible by only the user if it contains a
9520 \*(UA will always require these strict permissions.
9524 Of the following list of supported tokens \*(UA only uses (and caches)
9529 At runtime the command
9531 can be used to control \*(UA's
9535 .Bl -tag -width password
9536 .It Cd machine Ar name
9537 The hostname of the entries' machine, lowercase-normalized by \*(UA
9539 Any further file content, until either end-of-file or the occurrence
9544 first-class token is bound (only related) to the machine
9547 As an extension that shouldn't be the cause of any worries
9548 \*(UA supports a single wildcard prefix for
9550 .Bd -literal -offset indent
9551 machine *.example.com login USER password PASS
9552 machine pop3.example.com login USER password PASS
9553 machine smtp.example.com login USER password PASS
9559 .Ql pop3.example.com ,
9563 .Ql local.smtp.example.com .
9564 Note that in the example neither
9565 .Ql pop3.example.com
9567 .Ql smtp.example.com
9568 will be matched by the wildcard, since the exact matches take
9569 precedence (it is however faster to specify it the other way around).
9574 except that it is a fallback entry that is used shall none of the
9575 specified machines match; only one default token may be specified,
9576 and it must be the last first-class token.
9578 .It Cd login Ar name
9579 The user name on the remote machine.
9581 .It Cd password Ar string
9582 The user's password on the remote machine.
9584 .It Cd account Ar string
9585 Supply an additional account password.
9586 This is merely for FTP purposes.
9588 .It Cd macdef Ar name
9590 A macro is defined with the specified
9592 it is formed from all lines beginning with the next line and continuing
9593 until a blank line is (consecutive newline characters are) encountered.
9596 entries cannot be utilized by multiple machines, too, but must be
9597 defined following the
9599 they are intended to be used with.)
9602 exists, it is automatically run as the last step of the login process.
9603 This is merely for FTP purposes.
9610 .\" .Sh EXAMPLES {{{
9613 .\" .Ss "An example configuration" {{{
9614 .Ss "An example configuration"
9616 .Bd -literal -offset indent
9617 # This example assumes v15.0 compatibility mode
9620 # Where are the up-to-date SSL certificates?
9621 #set ssl-ca-dir=/etc/ssl/certs
9622 set ssl-ca-file=/etc/ssl/certs/ca-certificates.crt
9624 # (Since we manage up-to-date ones explicitly, don't use any,
9625 # possibly outdated, default certificates shipped with OpenSSL)
9626 set ssl-no-default-ca
9628 # Don't use protocols older than TLS v1.2.
9629 # Change this only when the remote server doesn't support it:
9630 # maybe use ssl-protocol-HOST (or -USER@HOST) syntax to define
9631 # such explicit exceptions, then
9632 set ssl-protocol='-ALL,+TLSv1.2'
9634 # Explicitly define the list of ciphers, which may improve security,
9635 # especially with protocols older than TLS v1.2. See ciphers(1).
9636 # Including "@STRENGTH" will sort the final list by algorithm strength.
9637 # In reality it is possibly best to only use ssl-cipher-list-HOST
9638 # (or -USER@HOST), as necessary, again..
9639 set ssl-cipher-list=TLSv1.2:!aNULL:!eNULL:!MEDIUM:!LOW:!EXPORT:@STRENGTH
9640 # ALL:!aNULL:!MEDIUM:!LOW:!MD5:!RC4:!EXPORT:@STRENGTH
9642 # Request strict transport security checks!
9643 set ssl-verify=strict
9645 # Essential setting: select allowed character sets
9646 set sendcharsets=utf-8,iso-8859-1
9648 # A very kind option: when replying to a message, first try to
9649 # use the same encoding that the original poster used herself!
9650 set reply-in-same-charset
9652 # When replying to or forwarding a message the comment and name
9653 # parts of email addresses are removed unless this variable is set
9656 # When sending messages, wait until the Mail-Transfer-Agent finishs.
9657 # Only like this you'll be able to see errors reported through the
9658 # exit status of the MTA (including the builtin SMTP one)!
9661 # Only use builtin MIME types, no mime.types(5) files
9662 set mimetypes-load-control
9664 # Default directory where we act in (relative to $HOME)
9666 # A leading "+" (often) means: under *folder*
9667 # *record* is used to save copies of sent messages
9668 set MBOX=+mbox.mbox record=+sent.mbox DEAD=+dead.txt
9670 # Make "file mymbox" and "file myrec" go to..
9671 shortcut mymbox %:+mbox.mbox myrec +sent.mbox
9673 # Not really optional, e.g., for S/MIME
9674 set from='Your Name <address@exam.ple>'
9676 # It may be necessary to set hostname and/or smtp-hostname
9677 # if the "SERVER" of mta and "domain" of from don't match.
9678 # The `urlencode' command can be used to encode USER and PASS
9679 set mta=(smtps?|submission)://[USER[:PASS]@]SERVER[:PORT] \e
9680 smtp-auth=login/plain... \e
9683 # Never refuse to start into interactive mode, and more
9685 colour-pager crt= \e
9686 followup-to followup-to-honour=ask-yes \e
9687 history-file=+.\*(uAhist history-size=-1 history-gabby \e
9688 mime-counter-evidence=0xE \e
9689 prompt='?\e?[\e$ \e@]\e& ' \e
9690 reply-to-honour=ask-yes \e
9693 # When `t'yping messages, show only these headers
9694 # (use `T'ype for all headers and `S'how for raw message)
9695 retain date from to cc subject
9697 # Some mailing lists
9698 mlist '@xyz-editor\e.xyz$' '@xyzf\e.xyz$'
9699 mlsubscribe '^xfans@xfans\e.xyz$'
9701 # A real life example of a very huge free mail provider
9703 set folder=~/spool/XooglX MAIL=+syste.mbox sent=+sent
9704 set from='Your Name <address@examp.ple>'
9705 set mta=smtp://USER:PASS@smtp.gmXil.com smtp-use-starttls
9708 # Here is a pretty large one which does not allow sending mails
9709 # if there is a domain name mismatch on the SMTP protocol level,
9710 # which would bite us if the value of from does not match, e.g.,
9711 # for people who have a sXXXXeforge project and want to speak
9712 # with the mailing list under their project account (in from),
9713 # still sending the message through their normal mail provider
9715 set folder=~/spool/XandeX MAIL=+syste.mbox sent=+sent
9716 set from='Your Name <address@exam.ple>'
9717 set mta=smtps://USER:PASS@smtp.yaXXex.ru:465 \e
9718 hostname=yaXXex.com smtp-hostname=
9721 # Create some new commands so that, e.g., `ls /tmp' will..
9722 wysh ghost lls '!ls ${LS_COLOR_FLAG} -aFlrS'
9723 wysh ghost llS '!ls ${LS_COLOR_FLAG} -aFlS'
9724 wysh ghost ls '!ls ${LS_COLOR_FLAG} -aFrS'
9725 wysh ghost lS '!ls ${LS_COLOR_FLAG} -aFS'
9726 wysh ghost lla '!ls ${LS_COLOR_FLAG} -aFlr'
9727 wysh ghost llA '!ls ${LS_COLOR_FLAG} -aFl'
9728 wysh ghost la '!ls ${LS_COLOR_FLAG} -aFr'
9729 wysh ghost lA '!ls ${LS_COLOR_FLAG} -aF'
9730 wysh ghost ll '!ls ${LS_COLOR_FLAG} -aFltr'
9731 wysh ghost lL '!ls ${LS_COLOR_FLAG} -aFlt'
9732 wysh ghost l '!ls ${LS_COLOR_FLAG} -aFtr'
9733 wysh ghost L '!ls ${LS_COLOR_FLAG} -aFt'
9735 # We don't support gpg(1) directly yet. But simple --clearsign'd
9736 # message parts can be dealt with as follows:
9738 wysh set pipe-text/plain=$'@*#++=@\e
9739 < "${NAIL_FILENAME_TEMPORARY}" awk \e
9740 -v TMPFILE="${NAIL_FILENAME_TEMPORARY}" \e'\e
9742 /^-----BEGIN PGP SIGNED MESSAGE-----/,/^$/{\e
9745 print "--- GPG --verify ---";\e
9746 system("gpg --verify " TMPFILE " 2>&1");\e
9747 print "--- GPG --verify ---";\e
9751 /^-----BEGIN PGP SIGNATURE-----/,\e
9752 /^-----END PGP SIGNATURE-----/{\e
9762 !printf 'Key IDs to gpg --recv-keys: ';\e
9764 gpg --recv-keys ${keyids};
9770 When storing passwords in
9772 appropriate permissions should be set on this file with
9773 .Ql $ chmod 0600 \*(ur .
9776 is available user credentials can be stored in the central
9778 file instead; e.g., here is a different version of the example account
9779 that sets up SMTP and POP3:
9781 .Bd -literal -offset indent
9783 set folder=~/spool/XandeX MAIL=+syste.mbox sent=+sent
9784 set from='Your Name <address@exam.ple>'
9786 # Load an encrypted ~/.netrc by uncommenting the next line
9787 #set netrc-pipe='gpg -qd ~/.netrc.pgp'
9789 set mta=smtps://smtp.yXXXXx.ru:465 \e
9790 smtp-hostname= hostname=yXXXXx.com
9791 set pop3-keepalive=240 pop3-no-apop-pop.yXXXXx.ru
9792 ghost xp fi pop3s://pop.yXXXXx.ru
9801 .Bd -literal -offset indent
9802 machine *.yXXXXx.ru login USER password PASS
9806 This configuration should now work just fine:
9809 .Dl $ echo text | \*(uA -vv -AXandeX -s Subject user@exam.ple
9812 .\" .Ss "Signed and encrypted messages with S/MIME" {{{
9813 .Ss "Signed and encrypted messages with S/MIME"
9815 \*(OP S/MIME provides two central mechanisms:
9816 message signing and message encryption.
9817 A signed message contains some data in addition to the regular text.
9818 The data can be used to verify that the message was sent using a valid
9819 certificate, that the sender's address in the message header matches
9820 that in the certificate, and that the message text has not been altered.
9821 Signing a message does not change its regular text;
9822 it can be read regardless of whether the recipient's software is able to
9826 It is thus usually possible to sign all outgoing messages if so desired.
9827 Encryption, in contrast, makes the message text invisible for all people
9828 except those who have access to the secret decryption key.
9829 To encrypt a message, the specific recipient's public encryption key
9831 It is therefore not possible to send encrypted mail to people unless their
9832 key has been retrieved from either previous communication or public key
9834 A message should always be signed before it is encrypted.
9835 Otherwise, it is still possible that the encrypted message text is
9839 A central concept to S/MIME is that of the certification authority (CA).
9840 A CA is a trusted institution that issues certificates.
9841 For each of these certificates it can be verified that it really
9842 originates from the CA, provided that the CA's own certificate is
9844 A set of CA certificates is usually delivered with OpenSSL and installed
9846 If you trust the source of your OpenSSL software installation,
9847 this offers reasonable security for S/MIME on the Internet.
9849 .Va ssl-no-default-ca
9853 .Va smime-ca-dir . )
9854 In general, a certificate cannot be more secure than the method its CA
9855 certificate has been retrieved with, though.
9856 Thus if you download a CA certificate from the Internet,
9857 you can only trust the messages you verify using that certificate as
9858 much as you trust the download process.
9861 The first thing you need for participating in S/MIME message exchange is
9862 your personal certificate, including a private key.
9863 The certificate contains public information, in particular your name and
9864 your email address(es), and the public key that is used by others to
9865 encrypt messages for you,
9866 and to verify signed messages they supposedly received from you.
9867 The certificate is included in each signed message you send.
9868 The private key must be kept secret.
9869 It is used to decrypt messages that were previously encrypted with your
9870 public key, and to sign messages.
9873 For personal use it is recommended that you get a S/MIME certificate
9874 from one of the major CAs on the Internet using your WWW browser.
9875 Many CAs offer such certificates for free.
9877 .Lk https://www.CAcert.org
9878 which issues client and server certificates to members of their
9879 community for free; their root certificate
9880 .Pf ( Lk https://\:www.cacert.org/\:certs/\:root.crt )
9881 is often not in the default set of trusted CA root certificates, though,
9882 which means you will have to download their root certificate separately
9883 and ensure it is part of our S/MIME certificate validation chain by
9886 or as a vivid member of the
9888 But let's take a step-by-step tour on how to setup S/MIME with
9889 a certificate from CAcert.org despite this situation!
9892 First of all you will have to become a member of the CAcert.org
9893 community, simply by registrating yourself via the web interface.
9894 Once you are, create and verify all email addresses you want to be able
9895 to create signed and encrypted messages for/with using the corresponding
9896 entries of the web interface.
9897 Now ready to create S/MIME certificates, so let's create a new
9898 .Dq client certificate ,
9899 ensure to include all email addresses that should be covered by the
9900 certificate in the following web form, and also to use your name as the
9904 Create a private key and a certificate request on your local computer
9905 (please see the manual pages of the used commands for more in-depth
9906 knowledge on what the used arguments etc. do):
9909 .Dl openssl req -nodes -newkey rsa:4096 -keyout key.pem -out creq.pem
9912 Afterwards copy-and-paste the content of
9914 into the certificate-request (CSR) field of the web form on the
9915 CAcert.org website (you may need to unfold some
9916 .Dq advanced options
9917 to see the corresponding text field).
9918 This last step will ensure that your private key (which never left your
9919 box) and the certificate belong together (through the public key that
9920 will find its way into the certificate via the certificate-request).
9921 You are now ready and can create your CAcert certified certificate.
9922 Download and store or copy-and-paste it as
9927 In order to use your new S/MIME setup you will have to create
9928 a combined private key/public key (certificate) file:
9931 .Dl cat key.pem pub.crt > ME@HERE.com.paired
9934 This is the file \*(UA will work with.
9935 If you have created your private key with a passphrase then \*(UA will
9936 ask you for it whenever a message is signed or decrypted.
9937 Set the following variables to henceforth use S/MIME (setting
9939 is of interest for verification only):
9941 .Bd -literal -offset indent
9942 set smime-ca-file=ALL-TRUSTED-ROOT-CERTS-HERE \e
9943 smime-sign-cert=ME@HERE.com.paired \e
9944 smime-sign-message-digest=SHA256 \e
9949 From each signed message you send, the recipient can fetch your
9950 certificate and use it to send encrypted mail back to you.
9951 Accordingly if somebody sends you a signed message, you can do the same,
9954 command to check the validity of the certificate.
9957 Variables of interest for S/MIME signing:
9961 .Va smime-crl-file ,
9962 .Va smime-no-default-ca ,
9964 .Va smime-sign-cert ,
9965 .Va smime-sign-include-certs
9967 .Va smime-sign-message-digest .
9970 After it has been verified save the certificate via
9972 and tell \*(UA that it should use it for encryption for further
9973 communication with that somebody:
9975 .Bd -literal -offset indent
9977 set smime-encrypt-USER@HOST=FILENAME \e
9978 smime-cipher-USER@HOST=AES256
9982 Additional variables of interest for S/MIME en- and decryption:
9985 .Va smime-encrypt-USER@HOST .
9988 You should carefully consider if you prefer to store encrypted messages
9990 If you do, anybody who has access to your mail folders can read them,
9991 but if you do not, you might be unable to read them yourself later if
9992 you happen to lose your private key.
9995 command saves messages in decrypted form, while the
9999 commands leave them encrypted.
10002 Note that neither S/MIME signing nor encryption applies to message
10003 subjects or other header fields yet.
10004 Thus they may not contain sensitive information for encrypted messages,
10005 and cannot be trusted even if the message content has been verified.
10006 When sending signed messages,
10007 it is recommended to repeat any important header information in the
10011 .\" .Ss "Using CRLs with S/MIME or SSL/TLS" {{{
10012 .Ss "Using CRLs with S/MIME or SSL/TLS"
10014 \*(OP Certification authorities (CAs) issue certificate revocation
10015 lists (CRLs) on a regular basis.
10016 These lists contain the serial numbers of certificates that have been
10017 declared invalid after they have been issued.
10018 Such usually happens because the private key for the certificate has
10020 because the owner of the certificate has left the organization that is
10021 mentioned in the certificate, etc.
10022 To seriously use S/MIME or SSL/TLS verification,
10023 an up-to-date CRL is required for each trusted CA.
10024 There is otherwise no method to distinguish between valid and
10025 invalidated certificates.
10026 \*(UA currently offers no mechanism to fetch CRLs, nor to access them on
10027 the Internet, so you have to retrieve them by some external mechanism.
10030 \*(UA accepts CRLs in PEM format only;
10031 CRLs in DER format must be converted, like, e.\|g.:
10034 .Dl $ openssl crl \-inform DER \-in crl.der \-out crl.pem
10037 To tell \*(UA about the CRLs, a directory that contains all CRL files
10038 (and no other files) must be created.
10043 variables, respectively, must then be set to point to that directory.
10044 After that, \*(UA requires a CRL to be present for each CA that is used
10045 to verify a certificate.
10048 .\" .Ss "Handling spam" {{{
10049 .Ss "Handling spam"
10051 \*(OP \*(UA can make use of several spam interfaces for the purpose of
10052 identification of, and, in general, dealing with spam messages.
10053 A precondition of most commands in order to function is that the
10055 variable is set to one of the supported interfaces.
10056 Once messages have been identified as spam their (volatile)
10058 state can be prompted: the
10062 message specifications will address respective messages and their
10064 entries will be used when displaying the
10066 in the header display.
10071 rates the given messages and sets their
10074 If the spam interface offers spam scores those can also be displayed in
10075 the header display by including the
10085 will interact with the Bayesian filter of the chosen interface and learn
10086 the given messages as
10090 respectively; the last command can be used to cause
10092 of messages; it adheres to their current
10094 state and thus reverts previous teachings.
10099 will simply set and clear, respectively, the mentioned volatile
10101 message flag, without any interface interaction.
10108 .Va spam-interface Ns s
10112 require a running instance of the
10114 server in order to function, started with the option
10116 shall Bayesian filter learning be possible.
10118 only works via a local path-based
10120 socket, but otherwise the following will be equivalently fine:
10122 .Bd -literal -offset indent
10123 $ spamd -i localhost:2142 -i /tmp/.spamsock -d [-L] [-l]
10124 $ spamd --listen=localhost:2142 --listen=/tmp/.spamsock \e
10125 --daemonize [--local] [--allow-tell]
10129 Thereafter \*(UA can make use of these interfaces:
10131 .Bd -literal -offset indent
10132 $ \*(uA -Sspam-interface=spamd -Sspam-maxsize=500000 \e
10133 -Sspamd-socket=/tmp/.spamsock -Sspamd-user=
10135 $ \*(uA -Sspam-interface=spamc -Sspam-maxsize=500000 \e
10136 -Sspamc-command=/usr/local/bin/spamc \e
10137 -Sspamc-arguments="-U /tmp/.spamsock" -Sspamc-user=
10139 $ \*(uA -Sspam-interface=spamc -Sspam-maxsize=500000 \e
10140 -Sspamc-command=/usr/local/bin/spamc \e
10141 -Sspamc-arguments="-d localhost -p 2142" -Sspamc-user=
10145 Using the generic filter approach allows usage of programs like
10147 Here is an example, requiring it to be accessible via
10150 .Bd -literal -offset indent
10151 $ \*(uA -Sspam-interface=filter -Sspam-maxsize=500000 \e
10152 -Sspamfilter-ham="bogofilter -n" \e
10153 -Sspamfilter-noham="bogofilter -N" \e
10154 -Sspamfilter-nospam="bogofilter -S" \e
10155 -Sspamfilter-rate="bogofilter -TTu 2>/dev/null" \e
10156 -Sspamfilter-spam="bogofilter -s" \e
10157 -Sspamfilter-rate-scanscore="1;^(.+)$"
10161 Because messages must exist on local storage in order to be scored (or
10162 used for Bayesian filter training), it is possibly a good idea to
10163 perform the local spam check last:
10165 .Bd -literal -offset indent
10166 define spamdelhook {
10168 spamset (header x-dcc-brand-metrics "bulk")
10169 # Server-side spamassassin(1)
10170 spamset (header x-spam-flag "YES")
10171 del :s # TODO we HAVE to be able to do `spamrate :u ! :sS'
10172 move :S +maybe-spam
10175 move :S +maybe-spam
10177 set folder-hook-FOLDER=spamdelhook
10181 See also the documentation for the variables
10182 .Va spam-interface , spam-maxsize ,
10183 .Va spamc-command , spamc-arguments , spamc-user ,
10184 .Va spamd-socket , spamd-user ,
10185 .Va spamfilter-ham , spamfilter-noham , spamfilter-nospam , \
10188 .Va spamfilter-rate-scanscore .
10196 In general it is a good idea to turn on
10202 twice) if something doesn't work well.
10203 Very often a diagnostic message can be produced that leads to the
10204 problems' solution.
10206 .\" .Ss "\*(UA shortly hangs on startup" {{{
10207 .Ss "\*(UA shortly hangs on startup"
10209 This can have two reasons, one is the necessity to wait for a file lock
10210 and can't be helped, the other being that \*(UA calls the function
10212 in order to query the nodename of the box (sometimes the real one is
10213 needed instead of the one represented by the internal variable
10215 You may have varying success by ensuring that the real hostname and
10219 or, more generally, that the name service is properly setup \(en
10222 return what you'd expect?
10223 Does this local hostname has a domain suffix?
10224 RFC 6762 standardized the link-local top-level domain
10228 .\" .Ss "I can't login to Google mail aka GMail" {{{
10229 .Ss "I can't login to Google mail aka GMail"
10231 Since 2014 some free service providers classify programs as
10233 unless they use a special authentification method (OAuth 2.0) which
10234 wasn't standardized for non-HTTP protocol authentication token query
10235 until August 2015 (RFC 7628).
10238 Different to Kerberos / GSSAPI, which is developed since the mid of the
10239 1980s, where a user can easily create a local authentication ticket for
10240 her- and himself with the locally installed
10242 program, that protocol has no such local part but instead requires
10243 a world-wide-web query to create or fetch a token; since there is no
10244 local cache this query has to be performed whenever \*(UA is invoked
10245 from the command line (in interactive sessions situation may differ).
10248 \*(UA doesn't support OAuth.
10249 Because of this it is necessary to declare \*(UA a
10250 .Dq less secure app
10251 (on the providers account web page) in order to read and send mail.
10252 However, it also seems possible to take the following steps instead:
10257 give the provider the number of a mobile phone,
10260 .Dq 2-Step Verification ,
10262 create an application specific password (16 characters), and
10264 use that special password instead of your real Google account password in
10265 \*(UA (for more on that see the section
10266 .Sx "On URL syntax and credential lookup" ) .
10270 .\" .Ss "Not \(dqdefunctional\(dq, but the editor key won't work" {{{
10271 .Ss "Not \(dqdefunctional\(dq, but the editor key won't work"
10273 It can happen that the terminal library (see
10274 .Sx "On terminal control and line editor",
10277 reports different codes than the terminal really sends, in which case
10278 \*(UA will tell that a key binding is functional, but won't be able to
10279 recognize it because the received data doesn't match anything expected.
10280 The verbose listing of
10282 ings will show the byte sequences that are expected.
10285 To overcome the situation, use, e.g., the program
10287 in conjunction with the
10289 flag if available, to see the byte sequences which are actually produced
10290 by keypresses, and use the variable
10292 to make \*(UA aware of them.
10293 E.g., the terminal this is typed on produces some false sequences, here
10294 an example showing the shifted home key:
10296 .Bd -literal -offset indent
10299 # 1B 5B=[ 31=1 3B=; 32=2 48=H
10304 ? \*(uA -v -Stermcap='kHOM=\eE[H'
10313 .\" .Sh "SEE ALSO" {{{
10323 .Xr spamassassin 1 ,
10332 .Xr mailwrapper 8 ,
10337 .\" .Sh HISTORY {{{
10340 M. Douglas McIlroy writes in his article
10341 .Dq A Research UNIX Reader: Annotated Excerpts \
10342 from the Programmer's Manual, 1971-1986
10345 command already appeared in First Edition
10349 .Bd -ragged -offset indent
10350 Electronic mail was there from the start.
10351 Never satisfied with its exact behavior, everybody touched it at one
10352 time or another: to assure the safety of simultaneous access, to improve
10353 privacy, to survive crashes, to exploit uucp, to screen out foreign
10354 freeloaders, or whatever.
10355 Not until v7 did the interface change (Thompson).
10356 Later, as mail became global in its reach, Dave Presotto took charge and
10357 brought order to communications with a grab-bag of external networks
10363 Mail was written in 1978 by Kurt Shoens and developed as part of the
10366 distribution until 1995.
10367 Mail has then seen further development in open source
10369 variants, noticeably by Christos Zoulas in
10371 Basing upon this Nail, later Heirloom Mailx, was developed by Gunnar
10372 Ritter in the years 2000 until 2008.
10373 Since 2012 S-nail is maintained by Steffen (Daode) Nurpmeso.
10374 This man page is derived from
10375 .Dq The Mail Reference Manual
10376 that was originally written by Kurt Shoens.
10382 .An "Kurt Shoens" ,
10383 .An "Edward Wang" ,
10384 .An "Keith Bostic" ,
10385 .An "Christos Zoulas" ,
10386 .An "Gunnar Ritter" ,
10387 .An "Steffen Nurpmeso" Aq Mt s-nail-users@lists.sourceforge.net
10389 .Mt s-mailx@sdaoden.eu ) .
10392 .\" .Sh CAVEATS {{{
10395 \*(ID Interrupting an operation via
10399 is often problematic: many library functions cannot deal with the
10401 that this software (still) performs.
10404 The SMTP and POP3 protocol support of \*(UA is very basic.
10405 Also, if it fails to contact its upstream SMTP server, it will not make
10406 further attempts to transfer the message at a later time (setting
10411 If this is a concern, it might be better to set up a local SMTP server
10412 that is capable of message queuing.
10418 After deleting some message of a POP3 mailbox the header summary falsely
10419 claims that there are no messages to display, you need to perform
10420 a scroll or dot movement to restore proper state.
10422 In threaded display a power user may encounter crashes very
10423 occasionally (this is may and very).
10427 in the source repository lists future directions.