1 .\"@ nail.1 - S-nail(1) reference manual.
3 .\" Copyright (c) 2000-2008 Gunnar Ritter, Freiburg i. Br., Germany.
4 .\" Copyright (c) 2012 - 2017 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.9.0-pre3 / 2016-12-31
36 .ds VV \\%v14.9.0-pre3
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
130 .Sx "Shell-style argument quoting"
131 rules, for example, and shell metacharacters will become meaningful.
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 provides a simple and friendly environment for sending and
147 It is intended to provide the functionality of the POSIX
149 command, but is MIME capable and optionally offers extensions for
150 line editing, S/MIME, SMTP and POP3, among others.
151 \*(UA divides incoming mail into its constituent messages and allows
152 the user to deal with them in any order.
156 .Sx "INTERNAL VARIABLES"
157 for manipulating messages and sending mail.
158 It provides the user simple editing capabilities to ease the composition
159 of outgoing messages, and increasingly powerful and reliable
160 non-interactive scripting capabilities.
162 .\" .Ss "Options" {{{
165 .Bl -tag -width ".It Fl BaNg"
168 Explicitly control which of the
170 shall be loaded: if the letter
172 is (case-insensitively) part of the
176 is loaded, likewise the letter
178 controls loading of the user's personal
180 file, whereas the letters
184 explicitly forbid loading of any resource files.
185 This option should be used by scripts: to avoid environmental noise they
188 from any configuration files and create a script-local environment,
189 explicitly setting any of the desired
190 .Sx "INTERNAL VARIABLES"
193 This option overrides
200 command for the given user email
202 after program startup is complete (all resource files are loaded, any
204 setting is being established; only
206 commands have not been evaluated yet).
207 Being a special incarnation of
209 macros for the purpose of bundling longer-lived settings, activating
210 such an email account also switches to the accounts
212 .Sx "primary system mailbox"
217 .It Fl a Ar file Ns Op Ar =input-charset Ns Op Ar #output-charset
220 to the message (for compose mode opportunities refer to
224 .Sx "Filename transformations"
227 will be performed, but shell word expansion is restricted to the tilde
231 not be accessible but contain a
233 character, then anything before the
235 will be used as the filename, anything thereafter as a character set
238 If an input character set is specified,
239 .Mx -ix "character set specification"
240 but no output character set, then the given input character set is fixed
241 as-is, and no conversion will be applied;
242 giving the special string hyphen-minus
244 will be treated as if
246 has been specified (the default).
247 If an output character set has also been given then the conversion will
248 be performed exactly as specified and on-the-fly, not considering the
249 file's type and content.
250 As an exception, if the output character set is specified as hyphen-minus
252 then the default conversion algorithm (see
253 .Sx "Character sets" )
254 is applied (therefore no conversion is performed on-the-fly,
256 will be MIME-classified and its contents will be inspected first).
257 It is an error to specify anything but
259 if no character set conversion is available
261 does not include the term
266 (\*(OB: \*(UA will always use line-buffered output, to gain
267 line-buffered input even in batch mode enable batch mode via
272 Send a blind carbon copy to
274 ess, if the setting of
277 .Sx "INTERNAL VARIABLES" ,
279 The option may be used multiple times.
281 .Sx "On sending mail, and non-interactive mode" .
285 Send carbon copies to the given receiver, if so allowed by
287 May be used multiple times.
292 the internal variable
294 which enables debug messages and disables message delivery,
295 among others; effectively turns almost any operation into a dry-run.
301 and thus discard messages with an empty message part body.
302 This command line option is \*(OB.
306 Just check if mail is present (in the specified or system
308 if yes, return an exit status of zero, a non-zero value otherwise.
309 To restrict the set of mails to consider in this evaluation a message
310 specification can be added with the option
315 Save the message to send in a file named after the local part of the
316 first recipient's address (instead of in
321 Read in the contents of the user's
323 (or the specified file) for processing;
324 when \*(UA is quit, it writes undeleted messages back to this file
330 argument will undergo some special
331 .Sx "Filename transformations"
336 is not a argument to the flag
338 but is instead taken from the command line after option processing has
342 that starts with a hyphen-minus, prefix with a relative path, as in
343 .Ql ./-hyphenbox.mbox .
347 Display a summary of the
349 of all messages in the specified mailbox or system
352 A configurable summary view is available via the
358 Show a short usage summary.
359 Because of widespread use a
361 argument will have the same effect.
367 to ignore tty interrupt signals.
370 .It Fl L Ar spec-list
371 Display a summary of all
373 of only those messages in the specified mailbox or the system
379 .Sx "Specifying messages"
386 option has been given in addition no header summary is produced,
387 but \*(UA will instead indicate via its exit status whether
393 note that any verbose output is suppressed in this mode and must instead
394 be enabled explicitly (e.g., by using the option
399 Special send mode that will flag standard input with the MIME
403 and use it as the main message body.
404 \*(ID Using this option will bypass processing of
405 .Va message-inject-head ,
408 .Va message-inject-tail .
414 Special send mode that will MIME classify the specified
416 and use it as the main message body.
417 \*(ID Using this option will bypass processing of
418 .Va message-inject-head ,
421 .Va message-inject-tail .
427 inhibit the initial display of message headers when reading mail or
428 editing a mail folder by calling
430 for the internal variable
435 Standard flag that inhibits reading the system wide
440 allows more control over the startup sequence; also see
441 .Sx "Resource files" .
445 Special send mode that will initialize the message body with the
446 contents of the specified
448 which may be standard input
450 only in non-interactive context.
456 Any folder opened will be in read-only mode.
460 .It Fl r Ar from-addr
461 The source address that appears in the
464 header of a message (or in the
467 header if the former contains multiple addresses) is not used for
468 relaying and delegating a message over the wire via SMTP, but instead an
469 envelope will enwrap the message content and provide the necessary
470 information (i.e., the RFC 5321 reverse-path, also used to report, e.g.,
471 delivery errors) to transmit the message to its destination(s).
472 Whereas said headers and internal variables will be used by \*(UA to
473 create the envelope if the builtin SMTP
475 (Mail-Transfer-Agent) is used, a file-based MTA will instead use the
476 identity of the message-originating user.
478 This command line option can be used to specify the reverse-path, to be
479 passed to a file-based
481 when a message is sent, via
482 .Ql -f Ar from-addr .
485 include a user name, then the address components will be separated and
486 the name part will be passed to a file-based
492 is also assigned to the internal variable
494 Many default installations and sites disallow explicit overriding of the
495 user identity which could be adjusted by this option, unless either
497 has been configured accordingly, or the user is member of a group with
498 special privileges, respectively.
500 If an empty string is passed as
502 then the content of the variable
504 (or, if that contains multiple addresses,
506 will be evaluated and used for this purpose whenever the file-based
509 Note that \*(UA by default, without
511 that is, neither passes
515 command line options to a file-based MTA by itself, unless this
516 automatic deduction is enforced by
518 ing the internal variable
519 .Va r-option-implicit .
523 .It Fl S Ar var Ns Op = Ns value
527 iable and, in case of a non-boolean variable which has a value, assign
531 .Sx "INTERNAL VARIABLES"
535 may be overwritten from within resource files,
536 the command line setting will be reestablished after all resource files
541 Specify the subject of the message to be sent.
542 Newline (NL) and carriage-return (CR) bytes are invalid and will be
543 normalized to space (SP) characters.
547 The message given (on standard input) is expected to contain, separated
548 from the message body by an empty line, a message header with
553 fields giving its recipients, which will be added to any recipients
554 specified on the command line.
555 If a message subject is specified via
557 then it will be used in favour of one given on the command line.
573 .Ql Mail-Followup-To: ,
574 by default created automatically dependent on message context, will
575 be used if specified (a special address massage will however still occur
577 Any other custom header field (also see
580 is passed through entirely
581 unchanged, and in conjunction with the option
583 it is possible to embed
584 .Sx "COMMAND ESCAPES" .
592 .Sx "primary system mailbox"
595 appropriate privileges presumed; effectively identical to
605 will also show the list of
607 .Ql $ \*(uA -Xversion -Xx .
612 ting the internal variable
614 enables display of some informational context messages.
615 Using it twice increases the level of verbosity.
619 Add the given (or multiple for a multiline argument)
621 to the list of commands to be executed,
622 as a last step of program startup, before normal operation starts.
623 This is the only possibility to execute commands in non-interactive mode
624 when reading startup files is actively prohibited.
625 The commands will be evaluated as a unit, just as via
627 but different to that errors won't stop evaluation.
631 .Va batch-exit-on-error .
636 .Sx "COMMAND ESCAPES"
637 even if not in interactive mode.
638 This can be used to, e.g., automatically format the composed message
639 text before sending the message:
640 .Bd -literal -offset indent
641 $ ( echo 'line one. Word. Word2.'; \e
642 echo '~| /usr/bin/fmt -tuw66' ) |\e
643 LC_ALL=C \*(uA -:/ -Sttycharset=utf-8 -d~ bob@exam.ple
649 In batch mode the full set of commands is available, just like in
650 interactive mode, standard input is made line buffered, and diverse
651 .Sx "INTERNAL VARIABLES"
652 are adjusted for batch necessities, e.g., it
668 .Sx "COMMAND ESCAPES"
669 is enabled in compose mode.
670 The following prepares an email message in a batched dry run:
671 .Bd -literal -offset indent
672 $ LC_ALL=C printf 'm bob\en~s ubject\enText\en~.\enx\en' | \e
673 LC_ALL=C \*(uA -:/ -d# -X'alias bob bob@exam.ple'
678 This flag forces termination of option processing in order to prevent
681 It also forcefully puts \*(UA into send mode, see
682 .Sx "On sending mail, and non-interactive mode" .
690 argument, as well as all receivers established by the command line options
694 are subject to checks established via
697 .Sx "INTERNAL VARIABLES" .
699 .Op Ar mta-option ...
701 arguments that are given at the end of the command line after a
703 separator will be passed through to a file-based
705 (Mail-Transfer-Agent) and persist for an entire (interactive) session
706 \(en if the setting of the internal variable
708 allows their recognition; no such constraints apply to the variable
712 .\" .Ss "A starter" {{{
715 \*(UA is a direct descendant of
717 Mail, a successor of the Research
720 .Dq was there from the start
723 It thus represents the user side of the
725 mail system, whereas the system side (Mail-Transfer-Agent, MTA) was
726 traditionally taken by
728 and most MTAs provide a binary of this name for compatibility purposes.
733 of \*(UA then the system side is not a mandatory precondition for mail
737 Because \*(UA strives for compliance with POSIX
739 it is likely that some configuration settings have to be adjusted before
740 using it is a smooth experience.
743 resource file bends those standard imposed settings of the
744 .Sx "INTERNAL VARIABLES"
745 a bit towards more user friendliness and safety, however, e.g., it
750 in order to suppress the automatic moving of messages to
752 that would otherwise occur (see
753 .Sx "Message states" ) ,
756 to not remove empty system (MBOX) mailbox files in order not to mangle
757 file permissions when files eventually get recreated \(en
758 \*(UA will remove all empty (MBOX) mailbox files unless this variable is
761 .Pf ( Ev POSIXLY_CORRECT )
762 mode has been enabled.
763 The file mode creation mask is explicitly managed via
769 in order to synchronize \*(UA with the exit status report of the used
774 to enter interactive startup even if the initial mailbox is empty,
776 to allow editing of headers as well as
778 to not strip down addresses in compose mode, and
780 to include the message that is being responded to when
785 contains some more complete configuration examples.
788 .\" .Ss "On sending mail, and non-interactive mode" {{{
789 .Ss "On sending mail, and non-interactive mode"
791 To send a message to one or more people, using a local or a builtin
793 (Mail-Transfer-Agent) transport to actually deliver the generated mail
794 message, \*(UA can be invoked with arguments which are the names of
795 people to whom the mail will be sent, and the command line options
799 can be used to add (blind) carbon copy receivers:
801 .Bd -literal -offset indent
803 $ \*(uA -s ubject -a ttach.txt bill@exam.ple
805 # But... try it in an isolated dry-run mode (-d) first
806 $ LC_ALL=C \*(uA -d -:/ -Ssendwait \e
807 -b bcc@exam.ple -c cc@exam.ple \e
808 -. '(Lovely) Bob <bob@exam.ple>' eric@exam.ple
811 $ LC_ALL=C \*(uA -d -:/ -Sv15-compat -Ssendwait \e
812 -S 'mta=smtps://mylogin@exam.ple:465' -Ssmtp-auth=login \e
813 -S 'from=scriptreply@exam.ple' \e
819 If standard input is a terminal rather than the message to be sent,
820 the user is expected to type in the message contents.
821 In this compose mode \*(UA treats lines beginning with the character
823 special \(en these are so-called
824 .Sx "COMMAND ESCAPES" ,
825 which can be used to read in files, process shell commands, add and edit
826 attachments and more; e.g., the command escape
828 will start the text editor to revise the message in its current state,
830 allows editing of the most important message headers, with
832 custom headers can be created (more specifically than with
835 gives an overview of most other available command escapes.
839 at the beginning of an empty line leaves compose mode and causes the
840 message to be sent, whereas typing
843 twice will abort the current letter (saving its contents in the file
849 Messages are sent asynchronously, without supervision, unless the variable
851 is set, therefore send errors are not recognizable until then.
857 .Sx "INTERNAL VARIABLES"
858 can be used to alter default behavior; e.g.,
863 will automatically startup a text editor when compose mode is entered,
865 allows editing of headers additionally to plain body content,
867 will cause the user to be prompted actively for carbon-copy recipients
870 will allow leaving compose mode by writing a line consisting solely of
876 hook variables may be set to
878 d macros to automatically adjust some settings dependent
879 on receiver, sender or subject contexts, and via the
880 .Va on-compose-done-shell
883 variables, the latter also to be set to a
885 d macro, increasingly powerful mechanisms to perform automated message
886 adjustments are available.
889 Especially for using public mail provider accounts with the SMTP
891 it is often necessary to set
895 (even finer control via
896 .Va smtp-hostname ) ,
897 which also causes creation of
901 header fields (even if empty) unless
903 is set; saving a copy of sent messages in a
905 mailbox may be desirable \(en as for most mailbox
907 targets the value will undergo
908 .Sx "Filename transformations" .
911 for the purpose of arranging a complete environment of settings that can
912 be switched to with a single command or command line option may be
915 contains example configurations for sending messages via some of the
916 well-known public mail providers and also gives a compact overview on
917 how to setup a secure SSL/TLS environment).
922 sandbox dry-run tests first will prove correctness.
926 .Sx "On URL syntax and credential lookup"
927 will spread light on the different ways of how to specify user email
928 account credentials, the
930 variable chains, and accessing protocol-specific resources,
933 goes into the details of character encoding and how to use them for
934 representing messages and MIME part contents by specifying them in
936 and reading the section
937 .Sx "The mime.types files"
938 should help to understand how the MIME-type of outgoing attachments are
939 classified, and what can be done for fine-tuning.
940 Over the wire an intermediate, configurable
941 .Pf content-transfer-\: Va encoding
942 may be applied to the raw message part data.
945 Message recipients (as specified on the command line or defined in
950 may not only be email addressees but can also be names of mailboxes and
951 even complete shell command pipe specifications.
954 is not set then only network addresses (see
956 for a description of mail addresses) and plain user names (including MTA
957 aliases) may be used, other types will be filtered out, giving a warning
961 can be used to generate standard compliant network addresses.
963 .\" When changing any of the following adjust any RECIPIENTADDRSPEC;
964 .\" grep the latter for the complete picture
968 is set then extended recipient addresses will optionally be accepted:
969 Any name which starts with a vertical bar
971 character specifies a command pipe \(en the command string following the
973 is executed and the message is sent to its standard input;
974 Likewise, any name that starts with the character solidus
976 or the character sequence dot solidus
978 is treated as a file, regardless of the remaining content;
979 likewise a name that solely consists of a hyphen-minus
981 Any other name which contains a commercial at
983 character is treated as a network address;
984 Any other name which starts with a plus sign
986 character specifies a mailbox name;
987 Any other name which contains a solidus
989 character but no exclamation mark
993 character before also specifies a mailbox name;
994 What remains is treated as a network address.
996 .Bd -literal -offset indent
997 $ echo bla | \*(uA -Sexpandaddr -s test ./mbox.mbox
998 $ echo bla | \*(uA -Sexpandaddr -s test '|cat >> ./mbox.mbox'
999 $ echo safe | LC_ALL=C \e
1000 \*(uA -:/ -Sv15-compat -Ssendwait -Snosave \e
1001 -Sexpandaddr=fail,-all,+addr,failinvaddr -s test \e
1006 It is possible to create personal distribution lists via the
1008 command, so that, for instance, the user can send mail to
1010 and have it go to a group of people.
1011 These aliases have nothing in common with the system wide aliases that
1012 may be used by the MTA, which are subject to the
1016 and are often tracked in a file
1022 Personal aliases will be expanded by \*(UA before the message is sent,
1023 and are thus a convenient alternative to specifying each addressee by
1024 itself; they correlate with the active set of
1031 .Dl alias cohorts bill jkf mark kridle@ucbcory ~/mail/cohorts.mbox
1034 To avoid environmental noise scripts should
1036 \*(UA from any configuration files and create a script-local
1037 environment, ideally with the command line options
1039 to disable any configuration file in conjunction with repetitions of
1041 to specify variables:
1043 .Bd -literal -offset indent
1044 $ env LC_ALL=C \*(uA -:/ \e
1045 -Sv15-compat -Ssendwait -Snosave -Sttycharset=utf-8 \e
1046 -Sexpandaddr=fail,-all,failinvaddr \e
1047 -S 'mta=smtps://mylogin@exam.ple:465' -Ssmtp-auth=login \e
1048 -S 'from=scriptreply@exam.ple' \e
1049 -s 'subject' -a attachment_file \e
1050 -. "Recipient 1 <rec1@exam.ple>" rec2@exam.ple \e
1055 As shown, scripts can
1057 a locale environment, the above specifies the all-compatible 7-bit clean
1060 but will nonetheless take and send UTF-8 in the message text by using
1062 In interactive mode, which is introduced in the next section, messages
1063 can be sent by calling the
1065 command with a list of recipient addresses \(em the semantics are
1066 completely identical to non-interactive message sending:
1068 .Bd -literal -offset indent
1069 $ \*(uA -d -Squiet -Semptystart
1070 "/var/spool/mail/user": 0 messages
1071 ? mail "Recipient 1 <rec1@exam.ple>", rec2@exam.ple
1072 ? # Will do the right thing (tm)
1073 ? m rec1@exam.ple rec2@exam.ple
1077 .\" .Ss "On reading mail, and interactive mode" {{{
1078 .Ss "On reading mail, and interactive mode"
1080 When invoked without addressees \*(UA enters interactive mode in which
1082 When used like that the user's system
1086 for an in-depth description of the different mailbox types that exist)
1087 is read in and a one line header of each message therein is displayed.
1088 The visual style of this summary of
1090 can be adjusted through the variable
1092 and the possible sorting criterion via
1098 can be performed with the command
1100 If the initially opened mailbox is empty \*(UA will instead exit
1101 immediately (after displaying a message) unless the variable
1110 will give a listing of all available commands and
1112 will give a summary of some common ones.
1113 If the \*(OPal documentation strings are available one can type
1116 and see the actual expansion of
1118 and what its purpose is, i.e., commands can be abbreviated
1119 (note that POSIX defines some abbreviations, so that the alphabetical
1120 order of commands does not necessarily relate to the abbreviations; it is
1121 possible to define overwrites with the
1124 These commands can also produce a more
1129 Messages are given numbers (starting at 1) which uniquely identify
1130 messages; the current message \(en the
1132 \(en will either be the first new message, or the first unread message,
1133 or the first message of the mailbox; the internal variable
1135 will instead cause usage of the last message for this purpose.
1140 ful of header summaries containing the
1144 will display only the summaries of the given messages, defaulting to the
1148 Message content can be displayed with the command
1155 controls whether and when \*(UA will use the configured
1157 for display instead of directly writing to the user terminal
1159 the sole difference to the command
1161 which will always use the
1165 will instead only show the first
1167 of a message (maybe even compressed if
1172 By default the current message
1174 is displayed, but like with many other commands it is possible to give
1175 a fancy message specification (see
1176 .Sx "Specifying messages" ) ,
1179 will display all unread messages,
1184 will type the messages 1 and 5,
1186 will type the messages 1 through 5, and
1190 will display the last and the next message, respectively.
1193 (a more substantial alias for
1195 will display a header summary of the given message specification list
1196 instead of their content, e.g., the following will search for subjects:
1199 .Dl from "'@Some subject to search for'"
1202 In the default setup all header fields of a message will be
1204 d, but fields can be white- or blacklisted for a variety of
1205 applications by using the command
1207 e.g., to restrict display to a very restricted set:
1208 .Ql Ic \:headerpick Cd \:type retain add Ar \:from to cc subject .
1209 In order to display all header fields of a message regardless of
1210 currently active ignore or retain lists, use the commands
1214 Note that historically the global
1216 not only adjusts the list of displayed headers, but also sets
1220 Dependent upon the configuration a line editor (see the section
1221 .Sx "On terminal control and line editor" )
1222 aims at making user experience with the many
1225 When reading the system
1231 specified a mailbox explicitly prefixed with the special
1233 modifier (propagating the mailbox to a
1235 .Sx "primary system mailbox" ) ,
1236 then messages which have been read will be moved to a
1238 .Sx "secondary mailbox" ,
1241 file, automatically when the mailbox is left, either by changing the
1242 active mailbox or by quitting \*(UA (also see
1243 .Sx "Message states" )
1244 \(en this automatic moving from a system or primary to the secondary
1245 mailbox is not performed when the variable
1250 After examining a message the user can also
1254 to the sender and all recipients or
1256 exclusively to the sender(s).
1257 Messages can also be
1259 ed (shorter alias is
1261 Note that when replying to or forwarding a message recipient addresses
1262 will be stripped from comments and names unless the internal variable
1265 Deletion causes \*(UA to forget about the message;
1266 This is not irreversible, though, one can
1268 the message by giving its number,
1269 or the \*(UA session can be ended by giving the
1274 To end a mail processing session one may either issue
1276 to cause a full program exit, which possibly includes
1277 automatic moving of read messages to
1279 as well as updating the \*(OPal line editor
1283 instead in order to prevent any of these actions.
1286 .\" .Ss "HTML mail and MIME attachments" {{{
1287 .Ss "HTML mail and MIME attachments"
1289 Messages which are HTML-only get more and more common and of course many
1290 messages come bundled with a bouquet of MIME attachments.
1291 Whereas \*(UA \*(OPally supports a simple HTML-to-text converter to deal
1292 with HTML messages (see
1293 .Sx "The mime.types files" ) ,
1294 it normally cannot deal with any of these itself, but instead programs
1295 need to become registered to deal with specific MIME types or file
1297 These programs may either prepare plain text versions of their input
1298 in order to enable \*(UA to display the content on the terminal,
1299 or display the content themselves, for example in a graphical window.
1302 To install an external handler program for a specific MIME type set an
1304 .Va pipe-TYPE/SUBTYPE
1305 variable; to instead define a handler for a specific file extension set
1308 variable \(en these handlers take precedence.
1309 \*(OPally \*(UA supports mail user agent configuration as defined in
1310 RFC 1524; this mechanism, documented in the section
1311 .Sx "The Mailcap files" ,
1312 will be queried for display or quote handlers if none of the former two
1313 .\" TODO v15-compat "will be" -> "is"
1314 did; it will be the sole source for handlers of other purpose.
1315 A last source for handlers may be the MIME type definition itself, if
1316 the \*(UA specific type-marker extension was used when defining the type
1319 (Many of the builtin MIME types do so by default.)
1323 .Va mime-counter-evidence
1324 can be set to improve dealing with faulty MIME part declarations as are
1325 often seen in real-life messages.
1326 E.g., to display a HTML message inline (that is, converted to a more
1327 fancy plain text representation than the builtin converter is capable to
1328 produce) with either of the text-mode browsers
1332 teach \*(UA about MathML documents and make it display them as plain
1333 text, and to open PDF attachments in an external PDF viewer,
1334 asynchronously and with some other magic attached:
1336 .Bd -literal -offset indent
1337 if [ "$features" !@ +filter-html-tagsoup ]
1338 #set pipe-text/html='elinks -force-html -dump 1'
1339 set pipe-text/html='lynx -stdin -dump -force_html'
1340 # Display HTML as plain text instead
1341 #set pipe-text/html=@
1343 mimetype '@ application/mathml+xml mathml'
1344 wysh set pipe-application/pdf='@&=@ \e
1345 trap "rm -f \e"${MAILX_FILENAME_TEMPORARY}\e"" EXIT;\e
1346 trap "trap \e"\e" INT QUIT TERM; exit 1" INT QUIT TERM;\e
1347 mupdf "${MAILX_FILENAME_TEMPORARY}"'
1351 Note: special care must be taken when using such commands as mail
1352 viruses may be distributed by this method: if messages of type
1353 .Ql application/x-sh
1354 or files with the extension
1356 were blindly filtered through the shell, for example, a message sender
1357 could easily execute arbitrary code on the system \*(UA is running on.
1358 For more on MIME, also in respect to sending of messages, see the
1360 .Sx "The mime.types files" ,
1361 .Sx "The Mailcap files"
1366 .\" .Ss "Mailing lists" {{{
1369 \*(UA offers some support to ease handling of mailing lists.
1372 promotes all given arguments to known mailing lists, and
1374 sets their subscription attribute, creating them first as necessary.
1379 automatically, but only resets the subscription attribute.)
1380 Using the commands without arguments will show (a subset of) all
1381 currently defined mailing lists.
1386 can be used to mark out messages with configured list addresses
1387 in the header display.
1390 \*(OPally mailing lists may also be specified as (extended) regular
1391 expressions, which allows matching of many addresses with a single
1393 However, all fully qualified list addresses are matched via a fast
1394 dictionary, whereas expressions are placed in (a) list(s) which is
1395 (are) matched sequentially.
1397 .Bd -literal -offset indent
1398 set followup-to followup-to-honour=ask-yes reply-to-honour=ask-yes
1399 wysh mlist a1@b1.c1 a2@b2.c2 '.*@lists\e.c3$'
1400 mlsubscribe a4@b4.c4 exact@lists.c3
1405 .Va followup-to-honour
1407 .Ql Mail-\:Followup-\:To:
1408 header is honoured when the message is being replied to (via
1414 controls whether this header is created when sending mails; it will be
1415 created automatically for a couple of reasons, too, like when the
1417 .Dq mailing list specific
1422 is used to respond to a message with its
1423 .Ql Mail-Followup-To:
1427 A difference in between the handling of known and subscribed lists is
1428 that the address of the sender is usually not part of a generated
1429 .Ql Mail-Followup-To:
1430 when addressing the latter, whereas it is for the former kind of lists.
1431 Usually because there are exceptions: say, if multiple lists are
1432 addressed and not all of them are subscribed lists.
1434 For convenience \*(UA will, temporarily, automatically add a list
1435 address that is presented in the
1437 header of a message that is being responded to to the list of known
1439 Shall that header have existed \*(UA will instead, dependent on the
1441 .Va reply-to-honour ,
1444 for this purpose in order to accept a list administrators' wish that
1445 is supposed to have been manifested like that (but only if it provides
1446 a single address which resides on the same domain as what is stated in
1450 .\" .Ss "Resource files" {{{
1451 .Ss "Resource files"
1453 Upon startup \*(UA reads in several resource files:
1455 .Bl -tag -width ".It Pa BaNg"
1458 System wide initialization file.
1459 Reading of this file can be suppressed, either by using the
1461 (and according argument) or
1463 command line options, or by setting the
1466 .Ev MAILX_NO_SYSTEM_RC .
1470 File giving initial commands.
1471 A different file can be chosen by setting the
1475 Reading of this file can be suppressed with the
1477 command line option.
1479 .It Va mailx-extra-rc
1480 Can be used to define an optional startup file to be read after all
1481 other resource files.
1482 It can be used to specify settings that are not understood by other
1484 implementations, for example.
1485 This variable is only honoured when defined in a resource file, e.g.,
1487 .Sx "INTERNAL VARIABLES" .
1491 The content of these files is interpreted as follows:
1494 .Bl -bullet -compact
1496 A lines' leading whitespace is removed.
1498 Empty lines are ignored.
1500 Any other line is interpreted as a command.
1501 It may be spread over multiple input lines if the newline character is
1503 by placing a reverse solidus character
1505 as the last character of the line; whereas any leading whitespace of
1506 follow lines is ignored, trailing whitespace before a escaped newline
1507 remains in the input.
1509 If the line (content) starts with the number sign
1511 then it is a comment-command \(en a real command! \(en and also ignored.
1512 This command is the only form of comment that is understood.
1516 Unless \*(UA is about to enter interactive mode syntax errors that occur
1517 while loading these files are treated as errors and cause program exit.
1518 More files with syntactically equal content can be
1520 The following, saved in a file, would be an examplary content:
1522 .Bd -literal -offset indent
1523 # This line is a comment command. And y\e
1524 es, it is really continued here.
1531 .\" .Ss "Character sets" {{{
1532 .Ss "Character sets"
1534 \*(OP \*(UA detects the character set of the terminal by using
1535 mechanisms that are controlled by the
1540 should give an overview); the \*(UA internal variable
1542 will be set to the detected terminal character set accordingly
1543 and will thus show up in the output of the commands
1549 However, a user supplied
1551 value is not overwritten by this detection mechanism: this
1553 must be used if the detection does not work properly,
1554 and it may be used to adjust the name of the locale character set.
1555 E.g., on BSD systems one may use a locale with the character set
1556 ISO8859-1, which is not a valid name for this character set; to be on
1557 the safe side, one may set
1559 to the correct name, which is ISO-8859-1.
1562 Note that changing the value does not mean much beside that,
1563 since several aspects of the real character set are implied by the
1564 locale environment of the system,
1565 and that stays unaffected by the content of an overwritten
1568 (This is mostly an issue when interactively using \*(UA, though.
1569 It is actually possible to send mail in a completely
1571 locale environment, an option that \*(UA's test-suite uses excessively.)
1574 If no character set conversion capabilities have been compiled into
1577 does not include the term
1581 will be the only supported character set,
1582 it is simply assumed that it can be used to exchange 8-bit messages
1583 (over the wire an intermediate
1584 .Pf content-transfer-\: Va encoding
1586 and the rest of this section does not apply;
1587 it may however still be necessary to explicitly set it if automatic
1588 detection fails, since in that case it defaults to the mentioned
1589 .\" (Keep in SYNC: ./nail.1:"Character sets", ./nail.h:CHARSET_*!)
1593 When reading messages, their text is converted into
1595 as necessary in order to display them on the users terminal.
1596 Unprintable characters and invalid byte sequences are detected
1597 and replaced by proper substitution characters.
1598 Character set mappings for source character sets can be established with
1601 which may be handy to work around faulty character set catalogues (e.g.,
1602 to add a missing LATIN1 to ISO-8859-1 mapping), or to enforce treatment
1603 of one character set as another one (e.g., to interpret LATIN1 as CP1252).
1605 .Va charset-unknown-8bit
1606 to deal with another hairy aspect of message interpretation.
1609 When sending messages all their parts and attachments are classified.
1610 Whereas no character set conversion is performed on those parts which
1611 appear to be binary data,
1612 the character set being used must be declared within the MIME header of
1613 an outgoing text part if it contains characters that do not conform to
1614 the set of characters that are allowed by the email standards.
1615 Permissible values for character sets can be declared using the
1619 which defines a catch-all last-resort fallback character set that is
1620 implicitly appended to the list of character sets in
1624 When replying to a message and the variable
1625 .Va reply-in-same-charset
1626 is set then the character set of the message being replied to is tried
1627 first (after mapping via
1628 .Ic charsetalias ) .
1629 And it is also possible to make \*(UA work even more closely related to
1630 the current locale setting automatically by using the variable
1631 .Va sendcharsets-else-ttycharset ,
1632 please see there for more information.
1635 All the specified character sets are tried in order unless the
1636 conversion of the part or attachment succeeds.
1637 If none of the tried (8-bit) character sets is capable to represent the
1638 content of the part or attachment,
1639 then the message will not be sent and its text will optionally be
1643 In general, if the message
1644 .Dq Cannot convert from a to b
1645 appears, either some characters are not appropriate for the currently
1646 selected (terminal) character set,
1647 or the needed conversion is not supported by the system.
1648 In the first case, it is necessary to set an appropriate
1650 locale and/or the variable
1654 The best results are usually achieved when \*(UA is run in a UTF-8
1655 locale on a UTF-8 capable terminal, in which case the full Unicode
1656 spectrum of characters is available.
1657 In this setup characters from various countries can be displayed,
1658 while it is still possible to use more simple character sets for sending
1659 to retain maximum compatibility with older mail clients.
1662 On the other hand the POSIX standard defines a locale-independent 7-bit
1663 .Dq portable character set
1664 that should be used when overall portability is an issue, the even more
1665 restricted subset named
1666 .Dq portable filename character set
1667 consisting of A-Z, a-z, 0-9, period
1675 .\" .Ss "Message states" {{{
1676 .Ss "Message states"
1678 \*(UA differentiates in between several different message states;
1679 the current state will be reflected in header summary displays if
1681 is configured to do so (via the internal variable
1683 and messages can also be selected and be acted upon depending on their
1685 .Sx "Specifying messages" ) .
1686 When operating on the system
1690 .Sx "primary system mailbox" ,
1691 special actions, like the automatic moving of messages to the
1693 .Sx "secondary mailbox"
1695 may be applied when the mailbox is left (also implicitly via
1696 a successful exit of \*(UA, but not if the special command
1698 is used) \(en however, because this may be irritating to users which
1701 mail-user-agents, the default global
1707 variables in order to suppress this behaviour.
1709 .Bl -hang -width ".It Ql new"
1711 Message has neither been viewed nor moved to any other state.
1712 Such messages are retained even in the
1714 .Sx "primary system mailbox" .
1717 Message has neither been viewed nor moved to any other state, but the
1718 message was present already when the mailbox has been opened last:
1719 Such messages are retained even in the
1721 .Sx "primary system mailbox" .
1724 The message has been processed by one of the following commands:
1743 will always try to automatically
1749 logical message, and may thus mark multiple messages as read, the
1751 command will do so if the internal variable
1756 command is used, messages that are in a
1758 .Sx "primary system mailbox"
1761 state when the mailbox is left will be saved in
1763 unless the internal variable
1768 The message has been processed by one of the following commands:
1774 can be used to access such messages.
1777 The message has been processed by a
1779 command and it will be retained in its current location.
1782 The message has been processed by one of the following commands:
1788 command is used, messages that are in a
1790 .Sx "primary system mailbox"
1793 state when the mailbox is left will be deleted; they will be saved in
1795 when the internal variable
1801 In addition to these message states, flags which otherwise have no
1802 technical meaning in the mail system except allowing special ways of
1803 addressing them when
1804 .Sx "Specifying messages"
1805 can be set on messages.
1806 These flags are saved with messages and are thus persistent, and are
1807 portable between a set of widely used MUAs.
1809 .Bl -hang -width ".It Ic answered"
1811 Mark messages as having been answered.
1813 Mark messages as being a draft.
1815 Mark messages which need special attention.
1819 .\" .Ss "Specifying messages" {{{
1820 .Ss "Specifying messages"
1827 can be given a list of message numbers as arguments to apply to a number
1828 of messages at once.
1831 deletes messages 1 and 2,
1834 will delete the messages 1 through 5.
1835 In sorted or threaded mode (see the
1839 will delete the messages that are located between (and including)
1840 messages 1 through 5 in the sorted/threaded order, as shown in the
1843 The following special message names exist:
1846 .Bl -tag -width ".It Ar BaNg"
1848 The current message, the so-called
1852 The message that was previously the current message.
1855 The parent message of the current message,
1856 that is the message with the Message-ID given in the
1858 field or the last entry of the
1860 field of the current message.
1863 The next previous undeleted message,
1864 or the next previous deleted message for the
1867 In sorted/threaded mode,
1868 the next previous such message in the sorted/threaded order.
1871 The next undeleted message,
1872 or the next deleted message for the
1875 In sorted/threaded mode,
1876 the next such message in the sorted/threaded order.
1879 The first undeleted message,
1880 or the first deleted message for the
1883 In sorted/threaded mode,
1884 the first such message in the sorted/threaded order.
1888 In sorted/threaded mode,
1889 the last message in the sorted/threaded order.
1893 selects the message addressed with
1897 is any other message specification,
1898 and all messages from the thread that begins at it.
1899 Otherwise it is identical to
1904 the thread beginning with the current message is selected.
1909 All messages that were included in the
1910 .Sx "Message list arguments"
1911 of the previous command.
1914 An inclusive range of message numbers.
1915 Selectors that may also be used as endpoints include any of
1920 .Dq any substring matches
1923 header, which will match addresses (too) even if
1925 is set (and POSIX says
1926 .Dq any address as shown in a header summary shall be matchable in this form ) ;
1929 variable is set, only the local part of the address is evaluated
1930 for the comparison, not ignoring case, and the setting of
1932 is completely ignored.
1933 For finer control and match boundaries use the
1937 .It Ar / Ns Ar string
1938 All messages that contain
1940 in the subject field (case ignored).
1947 the string from the previous specification of that type is used again.
1949 .It Xo Op Ar @ Ns Ar name-list Ns
1952 All messages that contain the given case-insensitive search
1954 ession; if the \*(OPal regular expression (see
1956 support is available
1958 will be interpreted as (an extended) one if any of the
1960 (extended) regular expression characters is seen: in this case this
1961 should match strings correctly which are in the locale
1965 .Ar @ Ns Ar name-list
1966 part is missing, the search is restricted to the subject field body,
1969 specifies a comma-separated list of header fields to search, as in
1971 .Dl '@to,from,cc@Someone i ought to know'
1973 In order to search for a string that includes a
1975 (commercial at) character the
1977 is effectively non-optional, but may be given as the empty string.
1978 Some special header fields may be abbreviated:
1992 respectively and case-insensitively.
1997 can be used to search in (all of) the header(s) of the message, and the
2006 can be used to perform full text searches \(en whereas the former
2007 searches only the body, the latter also searches the message header.
2009 This message specification performs full text comparison, but even with
2010 regular expression support it is almost impossible to write a search
2011 expression that savely matches only a specific address domain.
2012 To request that the content of the header is treated as a list of
2013 addresses, and to strip those down to the plain email address which the
2014 search expression is to be matched against, prefix the header name
2015 (abbreviation) with a tilde
2018 .Dl @~f@@a\e.safe\e.domain\e.match$
2021 All messages of state
2025 is one or multiple of the following colon modifiers:
2027 .Bl -tag -compact -width ".It Ar :M"
2032 Old messages (any not in state
2054 messages (cf. the variable
2055 .Va markanswered ) .
2060 \*(OP Messages classified as spam (see
2061 .Sx "Handling spam" . )
2063 \*(OP Messages with unsure spam classification.
2069 \*(OP IMAP-style SEARCH expressions may also be used.
2070 This addressing mode is available with all types of folders;
2071 \*(UA will perform the search locally as necessary.
2072 Strings must be enclosed by double quotes
2074 in their entirety if they contain white space or parentheses;
2075 within the quotes, only reverse solidus
2077 is recognized as an escape character.
2078 All string searches are case-insensitive.
2079 When the description indicates that the
2081 representation of an address field is used,
2082 this means that the search string is checked against both a list
2085 .Bd -literal -offset indent
2086 (\*qname\*q \*qsource\*q \*qlocal-part\*q \*qdomain-part\*q)
2091 and the addresses without real names from the respective header field.
2092 These search expressions can be nested using parentheses, see below for
2096 .Bl -tag -compact -width ".It Ar _n_u"
2097 .It Ar ( criterion )
2098 All messages that satisfy the given
2100 .It Ar ( criterion1 criterion2 ... criterionN )
2101 All messages that satisfy all of the given criteria.
2103 .It Ar ( or criterion1 criterion2 )
2104 All messages that satisfy either
2109 To connect more than two criteria using
2111 specifications have to be nested using additional parentheses,
2113 .Ql (or a (or b c)) ,
2117 .Ql ((a or b) and c) .
2120 operation of independent criteria on the lowest nesting level,
2121 it is possible to achieve similar effects by using three separate
2125 .It Ar ( not criterion )
2126 All messages that do not satisfy
2128 .It Ar ( bcc \*q Ns Ar string Ns Ar \*q )
2129 All messages that contain
2131 in the envelope representation of the
2134 .It Ar ( cc \*q Ns Ar string Ns Ar \*q )
2135 All messages that contain
2137 in the envelope representation of the
2140 .It Ar ( from \*q Ns Ar string Ns Ar \*q )
2141 All messages that contain
2143 in the envelope representation of the
2146 .It Ar ( subject \*q Ns Ar string Ns Ar \*q )
2147 All messages that contain
2152 .It Ar ( to \*q Ns Ar string Ns Ar \*q )
2153 All messages that contain
2155 in the envelope representation of the
2158 .It Ar ( header name \*q Ns Ar string Ns Ar \*q )
2159 All messages that contain
2164 .It Ar ( body \*q Ns Ar string Ns Ar \*q )
2165 All messages that contain
2168 .It Ar ( text \*q Ns Ar string Ns Ar \*q )
2169 All messages that contain
2171 in their header or body.
2172 .It Ar ( larger size )
2173 All messages that are larger than
2176 .It Ar ( smaller size )
2177 All messages that are smaller than
2181 .It Ar ( before date )
2182 All messages that were received before
2184 which must be in the form
2188 denotes the day of the month as one or two digits,
2190 is the name of the month \(en one of
2191 .Ql Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec ,
2194 is the year as four digits, e.g.,
2198 All messages that were received on the specified date.
2199 .It Ar ( since date )
2200 All messages that were received since the specified date.
2201 .It Ar ( sentbefore date )
2202 All messages that were sent on the specified date.
2203 .It Ar ( senton date )
2204 All messages that were sent on the specified date.
2205 .It Ar ( sentsince date )
2206 All messages that were sent since the specified date.
2208 The same criterion as for the previous search.
2209 This specification cannot be used as part of another criterion.
2210 If the previous command line contained more than one independent
2211 criterion then the last of those criteria is used.
2215 .\" .Ss "On URL syntax and credential lookup" {{{
2216 .Ss "On URL syntax and credential lookup"
2218 \*(IN For accessing protocol-specific resources usage of Uniform
2219 Resource Locators (URL, RFC 1738) has become omnipresent.
2220 \*(UA expects and understands URLs in the following form;
2223 denote optional parts, optional either because there also exist other
2224 ways to define the information in question or because support of the
2225 part is protocol-specific (e.g.,
2227 is used by the IMAP protocol but not by POP3);
2232 are specified they must be given in URL percent encoded form (RFC 3986;
2238 .Dl PROTOCOL://[USER[:PASSWORD]@]server[:port][/path]
2241 Note that these \*(UA URLs most often do not conform to any real
2242 standard, but instead represent a normalized variant of RFC 1738 \(en
2243 they are not used in data exchange but only meant as a compact,
2244 easy-to-use way of defining and representing information in
2245 a well-known notation.
2248 Many internal variables of \*(UA exist in multiple versions, called
2249 variable chains for the rest of this document: the plain
2254 .Ql variable-USER@HOST .
2261 had been specified in the respective URL, otherwise it refers to the plain
2267 that had been found when doing the user chain lookup as is described
2270 will never be in URL percent encoded form, whether it came from an URL
2271 or not; i.e., variable chain name extensions of
2272 .Sx "INTERNAL VARIABLES"
2273 must not be URL percent encoded.
2276 For example, whether an hypothetical URL
2277 .Ql smtp://hey%3Ayou@our.house
2278 had been given that includes a user, or whether the URL was
2279 .Ql smtp://our.house
2280 and the user had been found differently, to lookup the variable chain
2281 .Va smtp-use-starttls
2282 \*(UA first looks for whether
2283 .Ql smtp-\:use-\:starttls-\:hey:you@our.house
2284 is defined, then whether
2285 .Ql smtp-\:use-\:starttls-\:our.house
2286 exists before finally ending up looking at the plain variable itself.
2289 \*(UA obeys the following logic scheme when dealing with the
2290 necessary credential information of an account:
2296 has been given in the URL the variables
2300 are looked up; if no such variable(s) can be found then \*(UA will,
2301 when enforced by the \*(OPal variables
2302 .Va netrc-lookup-HOST
2309 specific entry which provides a
2311 name: this lookup will only succeed if unambiguous (one possible matching
2314 It is possible to load encrypted
2319 If there is still no
2321 then \*(UA will fall back to the user who is supposed to run \*(UA,
2322 the identity of which has been fixated during \*(UA startup and is
2323 known to be a valid user on the current host.
2326 Authentication: unless otherwise noted this will lookup the
2327 .Va PROTOCOL-auth-USER@HOST , PROTOCOL-auth-HOST , PROTOCOL-auth
2328 variable chain, falling back to a protocol-specific default should this
2334 has been given in the URL, then if the
2336 has been found through the \*(OPal
2338 that may have already provided the password, too.
2339 Otherwise the variable chain
2340 .Va password-USER@HOST , password-HOST , password
2341 is looked up and used if existent.
2343 Afterwards the complete \*(OPal variable chain
2344 .Va netrc-lookup-USER@HOST , netrc-lookup-HOST , netrc-lookup
2348 cache is searched for a password only (multiple user accounts for
2349 a single machine may exist as well as a fallback entry without user
2350 but with a password).
2352 If at that point there is still no password available, but the
2353 (protocols') chosen authentication type requires a password, then in
2354 interactive mode the user will be prompted on the terminal.
2359 S/MIME verification works relative to the values found in the
2363 header field(s), which means that the values of
2364 .Va smime-sign , smime-sign-cert , smime-sign-include-certs
2366 .Va smime-sign-message-digest
2367 will not be looked up using the
2371 chains from above but instead use the corresponding values from the
2372 message that is being worked on.
2373 In unusual cases multiple and different
2377 combinations may therefore be involved \(en on the other hand those
2378 unusual cases become possible.
2379 The usual case is as short as:
2382 .Dl set mta=smtp://USER:PASS@HOST smtp-use-starttls \e
2383 .Dl \ \ \ \ smime-sign smime-sign-cert=+smime.pair
2388 contains complete example configurations.
2391 .\" .Ss "On terminal control and line editor" {{{
2392 .Ss "On terminal control and line editor"
2394 \*(OP Terminal control will be realized through one of the standard
2396 libraries, either the
2398 or, alternatively, the
2400 both of which will be initialized to work with the environment variable
2402 Terminal control will enhance or enable interactive usage aspects, e.g.,
2403 .Sx "Coloured display" ,
2404 and extend behaviour of the Mailx-Line-Editor (MLE), which may learn the
2405 byte-sequences of keys like the cursor and function keys, and which will
2406 automatically enter the so-called
2408 alternative screen shall the terminal support it.
2409 The internal variable
2411 can be used to overwrite settings or to learn (correct(ed)) keycodes.
2412 Actual interaction with the chosen library can be disabled completely by
2413 setting the internal variable
2414 .Va termcap-disable ;
2416 will be queried regardless, even if the \*(OPal support for the
2417 libraries has not been enabled at configuration time.
2420 \*(OP The builtin \*(UA Mailx-Line-Editor (MLE) should work in all
2421 environments which comply to the ISO C standard
2423 and will support wide glyphs if possible (the necessary functionality
2424 had been removed from ISO C, but was included in
2426 Prevent usage of a line editor in interactive mode by setting the
2428 .Va line-editor-disable .
2429 Especially if the \*(OPal terminal control support is missing setting
2430 entries in the internal variable
2432 will help shall the MLE misbehave, see there for more.
2433 The MLE can support a little bit of
2439 feature is available then input from line editor prompts will be saved
2440 in a history list that can be searched in and be expanded from.
2441 Such saving can be prevented by prefixing input with any amount of
2443 Aspects of history, like allowed content and maximum size, as well as
2444 whether history shall be saved persistently, can be configured with the
2448 .Va history-gabby-persist
2453 The MLE supports a set of editing and control commands.
2454 By default (as) many (as possible) of these will be assigned to a set of
2455 single-letter control codes, which should work on any terminal (and can
2456 be generated by holding the
2458 key while pressing the key of desire, e.g.,
2462 command is available then the MLE commands can also be accessed freely
2463 by assigning the command name, which is shown in parenthesis in the list
2464 below, to any desired key-sequence, and the MLE will instead and also use
2466 to establish its builtin key bindings
2467 (more of them if the \*(OPal terminal control is available),
2468 an action which can then be suppressed completely by setting
2469 .Va line-editor-no-defaults .
2470 .Sx "Shell-style argument quoting"
2471 notation is used in the following;
2472 combinations not mentioned either cause job control signals or do not
2473 generate a (unique) keycode:
2477 .Bl -tag -compact -width ".It Ql Ba"
2479 Go to the start of the line
2481 .Pf ( Cd mle-go-home ) .
2484 Move the cursor backward one character
2486 .Pf ( Cd mle-go-bwd ) .
2489 Forward delete the character under the cursor;
2490 quits \*(UA if used on the empty line unless the internal variable
2494 .Pf ( Cd mle-del-fwd ) .
2497 Go to the end of the line
2499 .Pf ( Cd mle-go-end ) .
2502 Move the cursor forward one character
2504 .Pf ( Cd mle-go-fwd ) .
2507 Cancel current operation, full reset.
2508 If there is an active history search or tabulator expansion then this
2509 command will first reset that, reverting to the former line content;
2510 thus a second reset is needed for a full reset in this case
2512 .Pf ( Cd mle-reset ) .
2515 Backspace: backward delete one character
2517 .Pf ( Cd mle-del-bwd ) .
2521 Horizontal tabulator:
2522 try to expand the word before the cursor, supporting the usual
2523 .Sx "Filename transformations"
2525 .Pf ( Cd mle-complete ) .
2527 .Cd mle-quote-rndtrip .
2531 commit the current line
2533 .Pf ( Cd mle-commit ) .
2536 Cut all characters from the cursor to the end of the line
2538 .Pf ( Cd mle-snarf-end ) .
2543 .Pf ( Cd mle-repaint ) .
2546 \*(OP Go to the next history entry
2548 .Pf ( Cd mle-hist-fwd ) .
2551 (\*(OPally context-dependent) Invokes the command
2555 \*(OP Go to the previous history entry
2557 .Pf ( Cd mle-hist-bwd ) .
2560 Toggle roundtrip mode shell quotes, where produced,
2563 .Pf ( Cd mle-quote-rndtrip ) .
2564 This setting is temporary, and will be forgotten once the command line
2568 \*(OP Complete the current line from (the remaining) older history entries
2570 .Pf ( Cd mle-hist-srch-bwd ) .
2573 \*(OP Complete the current line from (the remaining) newer history entries
2575 .Pf ( Cd mle-hist-srch-fwd ) .
2578 Paste the snarf buffer
2580 .Pf ( Cd mle-paste ) .
2588 .Pf ( Cd mle-snarf-line ) .
2591 Prompts for a Unicode character (its hexadecimal number) to be inserted
2593 .Pf ( Cd mle-prompt-char ) .
2594 Note this command needs to be assigned to a single-letter control code
2595 in order to become recognized and executed during input of
2596 a key-sequence (only three single-letter control codes can be used for
2597 that shortcut purpose); this control code is special-treated and cannot
2598 be part of any other sequence, because any occurrence will perform the
2600 function immediately.
2603 Cut the characters from the one preceding the cursor to the preceding
2606 .Pf ( Cd mle-snarf-word-bwd ) .
2609 Move the cursor forward one word boundary
2611 .Pf ( Cd mle-go-word-fwd ) .
2614 Move the cursor backward one word boundary
2616 .Pf ( Cd mle-go-word-bwd ) .
2619 Escape: reset a possibly used multibyte character input state machine
2620 and \*(OPally a lingering, incomplete key binding
2622 .Pf ( Cd mle-cancel ) .
2623 This command needs to be assigned to a single-letter control code in
2624 order to become recognized and executed during input of a key-sequence
2625 (only three single-letter control codes can be used for that shortcut
2627 This control code may also be part of a multi-byte sequence, but if
2628 a sequence is active and the very control code is currently also an
2629 expected input, then it will first be consumed by the active sequence.
2632 (\*(OPally context-dependent) Invokes the command
2636 (\*(OPally context-dependent) Invokes the command
2640 (\*(OPally context-dependent) Invokes the command
2644 Cut the characters from the one after the cursor to the succeeding word
2647 .Pf ( Cd mle-snarf-word-fwd ) .
2658 this will immediately reset a possibly active search etc.
2663 ring the audible bell.
2667 .\" .Ss "Coloured display" {{{
2668 .Ss "Coloured display"
2670 \*(OP \*(UA can be configured to support a coloured display and font
2671 attributes by emitting ANSI / ISO 6429 SGR (select graphic rendition)
2673 Usage of colours and font attributes solely depends upon the
2674 capability of the detected terminal type that is defined by the
2675 environment variable
2677 and which can be fine-tuned by the user via the internal variable
2681 On top of what \*(UA knows about the terminal the boolean variable
2683 defines whether the actually applicable colour and font attribute
2684 sequences should also be generated when output is going to be paged
2685 through the external program defined by the environment variable
2690 This is not enabled by default because different pager programs need
2691 different command line switches or other configuration in order to
2692 support those sequences.
2693 \*(UA however knows about some widely used pagers and in a clean
2694 environment it is often enough to simply set
2696 please refer to that variable for more on this topic.
2701 is set then any active usage of colour and font attribute sequences
2702 is suppressed, but without affecting possibly established
2707 To define and control colours and font attributes a single multiplexer
2708 command family exists:
2710 shows or defines colour mappings for the given colour type (e.g.,
2713 can be used to remove mappings of a given colour type.
2714 Since colours are only available in interactive mode, it may make
2715 sense to conditionalize the colour setup by encapsulating it with
2718 .Bd -literal -offset indent
2719 if terminal && $features =@ +colour
2720 colour iso view-msginfo ft=bold,fg=green
2721 colour iso view-header ft=bold,fg=red "from,subject"
2722 colour iso view-header fg=red
2724 uncolour iso view-header from,subject
2725 colour iso view-header ft=bold,fg=magenta,bg=cyan
2726 colour 256 view-header ft=bold,fg=208,bg=230 subject,from
2727 colour mono view-header ft=bold
2728 colour mono view-header ft=bold,ft=reverse subject,from
2732 .\" }}} (DESCRIPTION)
2735 .\" .Sh COMMANDS {{{
2738 Each command is typed on a line by itself,
2739 and may take arguments following the command word.
2740 An unquoted reverse solidus
2742 at the end of a command line
2744 the newline character: it is discarded and the next line of input is
2745 used as a follow-up line, with all leading whitespace removed;
2746 once the entire command line is completed, the processing that is
2747 documented in the following begins.
2750 Command names may be abbreviated, in which case the first command that
2751 matches the given prefix will be used.
2754 can be used to show the list of all commands, either alphabetically
2755 sorted or in prefix search order (these do not match, also because the
2756 POSIX standard prescribes a set of abbreviations).
2757 \*(OPally the command
2761 when given an argument, will show a documentation string for the
2762 command matching the expanded argument, as in
2764 which should be a shorthand of
2766 Both commands support a more
2768 listing mode which includes the argument type of the command,
2769 and other information which applies; a handy suggestion might be:
2771 .Bd -literal -offset indent
2773 # Be careful to choose sh(1)ell-style on _entire_ line!
2774 # Result status ends up in $!
2775 localopts 1;wysh set verbose;ignerr eval "${@}";return ${?}
2777 ? ghost xv '\ecall __xv'
2781 .\" .Ss "Command modifiers" {{{
2782 .Ss "Command modifiers"
2784 Commands may be prefixed by one or multiple command modifiers.
2789 The modifier reverse solidus
2792 to be placed first, prevents
2794 expansions on the remains of the line, e.g.,
2796 will always evaluate the command
2798 even if a ghost of the same name exists.
2800 content may itself contain further command modifiers, including
2801 an initial reverse solidus to prevent further expansions.
2807 indicates that any error generated by the following command should be
2808 ignored by the state machine, via, e.g.,
2809 .Va batch-exit-on-error .
2812 .Sx "INTERNAL VARIABLES" ,
2813 will be set to the real exit status of the command regardless.
2816 Some commands support the
2819 modifier: if used, they expect the name of a variable, which can itself
2820 be a variable, i.e., shell expansion is applied, as their first
2821 argument, and will place their computation result in it instead of the
2822 default location (it is usually written to standard output).
2823 The given name will be tested for being a valid
2825 variable name, and may therefore only consist of upper- and lowercase
2826 characters, digits, and the underscore; the hyphen-minus may be used as
2827 a non-portable extension.
2828 In addition the name may either not be one of the known
2829 .Sx "INTERNAL VARIABLES" ,
2830 or must otherwise refer to a writable (non-boolean) value variable.
2831 It is a hard error that is tracked in
2833 if any of these tests fail.
2834 The actual put operation may fail nonetheless, e.g., if the variable
2835 expects a number argument only a number will be accepted.
2836 Some commands may report this as a hard failure in
2838 but most will use the soft exit status
2840 to indicate these failures.
2843 Last, but not least, the modifier
2846 can be used for some old and established commands to choose the new
2847 .Sx "Shell-style argument quoting"
2848 rules over the traditional
2849 .Sx "Old-style argument quoting" .
2853 .\" .Ss "Message list arguments" {{{
2854 .Ss "Message list arguments"
2856 Some commands expect arguments that represent messages (actually
2857 their symbolic message numbers), as has been documented above under
2858 .Sx "Specifying messages"
2860 If no explicit message list has been specified, the next message
2861 forward that satisfies the command's requirements will be used,
2862 and if there are no messages forward of the current message,
2863 the search proceeds backwards;
2864 if there are no good messages at all to be found, an error message is
2865 shown and the command is aborted.
2868 .\" .Ss "Old-style argument quoting" {{{
2869 .Ss "Old-style argument quoting"
2871 \*(ID This section documents the old, traditional style of quoting
2872 non-message-list arguments to commands which expect this type of
2873 arguments: whereas still used by the majority of such commands, the new
2874 .Sx "Shell-style argument quoting"
2875 may be available even for those via
2878 .Sx "Command modifiers" .
2879 Nonetheless care must be taken, because only new commands have been
2880 designed with all the capabilities of the new quoting rules in mind,
2881 which can, e.g., generate control characters.
2884 .Bl -bullet -offset indent
2886 An argument can be enclosed between paired double-quotes
2891 any white space, shell word expansion, or reverse solidus characters
2892 (except as described next) within the quotes are treated literally as
2893 part of the argument.
2894 A double-quote will be treated literally within single-quotes and vice
2896 Inside such a quoted string the actually used quote character can be
2897 used nonetheless by escaping it with a reverse solidus
2903 An argument that is not enclosed in quotes, as above, can usually still
2904 contain space characters if those spaces are reverse solidus escaped, as in
2908 A reverse solidus outside of the enclosing quotes is discarded
2909 and the following character is treated literally as part of the argument.
2913 .\" .Ss "Shell-style argument quoting" {{{
2914 .Ss "Shell-style argument quoting"
2916 Commands which don't expect message-list arguments use
2918 ell-style, and therefore POSIX standardized, argument parsing and
2920 \*(ID Most new commands only support these new rules and are flagged
2921 \*(NQ, some elder ones can use them with the command modifier
2923 in the future only this type of argument quoting will remain.
2926 A command line is parsed from left to right and an input token is
2927 completed whenever an unquoted, otherwise ignored, metacharacter is seen.
2928 Metacharacters are vertical bar
2935 .Cm space , tabulator , newline .
2936 The additional metacharacters left and right parenthesis
2938 and less-than and greater-than signs
2942 supports are not used, and are treated as ordinary characters: for one
2943 these characters are a vivid part of email addresses, and it also seems
2944 highly unlikely that their function will become meaningful to \*(UA.
2947 Any unquoted number sign
2949 at the beginning of new token starts a comment that extends to the end
2950 of the line, and therefore ends argument processing.
2951 An unquoted dollar sign
2953 will cause variable expansion of the given name:
2954 .Sx "INTERNAL VARIABLES"
2957 (shell) variables can be accessed through this mechanism, brace
2958 enclosing the name is supported (i.e., to subdivide a token).
2961 Whereas the metacharacters
2962 .Cm space , tabulator , newline
2963 only complete an input token, vertical bar
2969 also act as control operators and perform control functions.
2970 For now supported is semicolon
2972 which terminates a single command, therefore sequencing the command line
2973 and making the remainder of the line a subject to reevaluation.
2974 With sequencing, multiple command argument types and quoting rules may
2975 therefore apply to a single line, which can become problematic before
2976 v15: e.g., the first of the following will cause surprising results.
2979 .Dl ? echo one; set verbose; echo verbose=$verbose.
2980 .Dl ? echo one; wysh set verbose; echo verbose=$verbose.
2983 Quoting is a mechanism that will remove the special meaning of
2984 metacharacters and reserved words, and will prevent expansion.
2985 There are four quoting mechanisms: the escape character, single-quotes,
2986 double-quotes and dollar-single-quotes:
2989 .Bl -bullet -offset indent
2991 The literal value of any character can be preserved by preceding it
2992 with the escape character reverse solidus
2996 Arguments which are enclosed in
2997 .Ql 'single-\:quotes'
2998 retain their literal value.
2999 A single-quote cannot occur within single-quotes.
3002 The literal value of all characters enclosed in
3003 .Ql \(dqdouble-\:quotes\(dq
3004 is retained, with the exception of dollar sign
3006 which will cause variable expansion, as above, backquote (grave accent)
3008 (which not yet means anything special), reverse solidus
3010 which will escape any of the characters dollar sign
3012 (to prevent variable expansion), backquote (grave accent)
3016 (to prevent ending the quote) and reverse solidus
3018 (to prevent escaping, i.e., to embed a reverse solidus character as-is),
3019 but has no special meaning otherwise.
3022 Arguments enclosed in
3023 .Ql $'dollar-\:single-\:quotes'
3024 extend normal single quotes in that reverse solidus escape sequences are
3025 expanded as follows:
3027 .Bl -tag -compact -width "Ql \eNNN"
3033 an escape character.
3035 an escape character.
3047 emits a reverse solidus character.
3051 double quote (escaping is optional).
3053 eight-bit byte with the octal value
3055 (one to three octal digits), optionally prefixed by an additional
3057 A 0 byte will suppress further output for the quoted argument.
3059 eight-bit byte with the hexadecimal value
3061 (one or two hexadecimal characters).
3062 A 0 byte will suppress further output for the quoted argument.
3064 the Unicode / ISO-10646 character with the hexadecimal codepoint value
3066 (one to eight hexadecimal digits) \(em note that Unicode defines the
3067 maximum codepoint ever to be supported as
3072 This escape is only supported in locales which support Unicode (see
3073 .Sx "Character sets" ) ,
3074 in other cases the sequence will remain unexpanded unless the given code
3075 point is ASCII compatible or can be represented in the current locale.
3076 The character NUL will suppress further output for the quoted argument.
3080 except it takes only one to four hexadecimal digits.
3082 Emits the non-printable (ASCII and compatible) C0 control codes
3083 0 (NUL) to 31 (US), and 127 (DEL).
3084 Printable representations of ASCII control codes can be created by
3085 mapping them to a different part of the ASCII character set, which is
3086 possible by adding the number 64 for the codes 0 to 31, e.g., 7 (BEL) is
3087 .Ql 7 + 64 = 71 = G .
3088 The real operation is a bitwise logical XOR with 64 (bit 7 set, see
3090 thus also covering code 127 (DEL), which is mapped to 63 (question mark):
3091 .Ql ? vexpr ^ 127 64 .
3093 Whereas historically circumflex notation has often been used for
3094 visualization purposes of control codes, e.g.,
3096 the reverse solidus notation has been standardized:
3098 Some control codes also have standardized (ISO 10646, ISO C) aliases,
3099 as shown above (e.g.,
3103 whenever such an alias exists it will be used for display purposes.
3104 The control code NUL
3106 a non-standard extension) ends argument processing without producing
3109 Non-standard extension: expand the given variable name, as above.
3110 Brace enclosing the name is supported.
3112 Not yet supported, just to raise awareness: Non-standard extension.
3119 .Bd -literal -offset indent
3120 echo 'Quotes '${HOME}' and 'tokens" differ!"# no comment
3121 echo Quotes ${HOME} and tokens differ! # comment
3122 echo Don"'"t you worry$'\ex21' The sun shines on us. $'\eu263A'
3126 .\" .Ss "Filename transformations" {{{
3127 .Ss "Filename transformations"
3129 Filenames, where expected, and unless documented otherwise, are
3130 subsequently subject to the following filename transformations, in
3133 .Bl -bullet -offset indent
3135 If the given name is a registered
3137 it will be replaced with the expanded shortcut.
3140 The filename is matched against the following patterns or strings:
3142 .Bl -hang -compact -width ".Ar %user"
3144 (Number sign) is expanded to the previous file.
3146 (Percent sign) is replaced by the invoking
3147 .Mx -ix "primary system mailbox"
3148 user's primary system mailbox, which either is the (itself expandable)
3150 if that is set, the standardized absolute pathname indicated by
3152 if that is set, or a builtin compile-time default otherwise.
3154 Expands to the primary system mailbox of
3156 (and never the value of
3158 regardless of its actual setting).
3160 (Ampersand) is replaced with the invoking users
3161 .Mx -ix "secondary mailbox"
3162 secondary mailbox, the
3169 directory (if that variable is set).
3171 Expands to the same value as
3173 but has special meaning when used with, e.g., the command
3175 the file will be treated as a primary system mailbox by, e.g., the
3179 commands, meaning that messages that have been read in the current
3180 session will be moved to the
3182 mailbox instead of simply being flagged as read.
3186 Meta expansions are applied to the resulting filename, as applicable to
3187 the resulting file access protocol (also see
3188 .Sx "On URL syntax and credential lookup" ) .
3189 If the fully expanded filename results in multiple pathnames and the
3190 command is expecting only one file, an error results.
3192 For the file-protocol, a leading tilde
3194 character will be replaced by the expansion of
3196 except when followed by a valid user name, in which case the home
3197 directory of the given user is used instead.
3203 will be replaced by the expansion of the variable, if possible;
3204 .Sx "INTERNAL VARIABLES"
3207 (shell) variables can be accessed through this mechanism, and the usual
3208 escape mechanism has to be applied to prevent interpretation.
3210 In interactive context, in order to allow simple value acceptance (via
3212 arguments will usually be displayed in a properly quoted form, e.g., a file
3213 .Ql diet\e is \ecurd.txt
3215 .Ql 'diet\e is \ecurd.txt' .
3219 .\" .Ss "Commands" {{{
3222 The following commands are available:
3224 .Bl -tag -width ".It Ic BaNg"
3229 command which follows, replacing unescaped exclamation marks with the
3230 previously executed command if the internal variable
3236 The comment-command causes the entire line to be ignored.
3238 this really is a normal command which' purpose is to discard its
3241 indicating special character, which means that, e.g., trailing comments
3242 on a line are not possible.
3246 Goes to the next message in sequence and types it
3252 Display the preceding message, or the n'th previous message if given
3253 a numeric argument n.
3257 Show the current message number (the
3262 Show a brief summary of commands.
3263 \*(OP Given an argument a synopsis for the command in question is
3264 shown instead; commands can be abbreviated in general and this command
3265 can be used to see the full expansion of an abbreviation including the
3266 synopsis, try, e.g.,
3271 and see how the output changes.
3272 This mode also supports a more
3274 output, which will provide the informations documented for
3285 \*(NQ Interprets the remainder of the word as a macro name and passes
3290 is a shorter synonym for
3291 .Ql call Ar mymacro .
3295 (ac) Creates, selects or lists (an) account(s).
3296 Accounts are special incarnations of
3298 macros and group commands and variable settings which together usually
3299 arrange the environment for the purpose of creating an email account.
3300 Different to normal macros settings which are covered by
3302 \(en here by default enabled! \(en will not be reverted before the
3307 (case-insensitive) always exists, and all but it can be deleted via
3310 Without arguments a listing of all defined accounts is shown.
3311 With one argument the given account is activated: the system
3313 of that account will be activated (as via
3315 a possibly installed
3317 will be run, and the internal variable
3320 The two argument form is identical to defining a macro as via
3322 .Bd -literal -offset indent
3324 set folder=~/mail inbox=+syste.mbox record=+sent.mbox
3325 set from='myname@myisp.example (My Name)'
3326 set mta=smtp://mylogin@smtp.myisp.example
3332 \*(NQ Interprets the given arguments as an email address specification,
3333 formats it as induced by email standards, and then shows the result.
3337 .Sx "Command modifiers" ) .
3338 The return status is tracked via
3340 \*(ID This will improve further.
3344 (a) Aliases are a method of creating personal distribution lists that
3345 map a single alias name to none to multiple real receivers;
3346 these aliases become expanded after message composing is completed; to
3347 delete aliases, use the command
3349 With no arguments the command shows all currently defined aliases.
3350 With one argument, shows the expansion of the given alias.
3351 With more than one argument, creates or appends to the alias name given
3352 as the first argument the remaining arguments.
3353 Alias names are restricted to alphabetic characters, digits, the
3354 underscore, hyphen-minus, the number sign, colon, commercial at and
3355 period, the last character can also be the dollar sign:
3356 .Ql [[:alnum:]_#:@.-]+$? .
3360 (alt) Manage a list of alternate addresses or names of the active user,
3361 members of which will be removed from recipient lists when replying to
3364 variable is not set).
3365 Without arguments the current set of alternates is displayed, otherwise
3366 the set of alternate names is replaced by the given arguments, and the
3369 is updated accordingly.
3373 Takes a message list and marks each message as having been answered.
3374 Messages will be marked answered when being
3376 to automatically if the
3380 .Sx "Message states" .
3385 \*(OP\*(NQ The bind command extends the MLE (see
3386 .Sx "On terminal control and line editor" )
3387 with freely configurable key bindings.
3388 With one argument all bindings for the given context are shown,
3389 specifying an asterisk
3391 will show the bindings of all contexts; a more verbose listing will be
3392 produced if either of
3397 With two or more arguments a binding is (re)established:
3398 the first argument is the context to which the binding shall apply,
3399 the second argument is a comma-separated list of the
3401 which form the binding, and any remaining arguments form the expansion.
3402 To indicate that a binding shall not be auto-committed, but that the
3403 expansion shall instead be furtherly editable by the user, a commercial at
3405 (that will be removed) can be placed last in the expansion, from which
3406 leading and trailing whitespace will finally be removed.
3407 Reverse solidus cannot be used as the last character of expansion.
3410 Contexts define when a binding applies, i.e., a binding will not be seen
3411 unless the context for which it is defined for is currently active.
3412 This is not true for the shared binding
3414 which is the foundation for all other bindings and as such always
3415 applies, its bindings, however, only apply secondarily.
3416 The available contexts are the shared
3420 context which is used in all not otherwise documented situations, and
3422 which applies to compose mode only.
3426 which form the binding are specified as a comma-separated list of
3427 byte-sequences, where each list entry corresponds to one key(press).
3428 \*(OPally a list entry may, indicated by a leading colon character
3430 also refer to the name of a terminal capability;
3431 several dozen names will be compiled into \*(UA and may be specified
3434 or, if existing, by their
3436 name, regardless of the actually used terminal control library.
3437 It is however possible to use any capability, as long as the name is
3438 resolvable by the control library or defined in the internal variable
3440 Input sequences are not case-normalized, so that an exact match is
3441 required to update or remove a binding.
3444 .Bd -literal -offset indent
3445 bind base $'\eE',d mle-snarf-word-fwd # Esc(ape)
3446 bind base $'\eE',$'\ec?' mle-snarf-word-bwd # Esc, Delete
3447 bind default $'\ecA',:khome,w 'echo An editable binding@'
3448 bind default a,b,c rm -rf / @ # Another editable binding
3449 bind default :kf1 File %
3450 bind compose :kf1 ~e
3454 Note that the entire comma-separated list is first parsed (over) as a
3455 shell-token with whitespace as the field separator, before being parsed
3456 and expanded for real with comma as the field separator, therefore
3457 whitespace needs to be properly quoted, see
3458 .Sx "Shell-style argument quoting" .
3459 Using Unicode reverse solidus escape sequences renders a binding
3460 defunctional if the locale does not support Unicode (see
3461 .Sx "Character sets" ) ,
3462 and using terminal capabilities does so if no terminal control support
3463 is (currently) available.
3466 The following terminal capability names are builtin and can be used in
3468 or (if available) the two-letter
3470 notation regardless of the actually used library.
3471 See the respective manual for a list of capabilities.
3474 can be used to show all the capabilities of
3476 or the given terminal type;
3479 flag will also show supported (non-standard) extensions.
3482 .Bl -tag -compact -width kcuuf_or_kcuuf
3483 .It Cd kbs Ns \0or Cd kb
3485 .It Cd kdch1 Ns \0or Cd kD
3487 .It Cd kDC Ns \0or Cd *4
3488 \(em shifted variant.
3489 .It Cd kel Ns \0or Cd kE
3490 Clear to end of line.
3491 .It Cd kext Ns \0or Cd @9
3493 .It Cd kich1 Ns \0or Cd kI
3495 .It Cd kIC Ns \0or Cd #3
3496 \(em shifted variant.
3497 .It Cd khome Ns \0or Cd kh
3499 .It Cd kHOM Ns \0or Cd #2
3500 \(em shifted variant.
3501 .It Cd kend Ns \0or Cd @7
3503 .It Cd knp Ns \0or Cd kN
3505 .It Cd kpp Ns \0or Cd kP
3507 .It Cd kcub1 Ns \0or Cd kl
3508 Left cursor (with more modifiers: see below).
3509 .It Cd kLFT Ns \0or Cd #4
3510 \(em shifted variant.
3511 .It Cd kcuf1 Ns \0or Cd kr
3512 Right cursor (ditto).
3513 .It Cd kRIT Ns \0or Cd %i
3514 \(em shifted variant.
3515 .It Cd kcud1 Ns \0or Cd kd
3516 Down cursor (ditto).
3518 \(em shifted variant (only terminfo).
3519 .It Cd kcuu1 Ns \0or Cd ku
3522 \(em shifted variant (only terminfo).
3523 .It Cd kf0 Ns \0or Cd k0
3525 Add one for each function key up to
3530 .It Cd kf10 Ns \0or Cd k;
3532 .It Cd kf11 Ns \0or Cd F1
3534 Add one for each function key up to
3542 Some terminals support key-modifier combination extensions, e.g.,
3544 For example, the delete key,
3546 in its shifted variant, the name is mutated to
3548 then a number is appended for the states
3560 .Ql Shift+Alt+Control
3562 The same for the left cursor key,
3564 .Cd KLFT , KLFT3 , KLFT4 , KLFT5 , KLFT6 , KLFT7 , KLFT8 .
3567 Key bindings can be removed with the command
3569 It is advisable to use an initial escape or other control character (e.g.,
3571 for bindings which describe user key combinations (as opposed to purely
3572 terminal capability based ones), in order to avoid ambiguities whether
3573 input belongs to key sequences or not; it also reduces search time.
3576 may help shall keys and sequences be falsely recognized.
3581 \*(NQ Calls the given macro, which must have been created via
3583 Parameters given to macros are implicitly local to the macro's scope, and
3584 may be accessed via the special parameter syntax that is known from the
3591 Positional parameters may be removed by
3593 ing them off the stack.
3594 Macro execution can be terminated at any time by calling
3596 Numeric and string operations can be performed via
3600 may be helpful to recreate argument lists.
3601 .Bd -literal -offset indent
3603 echo Parameter 1 of ${#} is ${1}, all: ${*} / ${@}
3606 call exmac Hello macro exmac!
3613 if the given macro has been created via
3615 but doesn't fail nor warn if the macro doesn't exist.
3619 (ch) Change the working directory to
3621 or the given argument.
3627 \*(OP Only applicable to S/MIME signed messages.
3628 Takes a message list and a file name and saves the certificates
3629 contained within the message signatures to the named file in both
3630 human-readable and PEM format.
3631 The certificates can later be used to send encrypted messages to the
3632 respective message senders by setting
3633 .Va smime-encrypt-USER@HOST
3638 .It Ic charsetalias , uncharsetalias
3639 \*(NQ Manage (character set conversion) character set alias mappings,
3640 as documented in the section
3641 .Sx "Character sets" .
3642 Character set aliases are expanded recursively, but no expansion is
3643 performed on values of the user-settable variables, e.g.,
3645 These are effectively no-operations if character set conversion
3646 is not available (i.e., no
3650 Without arguments the list of all currently defined aliases is shown.
3651 Otherwise all given arguments are treated as pairs of character sets and
3652 their desired target alias name, creating new or changing already
3653 existing aliases, as necessary.
3655 The latter deletes all aliases given as arguments, the special argument
3657 will remove all aliases.
3661 (ch) Change the working directory to
3663 or the given argument.
3669 Only applicable to threaded mode.
3670 Takes a message list and makes all replies to these messages invisible
3671 in header summaries, unless they are in state
3677 \*(OP\*(NQ Manage colour mappings of and for a
3678 .Sx "Coloured display" .
3679 The type of colour is given as the (case-insensitive) first argument,
3680 which must be one of
3682 for 256-colour terminals,
3687 for the standard 8-colour ANSI / ISO 6429 color palette and
3691 for monochrome terminals.
3692 Monochrome terminals cannot deal with colours, but only (some) font
3696 Without further arguments the list of all currently defined mappings
3697 for the given colour type is shown (as a special case giving
3701 will show the mappings of all types).
3702 Otherwise the second argument defines the mappable slot, and the third
3703 argument a (comma-separated list of) colour and font attribute
3704 specification(s), and the optional fourth argument can be used to
3705 specify a precondition: if conditioned mappings exist they are tested in
3706 (creation) order unless a (case-insensitive) match has been found, and
3707 the default mapping (if any has been established) will only be chosen as
3709 The types of precondition available depend on the mappable slot (see
3710 .Sx "Coloured display"
3711 for some examples), the following of which exist:
3714 Mappings prefixed with
3716 are used for the \*(OPal builtin Mailx-Line-Editor (MLE, see
3717 .Sx "On terminal control and line editor" )
3718 and do not support preconditions.
3720 .Bl -tag -compact -width view-partinfo
3722 This mapping is used for the position indicator that is visible when
3723 a line cannot be fully displayed on the screen.
3730 Mappings prefixed with
3732 are used in header summaries, and they all understand the preconditions
3734 (the current message) and
3736 for elder messages (only honoured in conjunction with
3737 .Va datefield-markout-older ) .
3739 .Bl -tag -compact -width view-partinfo
3741 This mapping is used for the
3743 that can be created with the
3747 formats of the variable
3750 For the complete header summary line except the
3752 and the thread structure.
3754 For the thread structure which can be created with the
3756 format of the variable
3761 Mappings prefixed with
3763 are used when displaying messages.
3765 .Bl -tag -compact -width view-partinfo
3767 This mapping is used for so-called
3769 lines, which are MBOX file format specific header lines.
3772 A comma-separated list of headers to which the mapping applies may be
3773 given as a precondition; if the \*(OPal regular expression support is
3774 available then if any of the
3776 (extended) regular expression characters is seen the precondition will
3777 be evaluated as (an extended) one.
3779 For the introductional message info line.
3780 .It Ar view-partinfo
3781 For MIME part info lines.
3785 The following (case-insensitive) colour definitions and font attributes
3786 are understood, multiple of which can be specified in a comma-separated
3796 It is possible (and often applicable) to specify multiple font
3797 attributes for a single mapping.
3800 foreground colour attribute:
3810 To specify a 256-color mode a decimal number colour specification in
3811 the range 0 to 255, inclusive, is supported, and interpreted as follows:
3813 .Bl -tag -compact -width "999 - 999"
3815 the standard ISO 6429 colors, as above.
3817 high intensity variants of the standard colors.
3819 216 colors in tuples of 6.
3821 grayscale from black to white in 24 steps.
3823 .Bd -literal -offset indent
3825 fg() { printf "\e033[38;5;${1}m($1)"; }
3826 bg() { printf "\e033[48;5;${1}m($1)"; }
3828 while [ $i -lt 256 ]; do fg $i; i=$(($i + 1)); done
3829 printf "\e033[0m\en"
3831 while [ $i -lt 256 ]; do bg $i; i=$(($i + 1)); done
3832 printf "\e033[0m\en"
3836 background colour attribute (see
3838 for possible values).
3842 Mappings may be removed with the command
3844 For a generic overview see the section
3845 .Sx "Coloured display" .
3850 (C) Copy messages to files whose names are derived from the author of
3851 the respective message and do not mark them as being saved;
3852 otherwise identical to
3857 (c) Copy messages to the named file and do not mark them as being saved;
3858 otherwise identical to
3863 Show the name of the current working directory, as reported by
3868 .Sx "Command modifiers" ) .
3869 The return status is tracked via
3874 \*(OP For unencrypted messages this command is identical to
3876 Encrypted messages are first decrypted, if possible, and then copied.
3880 \*(OP For unencrypted messages this command is identical to
3882 Encrypted messages are first decrypted, if possible, and then copied.
3886 Without arguments the current list of macros, including their content,
3887 is shown, otherwise a macro is defined.
3888 A macro definition is a sequence of commands in the following form:
3889 .Bd -literal -offset indent
3898 A defined macro can be invoked explicitly by using the
3902 commands, or implicitly if a macro hook is triggered, e.g., a
3904 It is possible to localize adjustments, like creation, deletion and
3906 .Sx "INTERNAL VARIABLES" ,
3909 command; the scope which is localized depends on how (i.e.,
3911 normal macro, folder hook, hook,
3913 switch) the macro is invoked.
3914 Execution of a macro body can be stopped from within by calling
3918 ed macro, given positional parameters can be
3921 Macros can be deleted via
3926 (d) Marks the given message list as
3928 Deleted messages will neither be saved in
3930 nor will they be available for most other commands.
3933 variable is set, automatically
3946 Superseded by the multiplexer
3952 Delete the given messages and automatically
3956 if one exists, regardless of the setting of
3963 up or down by one message when given
3967 argument, respectively.
3971 Takes a message list and marks each given message as a draft.
3973 .Sx "Message states" .
3977 \*(NQ (ec) Echoes arguments to standard output and writes a trailing
3978 newline, whereas the otherwise identical
3981 .Sx "Shell-style argument quoting"
3983 .Sx "Filename transformations"
3984 are applied to the expanded arguments.
3990 except that is echoes to standard error.
3998 but does not write a trailing newline.
4004 but does not write a trailing newline.
4008 (e) Point the text editor (as defined in
4010 at each message from the given list in turn.
4011 Modified contents are discarded unless the
4018 .Ic if Ns / Ns Ic elif Ns / Ns Ic else Ns / Ns Ic endif
4019 conditional \(em if the condition of a preceding
4021 was false, check the following condition and execute the following block
4022 if it evaluates true.
4027 .Ic if Ns / Ns Ic elif Ns / Ns Ic else Ns / Ns Ic endif
4028 conditional \(em if none of the conditions of the preceding
4032 commands was true, the
4038 (en) Marks the end of an
4039 .Ic if Ns / Ns Ic elif Ns / Ns Ic else Ns / Ns Ic endif
4040 conditional execution block.
4045 \*(NQ \*(UA has a strict notion about which variables are
4046 .Sx "INTERNAL VARIABLES"
4047 and which are managed in the program
4049 Since some of the latter are a vivid part of \*(UAs functioning,
4050 however, they are transparently integrated into the normal handling of
4051 internal variables via
4055 To integrate other environment variables of choice into this
4056 transparent handling, and also to export internal variables into the
4057 process environment where they normally are not, a
4059 needs to become established with this command, as in, e.g.,
4062 .Dl environ link PERL5LIB from TZ
4065 Afterwards changing such variables with
4067 will cause automatic updates of the program environment, and therefore
4068 be inherited by newly created child processes.
4069 Sufficient system support provided (it was in BSD as early as 1987, and
4070 is standardized since Y2K) removing such variables with
4072 will remove them also from the program environment, but in any way
4073 the knowledge they ever have been
4076 Note this implies that
4078 may cause loss of links.
4083 will remove an existing link, but leaves the variables as such intact.
4084 Additionally the subcommands
4088 are provided, which work exactly the same as the documented commands
4092 but (additionally) link the variable(s) with the program environment and
4093 thus immediately export them to, or remove them from (if possible),
4094 respectively, the program environment.
4099 \*(OP Since \*(UA uses the console as a user interface it can happen
4100 that messages scroll by too fast to become recognized.
4101 Optionally an error message ring queue is available which stores
4102 duplicates of any error message and notifies the user in interactive
4103 sessions whenever a new error has occurred.
4104 The queue is finite: if its maximum size is reached any new message
4105 replaces the eldest.
4108 can be used to manage this message queue: if given
4110 or no argument the queue will be displayed and cleared,
4112 will only clear all messages from the queue.
4116 \*(NQ Construct a command by concatenating the arguments, separated with
4117 a single space character, and then evaluate the result.
4118 This command passes through the status of the evaluated command.
4121 .Bd -literal -offset indent
4123 # Like this, sh(1)ell-stylish from begin to end: works!
4124 # Result status ends up in $!, then
4125 localopts 1;wysh set verbose;ignerr eval "${@}";return ${?}
4127 ghost xv '\ecall xverbose'
4140 call yyy '~xxx' "b\e$'\et'u ' "
4148 (ex or x) Exit from \*(UA without changing the active mailbox and skip
4149 any saving of messages in
4151 as well as a possibly tracked line editor history file.
4157 but open the mailbox read-only.
4162 (fi) The file command switches to a new mailbox.
4163 Without arguments it shows status information of the current mailbox.
4164 If an argument is given, it will write out changes (such as deletions)
4165 the user has made and open a new mailbox.
4166 .Sx "Filename transformations"
4167 will be applied to the
4172 If the name ends with
4177 it is treated as being compressed with
4182 respectively, and transparently handled through an intermediate
4183 (un)compression step (using a temporary file) with the according
4184 facility, sufficient support provided.
4185 Likewise, if the named file does not exist, but a file with one of the
4186 mentioned compression extensions does, then the name is automatically
4187 expanded and the compressed file is used.
4190 Otherwise, if the name ends with an extension for which
4191 .Va file-hook-load-EXTENSION
4193 .Va file-hook-save-EXTENSION
4194 variables are set, then the given hooks will be used to load and save
4196 and \*(UA will work with an intermediate temporary file.
4198 MBOX files (flat file-based mailboxes) are generally locked during file
4199 operations in order to avoid inconsistencies due to concurrent
4201 \*(OPal Mailbox files which \*(UA treats as the system
4206 .Sx "primary system mailbox" Ns
4207 es in general will also be protected by so-called dotlock files, the
4208 traditional way of mail spool file locking: for any file
4212 will be created for the duration of the synchronization \(em
4213 as necessary a privilege-separated dotlock child process will be used
4214 to accommodate for necessary privilege adjustments in order to create
4215 the dotlock file in the same directory
4216 and with the same user and group identities as the file of interest.
4219 \*(UA by default uses tolerant POSIX rules when reading MBOX database
4220 files, but it will detect invalid message boundaries in this mode and
4221 complain (even more with
4223 if any is seen: in this case
4225 can be used to create a valid MBOX database from the invalid input.
4230 refers to a directory with the subdirectories
4235 then it is treated as a folder in
4237 format; \*(ID the variable
4239 can be used to control the format of yet non-existent folders.
4243 .Dl \*(IN protocol://[user[:password]@]host[:port][/path]
4244 .Dl \*(OU protocol://[user@]host[:port][/path]
4247 is taken as an Internet mailbox specification.
4248 The \*(OPally supported protocols are
4252 (POP3 with SSL/TLS encrypted transport).
4255 part is valid only for IMAP; there it defaults to
4257 Also see the section
4258 .Sx "On URL syntax and credential lookup" .
4263 contains special characters, in particular
4267 they must be escaped in URL notation \(en the command
4269 can be used to show the necessary conversion.
4274 Takes a message list and marks the messages as flagged for
4275 urgent/special attention.
4277 .Sx "Message states" .
4286 With no arguments, list the names of the folders in the folder directory.
4287 With an existing folder as an argument,
4288 lists the names of folders below the named folder.
4294 but saves the message in a file named after the local part of the first
4295 recipient's address (instead of in
4302 but saves the message in a file named after the local part of the first
4303 recipient's address (instead of in
4310 but responds to all recipients regardless of the
4315 .It Ic followupsender
4318 but responds to the sender only regardless of the
4334 (f) Takes a list of message specifications and displays a summary of
4335 their message headers, exactly as via
4337 An alias of this command is
4340 .Sx "Specifying messages" .
4346 but saves the message in a file named after the local part of the
4347 recipient's address (instead of in
4352 Takes a message and the address of a recipient
4353 and forwards the message to him.
4354 The text of the original message is included in the new one,
4355 with the value of the
4357 variable preceding it.
4358 To filter the included header fields to the desired subset use the
4360 slot of the white- and blacklisting command
4362 Only the first part of a multipart message is included unless
4363 .Va forward-as-attachment ,
4364 and recipient addresses will be stripped from comments, names etc.
4365 unless the internal variable
4371 \*(OB Superseded by the multiplexer
4376 \*(OB Superseded by the multiplexer
4381 Define or list command aliases, so-called ghosts.
4382 A ghost can be used everywhere a normal command can be used, but always
4383 takes precedence: any arguments that are given to the command alias are
4384 joined onto the alias content, and the resulting string forms the
4385 command line that is, in effect, executed.
4386 Command ghosts can be removed with
4388 Without arguments a list of all currently known aliases is shown.
4389 With one argument the expansion of the given alias is shown.
4391 With two or more arguments a command alias is defined or updated: the
4392 first argument is the name under which the remaining command line should
4393 be accessible, the content of which can be just about anything.
4394 A ghost may itself expand to another ghost, but to avoid expansion loops
4395 further expansion will be prevented if a ghost refers to itself or if an
4396 expansion depth limit is reached.
4397 Explicit expansion prevention is available via reverse solidus
4400 .Sx "Command modifiers" .
4401 .Bd -literal -offset indent
4403 \*(uA: `ghost': no such alias: xx
4406 ghost xx "echo hello,"
4416 \*(NQ Multiplexer command to establish white- and blacklisting
4417 selections of header fields for a variety of applications.
4418 Without arguments the set of contexts that have settings is displayed.
4419 When given arguments, the first argument is the context to which the
4420 command applies, one of (case-insensitively)
4422 for display purposes (via, e.g.,
4425 for selecting which headers shall be stored persistently when
4431 ing messages (note that MIME related etc. header fields should not be
4432 ignored in order to not destroy usability of the message in this case),
4434 for stripping down messages when
4436 ing message (has no effect if
4437 .Va forward-as-attachment
4440 for defining user-defined set of fields for the command
4444 The current settings of the given context are displayed if only the
4445 first argument is given.
4446 A second argument denotes the type of restriction that is to be chosen,
4447 it may be (a case-insensitive prefix of)
4451 for white- and blacklisting purposes, respectively.
4452 Establishing a whitelist suppresses inspection of the corresponding
4454 If no further argument is given the current settings of the given type
4458 With four or more arguments the third denotes the action to be applied,
4463 for addition of fields, and
4467 for removal of fields from the given type of the given context.
4468 The fourth, and any following arguments are expected to specify the
4469 fields of desire, or \*(OPally, regular expression matches ought to
4471 The special wildcard field (asterisk,
4473 will establish a (fast) shorthand setting which covers all fields, or
4474 remove all fields in one operation, respectively.
4479 (h) Show the current group of headers, the size of which depends on
4482 and the style of which can be adjusted with the variable
4484 If a message-specification is given the group of headers containing the
4485 first message therein is shown and the message at the top of the screen
4500 the list of history entries;
4503 argument selects and evaluates the respective history entry,
4504 which will become the new history top; a negative number is used as an
4505 offset to the current command, e.g.,
4507 will select the last command, the history top.
4508 The default mode if no arguments are given is
4515 Takes a message list and marks each message therein to be saved in the
4520 Does not override the
4523 \*(UA deviates from the POSIX standard with this command, because a
4525 command issued after
4527 will display the following message, not the current one.
4532 (i) Part of the nestable
4533 .Ic if Ns / Ns Ic elif Ns / Ns Ic else Ns / Ns Ic endif
4534 conditional execution construct \(em if the given condition is true then
4535 the encapsulated block is executed.
4536 POSIX only supports the (case-insensitive) conditions
4541 end, all remaining conditions are non-portable extensions; note that
4542 falsely specified conditions cause the execution of the entire
4543 conditional construct until the (matching) closing
4545 command to be suppressed.
4546 The syntax of the nestable
4548 conditional execution construct requires that each condition and syntax
4549 element is surrounded by whitespace.
4551 .Bd -literal -offset indent
4560 The (case-insensitive) condition
4562 erminal will evaluate to true if the standard input is a terminal, i.e.,
4563 in interactive sessions.
4564 Another condition can be any boolean value (see the section
4565 .Sx "INTERNAL VARIABLES"
4566 for textual boolean representations) to mark an enwrapped block as
4569 .Dq always execute .
4570 It is possible to check
4571 .Sx "INTERNAL VARIABLES"
4574 variables for existence or compare their expansion against a user given
4575 value or another variable by using the
4577 .Pf ( Dq variable next )
4578 conditional trigger character;
4579 a variable on the right hand side may be signalled using the same
4581 The variable names may be enclosed in a pair of matching braces.
4584 The available comparison operators are
4588 (less than or equal to),
4594 (greater than or equal to),
4598 (is substring of) and
4600 (is not substring of).
4601 The values of the left and right hand side are treated as strings and
4602 are compared 8-bit byte-wise, ignoring case according to the rules of
4603 the US-ASCII encoding (therefore, dependent on the active locale,
4604 possibly producing false results for strings in the locale encoding).
4605 Except for the substring checks the comparison will instead be performed
4606 arithmetically if both, the user given value as well as the variable
4607 content, can be parsed as numbers (integers).
4608 An unset variable is treated as the empty string.
4611 When the \*(OPal regular expression support is available, the additional
4617 They treat the right hand side as an extended regular expression that is
4618 matched case-insensitively and according to the active
4620 locale, meaning that strings in the locale encoding should be matched
4624 Conditions can be joined via AND-OR lists (where the AND operator is
4626 and the OR operator is
4628 which have equal precedence and will be evaluated with left
4629 associativity, thus using the same syntax that is known for the
4631 It is also possible to form groups of conditions and lists by enclosing
4632 them in pairs of brackets
4633 .Ql [\ \&.\&.\&.\ ] ,
4634 which may be interlocked within each other, and also be joined via
4638 The results of individual conditions and entire groups may be modified
4639 via unary operators: the unary operator
4641 will reverse the result.
4643 .Bd -literal -offset indent
4647 if [ "$ttycharset" == UTF-8 ] || [ "$ttycharset" == UTF8 ]
4648 echo *ttycharset* is set to UTF-8, case-insensitively
4651 if [ "${t1}" == "${t2}" ]
4652 echo These two variables are equal
4654 if [ "$version-major" >= 15 ]
4655 echo Running a new version..
4656 if [ "$features" =@ +regex ]
4657 if [ "$TERM" =~ "^xterm\&.*" ]
4658 echo ..in an X terminal
4661 if [ [ true ] && [ [ "${debug}" != '' ] || \e
4662 [ "$verbose" != '' ] ] ]
4665 if true && [ "$debug" != '' ] || [ "${verbose}" != '' ]
4666 echo Left associativity, as is known from the shell
4668 if ! ! true && ! [ ! "$debug" && ! "$verbose" ]
4669 echo Unary operator support
4679 Superseded by the multiplexer
4684 Shows the names of all available commands, alphabetically sorted.
4685 If given any non-whitespace argument the list will be shown in the order
4686 in which command prefixes are searched.
4687 In conjunction with a set variable
4689 additional information will be provided for each command: the argument
4690 type will be indicated, the \*(OPal documentation string will be shown,
4691 and the set of command flags will show up:
4693 .Bl -tag -compact -width ".It Ql BaNg"
4694 .It Ql "vput modifier"
4695 command supports the command modifier
4697 .It Ql "status in *!*"
4698 the soft exit status is tracked in
4701 commands needs an active mailbox, a
4703 .It Ql "ok: batch or interactive"
4704 command may only be used in interactive or
4707 .It Ql "ok: send mode"
4708 command can be used in send mode.
4709 .It Ql "not ok: compose mode"
4710 command is not available when in compose-mode.
4711 .It Ql "not ok: during startup"
4712 command cannot be used during program startup, e.g., while loading
4713 .Sx "Resource files" .
4714 .It Ql "ok: in subprocess"
4715 command is allowed to be used when running in a subprocess instance,
4716 e.g., from within a macro that is called via
4717 .Va on-compose-done .
4722 This command can be used to localize changes to variables, meaning that
4723 their state will be reverted to the former one once the covered scope
4725 It can only be used inside of macro definition blocks introduced by
4729 and is interpreted as a boolean (string, see
4730 .Sx "INTERNAL VARIABLES" ) ;
4733 of an account is left once it is switched off again.
4734 .Bd -literal -offset indent
4735 define temporary_settings {
4736 set possibly_global_option1
4741 set possibly_global_option2
4750 enables change localization and calls
4752 which explicitly resets localization, then any value changes within
4754 will still be reverted by
4756 \*(ID Once the outermost level, the one which enabled localization
4757 first, is left, but no earlier, all adjustments will be unrolled.
4758 \*(ID Likewise worth knowing, if in this example
4760 changes to a different
4762 which sets some variables that are yet covered by localizations, their
4763 scope will be extended, and in fact leaving the
4765 will (thus) restore settings in (likely) global scope which actually
4766 were defined in a local, private context.
4770 Reply to messages that come in via known
4773 .Pf ( Ic mlsubscribe )
4774 mailing lists, or pretend to do so (see
4775 .Sx "Mailing lists" ) :
4778 functionality this will actively resort and even remove message
4779 recipients in order to generate a message that is supposed to be sent to
4781 For example it will also implicitly generate a
4782 .Ql Mail-Followup-To:
4783 header if that seems useful, regardless of the setting of the variable
4790 but saves the message in a file named after the local part of the first
4791 recipient's address (instead of in
4796 (m) Takes a (list of) recipient address(es) as (an) argument(s),
4797 or asks on standard input if none were given;
4798 then collects the remaining mail content and sends it out.
4802 (mb) The given message list is to be sent to
4804 when \*(UA is quit; this is the default action unless the variable
4807 \*(ID This command can only be used in a
4809 .Sx "primary system mailbox" .
4813 Without any arguments the content of the MIME type cache will displayed.
4814 Otherwise each argument defines a complete MIME type specification of
4815 a type that shall be added (prepended) to the cache.
4816 In any event MIME type sources are loaded first as necessary \(en
4817 .Va mimetypes-load-control
4818 can be used to fine-tune which sources are actually loaded.
4819 Refer to the section on
4820 .Sx "The mime.types files"
4821 for more on MIME type specifications and this topic in general.
4822 MIME type unregistration and cache resets can be triggered with
4827 Without arguments the list of all currently defined mailing lists
4828 (and their attributes, if any) is shown; a more verbose listing will be
4829 produced if either of
4834 Otherwise all given arguments (which need not be quoted except for
4835 whitespace) will be added and henceforth be recognized as mailing lists.
4836 Mailing lists may be removed via the command
4839 If the \*(OPal regular expression support is available then mailing
4840 lists may also be specified as (extended) regular expressions (see
4846 Without arguments the list of all currently defined mailing lists which
4847 have a subscription attribute is shown; a more verbose listing will be
4848 produced if either of
4853 Otherwise this attribute will be set for all given mailing lists,
4854 newly creating them as necessary (as via
4856 Subscription attributes may be removed via the command
4865 but moves the messages to a file named after the local part of the
4866 sender address of the first message (instead of in
4873 but marks the messages for deletion if they were transferred
4880 but also displays header fields which would not pass the
4882 selection, and all MIME parts.
4890 on the given messages, even in non-interactive mode and as long as the
4891 standard output is a terminal.
4897 \*(OP When used without arguments or if
4899 has been given the content of the
4901 cache is shown, loading it first as necessary.
4904 then the cache will only be initialized and
4906 will remove its contents.
4907 Note that \*(UA will try to load the file only once, use
4908 .Ql Ic \&\&netrc Ns \:\0\:clear
4909 to unlock further attempts.
4914 .Sx "On URL syntax and credential lookup" ;
4916 .Sx "The .netrc file"
4917 documents the file format in detail.
4921 Checks for new mail in the current folder without committing any changes
4923 If new mail is present, a message is shown.
4927 the headers of each new message are also shown.
4928 This command is not available for all mailbox types.
4936 Goes to the next message in sequence and types it.
4937 With an argument list, types the next matching message.
4951 If the current folder is accessed via a network connection, a
4953 command is sent, otherwise no operation is performed.
4959 but also displays header fields which would not pass the
4961 selection, and all MIME parts.
4969 on the given messages, even in non-interactive mode and as long as the
4970 standard output is a terminal.
4978 but also pipes header fields which would not pass the
4980 selection, and all parts of MIME
4981 .Ql multipart/alternative
4986 (pi) Takes a message list and a shell command
4987 and pipes the messages through the command.
4988 Without an argument the current message is piped through the command
4995 every message is followed by a formfeed character.
5016 (q) Terminates the session, saving all undeleted, unsaved messages in
5019 preserving all messages marked with
5023 or never referenced in the system
5025 and removing all other messages from the
5027 .Sx "primary system mailbox" .
5028 If new mail has arrived during the session,
5030 .Dq You have new mail
5032 If given while editing a mailbox file with the command line option
5034 then the edit file is rewritten.
5035 A return to the shell is effected,
5036 unless the rewrite of edit file fails,
5037 in which case the user can escape with the exit command.
5041 \*(NQ Read a line from standard input, and assign the splitted and
5042 trimmed line data to the given variables.
5043 The variable names are check by the same rules as documented for
5045 If there are more fields than variables, assign successive fields to the
5046 last given variable.
5047 If there are less fields than variables, assign the empty string to the
5049 The return status is tracked via
5051 even though variable names are checked errors may still happen if it is
5052 tried to set, e.g., strings to variables which expect number settings;
5053 it thus only happens if names are used which have special meaning to \*(UA.
5054 \*(ID This command will likely be extended towards more
5056 compatibility: for now splitting always occurs at whitespace, reverse
5057 solidus newline escaping is always supported, and the \*(OPal line
5058 editing features are always available when on an interactive terminal.
5059 .Bd -literal -offset indent
5062 ? echo "<$a> <$b> <$c>"
5078 Removes the named files or directories.
5079 If a name refer to a mailbox, e.g., a Maildir mailbox, then a mailbox
5080 type specific removal will be performed, deleting the complete mailbox.
5081 The user is asked for confirmation in interactive mode.
5085 Takes the name of an existing folder
5086 and the name for the new folder
5087 and renames the first to the second one.
5088 Both folders must be of the same type.
5092 (R) Reply to originator.
5093 Does not reply to other recipients of the original message.
5095 will exchange this command with
5097 Unless the internal variable
5099 is set the recipient address will be stripped from comments, names etc.
5103 (r) Take a message and group-responds to it by addressing the sender
5106 .Va followup-to-honour ,
5109 .Va recipients-in-cc
5110 influence response behaviour.
5113 offers special support for replying to mailing lists.
5114 Unless the internal variable
5116 is set recipient addresses will be stripped from comments, names etc.
5129 but initiates a group-reply regardless of the value of
5136 but responds to the sender only regardless of the value of
5143 but does not add any header lines.
5144 This is not a way to hide the sender's identity,
5145 but useful for sending a message again to the same recipients.
5149 Takes a list of messages and a user name
5150 and sends each message to the named user.
5152 and related header fields are prepended to the new copy of the message.
5170 .It Ic respondsender
5176 (ret) Superseded by the multiplexer
5181 Only available inside the scope of a
5185 this will stop evaluation of any further macro content, and return
5186 execution control to the caller.
5187 If no arguments are specified, the return value, which will be stored in
5189 as well as the macro command exit status, which is made available in
5192 If only the return value is given the command exit status will be 0.
5193 Both optional parameters must be specified as unsigned (positive)
5196 \*(ID Notes: any non-0 command exit status is treated as a hard error
5197 by the state machinery, and will be propagated up and cause, e.g.,
5198 a file inclusion via
5200 to fail; this two argument form likely is a temporary hack that will
5207 but saves the messages in a file named after the local part of the
5208 sender of the first message instead of (in
5210 and) taking a filename argument.
5214 (s) Takes a message list and a filename and appends each message in turn
5215 to the end of the file.
5216 If no filename is given, the
5219 The filename in quotes, followed by the generated character count
5220 is echoed on the user's terminal.
5223 .Sx "primary system mailbox"
5224 the messages are marked for deletion.
5225 .Sx "Filename transformations"
5230 \*(OB Superseded by the multiplexer
5235 \*(OB Superseded by the multiplexer
5240 \*(OB Superseded by the multiplexer
5245 Takes a message specification (list) and displays a header summary of
5246 all matching messages, as via
5248 This command is an alias of
5251 .Sx "Specifying messages" .
5255 Takes a message list and marks all messages as having been read.
5259 (se) Without arguments this command shows all internal variables which
5260 are currently known to \*(UA (they have been set).
5261 A more verbose listing will be produced if either of
5265 are set, in which case variables may be preceded with a comment line
5266 that gives some context of what \*(UA knows about the given variable.
5268 Otherwise the given variables (and arguments) are set or adjusted.
5269 Arguments are of the form
5271 (no space before or after
5275 if there is no value, i.e., a boolean variable.
5276 Quotation marks may be placed around any part of the assignment
5277 statement to quote blanks or tabs, e.g.,
5279 .Dl set indentprefix='->'
5281 If an argument begins with
5285 the effect is the same as invoking the
5287 command with the remaining part of the variable
5288 .Pf ( Ql unset save ) .
5292 that is known to map to an environment variable will automatically cause
5293 updates in the program environment (unsetting a variable in the
5294 environment requires corresponding system support).
5295 Please use the command
5297 for further environmental control.
5302 .Sx "INTERNAL VARIABLES"
5308 (sh) Invokes an interactive version of the shell.
5312 Without arguments the list of all currently defined shortcuts is
5314 Otherwise all given arguments are treated as pairs of shortcuts and
5315 their expansions, creating new or changing already existing shortcuts,
5317 Shortcuts can be removed with the command
5322 Only available inside the scope of a
5324 ed macro, this will shift the positional parameters (starting at
5326 by the given number (which must be an unsigned, positive, decimal),
5327 or 1 if no argument has been given.
5328 It is an error if the value exceeds the number of positional parameters.
5329 If the given number is 0, no action is performed, successfully.
5335 but performs neither MIME decoding nor decryption, so that the raw
5336 message text is shown.
5340 (si) Shows the size in characters of each message of the given
5345 Shows the current sorting criterion when used without an argument.
5346 Otherwise creates a sorted representation of the current folder,
5349 command and the addressing modes such that they refer to messages in
5351 Message numbers are the same as in regular mode.
5355 a header summary in the new order is also displayed.
5356 Automatic folder sorting can be enabled by setting the
5358 variable, as in, e.g.,
5359 .Ql set autosort=thread .
5360 Possible sorting criterions are:
5362 .Bl -tag -compact -width "subject"
5364 Sort the messages by their
5366 field, that is by the time they were sent.
5368 Sort messages by the value of their
5370 field, that is by the address of the sender.
5373 variable is set, the sender's real name (if any) is used.
5375 Sort the messages by their size.
5377 \*(OP Sort the message by their spam score, as has been classified by
5380 Sort the messages by their message status.
5382 Sort the messages by their subject.
5384 Create a threaded display.
5386 Sort messages by the value of their
5388 field, that is by the address of the recipient.
5391 variable is set, the recipient's real name (if any) is used.
5396 (so) The source command reads commands from the given file.
5397 .Sx "Filename transformations"
5399 If the given expanded argument ends with a vertical bar
5401 then the argument will instead be interpreted as a shell command and
5402 \*(UA will read the output generated by it.
5403 Interpretation of commands read is stopped when an error is encountered.
5406 cannot be used from within macros that execute as
5407 .Va folder-hook Ns s
5410 i.e., it can only be called from macros that were
5417 (beside not supporting pipe syntax aka shell command input) is that
5418 this command will not generate an error nor warn if the given file
5419 argument cannot be opened successfully.
5423 \*(OP Takes a list of messages and clears their
5429 \*(OP Takes a list of messages and causes the
5431 to forget it has ever used them to train its Bayesian filter.
5432 Unless otherwise noted the
5434 flag of the message is inspected to chose whether a message shall be
5442 \*(OP Takes a list of messages and informs the Bayesian filter of the
5446 This also clears the
5448 flag of the messages in question.
5452 \*(OP Takes a list of messages and rates them using the configured
5453 .Va spam-interface ,
5454 without modifying the messages, but setting their
5456 flag as appropriate; because the spam rating headers are lost the rate
5457 will be forgotten once the mailbox is left.
5458 Refer to the manual section
5460 for the complete picture of spam handling in \*(UA.
5464 \*(OP Takes a list of messages and sets their
5470 \*(OP Takes a list of messages and informs the Bayesian filter of the
5476 flag of the messages in question.
5485 Create a threaded representation of the current folder,
5486 i.\|e. indent messages that are replies to other messages in the header
5487 display and change the
5489 command and the addressing modes such that they refer to messages in the
5491 Message numbers are the same as in unthreaded mode.
5495 a header summary in threaded order is also displayed.
5504 slot for white- and blacklisting header fields.
5508 (to) Takes a message list and types out the first
5510 lines of each message on the users' terminal.
5511 Unless a special selection has been established for the
5515 command, the only header fields that are displayed are
5526 It is possible to apply compression to what is displayed by setting
5528 Messages are decrypted and converted to the terminal character set
5533 (tou) Takes a message list and marks the messages for saving in
5535 \*(UA deviates from the POSIX standard with this command,
5538 command will display the following message instead of the current one.
5544 but also displays header fields which would not pass the
5546 selection, and all parts of MIME
5547 .Ql multipart/alternative
5552 (t) Takes a message list and types out each message on the users'
5556 For MIME multipart messages, all parts with a content type of
5560 are shown, the other are hidden except for their headers.
5561 Messages are decrypted and converted to the terminal character set
5566 Delete all given accounts.
5567 An error message is shown if a given account is not defined.
5570 will discard all existing accounts.
5574 (una) Takes a list of names defined by alias commands
5575 and discards the remembered groups of users.
5578 will discard all existing aliases.
5582 Takes a message list and marks each message as not having been answered.
5588 ing, specified by its context and input sequence, both of which may be
5589 specified as a wildcard (asterisk,
5593 will remove all bindings of all contexts.
5597 Only applicable to threaded mode.
5598 Takes a message list and makes the message and all replies to it visible
5599 in header summaries again.
5600 When a message becomes the current message,
5601 it is automatically made visible.
5602 Also when a message with collapsed replies is displayed,
5603 all of these are automatically uncollapsed.
5609 mapping for the given colour type (see
5611 for a list of types) and mapping; if the optional precondition argument
5612 is used then only the exact tuple of mapping and precondition is removed.
5615 will remove all mappings (no precondition allowed).
5617 .Sx "Coloured display"
5618 for the general picture.
5622 Undefine all given macros.
5623 An error message is shown if a given macro is not defined.
5626 will discard all existing macros.
5630 (u) Takes a message list and marks each message as not being deleted.
5633 variable is set, the last message restored will be
5635 d automatically; if no message list had been specified then the usual
5636 search for a visible message is performed, as documented for
5638 showing only the next input prompt if the search fails.
5646 Takes a message list and
5652 Takes a message list and marks each message as not being
5657 \*(OB Superseded by the multiplexer
5662 \*(OB Superseded by the multiplexer
5667 Remove all the given command
5671 will remove all ghosts.
5675 Superseded by the multiplexer
5680 Delete all given MIME types, e.g.,
5681 .Ql unmimetype text/plain
5682 will remove all registered specifications for the MIME type
5686 will discard all existing MIME types, just as will
5688 but which also reenables cache initialization via
5689 .Va mimetypes-load-control .
5693 Forget about all the given mailing lists.
5696 will remove all lists.
5701 .It Ic unmlsubscribe
5702 Remove the subscription attribute from all given mailing lists.
5705 will clear the attribute from all lists which have it set.
5716 Takes a message list and marks each message as not having been read.
5720 Superseded by the multiplexer
5725 \*(OB Superseded by the multiplexer
5730 \*(OB Superseded by the multiplexer
5735 \*(NQ (uns) Takes a list of internal variable names and discards their
5736 remembered values; the reverse of
5745 s given as arguments, the special argument
5747 will remove all shortcuts.
5751 Disable sorted or threaded mode
5757 return to normal message order and,
5761 displays a header summary.
5771 \*(NQ Perform URL percent codec operations, rather according to RFC 3986.
5775 .Sx "Command modifiers" ) .
5776 The return status is tracked via
5778 This is a character set agnostic and thus locale dependent operation,
5779 and it may decode bytes which are invalid in the current locale, unless
5780 the input solely consists of characters in the portable character set, see
5781 .Sx "Character sets" .
5782 \*(ID This command does not about URLs beside that.
5784 The first argument specifies the operation:
5788 perform plain URL percent en- and decoding, respectively.
5792 perform a slightly modified operation which should be better for
5793 pathnames: it does not allow a tilde
5795 and will neither accept hyphen-minus
5799 as an initial character.
5800 The remaining arguments form the URL data which is to be converted.
5804 \*(NQ Edit the values of or create the given variable(s) in the
5806 Boolean variables cannot be edited, and variables can also not be
5812 \*(NQ This command produces the same output as the listing mode of
5816 ity adjustments, but only for the given variables.
5820 \*(OP Takes a message list and verifies each message.
5821 If a message is not a S/MIME signed message,
5822 verification will fail for it.
5823 The verification process checks if the message was signed using a valid
5825 if the message sender's email address matches one of those contained
5826 within the certificate,
5827 and if the message content has been altered.
5840 \*(NQ Evaluate arguments according to a given operator.
5841 This is a multiplexer command which can be used to perform signed 64-bit
5842 numeric calculations as well as string operations.
5843 It uses polish notation, i.e., the operator is the first argument and
5844 defines the number and type, and the meaning of the remaining arguments.
5845 An empty argument is replaced with a 0 if a number is expected.
5849 .Sx "Command modifiers" ) .
5850 The return status is tracked via
5852 the result that is shown in case of (soft) errors is
5854 In general only invalid use cases cause hard errors which are reflected in
5856 and affect the state machine.
5859 Numeric operations work on one or two signed 64-bit integers.
5860 One integer is expected by assignment (equals sign
5862 which does nothing but parsing the argument, thus detecting validity and
5863 possible overflow conditions, and unary not (tilde
5865 which creates the bitwise complement.
5866 Two integers are used by addition (plus sign
5868 subtraction (hyphen-minus
5870 multiplication (asterisk
5874 and modulo (percent sign
5876 as well as for the bitwise operators logical or (vertical bar
5879 bitwise and (ampersand
5882 bitwise xor (circumflex
5884 the bitwise signed left- and right shifts
5887 as well as for the unsigned right shift
5891 All numeric operators can be suffixed with a commercial at
5895 this will turn the operation into a saturated one, which means that
5896 overflow errors and division and modulo by zero are still reflected in
5897 the return status, but the result will linger at the minimum or maximum
5898 possible value, instead of overflowing (or trapping).
5899 For the bitwise shifts, the saturated maximum is 63.
5900 If in saturated mode the overflow occurs during parsing the numbers,
5901 then the actual operation will not be performed but the given maximum
5902 value is used as the result immediately.
5905 String operations that take one argument are
5907 which queries the length of the given argument,
5909 which calculates the Chris Torek hash of the given string, and
5911 which performs the usual
5912 .Sx "Filename transformations" ,
5913 on its argument, as well as
5915 which generates a random string of the given length, or of
5917 bytes (a constant from
5919 if the value 0 is given; the random string will be base64url encoded
5920 according to RFC 4648, and thus be usable as a file name.
5923 String operations with two or more arguments are
5925 which searches in the first for the second argument, and shows the
5926 resulting 0-based offset shall it have been found,
5928 which is identical to
5930 but works case-insensitively according to the rules of the ASCII
5933 will show a substring of its first argument:
5934 the second argument is the 0-based starting offset, the optional third
5935 argument can be used to specify the length of the desired substring,
5936 by default the entire string is used;
5937 this operation tries to work around faulty arguments, but the (soft)
5938 return status will still reflect them (set
5945 will try to match the first argument with the regular expression given
5946 in the second argument, as does
5948 but which is case-insensitive.
5949 These operators match according to the active
5951 locale and thus should match correctly strings in the locale encoding.
5952 If the optional third argument has been given then instead of showing
5953 the match offset a replacement operation is performed:
5954 the third argument is treated as if specified via dollar-single-quote
5956 .Sx "Shell-style argument quoting" ) ,
5957 and any occurrence of a positional parameter, e.g.,
5959 is replaced by the corresponding match group of the regular expression.
5961 .Bd -literal -offset indent
5962 ? vexpr -@ +1 -9223372036854775808
5963 ? vput vexpr res ir bananarama (.*)nana(.*) '\e${1}au\e$2'
5970 (v) Takes a message list and invokes the display editor on each message.
5971 Modified contents are discarded unless the
5977 (w) For conventional messages the body without all headers is written.
5978 The original message is never marked for deletion in the originating
5980 The output is decrypted and converted to its native format as necessary.
5981 If the output file exists, the text is appended.
5982 If a message is in MIME multipart format its first part is written to
5983 the specified file as for conventional messages, handling of the remains
5984 depends on the execution mode.
5985 No special handling of compressed files is performed.
5987 In interactive mode the user is consecutively asked for the filenames of
5988 the processed parts.
5989 For convience saving of each part may be skipped by giving an empty
5990 value, the same result as writing it to
5992 Shell piping the part content by specifying a leading vertical bar
5994 character for the filename is supported.
5995 Other user input undergoes the usual
5996 .Sx "Filename transformations" ,
5997 and contents of the destination file are overwritten if the file
6000 \*(ID In non-interactive mode any part which does not specify a filename
6001 is ignored, and suspicious parts of filenames of the remaining parts are
6002 URL percent encoded (as via
6004 to prevent injection of malicious character sequences, resulting in
6005 a filename that will be written into the current directory.
6006 Existing files will not be overwritten, instead the part number or
6007 a dot are appended after a number sign
6009 to the name until file creation succeeds (or fails due to other
6019 \*(UA presents message headers in
6021 fuls as described under the
6024 Without arguments this command scrolls to the next window of messages,
6025 likewise if the argument is
6029 scrolls to the last,
6031 scrolls to the first, and
6036 A number argument prefixed by
6040 indicates that the window is calculated in relation to the current
6041 position, and a number without a prefix specifies an absolute position.
6047 but scrolls to the next or previous window that contains at least one
6057 .\" .Sh COMMAND ESCAPES {{{
6058 .Sh "COMMAND ESCAPES"
6060 Here is a summary of the command escapes available in compose mode,
6061 which are used to perform special functions when composing messages.
6062 Command escapes are only recognized at the beginning of lines.
6063 The actual escape character can be set via the internal variable
6065 it defaults to the tilde
6069 .Bl -tag -width ".It Ic BaNg"
6072 Insert the string of text in the message prefaced by a single
6074 (If the escape character has been changed,
6075 that character must be doubled
6076 in order to send it at the beginning of a line.)
6079 .It Ic ~! Ar command
6080 Execute the indicated shell
6082 which follows, replacing unescaped exclamation marks with the previously
6083 executed command if the internal variable
6085 is set, then return to the message.
6089 Same effect as typing the end-of-file character.
6092 .It Ic ~: Ar \*(UA-command Ns \0or Ic ~_ Ar \*(UA-command
6093 Execute the given \*(UA command.
6094 Not all commands, however, are allowed.
6098 Write a summary of command escapes.
6101 .It Ic ~< Ar filename
6106 .It Ic ~<! Ar command
6108 is executed using the shell.
6109 Its standard output is inserted into the message.
6112 .It Ic ~@ Op Ar filename...
6113 Append or edit the list of attachments.
6116 arguments is expected (see
6117 .Sx "Shell-style argument quoting" ;
6118 any token-separating commas are ignored), to be
6119 interpreted as documented for the command line option
6121 with the message number exception as below.
6124 arguments the attachment list is edited, entry by entry;
6125 if a filename is left empty, that attachment is deleted from the list;
6126 once the end of the list is reached either new attachments may be
6127 entered or the session can be quit by committing an empty
6130 For each mode, if a given file name solely consists of the number sign
6132 followed by a valid message number of the currently active mailbox, then
6133 the given message is attached as a MIME
6135 part (note the number sign is the comment character and must be quoted).
6139 Inserts the string contained in the
6142 .Ql Ic ~i Ns \0Sign ) .
6147 ting the variable(s) instead!) The escape sequences tabulator
6155 Inserts the string contained in the
6158 .Ql Ic ~i Ns \0sign ) .
6163 ting the variable(s) instead!) The escape sequences tabulator
6170 .It Ic ~b Ar name ...
6171 Add the given names to the list of blind carbon copy recipients.
6174 .It Ic ~c Ar name ...
6175 Add the given names to the list of carbon copy recipients.
6179 Read the file specified by the
6181 variable into the message.
6185 Invoke the text editor on the message collected so far.
6186 After the editing session is finished,
6187 the user may continue appending text to the message.
6190 .It Ic ~F Ar messages
6191 Read the named messages into the message being sent, including all
6192 message headers and MIME parts.
6193 If no messages are specified, read in the current message.
6196 .It Ic ~f Ar messages
6197 Read the named messages into the message being sent.
6198 If no messages are specified, read in the current message.
6199 Strips down the list of header fields according to the
6201 white- and blacklist selection of
6203 For MIME multipart messages,
6204 only the first displayable part is included.
6208 Edit the message header fields
6213 by typing each one in turn and allowing the user to edit the field.
6214 The default values for these fields originate from the
6222 Edit the message header fields
6228 by typing each one in turn and allowing the user to edit the field.
6231 .It Ic ~i Ar variable
6232 Insert the value of the specified variable into the message,
6233 adding a newline character at the end.
6234 The message remains unaltered if the variable is unset or empty.
6239 ting the variable(s) instead!) The escape sequences tabulator
6246 .It Ic ~M Ar messages
6247 Read the named messages into the message being sent,
6250 If no messages are specified, read the current message.
6253 .It Ic ~m Ar messages
6254 Read the named messages into the message being sent,
6257 If no messages are specified, read the current message.
6258 Strips down the list of header fields according to the
6260 white- and blacklist selection of
6262 For MIME multipart messages,
6263 only the first displayable part is included.
6267 Display the message collected so far,
6268 prefaced by the message header fields
6269 and followed by the attachment list, if any.
6273 Abort the message being sent,
6274 copying it to the file specified by the
6281 .It Ic ~R Ar filename
6284 but indent each line that has been read by
6288 .It Ic ~r Ar filename Op Ar HERE-delimiter
6289 Read the named file into the message.
6291 can also be a hyphen-minus
6293 in which case standard input is used, e.g., for pasting purposes.
6294 Only in this latter mode
6296 may be given: if it is data will be read in until the given
6298 is seen on a line by itself, and encountering EOF is an error; the
6300 is a required argument in non-interactive mode;
6301 note that variables expansion is performed on the delimiter.
6305 Cause the named string to become the current subject field.
6306 Newline (NL) and carriage-return (CR) bytes are invalid and will be
6307 normalized to space (SP) characters.
6310 .It Ic ~t Ar name ...
6311 Add the given name(s) to the direct recipient list.
6314 .It Ic ~U Ar messages
6315 Read in the given / current message(s) excluding all headers, indented by
6319 .It Ic ~u Ar messages
6320 Read in the given / current message(s), excluding all headers.
6324 Invoke an alternate editor (defined by the
6326 environment variable) on the message collected so far.
6327 Usually, the alternate editor will be a screen editor.
6328 After the editor is quit,
6329 the user may resume appending text to the end of the message.
6332 .It Ic ~w Ar filename
6333 Write the message onto the named file.
6335 the message is appended to it.
6341 except that the message is not saved at all.
6344 .It Ic ~| Ar command
6345 Pipe the message through the specified filter command.
6346 If the command gives no output or terminates abnormally,
6347 retain the original text of the message.
6350 is often used as a rejustifying filter.
6354 .It Ic ~^ Ar cmd Op Ar subcmd Op Ar arg3 Op Ar arg4
6355 Low-level command ment for scripted message access, i.e., for
6356 .Va on-compose-done-shell
6358 .Va on-compose-done .
6359 The used protocol is likely subject to changes, and therefore the
6360 mentioned hooks receive the used protocol version as an initial line.
6361 In general the first field of a response line represents a status code
6362 which specifies whether a command was successful or not, whether result
6363 data is to be expected, and if, the format of the result data.
6364 The status codes are:
6367 .Bl -tag -compact -width _210_
6369 Status ok; the remains of the line are the result.
6371 Status ok; the rest of the line is optionally used for more status.
6372 What follows are lines of result addresses, terminated by an empty line.
6373 The address lines consist of two fields, the first of which is the
6374 plain address, e.g.,
6376 separated by a single ASCII SP space from the second which contains the
6377 unstripped address, even if that is identical to the first field, e.g.,
6378 .Ql (Lovely) Bob <bob@exam.ple> .
6380 Status ok; the rest of the line is optionally used for more status.
6381 What follows are lines of furtherly unspecified string content,
6382 terminated by an empty line.
6383 (All the input, including the empty line, must be consumed before
6384 further commands can be issued.)
6386 Syntax error; invalid command.
6388 Syntax error in parameters or arguments.
6390 Error: an argument fails verification.
6391 For example an invalid address has been specified.
6393 Error: an otherwise valid argument is rendered invalid due to context.
6394 For example, a second address is added to a header which may consist of
6395 a single address only.
6399 If a command indicates failure then the message will have remained
6401 Most commands can fail with
6403 if required arguments are missing (false command usage).
6404 The following commands are supported, and, as usual, case-insensitive:
6407 .Bl -hang -width header
6409 This command allows listing, inspection, and editing of message headers.
6410 The second argument specifies the subcommand to apply, one of:
6413 .Bl -hang -compact -width remove
6415 Without a third argument a list of all yet existing headers is given via
6417 this command is the default command of
6419 if no second argument has been given.
6420 A third argument restricts output to the given header only, which may
6423 if no such field is defined.
6426 Shows the content of the header given as the third argument.
6427 Dependent on the header type this may respond with
6431 any failure results in
6435 This will remove all instances of the header given as the third
6440 if no such header can be found.
6443 Create a new or an additional instance of the header given in the third
6444 argument, with the header body content as given in the fourth argument
6445 (the remains of the line).
6448 if the third argument specifies a free-form header field name that is
6449 invalid, or if body content extraction fails to succeed,
6451 if any extracted address does not pass syntax and/or security checks, and
6453 to indicate prevention of excessing a single-instance header \(em note that
6455 can be appended to (a space separator will be added automatically first).
6457 is returned upon success.
6462 This command allows listing, removal and addition of message attachments.
6463 The second argument specifies the subcommand to apply, one of:
6466 .Bl -hang -compact -width remove
6468 List all attachments via
6472 if no attachments exist.
6473 This command is the default command of
6475 if no second argument has been given.
6478 This will remove the attachment given as the third argument, and report
6482 if no such attachment can be found.
6483 If there exists any path component in the given argument, then an exact
6484 match of the path which has been used to create the attachment is used
6485 directly, but if only the basename of that path matches then all
6486 attachments are traversed to find an exact match first, and the removal
6487 occurs afterwards; if multiple basenames match, a
6490 Message attachments are treated as absolute pathnames.
6492 If no path component exists in the given argument, then all attachments
6493 will be searched for
6495 parameter matches as well as for matches of the basename of the path
6496 which has been used when the attachment has been created; multiple
6501 This will interpret the third argument as a number and remove the
6502 attachment at that list position (counting from one!), reporting
6506 if the argument is not a number or
6508 if no such attachment exists.
6511 Adds the attachment given as the third argument, specified exactly as
6512 documented for the command line option
6514 and supporting the message number extension as documented for
6518 upon success, with the index of the new attachment following,
6520 if the given file cannot be opened,
6522 if an on-the-fly performed character set conversion fails, otherwise
6524 is reported; this is also reported if character set conversion is
6525 requested but not available.
6528 This uses the same search mechanism as described for
6530 and prints any known attributes of the first found attachment via
6534 if no such attachment can be found.
6535 The attributes are written as lines of keyword and value tuples, the
6536 keyword being separated from the rest of the line with an ASCII SP space
6540 This uses the same search mechanism as described for
6542 and is otherwise identical to
6545 .It Ar attribute-set
6546 This uses the same search mechanism as described for
6548 and will assign the attribute given as the fourth argument, which is
6549 expected to be a value tuple of keyword and other data, separated by
6550 a ASCII SP space or TAB tabulator character.
6551 If the value part is empty, then the given attribute is removed, or
6552 reset to a default value if existence of the attribute is crucial.
6555 upon success, with the index of the found attachment following,
6557 for message attachments or if the given keyword is invalid, and
6559 if no such attachment can be found.
6560 The following keywords may be used (case-insensitively):
6562 .Bl -hang -compact -width ".Ql filename"
6564 Sets the filename of the MIME part, i.e., the name that is used for
6565 display and when (suggesting a name for) saving (purposes).
6566 .It Ql content-description
6567 Associate some descriptive information to the attachment's content, used
6568 in favour of the plain filename by some MUAs.
6570 May be used for uniquely identifying MIME entities in several contexts;
6571 this expects a special reference address format as defined in RFC 2045
6574 upon address content verification failure.
6576 Specifies the media type and subtype of the part; managed automatically.
6577 .It Ql content-disposition
6578 Automatically set to the string
6582 .It Ar attribute-set-at
6583 This uses the same search mechanism as described for
6585 and is otherwise identical to
6595 .\" .Sh INTERNAL VARIABLES {{{
6596 .Sh "INTERNAL VARIABLES"
6598 Internal \*(UA variables are controlled via the
6602 commands; prefixing a variable name with the string
6606 has the same effect as using
6612 Creation or editing of variables can be performed in the
6617 will give more insight on the given variable(s), and
6619 when called without arguments, will show a listing of all variables.
6620 Both commands support a more
6623 Some well-known variables will also become inherited from the
6626 implicitly, others can be explicitly imported with the command
6628 and henceforth share said properties.
6631 Two different kind of internal variables exist.
6632 There are boolean variables, which can only be in one of the two states
6636 and value variables with a(n optional) string value.
6637 For the latter proper quoting is necessary upon assignment time, the
6638 introduction of the section
6640 documents the supported quoting rules.
6642 .Bd -literal -offset indent
6643 wysh set one=val\e 1 two="val 2" \e
6644 three='val "3"' four=$'val \e'4\e''; \e
6645 varshow one two three four; \e
6646 unset one two three four
6650 Dependent upon the actual option the string values will be interpreted
6651 as numbers, colour names, normal text etc., but there also exists
6652 a special kind of string value, the
6653 .Dq boolean string ,
6654 which must either be a decimal integer (in which case
6658 and any other value is true) or any of the (case-insensitive) strings
6664 for a false boolean and
6670 for a true boolean; a special kind of boolean string is the
6672 which is a boolean string that can optionally be prefixed with the
6673 (case-insensitive) term
6677 which causes prompting of the user in interactive mode, with the given
6678 boolean as the default value.
6680 .\" .Ss "Initial settings" {{{
6681 .\" (Keep in SYNC: ./nail.h:okeys, ./nail.rc, ./nail.1:"Initial settings")
6682 .Ss "Initial Settings"
6684 The standard POSIX 2008/Cor 2-2016 mandates the following initial
6690 .Pf no Va autoprint ,
6704 .Pf no Va ignoreeof ,
6706 .Pf no Va keepsave ,
6708 .Pf no Va outfolder ,
6716 .Pf no Va sendwait ,
6725 Notes: \*(UA does not support the
6727 variable \(en use command line options or
6729 to pass options through to a
6731 And the default global
6733 file, which is loaded unless the
6735 (with according argument) or
6737 command line options have been used, or the
6738 .Ev MAILX_NO_SYSTEM_RC
6739 environment variable is set, see
6740 .Sx "Resource files" )
6741 bends those initial settings a bit, e.g., it sets the variables
6746 to name a few, establishes a default
6748 selection etc., and should thus be taken into account.
6751 .\" .Ss "Variables" {{{
6754 .Bl -tag -width ".It Va BaNg"
6758 \*(RO The (hard) exit status of the last command.
6759 This exit status has a meaning for the state machine, in parts
6760 prescribed by the POSIX standard, and, e.g., for
6763 .Va batch-exit-on-error .
6764 This is why \*(UA also knows about a
6766 exit status, which is tracked in
6773 exit status of the last command, which, different to
6775 has no meaning for the state machine, and can therefore easily transport
6776 different error-indicating values.
6777 It is directly addressable with the command
6788 \*(RO Only available inside the scope of a
6790 ed macro, this will expand to all parameters of the macro, separated by
6792 \*(ID The special semantics of the equally named special parameter of the
6794 are not yet supported.
6798 \*(RO Only available inside the scope of a
6800 ed macro, this will expand to all parameters of the macro, separated by
6802 \*(ID The special semantics of the equally named special parameter of the
6804 are not yet supported.
6808 \*(RO Only available inside the scope of a
6810 ed macro, this will expand to the number of positional parameters in
6815 \*(RO Available inside the scope of a
6819 ed macro, this expands to the name of the calling macro, or to the empty
6820 string if the macro is running from top-level.
6821 For the \*(OPal regular expression search and replace operator of
6823 this expands to the entire matching expression.
6827 \*(RO Available inside the scope of a
6831 ed macro, this will access the first positional parameter passed.
6832 All further parameters can be accessed with this syntax, too, e.g.,
6835 etc.; positional parameters can be shifted off the stack by calling
6837 Positional parameters are also accessible in the \*(OPal regular
6838 expression search and replace expression of
6843 \*(RO Is set to the active
6848 \*(RO Is set to the list of
6852 .It Va -folder-resolved
6853 \*(RO Set to the fully resolved path of
6855 once that evaluation has occurred; rather internal.
6858 .It Va -mailbox-display
6859 \*(RO The name of the current mailbox
6861 possibly abbreviated for display purposes.
6864 .It Va -mailbox-resolved
6865 \*(RO The fully resolved path of the current mailbox.
6868 .It Va add-file-recipients
6869 \*(BO When file or pipe recipients have been specified,
6870 mention them in the corresponding address fields of the message instead
6871 of silently stripping them from their recipient list.
6872 By default such addressees are not mentioned.
6876 \*(BO Causes only the local part to be evaluated
6877 when comparing addresses.
6881 \*(BO Causes messages saved in
6883 to be appended to the end rather than prepended.
6884 This should always be set.
6888 \*(BO Causes \*(UA to prompt for the subject of each message sent.
6889 If the user responds with simply a newline,
6890 no subject field will be sent.
6894 \*(BO Causes the prompts for
6898 lists to appear after the message has been edited.
6902 \*(BO If set, \*(UA asks for files to attach at the end of each message,
6903 shall the list be found empty at that time.
6904 An empty line finalizes the list.
6908 \*(BO Causes the user to be prompted for carbon copy recipients
6909 (at the end of each message if
6913 are set) shall the list be found empty (at that time).
6914 An empty line finalizes the list.
6918 \*(BO Causes the user to be prompted for blind carbon copy
6919 recipients (at the end of each message if
6923 are set) shall the list be found empty (at that time).
6924 An empty line finalizes the list.
6928 \*(BO\*(OP Causes the user to be prompted if the message is to be
6929 signed at the end of each message.
6932 variable is ignored when this variable is set.
6936 \*(BO Alternative name for
6941 A sequence of characters to display in the
6945 as shown in the display of
6947 each for one type of messages (see
6948 .Sx "Message states" ) ,
6949 with the default being
6952 .Ql NU\ \ *HMFAT+\-$~
6955 variable is set, in the following order:
6957 .Bl -tag -compact -width ".It Ql _"
6979 start of a collapsed thread.
6981 an uncollapsed thread (TODO ignored for now).
6985 classified as possible spam.
6991 Specifies a list of recipients to which a blind carbon copy of each
6992 outgoing message will be sent automatically.
6996 Specifies a list of recipients to which a carbon copy of each outgoing
6997 message will be sent automatically.
7001 \*(BO Causes threads to be collapsed automatically when threaded mode
7008 \*(BO Enable automatic
7010 ing of a(n existing)
7016 commands, e.g., the message that becomes the new
7018 is shown automatically, as via
7025 \*(BO\*(OB Causes threaded mode (see the
7027 command) to be entered automatically when a folder is opened.
7029 .Ql autosort=thread .
7033 Causes sorted mode (see the
7035 command) to be entered automatically with the value of this variable as
7036 sorting method when a folder is opened, e.g.,
7037 .Ql set autosort=thread .
7041 \*(BO Enables the substitution of all not (reverse-solidus) escaped
7044 characters by the contents of the last executed command for the
7046 shell escape command and
7048 one of the compose mode
7049 .Sx "COMMAND ESCAPES" .
7050 If this variable is not set no reverse solidus stripping is performed.
7053 .It Va batch-exit-on-error
7054 If the batch mode has been enabled via the
7056 command line option, then this variable will be consulted whenever \*(UA
7057 completes one operation.
7058 It is ment as a convenient alternative to manually testing
7060 If any value is set, a number is expected; if it is
7062 then each failed operation will cause \*(UA to exit.
7064 \*(ID If it is set without a value, then only top-level operations that
7066 .Dq on the command-prompt ,
7067 i.e., neither in running macros nor from within source files etc., are
7068 considered, unless a main operation that directly affects the return
7069 value, like, e.g., a failed
7071 command, is affected; this mode of operation is likely to change in v15,
7072 and tests should be performed to see whether the desired effect is seen.
7076 \*(OP Terminals generate multi-byte sequences for certain forms of
7077 input, for example for function and other special keys.
7078 Some terminals however do not write these multi-byte sequences as
7079 a whole, but byte-by-byte, and the latter is what \*(UA actually reads.
7080 This variable specifies the timeout in milliseconds that the MLE (see
7081 .Sx "On terminal control and line editor" )
7082 waits for more bytes to arrive unless it considers a sequence
7088 \*(BO Causes automatic display of a header summary after executing a
7090 command, and thus complements the standard variable
7092 which controls header summary display on program startup.
7093 It is only meaningful if
7099 \*(BO Sets some cosmetical features to traditional BSD style;
7100 has the same affect as setting
7102 and all other variables prefixed with
7104 it also changes the behaviour of
7106 (which does not exist in BSD).
7110 \*(BO Changes the letters shown in the first column of a header
7111 summary to traditional BSD style.
7115 \*(BO Changes the display of columns in a header summary to traditional
7120 \*(BO Changes some informational messages to traditional BSD style.
7126 field to appear immediately after the
7128 field in message headers and with the
7130 .Sx "COMMAND ESCAPES" .
7134 The value that should appear in the
7138 MIME header fields when no character set conversion of the message data
7140 This defaults to US-ASCII, and the chosen character set should be
7141 US-ASCII compatible.
7145 \*(OP The default 8-bit character set that is used as an implicit last
7146 member of the variable
7148 This defaults to UTF-8 if character set conversion capabilities are
7149 available, and to ISO-8859-1 otherwise, in which case the only supported
7152 and this variable is effectively ignored.
7153 Refer to the section
7154 .Sx "Character sets"
7155 for the complete picture of character set conversion in \*(UA.
7158 .It Va charset-unknown-8bit
7159 \*(OP RFC 1428 specifies conditions when internet mail gateways shall
7161 the content of a mail message by using a character set with the name
7163 Because of the unclassified nature of this character set \*(UA will not
7164 be capable to convert this character set to any other character set.
7165 If this variable is set any message part which uses the character set
7167 is assumed to really be in the character set given in the value,
7168 otherwise the (final) value of
7170 is used for this purpose.
7172 This variable will also be taken into account if a MIME type (see
7173 .Sx "The mime.types files" )
7174 of a MIME message part that uses the
7176 character set is forcefully treated as text.
7180 The default value for the
7185 .It Va colour-disable
7186 \*(BO\*(OP Forcefully disable usage of colours.
7187 Also see the section
7188 .Sx "Coloured display" .
7192 \*(BO\*(OP Whether colour shall be used for output that is paged through
7194 Note that pagers may need special command line options, e.g.,
7202 in order to support colours.
7203 Often doing manual adjustments is unnecessary since \*(UA may perform
7204 adjustments dependent on the value of the environment variable
7206 (see there for more).
7210 In a(n interactive) terminal session, then if this valued variable is
7211 set it will be used as a threshold to determine how many lines the given
7212 output has to span before it will be displayed via the configured
7216 can be forced by setting this to the value
7218 setting it without a value will deduce the current height of the
7219 terminal screen to compute the treshold (see
7224 \*(ID At the moment this uses the count of lines of the message in wire
7225 format, which, dependent on the
7227 of the message, is unrelated to the number of display lines.
7228 (The software is old and historically the relation was a given thing.)
7232 Define a set of custom headers to be injected into newly composed or
7233 forwarded messages; it is also possible to create custom headers in
7236 which can be automated by setting one of the hooks
7237 .Va on-compose-done-shell
7239 .Va on-compose-done .
7240 The value is interpreted as a comma-separated list of custom headers to
7241 be injected, to include commas in the header bodies escape them with
7243 \*(ID Overwriting of automatically managed headers is neither supported
7246 .Dl set customhdr='Hdr1: Body1-1\e, Body1-2, Hdr2: Body2'
7250 Controls the appearance of the
7252 date and time format specification of the
7254 variable, that is used, for example, when viewing the summary of
7256 If unset, then the local receiving date is used and displayed
7257 unformatted, otherwise the message sending
7259 It is possible to assign a
7261 format string and control formatting, but embedding newlines via the
7263 format is not supported, and will result in display errors.
7265 .Ql %Y-%m-%d %H:%M ,
7267 .Va datefield-markout-older .
7270 .It Va datefield-markout-older
7271 Only used in conjunction with
7273 Can be used to create a visible distinction of messages dated more than
7274 a day in the future, or older than six months, a concept comparable to the
7276 option of the POSIX utility
7278 If set to the empty string, then the plain month, day and year of the
7280 will be displayed, but a
7282 format string to control formatting can be assigned.
7288 \*(BO Enables debug messages and obsoletion warnings, disables the
7289 actual delivery of messages and also implies
7295 .It Va disposition-notification-send
7297 .Ql Disposition-Notification-To:
7298 header (RFC 3798) with the message.
7302 .\" TODO .It Va disposition-notification-send-HOST
7304 .\".Va disposition-notification-send
7305 .\" for SMTP accounts on a specific host.
7306 .\" TODO .It Va disposition-notification-send-USER@HOST
7308 .\".Va disposition-notification-send
7309 .\"for a specific account.
7313 \*(BO When dot is set, a period
7315 on a line by itself during message input in (interactive) compose mode
7316 will be treated as end-of-message (in addition to the normal end-of-file
7325 .It Va dotlock-ignore-error
7326 \*(BO\*(OP Synchronization of mailboxes which \*(UA treats as
7328 .Sx "primary system mailbox" Ns
7329 es (see, e.g., the notes on
7330 .Sx "Filename transformations" ,
7331 as well as the documentation of
7333 will be protected with so-called dotlock files\(emthe traditional mail
7334 spool file locking method\(emin addition to system file locking.
7335 Because \*(UA ships with a privilege-separated dotlock creation program
7336 that should always be able to create such a dotlock file there is no
7337 good reason to ignore dotlock file creation errors, and thus these are
7338 fatal unless this variable is set.
7342 \*(BO If this variable is set then the editor is started automatically
7343 when a message is composed in interactive mode, as if the
7345 .Sx "COMMAND ESCAPES"
7349 variable is implied for this automatically spawned editor session.
7353 \*(BO When a message is edited while being composed,
7354 its header is included in the editable text.
7364 fields are accepted within the header, other fields are ignored.
7368 \*(BO When entering interactive mode \*(UA normally writes
7369 .Dq \&No mail for user
7370 and exits immediately if a mailbox is empty or does not exist.
7371 If this variable is set \*(UA starts even with an empty or nonexistent
7372 mailbox (the latter behaviour furtherly depends upon
7379 .Ql Content-Transfer-Encoding
7380 to use in outgoing text messages and message parts, where applicable.
7381 (7-bit clean text messages are sent as-is, without a transfer encoding.)
7384 .Bl -tag -compact -width "_%%_"
7387 8-bit transport effectively causes the raw data be passed through
7388 unchanged, but may cause problems when transferring mail messages over
7389 channels that are not ESMTP (RFC 1869) compliant.
7390 Also, several input data constructs are not allowed by the
7391 specifications and may cause a different transfer-encoding to be used.
7392 .It Ql quoted-printable
7394 Quoted-printable encoding is 7-bit clean and has the property that ASCII
7395 characters are passed through unchanged, so that an english message can
7396 be read as-is; it is also acceptible for other single-byte locales that
7397 share many characters with ASCII, like, e.g., ISO-8859-1.
7398 The encoding will cause a large overhead for messages in other character
7399 sets: e.g., it will require up to twelve (12) bytes to encode a single
7400 UTF-8 character of four (4) bytes.
7402 .Pf (Or\0 Ql b64 . )
7403 The default encoding, it is 7-bit clean and will always be used for
7405 This encoding has a constant input:output ratio of 3:4, regardless of
7406 the character set of the input data it will encode three bytes of input
7407 to four bytes of output.
7408 This transfer-encoding is not human readable without performing
7414 If defined, the first character of the value of this variable
7415 gives the character to use in place of tilde
7418 .Sx "COMMAND ESCAPES" .
7419 If set to the empty string, command escapes are disabled.
7423 If not set then file and command pipeline targets are not allowed,
7424 and any such address will be filtered out, giving a warning message.
7425 If set without a value then all possible recipient address
7426 specifications will be accepted \(en see the section
7427 .Sx "On sending mail, and non-interactive mode"
7429 To accept them, but only in interactive mode, or when tilde commands
7430 were enabled explicitly by using one of the command line options
7434 set this to the (case-insensitive) value
7436 (it actually acts like
7437 .Ql restrict,-all,+name,+addr ,
7438 so that care for ordering issues must be taken) .
7440 In fact the value is interpreted as a comma-separated list of values.
7443 then the existence of disallowed specifications is treated as a hard
7444 send error instead of only filtering them out.
7445 The remaining values specify whether a specific type of recipient
7446 address specification is allowed (optionally indicated by a plus sign
7448 prefix) or disallowed (prefixed with a hyphen-minus
7452 addresses all possible address specifications,
7456 command pipeline targets,
7458 plain user names and (MTA) aliases (\*(OB
7460 may be used as an alternative syntax to
7465 These kind of values are interpreted in the given order, so that
7466 .Ql restrict,\:fail,\:+file,\:-all,\:+addr
7467 will cause hard errors for any non-network address recipient address
7468 unless \*(UA is in interactive mode or has been started with the
7472 command line option; in the latter case(s) any address may be used, then.
7474 Historically invalid network addressees are silently stripped off.
7475 To change this and ensure that any encountered invalid email address
7476 instead causes a hard error, ensure the string
7478 is an entry in the above list.
7479 Setting this automatically enables network addressees
7480 (it actually acts like
7481 .Ql failinvaddr,+addr ,
7482 so that care for ordering issues must be taken) .
7486 Unless this variable is set additional
7488 (Mail-Transfer-Agent)
7489 arguments from the command line, as can be given after a
7491 separator, are ignored due to safety reasons.
7492 However, if set to the special (case-insensitive) value
7494 then the presence of additional MTA arguments is treated as a hard
7495 error that causes \*(UA to exit with failure status.
7496 A lesser strict variant is the otherwise identical
7498 which does accept such arguments in interactive mode, or if tilde
7499 commands were enabled explicitly by using one of the command line options
7506 \*(RO String giving a list of features \*(UA, preceded with a plus sign
7508 if the feature is available, and a hyphen-minus
7511 The output of the command
7513 will include this information.
7517 \*(BO This setting reverses the meanings of a set of reply commands,
7518 turning the lowercase variants, which by default address all recipients
7519 included in the header of a message
7520 .Pf ( Ic reply , respond , followup )
7521 into the uppercase variants, which by default address the sender only
7522 .Pf ( Ic Reply , Respond , Followup )
7525 .Ic replysender , respondsender , followupsender
7527 .Ic replyall , respondall , followupall
7528 are not affected by the current setting of
7533 .It Va file-hook-load-EXTENSION , file-hook-save-EXTENSION
7534 It is possible to install file hooks which will be used by the
7536 command in order to be able to transparently handle (through an
7537 intermediate temporary file) files with specific
7539 s: the variable values can include shell snippets and are expected to
7540 write data to standard output / read data from standard input,
7542 \*(ID The variables may not be changed while there is a mailbox
7544 .Bd -literal -offset indent
7545 set file-hook-load-xy='echo >&2 XY-LOAD; gzip -cd' \e
7546 file-hook-save-xy='echo >&2 XY-SAVE; gzip -c' \e
7547 record=+null-sent.xy
7552 The default path under which mailboxes are to be saved:
7553 file names that begin with the plus sign
7555 will have the plus sign replaced with the value of this variable if set,
7556 otherwise the plus sign will remain unchanged when doing
7557 .Sx "Filename transformations" ;
7560 for more on this topic.
7561 The value supports a subset of transformations itself, and if the
7562 non-empty value does not start with a solidus
7566 will be prefixed automatically.
7570 This variable can be set to the name of a
7572 macro which will be called whenever a
7575 The macro will also be invoked when new mail arrives,
7576 but message lists for commands executed from the macro
7577 only include newly arrived messages then.
7579 are activated by default in a folder hook, causing the covered settings
7580 to be reverted once the folder is left again.
7583 Macro behaviour, including option localization, will change in v15.
7584 One should be aware of that and possibly embed version checks in the
7585 used resource file(s).
7588 .It Va folder-hook-FOLDER
7593 Unlike other folder specifications, the fully expanded name of a folder,
7594 without metacharacters, is used to avoid ambiguities.
7595 However, if the mailbox resides under
7599 specification is tried in addition, e.g., if
7603 (and thus relative to the user's home directory) then
7604 .Pa /home/usr1/mail/sent
7606 .Ql folder-hook-/home/usr1/mail/sent
7607 first, but then followed by
7608 .Ql folder-hook-+sent .
7612 \*(BO Controls whether a
7613 .Ql Mail-Followup-To:
7614 header is generated when sending messages to known mailing lists.
7616 .Va followup-to-honour
7618 .Ic mlist , mlsubscribe , reply
7623 .It Va followup-to-honour
7625 .Ql Mail-Followup-To:
7626 header is honoured when group-replying to a message via
7630 This is a quadoption; if set without a value it defaults to
7640 .It Va forward-as-attachment
7641 \*(BO Original messages are normally sent as inline text with the
7644 and only the first part of a multipart message is included.
7645 With this setting enabled messages are sent as unmodified MIME
7647 attachments with all of their parts included.
7651 The address (or a list of addresses) to put into the
7653 field of the message header, quoting RFC 5322:
7654 the author(s) of the message, that is, the mailbox(es) of the person(s)
7655 or system(s) responsible for the writing of the message.
7658 ing to messages these addresses are handled as if they were in the
7662 If the machine's hostname is not valid at the Internet (for example at
7663 a dialup machine) then either this variable or
7665 (\*(IN and with a defined SMTP protocol in
7668 adds even more fine-tuning capabilities),
7672 contains more than one address,
7675 variable is required (according to the standard RFC 5322).
7677 If a file-based MTA is used, then
7679 (or, if that contains multiple addresses,
7681 can nonetheless be enforced to appear as the envelope sender address at
7682 the MTA protocol level (the RFC 5321 reverse-path), either by using the
7684 command line option (with an empty argument; see there for the complete
7685 picture on this topic), or by setting the internal variable
7686 .Va r-option-implicit .
7690 \*(BO When replying to or forwarding a message \*(UA normally removes
7691 the comment and name parts of email addresses.
7692 If this variable is set such stripping is not performed,
7693 and comments, names etc. are retained.
7697 The string to put before the text of a message with the
7701 .Va forward-as-attachment
7704 .Dq -------- Original Message --------
7705 if unset; No heading is put if it is set to the empty string.
7709 \*(BO Causes the header summary to be written at startup and after
7710 commands that affect the number of messages or the order of messages in
7711 the current folder; enabled by default.
7712 The command line option
7718 complements this and controls header summary display on folder changes.
7723 A format string to use for the summary of
7725 similar to the ones used for
7728 Format specifiers in the given string start with a percent sign
7730 and may be followed by an optional decimal number indicating the field
7731 width \(em if that is negative, the field is to be left-aligned.
7732 Valid format specifiers are:
7735 .Bl -tag -compact -width "_%%_"
7737 A plain percent sign.
7740 a space character but for the current message
7742 for which it expands to
7746 a space character but for the current message
7748 for which it expands to
7751 \*(OP The spam score of the message, as has been classified via the
7754 Shows only a replacement character if there is no spam support.
7756 Message attribute character (status flag); the actual content can be
7760 The date found in the
7762 header of the message when
7764 is set (the default), otherwise the date when the message was received.
7765 Formatting can be controlled by assigning a
7770 The indenting level in threaded mode.
7772 The address of the message sender.
7774 The message thread tree structure.
7775 (Note that this format does not support a field width.)
7777 The number of lines of the message, if available.
7781 The number of octets (bytes) in the message, if available.
7783 Message subject (if any).
7785 Message subject (if any) in double quotes.
7787 Message recipient flags: is the addressee of the message a known or
7788 subscribed mailing list \(en see
7793 The position in threaded/sorted order.
7797 .Ql %>\&%a\&%m\ %-18f\ %16d\ %4l/%\-5o\ %i%-s ,
7799 .Ql %>\&%a\&%m\ %20-f\ \ %16d\ %3l/%\-5o\ %i%-S
7810 .It Va headline-bidi
7811 Bidirectional text requires special treatment when displaying headers,
7812 because numbers (in dates or for file sizes etc.) will not affect the
7813 current text direction, in effect resulting in ugly line layouts when
7814 arabic or other right-to-left text is to be displayed.
7815 On the other hand only a minority of terminals is capable to correctly
7816 handle direction changes, so that user interaction is necessary for
7818 Note that extended host system support is required nonetheless, e.g.,
7819 detection of the terminal character set is one precondition;
7820 and this feature only works in an Unicode (i.e., UTF-8) locale.
7822 In general setting this variable will cause \*(UA to encapsulate text
7823 fields that may occur when displaying
7825 (and some other fields, like dynamic expansions in
7827 with special Unicode control sequences;
7828 it is possible to fine-tune the terminal support level by assigning
7830 no value (or any value other than
7835 will make \*(UA assume that the terminal is capable to properly deal
7836 with Unicode version 6.3, in which case text is embedded in a pair of
7837 U+2068 (FIRST STRONG ISOLATE) and U+2069 (POP DIRECTIONAL ISOLATE)
7839 In addition no space on the line is reserved for these characters.
7841 Weaker support is chosen by using the value
7843 (Unicode 6.3, but reserve the room of two spaces for writing the control
7844 sequences onto the line).
7849 select Unicode 1.1 support (U+200E, LEFT-TO-RIGHT MARK); the latter
7850 again reserves room for two spaces in addition.
7854 \*(OP If a line editor is available then this can be set to
7855 name the (expandable) path of the location of a permanent history file.
7860 .It Va history-gabby
7861 \*(BO\*(OP Add more entries to the history as is normally done.
7864 .It Va history-gabby-persist
7865 \*(BO\*(OP \*(UA's own MLE will not save the additional
7867 entries in persistent storage unless this variable is set.
7868 On the other hand it will not loose the knowledge of whether
7869 a persistent entry was gabby or not.
7875 \*(OP Setting this variable imposes a limit on the number of concurrent
7877 If set to the value 0 then no further history entries will be added, and
7878 loading and incorporation of the
7880 upon program startup can also be suppressed by doing this.
7881 Runtime changes will not be reflected, but will affect the number of
7882 entries saved to permanent storage.
7886 \*(BO This setting controls whether messages are held in the system
7888 and it is set by default.
7892 Use this string as hostname when expanding local addresses instead of
7893 the value obtained from
7897 It is used, e.g., in
7901 fields, as well as when generating
7903 MIME part related unique ID fields.
7904 Setting it to the empty string will cause the normal hostname to be
7905 used, but nonetheless enables creation of said ID fields.
7906 \*(IN in conjunction with the builtin SMTP
7909 also influences the results:
7910 one should produce some test messages with the desired combination of
7919 \*(BO\*(OP Can be used to turn off the automatic conversion of domain
7920 names according to the rules of IDNA (internationalized domain names
7922 Since the IDNA code assumes that domain names are specified with the
7924 character set, an UTF-8 locale charset is required to represent all
7925 possible international domain names (before conversion, that is).
7929 \*(BO Ignore interrupt signals from the terminal while entering
7930 messages; instead echo them as
7932 characters and discard the current line.
7936 \*(BO Ignore end-of-file conditions
7937 .Pf ( Ql control-D )
7938 in compose mode on message input and in interactive command input.
7939 If set an interactive command input session can only be left by
7940 explicitly using one of the commands
7944 and message input in compose mode can only be terminated by entering
7947 on a line by itself or by using the
7949 .Sx "COMMAND ESCAPES" ;
7951 overrides a setting of
7956 If this is set to a non-empty string it will specify the users
7958 .Sx "primary system mailbox" ,
7961 and the system-dependent default, and (thus) be used to replace
7964 .Sx "Filename transformations" ;
7967 for more on this topic.
7968 The value supports a subset of transformations itself.
7976 .Sx "COMMAND ESCAPES"
7979 option for indenting messages,
7980 in place of the normal tabulator character
7982 which is the default.
7983 Be sure to quote the value if it contains spaces or tabs.
7987 \*(BO If set, an empty system (MBOX) mailbox file is not removed.
7988 Note that, in conjunction with
7991 .Ev POSIXLY_CORRECT )
7992 any empty file will be removed unless this variable is set.
7993 This may improve the interoperability with other mail user agents
7994 when using a common folder directory, and prevents malicious users
7995 from creating fake mailboxes in a world-writable spool directory.
7996 \*(ID Only local regular (MBOX) files are covered, Maildir or other
7997 mailbox types will never be removed, even if empty.
8000 .It Va keep-content-length
8001 \*(BO When (editing messages and) writing
8003 mailbox files \*(UA can be told to keep the
8007 header fields that some MUAs generate by setting this variable.
8008 Since \*(UA does neither use nor update these non-standardized header
8009 fields (which in itself shows one of their conceptual problems),
8010 stripping them should increase interoperability in between MUAs that
8011 work with with same mailbox files.
8012 Note that, if this is not set but
8013 .Va writebackedited ,
8014 as below, is, a possibly performed automatic stripping of these header
8015 fields already marks the message as being modified.
8019 \*(BO When a message is saved it is usually discarded from the
8020 originating folder when \*(UA is quit.
8021 This setting causes all saved message to be retained.
8024 .It Va line-editor-disable
8025 \*(BO Turn off any enhanced line editing capabilities (see
8026 .Sx "On terminal control and line editor"
8030 .It Va line-editor-no-defaults
8031 \*(BO\*(OP Do not establish any default key binding.
8034 .It Va mailx-extra-rc
8035 An additional startup file that is loaded as the last of the
8036 .Sx "Resource files" .
8037 Use this file for commands that are not understood by other POSIX
8043 \*(BO When a message is replied to and this variable is set,
8044 it is marked as having been
8047 .Sx "Message states" .
8051 \*(BO If this is set then when opening MBOX mailbox files \*(UA will not
8052 use the tolerant POSIX rules for detecting message boundaries (so-called
8054 lines), as it does by default for compatibility reasons, but the more
8055 strict rules that have been defined in RFC 4155.
8056 When saving to MBOX mailboxes this indicates when so-called
8058 quoting is to be applied \(em note this is never necessary for any
8059 message newly generated by \*(UA, it only applies to messages generated
8060 by buggy or malicious MUAs.
8061 (\*(UA will use a proper
8065 lines cannot be misinterpreted as message boundaries.)
8067 This should not be set normally, but may be handy when \*(UA complains
8068 about having seen invalid
8070 lines when opening a MBOX: in this case temporarily setting this
8071 variable, re-opening the mailbox in question, unsetting this variable
8072 again and then invoking
8073 .Ql copy * SOME-FILE
8074 will perform proper, POSIX-compliant
8076 quoting for all detected messages, resulting in a valid MBOX mailbox.
8080 \*(BO Internal development variable.
8083 .It Va message-id-disable
8084 \*(BO By setting this variable the generation of
8086 can be completely suppressed, effectively leaving this task up to the
8088 (Mail-Transfer-Agent) or the SMTP server.
8089 (According to RFC 5321 a SMTP server is not required to add this
8090 field by itself, so it should be ensured that it accepts messages without
8092 This variable also affects automatic generation of
8097 .It Va message-inject-head
8098 A string to put at the beginning of each new message.
8099 The escape sequences tabulator
8106 .It Va message-inject-tail
8107 A string to put at the end of each new message.
8108 The escape sequences tabulator
8116 \*(BO Usually, when an
8118 expansion contains the sender, the sender is removed from the expansion.
8119 Setting this option suppresses these removals.
8124 option to be passed through to the
8126 (Mail-Transfer-Agent); though most of the modern MTAs no longer document
8127 this flag, no MTA is known which does not support it (for historical
8131 .It Va mime-allow-text-controls
8132 \*(BO When sending messages, each part of the message is MIME-inspected
8133 in order to classify the
8136 .Ql Content-Transfer-Encoding:
8139 that is required to send this part over mail transport, i.e.,
8140 a computation rather similar to what the
8142 command produces when used with the
8146 This classification however treats text files which are encoded in
8147 UTF-16 (seen for HTML files) and similar character sets as binary
8148 octet-streams, forcefully changing any
8153 .Ql application/octet-stream :
8154 If that actually happens a yet unset charset MIME parameter is set to
8156 effectively making it impossible for the receiving MUA to automatically
8157 interpret the contents of the part.
8159 If this variable is set, and the data was unambiguously identified as
8160 text data at first glance (by a
8164 file extension), then the original
8166 will not be overwritten.
8169 .It Va mime-alternative-favour-rich
8170 \*(BO If this variable is set then rich MIME alternative parts (e.g.,
8171 HTML) will be preferred in favour of included plain text versions when
8172 displaying messages, provided that a handler exists which produces
8173 output that can be (re)integrated into \*(UA's normal visual display.
8174 (E.g., at the time of this writing some newsletters ship their full
8175 content only in the rich HTML part, whereas the plain text part only
8176 contains topic subjects.)
8179 .It Va mime-counter-evidence
8182 field is used to decide how to handle MIME parts.
8183 Some MUAs however do not use
8185 or a similar mechanism to correctly classify content, but simply specify
8186 .Ql application/octet-stream ,
8187 even for plain text attachments like
8189 If this variable is set then \*(UA will try to classify such MIME
8190 message parts on its own, if possible, for example via a possibly
8191 existing attachment filename.
8192 A non-empty value may also be given, in which case a number is expected,
8193 actually a carrier of bits.
8194 Creating the bit-carrying number is a simple addition:
8195 .Bd -literal -offset indent
8196 ? !echo Value should be set to $((2 + 4 + 8))
8197 Value should be set to 14
8200 .Bl -bullet -compact
8202 If bit two is set (2) then the detected
8204 content-type will be carried along with the message and be used for
8206 .Va pipe-TYPE/SUBTYPE
8207 is responsible for the MIME part, shall that question arise;
8208 when displaying such a MIME part the part-info will indicate the
8209 overridden content-type by showing a plus sign
8212 If bit three is set (4) then the counter-evidence is always produced
8213 and a positive result will be used as the MIME type, even forcefully
8214 overriding the parts given MIME type.
8216 If bit four is set (8) then as a last resort the actual content of
8217 .Ql application/octet-stream
8218 parts will be inspected, so that data which looks like plain text can be
8223 .It Va mimetypes-load-control
8224 Can be used to control which of the
8226 databases are loaded by \*(UA, as furtherly described in the section
8227 .Sx "The mime.types files" .
8230 is part of the option value, then the user's personal
8232 file will be loaded (if it exists); likewise the letter
8234 controls loading of the system wide
8235 .Pa /etc/mime.types ;
8236 directives found in the user file take precedence, letter matching is
8238 If this variable is not set \*(UA will try to load both files.
8239 Incorporation of the \*(UA-builtin MIME types cannot be suppressed,
8240 but they will be matched last (the order can be listed via
8243 More sources can be specified by using a different syntax: if the
8244 value string contains an equals sign
8246 then it is instead parsed as a comma-separated list of the described
8249 pairs; the given filenames will be expanded and loaded, and their
8250 content may use the extended syntax that is described in the section
8251 .Sx "The mime.types files" .
8252 Directives found in such files always take precedence (are prepended to
8253 the MIME type cache).
8258 To choose an alternate Mail-Transfer-Agent, set this option to either
8259 the full pathname of an executable (optionally prefixed with a
8261 protocol indicator), or \*(OPally a SMTP protocol URL, e.g., \*(IN
8263 .Dl smtps?://[user[:password]@]server[:port]
8266 .Ql [smtp://]server[:port] . )
8267 The default has been chosen at compie time.
8268 All supported data transfers are executed in child processes, which
8269 run asynchronously, and without supervision, unless either the
8274 If such a child receives a TERM signal, it will abort and
8281 For a file-based MTA it may be necessary to set
8283 in in order to choose the right target of a modern
8286 It will be passed command line arguments from several possible sources:
8289 if set, from the command line if given and the variable
8292 Argument processing of the MTA will be terminated with a
8297 The otherwise occurring implicit usage of the following MTA command
8298 line arguments can be disabled by setting the boolean variable
8299 .Va mta-no-default-arguments
8300 (which will also disable passing
8304 (for not treating a line with only a dot
8306 character as the end of input),
8314 variable is set); in conjunction with the
8316 command line option \*(UA will also (not) pass
8322 \*(OP \*(UA can send mail over SMTP network connections to a single
8323 defined SMTP smarthost, the access URL of which has to be assigned to
8325 To use this mode it is helpful to read
8326 .Sx "On URL syntax and credential lookup" .
8327 It may be necessary to set the
8329 variable in order to use a specific combination of
8334 with some mail providers.
8337 .Bl -bullet -compact
8339 The plain SMTP protocol (RFC 5321) that normally lives on the
8340 server port 25 and requires setting the
8341 .Va smtp-use-starttls
8342 variable to enter a SSL/TLS encrypted session state.
8343 Assign a value like \*(IN
8344 .Ql smtp://[user[:password]@]server[:port]
8346 .Ql smtp://server[:port] )
8347 to choose this protocol.
8349 The so-called SMTPS which is supposed to live on server port 465
8350 and is automatically SSL/TLS secured.
8351 Unfortunately it never became a standardized protocol and may thus not
8352 be supported by your hosts network service database
8353 \(en in fact the port number has already been reassigned to other
8356 SMTPS is nonetheless a commonly offered protocol and thus can be
8357 chosen by assigning a value like \*(IN
8358 .Ql smtps://[user[:password]@]server[:port]
8360 .Ql smtps://server[:port] ) ;
8361 due to the mentioned problems it is usually necessary to explicitly
8366 Finally there is the SUBMISSION protocol (RFC 6409), which usually
8367 lives on server port 587 and is practically identically to the SMTP
8368 protocol from \*(UA's point of view beside that; it requires setting the
8369 .Va smtp-use-starttls
8370 variable to enter a SSL/TLS secured session state.
8371 Assign a value like \*(IN
8372 .Ql submission://[user[:password]@]server[:port]
8374 .Ql submission://server[:port] ) .
8379 .It Va mta-arguments
8380 Arguments to pass through to a file-based
8382 can be given via this variable, which is parsed according to
8383 .Sx "Shell-style argument quoting"
8384 into an array of arguments, and which will be joined onto MTA options
8385 from other sources, and then passed individually to the MTA:
8387 .Dl wysh set mta-arguments='-t -X \&"/tmp/my log\&"'
8390 .It Va mta-no-default-arguments
8391 \*(BO Unless this variable is set \*(UA will pass some well known
8392 standard command line options to a file-based
8394 (Mail-Transfer-Agent), see there for more.
8398 Many systems use a so-called
8400 environment to ensure compatibility with
8402 This works by inspecting the name that was used to invoke the mail
8404 If this variable is set then the mailwrapper (the program that is
8405 actually executed when calling the file-based
8407 will treat its contents as that name.
8412 .It Va netrc-lookup-USER@HOST , netrc-lookup-HOST , netrc-lookup
8413 \*(BO\*(IN\*(OP Used to control usage of the users
8415 file for lookup of account credentials, as documented in the section
8416 .Sx "On URL syntax and credential lookup"
8420 .Sx "The .netrc file"
8421 documents the file format.
8433 then \*(UA will read the output of a shell pipe instead of the users
8435 file if this variable is set (to the desired shell command).
8436 This can be used to, e.g., store
8440 .Dl set netrc-pipe='gpg -qd ~/.netrc.pgp'
8444 If this variable has the value
8446 newly created local folders will be in Maildir format.
8450 Checks for new mail in the current folder each time the prompt is shown.
8451 A Maildir folder must be re-scanned to determine if new mail has arrived.
8452 If this variable is set to the special value
8454 then a Maildir folder will not be rescanned completely, but only
8455 timestamp changes are detected.
8459 .It Va on-compose-done-shell , on-compose-done
8460 These hooks run once the normal compose mode is finished, but before the
8461 .Va on-compose-leave
8462 macro hook is called, the
8465 Both hooks will be executed in a subprocess, with their input and output
8466 connected to \*(UA such that they can act as if they would be an
8468 The difference in between them is that the former is a
8470 command, whereas the latter is a normal \*(UA macro, but which is
8471 restricted to a small set of commands (the
8475 will indicate said capability), just enough for the purpose of
8476 controlling the real \*(UA instance sufficiently.
8478 are enabled for these hooks (in the parent process), causing any setting
8479 to be forgotten after the message has been sent.
8481 During execution of these hook \*(UA will temporarily forget whether it
8482 has been started in interactive mode, (a restricted set of)
8483 .Sx "COMMAND ESCAPES"
8484 will always be available, and for guaranteed reproduceabilities sake
8486 will be set to its default.
8487 The compose mode command
8489 has been especially designed for scriptability (via these hooks).
8490 The first line the hook will read on its standard input is the protocol
8491 version of said command escape, currently
8493 backward incompatible protocol changes are to be expected in the
8494 future, and it is advisable to make use of the protocol version.
8495 \*(ID because most \*(UA commands do not take this new functionality
8496 into account but are ment for human interaction special care must be
8497 taken to avoid deadlocks because of unexpected control flow; i.e., that
8498 both involved processes wait for more input to happen at the same time,
8499 or one doesn't expect more input but the other is stuck waiting for
8500 consumation of its output.
8501 .Bd -literal -offset indent
8502 wysh set on-compose-done-shell=$'\e
8504 printf "hello $version! Headers: ";\e
8505 echo \e'~^header list\e';\e
8506 read status result;\e
8507 echo "status=$status result=$result";\e
8510 set on-compose-done=ocdm
8513 echo version is $ver, escape=$escape
8514 if [ "$features" !@ +regex ]
8515 echoerr 'Need regular-expression support, aborting send'
8518 echo '~^header list'
8521 echoerr 'Failed to read header list, bailing out'
8524 if [ "$hl" !@ ' cc' ]
8525 echo '~^header insert cc Diet is your <mirr.or>'
8528 echoerr 'Failed to insert Cc: header, bailing out'
8532 echo '~:set from="Hoola Hoop <hh@exam.ple>"'
8538 .It Va on-compose-enter , on-compose-leave
8539 Macro hooks which will be executed before compose mode is entered, and
8540 after composing has been finished (but before the
8542 is injected, etc.), respectively.
8544 are enabled for these hooks, causing any setting to be forgotten after
8545 the message has been sent.
8546 The following (read-only) variables will be set temporarily during
8547 execution of the macros:
8549 .Bl -tag -compact -width ".It Va compose_subject"
8552 .It Va compose-sender
8554 .It Va compose-to , compose-cc , compose-bcc
8555 The list of receiver addresses as a space-separated list.
8556 .It Va compose-subject
8562 \*(BO Causes the filename given in the
8565 and the sender-based filenames for the
8569 commands to be interpreted relative to the directory given in the
8571 variable rather than to the current directory,
8572 unless it is set to an absolute pathname.
8576 \*(BO If set, each message feed through the command given for
8578 is followed by a formfeed character
8582 .It Va password-USER@HOST , password-HOST , password
8583 \*(IN Variable chain that sets a password, which is used in case none has
8584 been given in the protocol and account-specific URL;
8585 as a last resort \*(UA will ask for a password on the user's terminal if
8586 the authentication method requires a password.
8587 Specifying passwords in a startup file is generally a security risk;
8588 the file should be readable by the invoking user only.
8590 .It Va password-USER@HOST
8591 \*(OU (see the chain above for \*(IN)
8592 Set the password for
8596 If no such variable is defined for a host,
8597 the user will be asked for a password on standard input.
8598 Specifying passwords in a startup file is generally a security risk;
8599 the file should be readable by the invoking user only.
8603 \*(BO Send messages to the
8605 command without performing MIME and character set conversions.
8609 .It Va pipe-TYPE/SUBTYPE
8610 When a MIME message part of type
8612 (case-insensitive) is displayed or quoted,
8613 its text is filtered through the value of this variable interpreted as
8617 forces interpretation of the message part as plain text, e.g.,
8618 .Ql set pipe-application/xml=@
8619 will henceforth display XML
8621 (The same could also be achieved by adding a MIME type marker with the
8624 And \*(OPally MIME type handlers may be defined via
8625 .Sx "The Mailcap files"
8626 \(em corresponding flag strings are shown in parenthesis below.)
8631 can in fact be used to adjust usage and behaviour of a following shell
8632 command specification by appending trigger characters to it, e.g., the
8633 following hypothetical command specification could be used:
8634 .Bd -literal -offset indent
8635 set pipe-X/Y='@*!++=@vim ${MAILX_FILENAME_TEMPORARY}'
8639 .Bl -tag -compact -width ".It Ql __"
8641 Simply by using the special
8643 prefix the MIME type (shell command) handler will only be invoked to
8644 display or convert the MIME part if the message is addressed directly
8645 and alone by itself.
8646 Use this trigger to disable this and always invoke the handler
8647 .Pf ( Cd x-mailx-always ) .
8650 If set the handler will not be invoked when a message is to be quoted,
8651 but only when it will be displayed
8652 .Pf ( Cd x-mailx-noquote ) .
8655 The command will be run asynchronously, i.e., without blocking \*(UA,
8656 which may be a handy way to display a, e.g., PDF file while also
8657 continuing to read the mail message
8658 .Pf ( Cd x-mailx-async ) .
8659 Asynchronous execution implies
8663 The command must be run on an interactive terminal, \*(UA will
8664 temporarily release the terminal to it
8665 .Pf ( Cd needsterminal ) .
8666 This flag is mutual exclusive with
8668 will only be used in interactive mode and implies
8672 Request creation of a zero-sized temporary file, the absolute pathname
8673 of which will be made accessible via the environment variable
8674 .Ev MAILX_FILENAME_TEMPORARY
8675 .Pf ( Cd x-mailx-tmpfile ) .
8676 If this trigger is given twice then the file will be unlinked
8677 automatically by \*(UA when the command loop is entered again at latest
8678 .Pf ( Cd x-mailx-tmpfile-unlink ) .
8679 (Do not use this for asynchronous handlers.)
8682 Normally the MIME part content is passed to the handler via standard
8683 input; if this flag is set then the data will instead be written into
8684 .Ev MAILX_FILENAME_TEMPORARY
8685 .Pf ( Cd x-mailx-tmpfile-fill ) ,
8686 the creation of which is implied; note however that in order to cause
8687 deletion of the temporary file you still have to use two plus signs
8692 To avoid ambiguities with normal shell command content you can use
8693 another commercial at to forcefully terminate interpretation of
8694 remaining characters.
8695 (Any character not in this list will have the same effect.)
8699 Some information about the MIME part to be displayed is embedded into
8700 the environment of the shell command:
8703 .Bl -tag -compact -width ".It Ev _AIL__ILENAME__ENERATED"
8705 .It Ev MAILX_CONTENT
8706 The MIME content-type of the part, if known, the empty string otherwise.
8709 .It Ev MAILX_CONTENT_EVIDENCE
8711 .Va mime-counter-evidence
8712 includes the carry-around-bit (2), then this will be set to the detected
8713 MIME content-type; not only then identical to
8714 .Ev \&\&MAILX_CONTENT
8718 .It Ev MAILX_FILENAME
8719 The filename, if any is set, the empty string otherwise.
8722 .It Ev MAILX_FILENAME_GENERATED
8726 .It Ev MAILX_FILENAME_TEMPORARY
8727 If temporary file creation has been requested through the command prefix
8728 this variable will be set and contain the absolute pathname of the
8734 .It Va pipe-EXTENSION
8735 This is identical to
8736 .Va pipe-TYPE/SUBTYPE
8739 (normalized to lowercase using character mappings of the ASCII charset)
8740 names a file extension, e.g.,
8742 Handlers registered using this method take precedence.
8745 .It Va pop3-auth-USER@HOST , pop3-auth-HOST , pop3-auth
8746 \*(OP\*(IN Variable chain that sets the POP3 authentication method.
8747 The only possible value as of now is
8749 which is thus the default.
8752 .Mx Va pop3-bulk-load
8753 .It Va pop3-bulk-load-USER@HOST , pop3-bulk-load-HOST , pop3-bulk-load
8754 \*(BO\*(OP When accessing a POP3 server \*(UA loads the headers of
8755 the messages, and only requests the message bodies on user request.
8756 For the POP3 protocol this means that the message headers will be
8758 If this variable is set then \*(UA will download only complete messages
8759 from the given POP3 server(s) instead.
8761 .Mx Va pop3-keepalive
8762 .It Va pop3-keepalive-USER@HOST , pop3-keepalive-HOST , pop3-keepalive
8763 \*(OP POP3 servers close the connection after a period of inactivity;
8764 the standard requires this to be at least 10 minutes,
8765 but practical experience may vary.
8766 Setting this variable to a numeric value greater than
8770 command to be sent each value seconds if no other operation is performed.
8773 .It Va pop3-no-apop-USER@HOST , pop3-no-apop-HOST , pop3-no-apop
8774 \*(BO\*(OP Unless this variable is set the
8776 authentication method will be used when connecting to a POP3 server that
8780 is that the password is not sent in clear text over the wire and that
8781 only a single packet is sent for the user/password tuple.
8783 .Va pop3-no-apop-HOST
8786 .Mx Va pop3-use-starttls
8787 .It Va pop3-use-starttls-USER@HOST , pop3-use-starttls-HOST , pop3-use-starttls
8788 \*(BO\*(OP Causes \*(UA to issue a
8790 command to make an unencrypted POP3 session SSL/TLS encrypted.
8791 This functionality is not supported by all servers,
8792 and is not used if the session is already encrypted by the POP3S method.
8794 .Va pop3-use-starttls-HOST
8799 \*(BO This flag enables POSIX mode, which changes behaviour of \*(UA
8800 where that deviates from standardized behaviour.
8801 It will be set implicitly before the
8802 .Sx "Resource files"
8803 are loaded if the environment variable
8805 is set, and adjusting any of those two will be reflected by the other
8809 .It Va print-alternatives
8810 \*(BO When a MIME message part of type
8811 .Ql multipart/alternative
8812 is displayed and it contains a subpart of type
8814 other parts are normally discarded.
8815 Setting this variable causes all subparts to be displayed,
8816 just as if the surrounding part was of type
8817 .Ql multipart/mixed .
8821 The string used as a prompt in interactive mode.
8822 Whenever the variable is evaluated the value is expanded as via
8823 dollar-single-quote expansion (see
8824 .Sx "Shell-style argument quoting" ) .
8825 This (post-assignment, i.e., second) expansion can be used to embed
8826 status information, for example
8831 .Va -mailbox-display .
8833 In order to embed characters which should not be counted when
8834 calculating the visual width of the resulting string, enclose the
8835 characters of interest in a pair of reverse solidus escaped brackets:
8837 a slot for coloured prompts is also available with the \*(OPal command
8839 Prompting may be prevented by setting this to the null string
8841 .Ql set noprompt ) .
8845 This string is used for secondary prompts, but is otherwise identical to
8852 \*(BO Suppresses the printing of the version when first invoked.
8856 If set, \*(UA starts a replying message with the original message
8857 prefixed by the value of the variable
8859 Normally, a heading consisting of
8860 .Dq Fromheaderfield wrote:
8861 is put before the quotation.
8866 variable, this heading is omitted.
8869 is assigned, only the headers selected by the
8872 selection are put above the message body,
8875 acts like an automatic
8877 .Sx "COMMAND ESCAPES"
8881 is assigned, all headers are put above the message body and all MIME
8882 parts are included, making
8884 act like an automatic
8887 .Va quote-as-attachment .
8890 .It Va quote-as-attachment
8891 \*(BO Add the original message in its entirety as a
8893 MIME attachment when replying to a message.
8894 Note this works regardless of the setting of
8899 \*(OP Can be set in addition to
8901 Setting this turns on a more fancy quotation algorithm in that leading
8902 quotation characters are compressed and overlong lines are folded.
8904 can be set to either one or two (space separated) numeric values,
8905 which are interpreted as the maximum (goal) and the minimum line length,
8906 respectively, in a spirit rather equal to the
8908 program, but line-, not paragraph-based.
8909 If not set explicitly the minimum will reflect the goal algorithmically.
8910 The goal cannot be smaller than the length of
8912 plus some additional pad.
8913 Necessary adjustments take place silently.
8916 .It Va r-option-implicit
8917 \*(BO Setting this option evaluates the contents of
8919 (or, if that contains multiple addresses,
8921 and passes the results onto the used (file-based) MTA as described for the
8923 option (empty argument case).
8926 .It Va recipients-in-cc
8927 \*(BO On group replies, specify only the sender of the original mail in
8929 and mention the other recipients in the secondary
8931 By default all recipients of the original mail will be addressed via
8936 If defined, gives the pathname of the folder used to record all outgoing
8938 If not defined, then outgoing mail is not saved.
8939 When saving to this folder fails the message is not sent,
8940 but instead saved to
8944 .It Va record-resent
8945 \*(BO If both this variable and the
8952 commands save messages to the
8954 folder as it is normally only done for newly composed messages.
8957 .It Va reply-in-same-charset
8958 \*(BO If this variable is set \*(UA first tries to use the same
8959 character set of the original message for replies.
8960 If this fails, the mechanism described in
8961 .Sx "Character sets"
8962 is evaluated as usual.
8965 .It Va reply-strings
8966 Can be set to a comma-separated list of (case-insensitive according to
8967 ASCII rules) strings which shall be recognized in addition to the
8970 reply message indicators \(en builtin are
8972 which is mandated by RFC 5322, as well as the german
8977 which often has been seen in the wild;
8978 I.e., the separating colon has to be specified explicitly.
8982 A list of addresses to put into the
8984 field of the message header.
8985 Members of this list are handled as if they were in the
8990 .It Va reply-to-honour
8993 header is honoured when replying to a message via
8997 This is a quadoption; if set without a value it defaults to
9001 .It Va rfc822-body-from_
9002 \*(BO This variable can be used to force displaying a so-called
9004 line for messages that are embedded into an envelope mail via the
9006 MIME mechanism, for more visual convenience.
9010 \*(BO Enable saving of (partial) messages in
9012 upon interrupt or delivery error.
9016 The number of lines that represents a
9025 line display and scrolling via
9027 If this variable is not set \*(UA falls back to a calculation based upon
9028 the detected terminal window size and the baud rate: the faster the
9029 terminal, the more will be shown.
9030 Overall screen dimensions and pager usage is influenced by the
9031 environment variables
9039 .It Va searchheaders
9040 \*(BO Expand message-list specifiers in the form
9042 to all messages containing the substring
9046 The string search is case insensitive.
9050 \*(OP A comma-separated list of character set names that can be used in
9051 outgoing internet mail.
9052 The value of the variable
9054 is automatically appended to this list of character sets.
9055 If no character set conversion capabilities are compiled into \*(UA then
9056 the only supported charset is
9059 .Va sendcharsets-else-ttycharset
9060 and refer to the section
9061 .Sx "Character sets"
9062 for the complete picture of character set conversion in \*(UA.
9065 .It Va sendcharsets-else-ttycharset
9066 \*(BO\*(OP If this variable is set, but
9068 is not, then \*(UA acts as if
9070 had been set to the value of the variable
9072 In effect this combination passes through the message data in the
9073 character set of the current locale (given that
9075 has not been set manually), i.e., without converting it to the
9077 fallback character set.
9078 Thus, mail message text will be in ISO-8859-1 encoding when send from
9079 within a ISO-8859-1 locale, and in UTF-8 encoding when send from within
9081 If no character set conversion capabilities are available in \*(UA then
9082 the only supported character set is
9087 An address that is put into the
9089 field of outgoing messages, quoting RFC 5322: the mailbox of the agent
9090 responsible for the actual transmission of the message.
9091 This field should normally not be used unless the
9093 field contains more than one address, on which case it is required.
9096 address is handled as if it were in the
9100 .Va r-option-implicit .
9104 \*(OB Predecessor of
9108 .It Va sendmail-arguments
9109 \*(OB Predecessor of
9113 .It Va sendmail-no-default-arguments
9114 \*(OB\*(BO Predecessor of
9115 .Va mta-no-default-arguments .
9118 .It Va sendmail-progname
9119 \*(OB Predecessor of
9124 \*(BO When sending a message wait until the
9126 (including the builtin SMTP one) exits before accepting further commands.
9128 with this variable set errors reported by the MTA will be recognizable!
9129 If the MTA returns a non-zero exit status,
9130 the exit status of \*(UA will also be non-zero.
9134 \*(BO This setting causes \*(UA to start at the last message
9135 instead of the first one when opening a mail folder.
9139 \*(BO Causes \*(UA to use the sender's real name instead of the plain
9140 address in the header field summary and in message specifications.
9144 \*(BO Causes the recipient of the message to be shown in the header
9145 summary if the message was sent by the user.
9149 The string to expand
9152 .Sx "COMMAND ESCAPES" ) .
9156 The string to expand
9159 .Sx "COMMAND ESCAPES" ) .
9163 Must correspond to the name of a readable file if set.
9164 The file's content is then appended to each singlepart message
9165 and to the first part of each multipart message.
9166 Be warned that there is no possibility to edit the signature for an
9170 .It Va skipemptybody
9171 \*(BO If an outgoing message does not contain any text in its first or
9172 only message part, do not send it but discard it silently (see also the
9178 .It Va smime-ca-dir , smime-ca-file
9179 \*(OP Specify the location of trusted CA certificates in PEM (Privacy
9180 Enhanced Mail) format as a directory and a file, respectively, for the
9181 purpose of verification of S/MIME signed messages.
9182 It is possible to set both, the file will be loaded immediately, the
9183 directory will be searched whenever no match has yet been found.
9184 The set of CA certificates which are built into the SSL/TLS library can
9185 be explicitly turned off by setting
9186 .Va smime-ca-no-defaults ,
9187 and further fine-tuning is possible via
9188 .Va smime-ca-flags .
9191 .It Va smime-ca-flags
9192 \*(OP Can be used to fine-tune behaviour of the X509 CA certificate
9193 storage, and the certificate verification that is used.
9194 The actual values and their meanings are documented for
9198 .It Va smime-ca-no-defaults
9199 \*(BO\*(OP Do not load the default CA locations that are built into the
9200 used to SSL/TLS library to verify S/MIME signed messages.
9203 .It Va smime-cipher-USER@HOST , smime-cipher
9204 \*(OP Specifies the cipher to use when generating S/MIME encrypted
9205 messages (for the specified account).
9206 RFC 5751 mandates a default of
9209 Possible values are (case-insensitive and) in decreasing cipher strength:
9217 (DES EDE3 CBC, 168 bits; default if
9219 is not available) and
9223 The actually available cipher algorithms depend on the cryptographic
9224 library that \*(UA uses.
9225 \*(OP Support for more cipher algorithms may be available through
9226 dynamic loading via, e.g.,
9227 .Xr EVP_get_cipherbyname 3
9228 (OpenSSL) if \*(UA has been compiled to support this.
9231 .It Va smime-crl-dir
9232 \*(OP Specifies a directory that contains files with CRLs in PEM format
9233 to use when verifying S/MIME messages.
9236 .It Va smime-crl-file
9237 \*(OP Specifies a file that contains a CRL in PEM format to use when
9238 verifying S/MIME messages.
9241 .It Va smime-encrypt-USER@HOST
9242 \*(OP If this variable is set, messages send to the given receiver are
9243 encrypted before sending.
9244 The value of the variable must be set to the name of a file that
9245 contains a certificate in PEM format.
9247 If a message is sent to multiple recipients,
9248 each of them for whom a corresponding variable is set will receive an
9249 individually encrypted message;
9250 other recipients will continue to receive the message in plain text
9252 .Va smime-force-encryption
9254 It is recommended to sign encrypted messages, i.e., to also set the
9259 .It Va smime-force-encryption
9260 \*(BO\*(OP Causes \*(UA to refuse sending unencrypted messages.
9264 \*(BO\*(OP S/MIME sign outgoing messages with the user's private key
9265 and include the user's certificate as a MIME attachment.
9266 Signing a message enables a recipient to verify that the sender used
9267 a valid certificate,
9268 that the email addresses in the certificate match those in the message
9269 header and that the message content has not been altered.
9270 It does not change the message text,
9271 and people will be able to read the message as usual.
9273 .Va smime-sign-cert , smime-sign-include-certs
9275 .Va smime-sign-message-digest .
9277 .Mx Va smime-sign-cert
9278 .It Va smime-sign-cert-USER@HOST , smime-sign-cert
9279 \*(OP Points to a file in PEM format.
9280 For the purpose of signing and decryption this file needs to contain the
9281 user's private key, followed by his certificate.
9285 is always derived from the value of
9287 (or, if that contains multiple addresses,
9289 For the purpose of encryption the recipient's public encryption key
9290 (certificate) is expected; the command
9292 can be used to save certificates of signed messages (the section
9293 .Sx "Signed and encrypted messages with S/MIME"
9294 gives some details).
9295 This mode of operation is usually driven by the specialized form.
9297 When decrypting messages the account is derived from the recipient
9302 of the message, which are searched for addresses for which such
9304 \*(UA always uses the first address that matches,
9305 so if the same message is sent to more than one of the user's addresses
9306 using different encryption keys, decryption might fail.
9308 For signing and decryption purposes it is possible to use encrypted
9309 keys, and the pseudo-host(s)
9310 .Ql USER@HOST.smime-cert-key
9313 .Ql USER@HOST.smime-cert-cert
9314 for the certificate stored in the same file)
9315 will be used for performing any necessary password lookup,
9316 therefore the lookup can be automatized via the mechanisms described in
9317 .Sx "On URL syntax and credential lookup" .
9318 For example, the hypothetical address
9320 could be driven with a private key / certificate pair path defined in
9321 .Va \&\&smime-sign-cert-bob@exam.ple ,
9322 and needed passwords would then be looked up via the pseudo hosts
9323 .Ql bob@exam.ple.smime-cert-key
9325 .Ql bob@exam.ple.smime-cert-cert ) .
9326 To include intermediate certificates, use
9327 .Va smime-sign-include-certs .
9329 .Mx Va smime-sign-include-certs
9330 .It Va smime-sign-include-certs-USER@HOST , smime-sign-include-certs
9331 \*(OP If used, this is supposed to a consist of a comma-separated list
9332 of files, each of which containing a single certificate in PEM format to
9333 be included in the S/MIME message in addition to the
9336 This can be used to include intermediate certificates of the certificate
9337 authority, in order to allow the receiver's S/MIME implementation to
9338 perform a verification of the entire certificate chain, starting from
9339 a local root certificate, over the intermediate certificates, down to the
9340 .Va smime-sign-cert .
9341 Even though top level certificates may also be included in the chain,
9342 they won't be used for the verification on the receiver's side.
9344 For the purpose of the mechanisms involved here,
9346 refers to the content of the internal variable
9348 (or, if that contains multiple addresses,
9351 .Ql USER@HOST.smime-include-certs
9352 will be used for performing password lookups for these certificates,
9353 shall they have been given one, therefore the lookup can be automatized
9354 via the mechanisms described in
9355 .Sx "On URL syntax and credential lookup" .
9357 .Mx Va smime-sign-message-digest
9358 .It Va smime-sign-message-digest-USER@HOST , smime-sign-message-digest
9359 \*(OP Specifies the message digest to use when signing S/MIME messages.
9360 RFC 5751 mandates a default of
9362 Possible values are (case-insensitive and) in decreasing cipher strength:
9370 The actually available message digest algorithms depend on the
9371 cryptographic library that \*(UA uses.
9372 \*(OP Support for more message digest algorithms may be available
9373 through dynamic loading via, e.g.,
9374 .Xr EVP_get_digestbyname 3
9375 (OpenSSL) if \*(UA has been compiled to support this.
9376 Remember that for this
9378 refers to the variable
9380 (or, if that contains multiple addresses,
9385 \*(OB\*(OP To use the builtin SMTP transport, specify a SMTP URL in
9387 \*(ID For compatibility reasons a set
9389 is used in preference of
9393 .It Va smtp-auth-USER@HOST , smtp-auth-HOST , smtp-auth
9394 \*(OP Variable chain that controls the SMTP
9396 authentication method, possible values are
9402 as well as the \*(OPal methods
9408 method does not need any user credentials,
9410 requires a user name and all other methods require a user name and
9418 .Va smtp-auth-password
9420 .Va smtp-auth-user ) .
9425 .Va smtp-auth-USER@HOST :
9426 may override dependent on sender address in the variable
9429 .It Va smtp-auth-password
9430 \*(OP\*(OU Sets the global fallback password for SMTP authentication.
9431 If the authentication method requires a password, but neither
9432 .Va smtp-auth-password
9434 .Va smtp-auth-password-USER@HOST
9436 \*(UA will ask for a password on the user's terminal.
9438 .It Va smtp-auth-password-USER@HOST
9440 .Va smtp-auth-password
9441 for specific values of sender addresses, dependent upon the variable
9444 .It Va smtp-auth-user
9445 \*(OP\*(OU Sets the global fallback user name for SMTP authentication.
9446 If the authentication method requires a user name, but neither
9449 .Va smtp-auth-user-USER@HOST
9451 \*(UA will ask for a user name on the user's terminal.
9453 .It Va smtp-auth-user-USER@HOST
9456 for specific values of sender addresses, dependent upon the variable
9460 .It Va smtp-hostname
9461 \*(OP\*(IN Normally \*(UA uses the variable
9463 to derive the necessary
9465 information in order to issue a
9472 can be used to use the
9474 from the SMTP account
9481 from the content of this variable (or, if that is the empty string,
9483 or the local hostname as a last resort).
9484 This often allows using an address that is itself valid but hosted by
9485 a provider other than which (in
9487 is about to send the message.
9488 Setting this variable also influences generated
9494 .Mx Va smtp-use-starttls
9495 .It Va smtp-use-starttls-USER@HOST , smtp-use-starttls-HOST , smtp-use-starttls
9496 \*(BO\*(OP Causes \*(UA to issue a
9498 command to make an SMTP
9500 session SSL/TLS encrypted, i.e., to enable transport layer security.
9504 .It Va spam-interface
9505 \*(OP In order to use any of the spam-related commands (like, e.g.,
9507 the desired spam interface must be defined by setting this variable.
9508 Please refer to the manual section
9510 for the complete picture of spam handling in \*(UA.
9511 All or none of the following interfaces may be available:
9513 .Bl -tag -width ".It Ql _ilte_"
9519 .Pf ( Lk http://spamassassin.apache.org SpamAssassin )
9521 Different to the generic filter interface \*(UA will automatically add
9522 the correct arguments for a given command and has the necessary
9523 knowledge to parse the program's output.
9526 will have been compiled into the \*(UA binary if
9531 Shall it be necessary to define a specific connection type (rather than
9532 using a configuration file for that), the variable
9534 can be used as in, e.g.,
9535 .Ql -d server.example.com -p 783 .
9536 It is also possible to specify a per-user configuration via
9538 Note that this interface does not inspect the
9540 flag of a message for the command
9544 generic spam filter support via freely configurable hooks.
9545 This interface is meant for programs like
9547 and requires according behaviour in respect to the hooks' exit
9548 status for at least the command
9551 meaning a message is spam,
9555 for unsure and any other return value indicating a hard error);
9556 since the hooks can include shell code snippets diverting behaviour
9557 can be intercepted as necessary.
9559 .Va spamfilter-ham , spamfilter-noham , spamfilter-nospam , \
9562 .Va spamfilter-spam ;
9565 contains examples for some programs.
9566 The process environment of the hooks will have the variable
9567 .Ev MAILX_FILENAME_GENERATED
9569 Note that spam score support for
9571 is not supported unless the \*(OPtional regular expression support is
9573 .Va spamfilter-rate-scanscore
9580 \*(OP Messages that exceed this size will not be passed through to the
9582 .Va spam-interface .
9583 If unset or 0, the default of 420000 bytes is used.
9586 .It Va spamc-command
9587 \*(OP The path to the
9591 .Va spam-interface .
9592 Note that the path is not expanded, but used
9594 A fallback path will have been compiled into the \*(UA binary if the
9595 executable had been found during compilation.
9598 .It Va spamc-arguments
9599 \*(OP Even though \*(UA deals with most arguments for the
9602 automatically, it may at least sometimes be desirable to specify
9603 connection-related ones via this variable, e.g.,
9604 .Ql -d server.example.com -p 783 .
9608 \*(OP Specify a username for per-user configuration files for the
9610 .Va spam-interface .
9611 If this is set to the empty string then \*(UA will use the name of the
9620 .It Va spamfilter-ham , spamfilter-noham , \
9621 spamfilter-nospam , spamfilter-rate , spamfilter-spam
9622 \*(OP Command and argument hooks for the
9624 .Va spam-interface .
9627 contains examples for some programs.
9630 .It Va spamfilter-rate-scanscore
9631 \*(OP Because of the generic nature of the
9634 spam scores are not supported for it by default, but if the \*(OPnal
9635 regular expression support is available then setting this variable can
9636 be used to overcome this restriction.
9637 It is interpreted as follows: first a number (digits) is parsed that
9638 must be followed by a semicolon
9640 and an extended regular expression.
9641 Then the latter is used to parse the first output line of the
9643 hook, and, in case the evaluation is successful, the group that has been
9644 specified via the number is interpreted as a floating point scan score.
9648 .It Va ssl-ca-dir , ssl-ca-file
9649 \*(OP Specify the location of trusted CA certificates in PEM (Privacy
9650 Enhanced Mail) format as a directory and a file, respectively, for the
9651 purpose of verification of SSL/TLS server certificates.
9652 It is possible to set both, the file will be loaded immediately, the
9653 directory will be searched whenever no match has yet been found.
9654 The set of CA certificates which are built into the SSL/TLS library can
9655 be explicitly turned off by setting
9656 .Va ssl-ca-no-defaults ,
9657 and further fine-tuning is possible via
9660 .Xr SSL_CTX_load_verify_locations 3
9661 for more information.
9666 \*(OP Can be used to fine-tune behaviour of the X509 CA certificate
9667 storage, and the certificate verification that is used (also see
9669 The value is expected to consist of a comma-separated list of
9670 configuration directives, with any intervening whitespace being ignored.
9671 The directives directly map to flags that can be passed to
9672 .Xr X509_STORE_set_flags 3 ,
9673 which are usually defined in a file
9674 .Pa openssl/x509_vfy.h ,
9675 and the availability of which depends on the used SSL/TLS library
9676 version: a directive without mapping is ignored (error log subject to
9678 Directives currently understood (case-insensitively) include:
9681 .Bl -tag -compact -width ".It Cd BaNg"
9682 .It Cd no-alt-chains
9683 If the initial chain is not trusted, do not attempt to build an
9685 Setting this flag will make OpenSSL certificate verification match that
9686 of older OpenSSL versions, before automatic building and checking of
9687 alternative chains has been implemented; also see
9689 .It Cd no-check-time
9690 Do not check certificate/CRL validity against current time.
9691 .It Cd partial-chain
9692 By default partial, incomplete chains which cannot be verified up to the
9693 chain top, a self-signed root certificate, will not verify.
9694 With this flag set, a chain succeeds to verify if at least one signing
9695 certificate of the chain is in any of the configured trusted stores of
9697 The OpenSSL manual page
9698 .Xr SSL_CTX_load_verify_locations 3
9699 gives some advise how to manage your own trusted store of CA certificates.
9701 Disable workarounds for broken certificates.
9702 .It Cd trusted-first
9703 Try building a chain using issuers in the trusted store first to avoid
9704 problems with server-sent legacy intermediate certificates.
9705 Newer versions of OpenSSL support alternative chain checking and enable
9706 it by default, resulting in the same behaviour; also see
9712 .It Va ssl-ca-no-defaults
9713 \*(BO\*(OP Do not load the default CA locations that are built into the
9714 used to SSL/TLS library to verify SSL/TLS server certificates.
9717 .It Va ssl-cert-USER@HOST , ssl-cert-HOST , ssl-cert
9718 \*(OP Variable chain that sets the file name for a SSL/TLS client
9719 certificate required by some servers.
9720 This is a direct interface to the
9724 function of the OpenSSL library, if available.
9726 .Mx Va ssl-cipher-list
9727 .It Va ssl-cipher-list-USER@HOST , ssl-cipher-list-HOST , ssl-cipher-list
9728 \*(OP Specifies a list of ciphers for SSL/TLS connections.
9729 This is a direct interface to the
9733 function of the OpenSSL library, if available; see
9735 for more information.
9736 By default \*(UA does not set a list of ciphers, in effect using a
9738 specific cipher (protocol standards ship with a list of acceptable
9739 ciphers), possibly cramped to what the actually used SSL/TLS library
9740 supports \(en the manual section
9741 .Sx "An example configuration"
9742 also contains a SSL/TLS use case.
9745 .It Va ssl-config-file
9746 \*(OP If this variable is set \*(UA will call
9747 .Xr CONF_modules_load_file 3
9748 to allow OpenSSL to be configured according to the host system wide
9750 If a non-empty value is given then this will be used to specify the
9751 configuration file to be used instead of the global OpenSSL default;
9752 note that in this case it is an error if the file cannot be loaded.
9753 The application name will always be passed as
9758 .It Va ssl-crl-dir , ssl-crl-file
9759 \*(OP Specify a directory / a file, respectively that contains a CRL in
9760 PEM format to use when verifying SSL/TLS server certificates.
9763 .It Va ssl-key-USER@HOST , ssl-key-HOST , ssl-key
9764 \*(OP Variable chain that sets the file name for the private key of
9765 a SSL/TLS client certificate.
9766 If unset, the name of the certificate file is used.
9767 The file is expected to be in PEM format.
9768 This is a direct interface to the
9772 function of the OpenSSL library, if available.
9775 .It Va ssl-method-USER@HOST , ssl-method-HOST , ssl-method
9776 \*(OB\*(OP Please use the newer and more flexible
9778 instead: if both values are set,
9780 will take precedence!
9781 Can be set to the following values, the actually used
9783 specification to which it is mapped is shown in parenthesis:
9785 .Pf ( Ql -ALL, TLSv1.2 ) ,
9787 .Pf ( Ql -ALL, TLSv1.1 ) ,
9789 .Pf ( Ql -ALL, TLSv1 )
9792 .Pf ( Ql -ALL, SSLv3 ) ;
9797 and thus includes the SSLv3 protocol.
9798 Note that SSLv2 is no longer supported at all.
9801 .It Va ssl-protocol-USER@HOST , ssl-protocol-HOST , ssl-protocol
9802 \*(OP Specify the used SSL/TLS protocol.
9803 This is a direct interface to the
9807 function of the OpenSSL library, if available;
9808 otherwise an \*(UA internal parser is used which understands the
9809 following subset of (case-insensitive) command strings:
9815 as well as the special value
9817 Multiple specifications may be given via a comma-separated list which
9818 ignores any whitespace.
9821 plus sign prefix will enable a protocol, a
9823 hyphen-minus prefix will disable it, so that
9825 will enable only the TLSv1.2 protocol.
9827 It depends upon the used TLS/SSL library which protocols are actually
9828 supported and which protocols are used if
9830 is not set, but note that SSLv2 is no longer supported at all and
9832 Especially for older protocols explicitly securing
9834 may be worthwile, see
9835 .Sx "An example configuration" .
9839 \*(OP Gives the pathname to an entropy daemon socket, see
9841 Not all SSL/TLS libraries support this.
9844 .It Va ssl-rand-file
9845 \*(OP Gives the filename to a file with random entropy data, see
9846 .Xr RAND_load_file 3 .
9847 If this variable is not set, or set to the empty string, or if the
9848 .Sx "Filename transformations"
9850 .Xr RAND_file_name 3
9851 will be used to create the filename if, and only if,
9853 documents that the SSL PRNG is not yet sufficiently seeded.
9854 If \*(UA successfully seeded the SSL PRNG then it will update the file
9855 .Pf ( Xr RAND_write_file 3 ) .
9856 This variable is only used if
9858 is not set (or not supported by the SSL/TLS library).
9861 .It Va ssl-verify-USER@HOST , ssl-verify-HOST , ssl-verify
9862 \*(OP Variable chain that sets the action to be performed if an error
9863 occurs during SSL/TLS server certificate validation against the
9864 specified or default trust stores
9867 or the SSL/TLS library builtin defaults (unless usage disallowed via
9868 .Va ssl-ca-no-defaults ) ,
9869 and as fine-tuned via
9871 Valid (case-insensitive) values are
9873 (fail and close connection immediately),
9875 (ask whether to continue on standard input),
9877 (show a warning and continue),
9879 (do not perform validation).
9885 If only set without an assigned value, then this setting inhibits the
9891 header fields that include obvious references to \*(UA.
9892 There are two pitfalls associated with this:
9893 First, the message id of outgoing messages is not known anymore.
9894 Second, an expert may still use the remaining information in the header
9895 to track down the originating mail user agent.
9902 suppression does not occur.
9907 (\*(OP) This specifies a comma-separated list of
9912 .Sx "On terminal control and line editor" ,
9913 escape commas with reverse solidus) to be used to overwrite or define
9915 Note that this variable will only be queried once at program startup and
9916 can thus only be specified in resource files or on the command line.
9919 String capabilities form
9921 pairs and are expected unless noted otherwise.
9922 Numerics have to be notated as
9924 where the number is expected in normal decimal notation.
9925 Finally, booleans do not have any value but indicate a true or false
9926 state simply by being defined or not; this indeed means that \*(UA
9927 does not support undefining an existing boolean.
9928 String capability values will undergo some expansions before use:
9929 for one notations like
9932 .Ql control-LETTER ,
9933 and for clarification purposes
9935 can be used to specify
9937 (the control notation
9939 could lead to misreadings when a left bracket follows, which it does for
9940 the standard CSI sequence);
9941 finally three letter octal sequences, as in
9944 To specify that a terminal supports 256-colours, and to define sequences
9945 that home the cursor and produce an audible bell, one might write:
9947 .Bd -literal -offset indent
9948 set termcap='Co#256,home=\eE[H,bel=^G'
9952 The following terminal capabilities are or may be meaningful for the
9953 operation of the builtin line editor or \*(UA in general:
9956 .Bl -tag -compact -width yay
9958 .It Cd colors Ns \0or Cd Co
9960 numeric capability specifying the maximum number of colours.
9961 Note that \*(UA does not actually care about the terminal beside that,
9962 but always emits ANSI / ISO 6429 escape sequences.
9965 .It Cd rmcup Ns \0or Cd te Ns \0/ Cd smcup Ns \0or Cd ti
9969 respectively: exit and enter the alternative screen
9971 effectively turning \*(UA into a fullscreen application.
9972 To disable that, set (at least) one to the empty string.
9974 .It Cd smkx Ns \0or Cd ks Ns \0/ Cd rmkx Ns \0or Cd ke
9978 respectively: enable and disable the keypad.
9979 This is always enabled if available, because it seems even keyboards
9980 without keypads generate other key codes for, e.g., cursor keys in that
9981 case, and only if enabled we see the codes that we are interested in.
9983 .It Cd ed Ns \0or Cd cd
9987 .It Cd clear Ns \0or Cd cl
9989 clear the screen and home cursor.
9990 (Will be simulated via
9995 .It Cd home Ns \0or Cd ho
10000 .It Cd el Ns \0or Cd ce
10002 clear to the end of line.
10003 (Will be simulated via
10005 plus repetitions of space characters.)
10007 .It Cd hpa Ns \0or Cd ch
10008 .Cd column_address :
10009 move the cursor (to the given column parameter) in the current row.
10010 (Will be simulated via
10016 .Cd carriage_return :
10017 move to the first column in the current row.
10018 The default builtin fallback is
10021 .It Cd cub1 Ns \0or Cd le
10023 move the cursor left one space (non-destructively).
10024 The default builtin fallback is
10027 .It Cd cuf1 Ns \0or Cd nd
10029 move the cursor right one space (non-destructively).
10030 The default builtin fallback is
10032 which is used by most terminals.
10040 Many more capabilities which describe key-sequences are documented for
10044 .It Va termcap-disable
10045 \*(OP Disable any interaction with a terminal control library.
10046 If set only some generic fallback builtins and possibly the content of
10048 describe the terminal to \*(UA.
10050 that this variable will only be queried once at program startup and can
10051 thus only be specified in resource files or on the command line.
10055 If defined, gives the number of lines of a message to be displayed
10058 if unset, the first five lines are printed, if set to 0 the variable
10061 If the value is negative then its absolute value will be used for
10062 unsigned right shifting (see
10070 \*(BO If set then the
10072 command series will strip adjacent empty lines and quotations.
10076 The character set of the terminal \*(UA operates on,
10077 and the one and only supported character set that \*(UA can use if no
10078 character set conversion capabilities have been compiled into it,
10079 in which case it defaults to ISO-8859-1 unless it can deduce a value
10082 locale environment.
10083 It defaults to UTF-8 if conversion is available.
10084 Refer to the section
10085 .Sx "Character sets"
10086 for the complete picture about character sets.
10089 .It Va typescript-mode
10090 \*(BO A special multiplex variable that disables all variables and
10091 settings which result in behaviour that interferes with running \*(UA in
10094 .Va colour-disable ,
10095 .Va line-editor-disable
10096 and (before startup completed only)
10097 .Va termcap-disable .
10098 Unsetting it does not restore the former state of the covered settings.
10102 For a safety-by-default policy \*(UA sets its process
10106 but this variable can be used to override that:
10107 set it to an empty value to do not change the (current) setting,
10108 otherwise the process file mode creation mask is updated to the new value.
10109 Child processes inherit the process file mode creation mask.
10112 .It Va user-HOST , user
10113 \*(IN Variable chain that sets a global fallback user name, which is
10114 used in case none has been given in the protocol and account-specific
10116 This variable defaults to the name of the user who runs \*(UA.
10120 \*(BO Setting this enables upward compatibility with \*(UA
10121 version 15.0 in respect to which configuration options are available and
10122 how they are handled.
10123 This manual uses \*(IN and \*(OU to refer to the new and the old way of
10124 doing things, respectively.
10128 \*(BO This setting, also controllable via the command line option
10130 causes \*(UA to be more verbose, e.g., it will display obsoletion
10131 warnings and SSL/TLS certificate chains.
10132 Even though marked \*(BO this option may be set twice in order to
10133 increase the level of verbosity even more, in which case even details of
10134 the actual message delivery and protocol conversations are shown.
10137 is sufficient to disable verbosity as such.
10143 .It Va version , version-major , version-minor , version-update
10144 \*(RO \*(UA version information: the first variable contains a string
10145 containing the complete version identification, the latter three contain
10146 only digits: the major, minor and update version numbers.
10147 The output of the command
10149 will include this information.
10152 .It Va writebackedited
10153 If this variable is set messages modified using the
10157 commands are written back to the current folder when it is quit;
10158 it is only honoured for writable folders in MBOX format, though.
10159 Note that the editor will be pointed to the raw message content in that
10160 case, i.e., neither MIME decoding nor decryption will have been
10161 performed, and proper RFC 4155
10163 quoting of newly added or edited content is also left as an excercise to
10166 .\" }}} (Variables)
10167 .\" }}} (INTERNAL VARIABLES)
10170 .\" .Sh ENVIRONMENT {{{
10174 .Dq environment variable
10175 should be considered an indication that these variables are either
10176 standardized as vivid parts of process environments, or that they are
10177 commonly found in there.
10178 The process environment is inherited from the
10180 once \*(UA is started, and unless otherwise explicitly noted handling of
10181 the following variables transparently integrates into that of the
10182 .Sx "INTERNAL VARIABLES"
10183 from \*(UA's point of view.
10184 This means that, e.g., they can be managed via
10188 causing automatic program environment updates (to be inherited by
10189 newly created child processes).
10192 In order to transparently integrate other environment variables equally
10193 they need to be imported (linked) with the command
10195 This command can also be used to set and unset non-integrated
10196 environment variables from scratch, sufficient system support provided.
10197 The following example, applicable to a POSIX shell, sets the
10199 environment variable for \*(UA only, and beforehand exports the
10201 in order to affect any further processing in the running shell:
10203 .Bd -literal -offset indent
10204 $ EDITOR="vim -u ${HOME}/.vimrc"
10206 $ COLUMNS=80 \*(uA -R
10209 .Bl -tag -width ".It Ev BaNg"
10212 The user's preferred width in column positions for the terminal screen
10214 Queried and used once on program startup, actively managed for child
10215 processes and the MLE (see
10216 .Sx "On terminal control and line editor" )
10217 in interactive mode thereafter.
10221 The name of the (mailbox)
10223 to use for saving aborted messages if
10225 is set; this defaults to
10232 is set no output will be generated, otherwise the contents of the file
10237 Pathname of the text editor to use in the
10241 .Sx "COMMAND ESCAPES" .
10242 A default editor is used if this value is not defined.
10246 The user's home directory.
10247 This variable is only used when it resides in the process environment.
10254 .It Ev LANG , LC_ALL , LC_COLLATE , LC_CTYPE , LC_MESSAGES
10258 .Sx "Character sets" .
10262 The user's preferred number of lines on a page or the vertical screen
10263 or window size in lines.
10264 Queried and used once on program startup, actively managed for child
10265 processes in interactive mode thereafter.
10269 Pathname of the directory lister to use in the
10271 command when operating on local mailboxes.
10274 (path search through
10279 Upon startup \*(UA will actively ensure that this variable refers to the
10280 name of the user who runs \*(UA, in order to be able to pass a verified
10281 name to any newly created child process.
10285 Is used as the users
10287 .Sx "primary system mailbox"
10291 This is assumed to be an absolute pathname.
10295 \*(OP Overrides the default path search for
10296 .Sx "The Mailcap files" ,
10297 which is defined in the standard RFC 1524 as
10298 .Ql ~/.mailcap:\:/etc/mailcap:\:/usr/etc/mailcap:\:/usr/local/etc/mailcap .
10299 .\" TODO we should have a mailcaps-default virtual RDONLY option!
10300 (\*(UA makes it a configuration option, however.)
10301 Note this is not a search path, but a path search.
10305 Is used as a startup file instead of
10308 When \*(UA scripts are invoked on behalf of other users,
10309 either this variable should be set to
10313 command line option should be used in order to avoid side-effects from
10314 reading their configuration files.
10315 This variable is only used when it resides in the process environment.
10318 .It Ev MAILX_NO_SYSTEM_RC
10319 If this variable is set then reading of
10321 at startup is inhibited, i.e., the same effect is achieved as if \*(UA
10322 had been started up with the option
10324 (and according argument) or
10326 This variable is only used when it resides in the process environment.
10330 The name of the users mbox file.
10331 A logical subset of the special
10332 .Sx "Filename transformations"
10336 The fallback default is
10343 .Sx "secondary mailbox"
10344 is used as the file to save messages from the
10346 .Sx "primary system mailbox"
10347 that have been read.
10349 .Sx "Message states" .
10353 \*(IN\*(OP This variable overrides the default location of the user's
10359 Pathname of the program to use for backing the command
10363 variable enforces usage of a pager for output.
10364 The default paginator is
10366 (path search through
10369 \*(UA inspects the contents of this variable: if its contains the string
10371 then a non-existing environment variable
10378 dependent on whether terminal control support is available and whether
10379 that supports full (alternative) screen mode or not (also see
10380 .Sx "On terminal control and line editor" ) .
10384 will optionally be set to
10391 A colon-separated list of directories that is searched by the shell when
10392 looking for commands, e.g.,
10393 .Ql /bin:/usr/bin:/usr/local/bin .
10396 .It Ev POSIXLY_CORRECT
10397 This variable is automatically looked for upon startup, see
10403 The shell to use for the commands
10408 .Sx "COMMAND ESCAPES"
10409 and when starting subprocesses.
10410 A default shell is used if this environment variable is not defined.
10413 .It Ev SOURCE_DATE_EPOCH
10414 If set, this specifies a time in seconds since the Unix epoch
10415 (1970-01-01) to be used in place of the current time.
10416 This is for the sake of reproduceability of tests, to be used during
10417 development or by software packagers.
10421 \*(OP The terminal type for which output is to be prepared.
10422 For extended colour and font control please refer to
10423 .Sx "Coloured display" ,
10424 and for terminal management in general to
10425 .Sx "On terminal control and line editor" .
10429 Used as directory for temporary files instead of
10432 This variable is only used when it resides in the process environment,
10433 but \*(UA will ensure at startup that this environment variable is
10434 updated to contain a usable temporary directory.
10440 (see there), but this variable is not standardized, should therefore not
10441 be used, and is only corrected if already set.
10445 Pathname of the text editor to use in the
10449 .Sx "COMMAND ESCAPES" .
10457 .Bl -tag -width ".It Pa BaNg"
10459 File giving initial commands.
10462 System wide initialization file.
10466 \*(OP Personal MIME type handler definition file, see
10467 .Sx "The Mailcap files" .
10468 (RFC 1524 location, the actual path is a configuration option.)
10471 .It Pa /etc/mailcap
10472 \*(OP System wide MIME type handler definition file, see
10473 .Sx "The Mailcap files" .
10474 (RFC 1524 location, the actual path is a configuration option.)
10477 .It Pa ~/.mime.types
10478 Personal MIME types, see
10479 .Sx "The mime.types files" .
10482 .It Pa /etc/mime.types
10483 System wide MIME types, see
10484 .Sx "The mime.types files" .
10488 \*(IN\*(OP The default location of the users
10490 file \(en the section
10491 .Sx "The .netrc file"
10492 documents the file format.
10495 .\" .Ss "The mime.types files" {{{
10496 .Ss "The mime.types files"
10498 When sending messages \*(UA tries to determine the content type of all
10500 When displaying message content or attachments \*(UA uses the content
10501 type to decide whether it can directly display data or whether it needs
10502 to deal with content handlers.
10503 It learns about M(ultipurpose) I(nternet) M(ail) E(xtensions) types and
10504 how to treat them by reading
10506 files, the loading of which can be controlled by setting the variable
10507 .Va mimetypes-load-control .
10510 can also be used to deal with MIME types.)
10512 files have the following syntax:
10515 .Dl type/subtype extension [extension ...]
10520 are strings describing the file contents, and one or multiple
10522 s, separated by whitespace, name the part of a filename starting after
10523 the last dot (of interest).
10524 Comments may be introduced anywhere on a line with a number sign
10526 causing the remaining line to be discarded.
10528 \*(UA also supports an extended, non-portable syntax in specially
10529 crafted files, which can be loaded via the alternative value syntax of
10530 .Va mimetypes-load-control
10531 and prepends an optional
10535 .Dl [type-marker ]type/subtype extension [extension ...]
10538 The following type markers are supported:
10541 .Bl -tag -compact -width ".It Ar _n_u"
10543 Treat message parts with this content as plain text.
10548 Treat message parts with this content as HTML tagsoup.
10549 If the \*(OPal HTML-tagsoup-to-text converter is not available treat
10550 the content as plain text instead.
10554 but instead of falling back to plain text require an explicit content
10555 handler to be defined.
10560 for sending messages:
10562 .Va mime-allow-text-controls ,
10563 .Va mimetypes-load-control .
10564 For reading etc. messages:
10565 .Sx "HTML mail and MIME attachments" ,
10566 .Sx "The Mailcap files" ,
10568 .Va mime-counter-evidence ,
10569 .Va mimetypes-load-control ,
10570 .Va pipe-TYPE/SUBTYPE ,
10571 .Va pipe-EXTENSION .
10574 .\" .Ss "The Mailcap files" {{{
10575 .Ss "The Mailcap files"
10577 .\" TODO MAILCAP DISABLED
10578 .Sy This feature is not available in v14.9.0, sorry!
10580 .Dq User Agent Configuration Mechanism
10581 which \*(UA \*(OPally supports.
10582 It defines a file format to be used to inform mail user agent programs
10583 about the locally-installed facilities for handling various data
10584 formats, i.e., about commands and how they can be used to display, edit
10585 etc. MIME part contents, as well as a default path search that includes
10586 multiple possible locations of
10590 environment variable that can be used to overwrite that (repeating here
10591 that it is not a search path, but instead a path search specification).
10592 Any existing files will be loaded in sequence, appending any content to
10593 the list of MIME type handler directives.
10597 files consist of a set of newline separated entries.
10598 Comment lines start with a number sign
10600 (in the first column!) and are ignored.
10601 Empty lines are also ignored.
10602 All other lines form individual entries that must adhere to the syntax
10604 To extend a single entry (not comment) its line can be continued on
10605 follow lines if newline characters are
10607 by preceding them with the reverse solidus character
10609 The standard does not specify how leading whitespace of follow lines
10610 is to be treated, therefore \*(UA retains it.
10614 entries consist of a number of semicolon
10616 separated fields, and the reverse solidus
10618 character can be used to escape any following character including
10619 semicolon and itself.
10620 The first two fields are mandatory and must occur in the specified
10621 order, the remaining fields are optional and may appear in any order.
10622 Leading and trailing whitespace of content is ignored (removed).
10625 The first field defines the MIME
10627 the entry is about to handle (case-insensitively, and no reverse solidus
10628 escaping is possible in this field).
10629 If the subtype is specified as an asterisk
10631 the entry is meant to match all subtypes of the named type, e.g.,
10633 would match any audio type.
10634 The second field defines the shell command which shall be used to
10636 MIME parts of the given type; it is implicitly called the
10643 shell commands message (MIME part) data is passed via standard input
10644 unless the given shell command includes one or more instances of the
10647 in which case these instances will be replaced with a temporary filename
10648 and the data will have been stored in the file that is being pointed to.
10651 shell commands data is assumed to be generated on standard output unless
10652 the given command includes (one ore multiple)
10654 In any case any given
10656 format is replaced with a(n already) properly quoted filename.
10657 Note that when a command makes use of a temporary file via
10659 then \*(UA will remove it again, as if the
10660 .Cd x-mailx-tmpfile ,
10661 .Cd x-mailx-tmpfile-fill
10663 .Cd x-mailx-tmpfile-unlink
10664 flags had been set; see below for more.
10667 The optional fields either define a shell command or an attribute (flag)
10668 value, the latter being a single word and the former being a keyword
10669 naming the field followed by an equals sign
10671 succeeded by a shell command, and as usual for any
10673 content any whitespace surrounding the equals sign will be removed, too.
10674 Optional fields include the following:
10677 .Bl -tag -width ".It Cd BaNg"
10679 A program that can be used to compose a new body or body part in the
10681 (Currently unused.)
10683 .It Cd composetyped
10686 field, but is to be used when the composing program needs to specify the
10688 header field to be applied to the composed data.
10689 (Currently unused.)
10692 A program that can be used to edit a body or body part in the given
10694 (Currently unused.)
10697 A program that can be used to print a message or body part in the given
10699 (Currently unused.)
10702 Specifies a program to be run to test some condition, e.g., the machine
10703 architecture, or the window system in use, to determine whether or not
10704 this mailcap entry applies.
10705 If the test fails, a subsequent mailcap entry should be sought; also see
10706 .Cd x-mailx-test-once .
10708 .It Cd needsterminal
10709 This flag field indicates that the given shell command must be run on
10710 an interactive terminal.
10711 \*(UA will temporarily release the terminal to the given command in
10712 interactive mode, in non-interactive mode this entry will be entirely
10713 ignored; this flag implies
10714 .Cd x-mailx-noquote .
10716 .It Cd copiousoutput
10717 A flag field which indicates that the output of the
10719 command will be an extended stream of textual output that can be
10720 (re)integrated into \*(UA's normal visual display.
10721 It is mutually exclusive with
10724 .Cd x-mailx-always .
10726 .It Cd textualnewlines
10727 A flag field which indicates that this type of data is line-oriented and
10728 that, if encoded in
10730 all newlines should be converted to canonical form (CRLF) before
10731 encoding, and will be in that form after decoding.
10732 (Currently unused.)
10734 .It Cd nametemplate
10735 This field gives a file name format, in which
10737 will be replaced by a random string, the joined combination of which
10738 will be used as the filename denoted by
10739 .Ev MAILX_FILENAME_TEMPORARY .
10740 One could specify that a GIF file being passed to an image viewer should
10741 have a name ending in
10744 .Ql nametemplate=%s.gif .
10745 Note that \*(UA ignores the name template unless that solely specifies
10746 a filename suffix that consists of (ASCII) alphabetic and numeric
10747 characters, the underscore and dot only.
10750 Names a file, in X11 bitmap (xbm) format, which points to an appropriate
10751 icon to be used to visually denote the presence of this kind of data.
10752 This field is not used by \*(UA.
10755 A textual description that describes this type of data.
10757 .It Cd x-mailx-always
10758 Extension flag field that denotes that the given
10760 command shall be executed even if multiple messages will be displayed
10762 Normally messages which require external viewers that produce output
10763 which does not integrate into \*(UA's visual display (i.e., do not have
10765 set) have to be addressed directly and individually.
10766 (To avoid cases where, e.g., a thousand PDF viewer instances are spawned
10769 .It Cd x-mailx-even-if-not-interactive
10770 An extension flag test field \(em by default handlers without
10772 are entirely ignored in non-interactive mode, but if this flag is set
10773 then their use will be considered.
10774 It is an error if this flag is set for commands that use the flag
10775 .Cd needsterminal .
10777 .It Cd x-mailx-noquote
10778 An extension flag field that indicates that even a
10781 command shall not be used to generate message quotes
10782 (as it would be by default).
10784 .It Cd x-mailx-async
10785 Extension flag field that denotes that the given
10787 command shall be executed asynchronously, without blocking \*(UA.
10788 Cannot be used in conjunction with
10789 .Cd needsterminal .
10791 .It Cd x-mailx-test-once
10792 Extension flag which denotes whether the given
10794 command shall be evaluated once only and the (boolean) result be cached.
10795 This is handy if some global unchanging condition is to be queried, like
10796 .Dq running under the X Window System .
10798 .It Cd x-mailx-tmpfile
10799 Extension flag field that requests creation of a zero-sized temporary
10800 file, the name of which is to be placed in the environment variable
10801 .Ev MAILX_FILENAME_TEMPORARY .
10802 It is an error to use this flag with commands that include a
10806 .It Cd x-mailx-tmpfile-fill
10807 Normally the MIME part content is passed to the handler via standard
10808 input; if this flag is set then the data will instead be written into
10810 .Cd x-mailx-tmpfile .
10811 In order to cause deletion of the temporary file you will have to set
10812 .Cd x-mailx-tmpfile-unlink
10814 It is an error to use this flag with commands that include a
10818 .It Cd x-mailx-tmpfile-unlink
10819 Extension flag field that requests that the temporary file shall be
10820 deleted automatically when the command loop is entered again at latest.
10821 (Do not use this for asynchronous handlers.)
10822 It is an error to use this flag with commands that include a
10824 format, or without also setting
10825 .Cd x-mailx-tmpfile
10827 .Cd x-mailx-tmpfile-fill .
10829 .It Cd x-mailx-tmpfile-keep
10832 implies the three tmpfile related flags above, but if you want, e.g.,
10834 and deal with the temporary file yourself, you can add in this flag to
10836 .Cd x-mailx-tmpfile-unlink .
10841 The standard includes the possibility to define any number of additional
10842 entry fields, prefixed by
10844 Flag fields apply to the entire
10846 entry \(em in some unusual cases, this may not be desirable, but
10847 differentiation can be accomplished via separate entries, taking
10848 advantage of the fact that subsequent entries are searched if an earlier
10849 one does not provide enough information.
10852 command needs to specify the
10856 command shall not, the following will help out the latter (with enabled
10860 level \*(UA will show information about handler evaluation):
10862 .Bd -literal -offset indent
10863 application/postscript; ps-to-terminal %s; needsterminal
10864 application/postscript; ps-to-terminal %s; compose=idraw %s
10868 In fields any occurrence of the format string
10870 will be replaced by the
10873 Named parameters from the
10875 field may be placed in the command execution line using
10877 followed by the parameter name and a closing
10880 The entire parameter should appear as a single command line argument,
10881 regardless of embedded spaces; thus:
10883 .Bd -literal -offset indent
10885 Content-type: multipart/mixed; boundary=42
10888 multipart/*; /usr/local/bin/showmulti \e
10889 %t %{boundary} ; composetyped = /usr/local/bin/makemulti
10891 # Executed shell command
10892 /usr/local/bin/showmulti multipart/mixed 42
10896 .\" TODO v15: Mailcap: %n,%F
10897 Note that \*(UA does not support handlers for multipart MIME parts as
10898 shown in this example (as of today).
10899 \*(UA does not support the additional formats
10903 An example file, also showing how to properly deal with the expansion of
10905 which includes any quotes that are necessary to make it a valid shell
10906 argument by itself and thus will cause undesired behaviour when placed
10907 in additional user-provided quotes:
10909 .Bd -literal -offset indent
10911 text/richtext; richtext %s; copiousoutput
10913 text/x-perl; perl -cWT %s
10915 application/pdf; \e
10917 trap "rm -f ${infile}" EXIT\e; \e
10918 trap "exit 75" INT QUIT TERM\e; \e
10920 x-mailx-async; x-mailx-tmpfile-keep
10922 application/*; echo "This is \e"%t\e" but \e
10923 is 50 \e% Greek to me" \e; < %s head -c 1024 | cat -vET; \e
10924 copiousoutput; x-mailx-noquote
10929 .Sx "HTML mail and MIME attachments" ,
10930 .Sx "The mime.types files" ,
10933 .Va mime-counter-evidence ,
10934 .Va pipe-TYPE/SUBTYPE ,
10935 .Va pipe-EXTENSION .
10938 .\" .Ss "The .netrc file" {{{
10939 .Ss "The .netrc file"
10943 file contains user credentials for machine accounts.
10944 The default location in the user's
10946 directory may be overridden by the
10948 environment variable.
10949 The file consists of space, tabulator or newline separated tokens.
10950 \*(UA implements a parser that supports a superset of the original BSD
10951 syntax, but users should nonetheless be aware of portability glitches
10952 of that file format, shall their
10954 be usable across multiple programs and platforms:
10957 .Bl -bullet -compact
10959 BSD does not support single, but only double quotation marks, e.g.,
10960 .Ql password="pass with spaces" .
10962 BSD (only?) supports escaping of single characters via a reverse solidus
10963 (e.g., a space can be escaped via
10965 in- as well as outside of a quoted string.
10967 BSD does not require a final quotation mark of the last user input token.
10969 The original BSD (Berknet) parser also supported a format which allowed
10970 tokens to be separated with commas \(en whereas at least Hewlett-Packard
10971 still seems to support this syntax, \*(UA does not!
10973 As a non-portable extension some widely-used programs support
10974 shell-style comments: if an input line starts, after any amount of
10975 whitespace, with a number sign
10977 then the rest of the line is ignored.
10979 Whereas other programs may require that the
10981 file is accessible by only the user if it contains a
10983 token for any other
10987 \*(UA will always require these strict permissions.
10991 Of the following list of supported tokens \*(UA only uses (and caches)
10996 At runtime the command
10998 can be used to control \*(UA's
11002 .Bl -tag -width ".It Cd BaNg"
11003 .It Cd machine Ar name
11004 The hostname of the entries' machine, lowercase-normalized by \*(UA
11006 Any further file content, until either end-of-file or the occurrence
11011 first-class token is bound (only related) to the machine
11014 As an extension that should not be the cause of any worries
11015 \*(UA supports a single wildcard prefix for
11017 .Bd -literal -offset indent
11018 machine *.example.com login USER password PASS
11019 machine pop3.example.com login USER password PASS
11020 machine smtp.example.com login USER password PASS
11026 .Ql pop3.example.com ,
11030 .Ql local.smtp.example.com .
11031 Note that in the example neither
11032 .Ql pop3.example.com
11034 .Ql smtp.example.com
11035 will be matched by the wildcard, since the exact matches take
11036 precedence (it is however faster to specify it the other way around).
11039 This is the same as
11041 except that it is a fallback entry that is used shall none of the
11042 specified machines match; only one default token may be specified,
11043 and it must be the last first-class token.
11045 .It Cd login Ar name
11046 The user name on the remote machine.
11048 .It Cd password Ar string
11049 The user's password on the remote machine.
11051 .It Cd account Ar string
11052 Supply an additional account password.
11053 This is merely for FTP purposes.
11055 .It Cd macdef Ar name
11057 A macro is defined with the specified
11059 it is formed from all lines beginning with the next line and continuing
11060 until a blank line is (consecutive newline characters are) encountered.
11063 entries cannot be utilized by multiple machines, too, but must be
11064 defined following the
11066 they are intended to be used with.)
11069 exists, it is automatically run as the last step of the login process.
11070 This is merely for FTP purposes.
11077 .\" .Sh EXAMPLES {{{
11080 .\" .Ss "An example configuration" {{{
11081 .Ss "An example configuration"
11083 .Bd -literal -offset indent
11084 # This example assumes v15.0 compatibility mode
11087 # Request strict transport security checks!
11088 set ssl-verify=strict
11090 # Where are the up-to-date SSL certificates?
11091 # (Since we manage up-to-date ones explicitly, do not use any,
11092 # possibly outdated, default certificates shipped with OpenSSL)
11093 #set ssl-ca-dir=/etc/ssl/certs
11094 set ssl-ca-file=/etc/ssl/certs/ca-certificates.crt
11095 set ssl-ca-no-defaults
11096 #set ssl-ca-flags=partial-chain
11097 wysh set smime-ca-file="${ssl-ca-file}" \e
11098 smime-ca-no-defaults #smime-ca-flags="${ssl-ca-flags}"
11100 # Do not use protocols older than TLS v1.2.
11101 # Change this only when the remote server does not support it:
11102 # maybe use ssl-protocol-HOST (or -USER@HOST) syntax to define
11103 # such explicit exceptions, then, e.g.
11104 # set ssl-protocol-exam.ple='-ALL,+TLSv1.1'
11105 set ssl-protocol='-ALL,+TLSv1.2'
11107 # Explicitly define the list of ciphers, which may improve security,
11108 # especially with protocols older than TLS v1.2. See ciphers(1).
11109 # Including "@STRENGTH" will sort the final list by algorithm strength.
11110 # In reality it is possibly best to only use ssl-cipher-list-HOST
11111 # (or -USER@HOST), as necessary, again..
11112 set ssl-cipher-list=TLSv1.2:!aNULL:!eNULL:@STRENGTH
11113 # TLSv1.2:!aNULL:!eNULL:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:\e
11114 DHE-RSA-AES256-SHA:@STRENGTH
11115 # ALL:!aNULL:!eNULL:!MEDIUM:!LOW:!MD5:!RC4:!EXPORT:@STRENGTH
11117 # Essential setting: select allowed character sets
11118 set sendcharsets=utf-8,iso-8859-1
11120 # A very kind option: when replying to a message, first try to
11121 # use the same encoding that the original poster used herself!
11122 set reply-in-same-charset
11124 # When replying to or forwarding a message the comment and name
11125 # parts of email addresses are removed unless this variable is set
11128 # When sending messages, wait until the Mail-Transfer-Agent finishs.
11129 # Only like this you will be able to see errors reported through the
11130 # exit status of the MTA (including the builtin SMTP one)!
11133 # Only use builtin MIME types, no mime.types(5) files
11134 set mimetypes-load-control
11136 # Default directory where we act in (relative to $HOME)
11138 # A leading "+" (often) means: under *folder*
11139 # *record* is used to save copies of sent messages
11140 set MBOX=+mbox.mbox record=+sent.mbox DEAD=+dead.txt
11142 # Make "file mymbox" and "file myrec" go to..
11143 shortcut mymbox %:+mbox.mbox myrec +sent.mbox
11145 # Not really optional, e.g., for S/MIME
11146 set from='Your Name <address@exam.ple>'
11148 # It may be necessary to set hostname and/or smtp-hostname
11149 # if the "SERVER" of mta and "domain" of from do not match.
11150 # The `urlencode' command can be used to encode USER and PASS
11151 set mta=(smtps?|submission)://[USER[:PASS]@]SERVER[:PORT] \e
11152 smtp-auth=login/plain... \e
11155 # Never refuse to start into interactive mode, and more
11157 colour-pager crt= \e
11158 followup-to followup-to-honour=ask-yes \e
11159 history-file=+.\*(uAhist history-size=-1 history-gabby \e
11160 mime-counter-evidence=0xE \e
11161 prompt='?\e?!\e![\e${-account}#\e${-mailbox-display}]? ' \e
11162 reply-to-honour=ask-yes \e
11165 # Only include the selected header fields when typing messages
11166 headerpick type retain add from_ date from to cc subject \e
11167 message-id mail-followup-to reply-to
11168 # ...when forwarding messages
11169 headerpick forward retain add subject date from to cc
11170 # ...when saving message, etc.
11171 #headerpick save ignore add ^Original-.*$ ^X-.*$
11173 # Some mailing lists
11174 mlist '@xyz-editor\e.xyz$' '@xyzf\e.xyz$'
11175 mlsubscribe '^xfans@xfans\e.xyz$'
11177 # A real life example of a very huge free mail provider
11179 set folder=~/spool/XooglX inbox=+syste.mbox sent=+sent
11180 set from='Your Name <address@examp.ple>'
11181 set mta=smtp://USER:PASS@smtp.gmXil.com smtp-use-starttls
11184 # Here is a pretty large one which does not allow sending mails
11185 # if there is a domain name mismatch on the SMTP protocol level,
11186 # which would bite us if the value of from does not match, e.g.,
11187 # for people who have a sXXXXeforge project and want to speak
11188 # with the mailing list under their project account (in from),
11189 # still sending the message through their normal mail provider
11191 set folder=~/spool/XandeX inbox=+syste.mbox sent=+sent
11192 set from='Your Name <address@exam.ple>'
11193 set mta=smtps://USER:PASS@smtp.yaXXex.ru:465 \e
11194 hostname=yaXXex.com smtp-hostname=
11197 # Create some new commands so that, e.g., `ls /tmp' will..
11198 wysh ghost lls '!ls ${LS_COLOR_FLAG} -aFlrS'
11199 wysh ghost llS '!ls ${LS_COLOR_FLAG} -aFlS'
11200 wysh ghost ls '!ls ${LS_COLOR_FLAG} -aFrS'
11201 wysh ghost lS '!ls ${LS_COLOR_FLAG} -aFS'
11202 wysh ghost lla '!ls ${LS_COLOR_FLAG} -aFlr'
11203 wysh ghost llA '!ls ${LS_COLOR_FLAG} -aFl'
11204 wysh ghost la '!ls ${LS_COLOR_FLAG} -aFr'
11205 wysh ghost lA '!ls ${LS_COLOR_FLAG} -aF'
11206 wysh ghost ll '!ls ${LS_COLOR_FLAG} -aFltr'
11207 wysh ghost lL '!ls ${LS_COLOR_FLAG} -aFlt'
11208 wysh ghost l '!ls ${LS_COLOR_FLAG} -aFtr'
11209 wysh ghost L '!ls ${LS_COLOR_FLAG} -aFt'
11211 # We do not support gpg(1) directly yet. But simple --clearsign'd
11212 # message parts can be dealt with as follows:
11215 wysh set pipe-text/plain=$'@*#++=@\e
11216 < "${MAILX_FILENAME_TEMPORARY}" awk \e
11217 -v TMPFILE="${MAILX_FILENAME_TEMPORARY}" \e'\e
11219 /^-----BEGIN PGP SIGNED MESSAGE-----/,/^$/ {\e
11222 print "--- GPG --verify ---";\e
11223 system("gpg --verify " TMPFILE " 2>&1");\e
11224 print "--- GPG --verify ---";\e
11228 /^-----BEGIN PGP SIGNATURE-----/,\e
11229 /^-----END PGP SIGNATURE-----/{\e
11239 !printf 'Key IDs to gpg --recv-keys: ';\e
11241 gpg --recv-keys ${keyids};
11247 When storing passwords in
11249 appropriate permissions should be set on this file with
11250 .Ql $ chmod 0600 \*(ur .
11253 is available user credentials can be stored in the central
11255 file instead; e.g., here is a different version of the example account
11256 that sets up SMTP and POP3:
11258 .Bd -literal -offset indent
11263 set folder=~/spool/XandeX inbox=+syste.mbox sent=+sent
11264 set from='Your Name <address@exam.ple>'
11266 # Load an encrypted ~/.netrc by uncommenting the next line
11267 #set netrc-pipe='gpg -qd ~/.netrc.pgp'
11269 set mta=smtps://smtp.yXXXXx.ru:465 \e
11270 smtp-hostname= hostname=yXXXXx.com
11271 set pop3-keepalive=240 pop3-no-apop-pop.yXXXXx.ru
11272 ghost xp fi pop3s://pop.yXXXXx.ru
11281 .Bd -literal -offset indent
11282 machine *.yXXXXx.ru login USER password PASS
11286 This configuration should now work just fine:
11289 .Dl $ echo text | \*(uA -vv -AXandeX -s Subject user@exam.ple
11292 .\" .Ss "Signed and encrypted messages with S/MIME" {{{
11293 .Ss "Signed and encrypted messages with S/MIME"
11295 \*(OP S/MIME provides two central mechanisms:
11296 message signing and message encryption.
11297 A signed message contains some data in addition to the regular text.
11298 The data can be used to verify that the message was sent using a valid
11299 certificate, that the sender's address in the message header matches
11300 that in the certificate, and that the message text has not been altered.
11301 Signing a message does not change its regular text;
11302 it can be read regardless of whether the recipient's software is able to
11306 It is thus usually possible to sign all outgoing messages if so desired.
11307 Encryption, in contrast, makes the message text invisible for all people
11308 except those who have access to the secret decryption key.
11309 To encrypt a message, the specific recipient's public encryption key
11311 It is therefore not possible to send encrypted mail to people unless their
11312 key has been retrieved from either previous communication or public key
11314 A message should always be signed before it is encrypted.
11315 Otherwise, it is still possible that the encrypted message text is
11319 A central concept to S/MIME is that of the certification authority (CA).
11320 A CA is a trusted institution that issues certificates.
11321 For each of these certificates it can be verified that it really
11322 originates from the CA, provided that the CA's own certificate is
11324 A set of CA certificates is usually delivered with OpenSSL and installed
11326 If you trust the source of your OpenSSL software installation,
11327 this offers reasonable security for S/MIME on the Internet.
11329 .Va smime-ca-no-defaults
11330 to avoid using the default certificate and point
11334 to a trusted pool of certificates.
11335 In general, a certificate cannot be more secure than the method its CA
11336 certificate has been retrieved with.
11339 The first thing you need for participating in S/MIME message exchange is
11340 your personal certificate, including a private key.
11341 The certificate contains public information, in particular your name and
11342 your email address(es), and the public key that is used by others to
11343 encrypt messages for you,
11344 and to verify signed messages they supposedly received from you.
11345 The certificate is included in each signed message you send.
11346 The private key must be kept secret.
11347 It is used to decrypt messages that were previously encrypted with your
11348 public key, and to sign messages.
11351 For personal use it is recommended that you get a S/MIME certificate
11352 from one of the major CAs on the Internet using your WWW browser.
11353 Many CAs offer such certificates for free.
11355 .Lk https://www.CAcert.org
11356 which issues client and server certificates to members of their
11357 community for free; their root certificate
11358 .Pf ( Lk https://\:www.cacert.org/\:certs/\:root.crt )
11359 is often not in the default set of trusted CA root certificates, though,
11360 which means you will have to download their root certificate separately
11361 and ensure it is part of our S/MIME certificate validation chain by
11364 or as a vivid member of the
11365 .Va smime-ca-file .
11366 But let us take a step-by-step tour on how to setup S/MIME with
11367 a certificate from CAcert.org despite this situation!
11370 First of all you will have to become a member of the CAcert.org
11371 community, simply by registrating yourself via the web interface.
11372 Once you are, create and verify all email addresses you want to be able
11373 to create signed and encrypted messages for/with using the corresponding
11374 entries of the web interface.
11375 Now ready to create S/MIME certificates, so let us create a new
11376 .Dq client certificate ,
11377 ensure to include all email addresses that should be covered by the
11378 certificate in the following web form, and also to use your name as the
11382 Create a private key and a certificate request on your local computer
11383 (please see the manual pages of the used commands for more in-depth
11384 knowledge on what the used arguments etc. do):
11387 .Dl openssl req -nodes -newkey rsa:4096 -keyout key.pem -out creq.pem
11390 Afterwards copy-and-paste the content of
11392 into the certificate-request (CSR) field of the web form on the
11393 CAcert.org website (you may need to unfold some
11394 .Dq advanced options
11395 to see the corresponding text field).
11396 This last step will ensure that your private key (which never left your
11397 box) and the certificate belong together (through the public key that
11398 will find its way into the certificate via the certificate-request).
11399 You are now ready and can create your CAcert certified certificate.
11400 Download and store or copy-and-paste it as
11405 In order to use your new S/MIME setup a combined private key/public key
11406 (certificate) file has to be created:
11409 .Dl cat key.pem pub.crt > ME@HERE.com.paired
11412 This is the file \*(UA will work with.
11413 If you have created your private key with a passphrase then \*(UA will
11414 ask you for it whenever a message is signed or decrypted.
11415 Set the following variables to henceforth use S/MIME (setting
11417 is of interest for verification only):
11419 .Bd -literal -offset indent
11420 set smime-ca-file=ALL-TRUSTED-ROOT-CERTS-HERE \e
11421 smime-sign-cert=ME@HERE.com.paired \e
11422 smime-sign-message-digest=SHA256 \e
11427 From each signed message you send, the recipient can fetch your
11428 certificate and use it to send encrypted mail back to you.
11429 Accordingly if somebody sends you a signed message, you can do the same,
11432 command to check the validity of the certificate.
11435 Variables of interest for S/MIME signing:
11437 .Va smime-ca-file ,
11438 .Va smime-ca-flags ,
11439 .Va smime-ca-no-defaults ,
11440 .Va smime-crl-dir ,
11441 .Va smime-crl-file ,
11443 .Va smime-sign-cert ,
11444 .Va smime-sign-include-certs
11446 .Va smime-sign-message-digest .
11449 After it has been verified save the certificate via
11451 and tell \*(UA that it should use it for encryption for further
11452 communication with that somebody:
11454 .Bd -literal -offset indent
11456 set smime-encrypt-USER@HOST=FILENAME \e
11457 smime-cipher-USER@HOST=AES256
11461 Additional variables of interest for S/MIME en- and decryption:
11464 .Va smime-encrypt-USER@HOST .
11467 You should carefully consider if you prefer to store encrypted messages
11469 If you do, anybody who has access to your mail folders can read them,
11470 but if you do not, you might be unable to read them yourself later if
11471 you happen to lose your private key.
11474 command saves messages in decrypted form, while the
11478 commands leave them encrypted.
11481 Note that neither S/MIME signing nor encryption applies to message
11482 subjects or other header fields yet.
11483 Thus they may not contain sensitive information for encrypted messages,
11484 and cannot be trusted even if the message content has been verified.
11485 When sending signed messages,
11486 it is recommended to repeat any important header information in the
11490 .\" .Ss "Using CRLs with S/MIME or SSL/TLS" {{{
11491 .Ss "Using CRLs with S/MIME or SSL/TLS"
11493 \*(OP Certification authorities (CAs) issue certificate revocation
11494 lists (CRLs) on a regular basis.
11495 These lists contain the serial numbers of certificates that have been
11496 declared invalid after they have been issued.
11497 Such usually happens because the private key for the certificate has
11499 because the owner of the certificate has left the organization that is
11500 mentioned in the certificate, etc.
11501 To seriously use S/MIME or SSL/TLS verification,
11502 an up-to-date CRL is required for each trusted CA.
11503 There is otherwise no method to distinguish between valid and
11504 invalidated certificates.
11505 \*(UA currently offers no mechanism to fetch CRLs, nor to access them on
11506 the Internet, so they have to be retrieved by some external mechanism.
11509 \*(UA accepts CRLs in PEM format only;
11510 CRLs in DER format must be converted, like, e.\|g.:
11513 .Dl $ openssl crl \-inform DER \-in crl.der \-out crl.pem
11516 To tell \*(UA about the CRLs, a directory that contains all CRL files
11517 (and no other files) must be created.
11522 variables, respectively, must then be set to point to that directory.
11523 After that, \*(UA requires a CRL to be present for each CA that is used
11524 to verify a certificate.
11527 .\" .Ss "Handling spam" {{{
11528 .Ss "Handling spam"
11530 \*(OP \*(UA can make use of several spam interfaces for the purpose of
11531 identification of, and, in general, dealing with spam messages.
11532 A precondition of most commands in order to function is that the
11534 variable is set to one of the supported interfaces.
11535 Once messages have been identified as spam their (volatile)
11537 state can be prompted: the
11541 message specifications will address respective messages and their
11543 entries will be used when displaying the
11545 in the header display.
11550 rates the given messages and sets their
11553 If the spam interface offers spam scores those can also be displayed in
11554 the header display by including the
11564 will interact with the Bayesian filter of the chosen interface and learn
11565 the given messages as
11569 respectively; the last command can be used to cause
11571 of messages; it adheres to their current
11573 state and thus reverts previous teachings.
11578 will simply set and clear, respectively, the mentioned volatile
11580 message flag, without any interface interaction.
11589 requires a running instance of the
11591 server in order to function, started with the option
11593 shall Bayesian filter learning be possible.
11595 .Bd -literal -offset indent
11596 $ spamd -i localhost:2142 -i /tmp/.spamsock -d [-L] [-l]
11597 $ spamd --listen=localhost:2142 --listen=/tmp/.spamsock \e
11598 --daemonize [--local] [--allow-tell]
11602 Thereafter \*(UA can make use of these interfaces:
11604 .Bd -literal -offset indent
11605 $ \*(uA -Sspam-interface=spamc -Sspam-maxsize=500000 \e
11606 -Sspamc-command=/usr/local/bin/spamc \e
11607 -Sspamc-arguments="-U /tmp/.spamsock" -Sspamc-user=
11609 $ \*(uA -Sspam-interface=spamc -Sspam-maxsize=500000 \e
11610 -Sspamc-command=/usr/local/bin/spamc \e
11611 -Sspamc-arguments="-d localhost -p 2142" -Sspamc-user=
11615 Using the generic filter approach allows usage of programs like
11617 Here is an example, requiring it to be accessible via
11620 .Bd -literal -offset indent
11621 $ \*(uA -Sspam-interface=filter -Sspam-maxsize=500000 \e
11622 -Sspamfilter-ham="bogofilter -n" \e
11623 -Sspamfilter-noham="bogofilter -N" \e
11624 -Sspamfilter-nospam="bogofilter -S" \e
11625 -Sspamfilter-rate="bogofilter -TTu 2>/dev/null" \e
11626 -Sspamfilter-spam="bogofilter -s" \e
11627 -Sspamfilter-rate-scanscore="1;^(.+)$"
11631 Because messages must exist on local storage in order to be scored (or
11632 used for Bayesian filter training), it is possibly a good idea to
11633 perform the local spam check last:
11635 .Bd -literal -offset indent
11636 define spamdelhook {
11638 spamset (header x-dcc-brand-metrics "bulk")
11639 # Server-side spamassassin(1)
11640 spamset (header x-spam-flag "YES")
11641 del :s # TODO we HAVE to be able to do `spamrate :u ! :sS'
11642 move :S +maybe-spam
11645 move :S +maybe-spam
11647 set folder-hook-FOLDER=spamdelhook
11651 See also the documentation for the variables
11652 .Va spam-interface , spam-maxsize ,
11653 .Va spamc-command , spamc-arguments , spamc-user ,
11654 .Va spamfilter-ham , spamfilter-noham , spamfilter-nospam , \
11657 .Va spamfilter-rate-scanscore .
11665 In general it is a good idea to turn on
11671 twice) if something does not work well.
11672 Very often a diagnostic message can be produced that leads to the
11673 problems' solution.
11675 .\" .Ss "\*(UA shortly hangs on startup" {{{
11676 .Ss "\*(UA shortly hangs on startup"
11678 This can have two reasons, one is the necessity to wait for a file lock
11679 and cannot be helped, the other being that \*(UA calls the function
11681 in order to query the nodename of the box (sometimes the real one is
11682 needed instead of the one represented by the internal variable
11684 One may have varying success by ensuring that the real hostname and
11688 or, more generally, that the name service is properly setup \(en
11691 return the expected value?
11692 Does this local hostname has a domain suffix?
11693 RFC 6762 standardized the link-local top-level domain
11695 try again after adding an (additional) entry with this extension.
11698 .\" .Ss "\*(UA exits quick, and output is cleared away" {{{
11699 .Ss "\*(UA exits quick, and output is cleared away"
11701 When this happens even with
11703 set, then this most likely indicates a problem with the creation of
11704 so-called dotlock files: setting
11705 .Va dotlock-ignore-error
11706 should overcome this situation.
11707 This only avoids symptoms, it does not address the problem, though.
11708 Since the output is cleared away \*(UA has support for
11709 .Sx "On terminal control and line editor" ,
11710 and switches to the
11712 which causes the output clearance: by doing
11713 .Ql set termcap='smcup='
11714 this mode can be suppressed, and by setting
11716 (twice) the actual problem should be reported.
11719 .\" .Ss "I cannot login to Google mail aka GMail" {{{
11720 .Ss "I cannot login to Google mail aka GMail"
11722 Since 2014 some free service providers classify programs as
11724 unless they use a special authentification method (OAuth 2.0) which
11725 was not standardized for non-HTTP protocol authentication token query
11726 until August 2015 (RFC 7628).
11729 Different to Kerberos / GSSAPI, which is developed since the mid of the
11730 1980s, where a user can easily create a local authentication ticket for
11731 her- and himself with the locally installed
11733 program, that protocol has no such local part but instead requires
11734 a world-wide-web query to create or fetch a token; since there is no
11735 local cache this query would have to be performed whenever \*(UA is
11736 invoked (in interactive sessions situation may differ).
11739 \*(UA does not support OAuth.
11740 Because of this it is necessary to declare \*(UA a
11741 .Dq less secure app
11742 (on the providers account web page) in order to read and send mail.
11743 However, it also seems possible to take the following steps instead:
11748 give the provider the number of a mobile phone,
11751 .Dq 2-Step Verification ,
11753 create an application specific password (16 characters), and
11755 use that special password instead of the real Google account password in
11756 \*(UA (for more on that see the section
11757 .Sx "On URL syntax and credential lookup" ) .
11761 .\" .Ss "Not \(dqdefunctional\(dq, but the editor key does not work" {{{
11762 .Ss "Not \(dqdefunctional\(dq, but the editor key does not work"
11764 It can happen that the terminal library (see
11765 .Sx "On terminal control and line editor",
11768 reports different codes than the terminal really sends, in which case
11769 \*(UA will tell that a key binding is functional, but will not be able to
11770 recognize it because the received data does not match anything expected.
11775 ings will show the byte sequences that are expected.
11778 To overcome the situation, use, e.g., the program
11780 in conjunction with the command line option
11782 if available, to see the byte sequences which are actually produced
11783 by keypresses, and use the variable
11785 to make \*(UA aware of them.
11786 E.g., the terminal this is typed on produces some false sequences, here
11787 an example showing the shifted home key:
11789 .Bd -literal -offset indent
11792 # 1B 5B=[ 31=1 3B=; 32=2 48=H
11797 ? \*(uA -v -Stermcap='kHOM=\eE[H'
11806 .\" .Sh "SEE ALSO" {{{
11816 .Xr spamassassin 1 ,
11825 .Xr mailwrapper 8 ,
11830 .\" .Sh HISTORY {{{
11833 M. Douglas McIlroy writes in his article
11834 .Dq A Research UNIX Reader: Annotated Excerpts \
11835 from the Programmer's Manual, 1971-1986
11838 command already appeared in First Edition
11842 .Bd -ragged -offset indent
11843 Electronic mail was there from the start.
11844 Never satisfied with its exact behavior, everybody touched it at one
11845 time or another: to assure the safety of simultaneous access, to improve
11846 privacy, to survive crashes, to exploit uucp, to screen out foreign
11847 freeloaders, or whatever.
11848 Not until v7 did the interface change (Thompson).
11849 Later, as mail became global in its reach, Dave Presotto took charge and
11850 brought order to communications with a grab-bag of external networks
11856 Mail was written in 1978 by Kurt Shoens and developed as part of the
11859 distribution until 1995.
11860 Mail has then seen further development in open source
11862 variants, noticeably by Christos Zoulas in
11864 Based upon this Nail, later Heirloom Mailx, was developed by Gunnar
11865 Ritter in the years 2000 until 2008.
11866 Since 2012 S-nail is maintained by Steffen (Daode) Nurpmeso.
11867 This man page is derived from
11868 .Dq The Mail Reference Manual
11869 that was originally written by Kurt Shoens.
11875 .An "Kurt Shoens" ,
11876 .An "Edward Wang" ,
11877 .An "Keith Bostic" ,
11878 .An "Christos Zoulas" ,
11879 .An "Gunnar Ritter" ,
11880 .An "Steffen Nurpmeso" Aq Mt s-nail-users@lists.sourceforge.net
11882 .Mt s-mailx@sdaoden.eu ) .
11885 .\" .Sh CAVEATS {{{
11888 \*(ID Interrupting an operation via
11892 is often problematic: many library functions cannot deal with the
11894 that this software (still) performs.
11897 The SMTP and POP3 protocol support of \*(UA is very basic.
11898 Also, if it fails to contact its upstream SMTP server, it will not make
11899 further attempts to transfer the message at a later time (setting
11904 If this is a concern, it might be better to set up a local SMTP server
11905 that is capable of message queuing.
11911 After deleting some message of a POP3 mailbox the header summary falsely
11912 claims that there are no messages to display, one needs to perform
11913 a scroll or dot movement to restore proper state.
11915 In threaded display a power user may encounter crashes very
11916 occasionally (this is may and very).
11920 in the source repository lists future directions.