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
960 .\" When changing any of the following adjust any RECIPIENTADDRSPEC;
961 .\" grep the latter for the complete picture
965 is set then extended recipient addresses will optionally be accepted:
966 Any name which starts with a vertical bar
968 character specifies a command pipe \(en the command string following the
970 is executed and the message is sent to its standard input;
971 Likewise, any name that starts with the character solidus
973 or the character sequence dot solidus
975 is treated as a file, regardless of the remaining content;
976 likewise a name that solely consists of a hyphen-minus
978 Any other name which contains an at sign
980 character is treated as a network address;
981 Any other name which starts with a plus sign
983 character specifies a mailbox name;
984 Any other name which contains a solidus
986 character but no exclamation mark
990 character before also specifies a mailbox name;
991 What remains is treated as a network address.
993 .Bd -literal -offset indent
994 $ echo bla | \*(uA -Sexpandaddr -s test ./mbox.mbox
995 $ echo bla | \*(uA -Sexpandaddr -s test '|cat >> ./mbox.mbox'
996 $ echo safe | LC_ALL=C \e
997 \*(uA -:/ -Sv15-compat -Ssendwait -Snosave \e
998 -Sexpandaddr=fail,-all,+addr,failinvaddr -s test \e
1003 It is possible to create personal distribution lists via the
1005 command, so that, for instance, the user can send mail to
1007 and have it go to a group of people.
1008 These aliases have nothing in common with the system wide aliases that
1009 may be used by the MTA, which are subject to the
1013 and are often tracked in a file
1019 Personal aliases will be expanded by \*(UA before the message is sent,
1020 and are thus a convenient alternative to specifying each addressee by
1021 itself; they correlate with the active set of
1028 .Dl alias cohorts bill jkf mark kridle@ucbcory ~/mail/cohorts.mbox
1031 To avoid environmental noise scripts should
1033 \*(UA from any configuration files and create a script-local
1034 environment, ideally with the command line options
1036 to disable any configuration file in conjunction with repetitions of
1038 to specify variables:
1040 .Bd -literal -offset indent
1041 $ env LC_ALL=C \*(uA -:/ \e
1042 -Sv15-compat -Ssendwait -Snosave -Sttycharset=utf-8 \e
1043 -Sexpandaddr=fail,-all,failinvaddr \e
1044 -S 'mta=smtps://mylogin@exam.ple:465' -Ssmtp-auth=login \e
1045 -S 'from=scriptreply@exam.ple' \e
1046 -s 'subject' -a attachment_file \e
1047 -. "Recipient 1 <rec1@exam.ple>" rec2@exam.ple \e
1052 As shown, scripts can
1054 a locale environment, the above specifies the all-compatible 7-bit clean
1057 but will nonetheless take and send UTF-8 in the message text by using
1059 In interactive mode, which is introduced in the next section, messages
1060 can be sent by calling the
1062 command with a list of recipient addresses \(em the semantics are
1063 completely identical to non-interactive message sending:
1065 .Bd -literal -offset indent
1066 $ \*(uA -d -Squiet -Semptystart
1067 "/var/spool/mail/user": 0 messages
1068 ? mail "Recipient 1 <rec1@exam.ple>", rec2@exam.ple
1069 ? # Will do the right thing (tm)
1070 ? m rec1@exam.ple rec2@exam.ple
1074 .\" .Ss "On reading mail, and interactive mode" {{{
1075 .Ss "On reading mail, and interactive mode"
1077 When invoked without addressees \*(UA enters interactive mode in which
1079 When used like that the user's system
1083 for an in-depth description of the different mailbox types that exist)
1084 is read in and a one line header of each message therein is displayed.
1085 The visual style of this summary of
1087 can be adjusted through the variable
1089 and the possible sorting criterion via
1095 can be performed with the command
1097 If the initially opened mailbox is empty \*(UA will instead exit
1098 immediately (after displaying a message) unless the variable
1107 will give a listing of all available commands and
1109 will give a summary of some common ones.
1110 If the \*(OPal documentation strings are available one can type
1113 and see the actual expansion of
1115 and what its purpose is, i.e., commands can be abbreviated
1116 (note that POSIX defines some abbreviations, so that the alphabetical
1117 order of commands does not necessarily relate to the abbreviations; it is
1118 possible to define overwrites with the
1121 These commands can also produce a more
1126 Messages are given numbers (starting at 1) which uniquely identify
1127 messages; the current message \(en the
1129 \(en will either be the first new message, or the first unread message,
1130 or the first message of the mailbox; the internal variable
1132 will instead cause usage of the last message for this purpose.
1137 ful of header summaries containing the
1141 will display only the summaries of the given messages, defaulting to the
1145 Message content can be displayed with the command
1152 controls whether and when \*(UA will use the configured
1154 for display instead of directly writing to the user terminal
1156 the sole difference to the command
1158 which will always use the
1162 will instead only show the first
1164 of a message (maybe even compressed if
1169 By default the current message
1171 is displayed, but like with many other commands it is possible to give
1172 a fancy message specification (see
1173 .Sx "Specifying messages" ) ,
1176 will display all unread messages,
1181 will type the messages 1 and 5,
1183 will type the messages 1 through 5, and
1187 will display the last and the next message, respectively.
1190 (a more substantial alias for
1192 will display a header summary of the given message specification list
1193 instead of their content, e.g., the following will search for subjects:
1196 .Dl from "'@Some subject to search for'"
1199 In the default setup all header fields of a message will be
1201 d, but fields can be white- or blacklisted for a variety of
1202 applications by using the command
1204 e.g., to restrict display to a very restricted set:
1205 .Ql Ic \:headerpick Cd \:type retain add Ar \:from to cc subject .
1206 In order to display all header fields of a message regardless of
1207 currently active ignore or retain lists, use the commands
1211 Note that historically the global
1213 not only adjusts the list of displayed headers, but also sets
1217 Dependent upon the configuration a line editor (see the section
1218 .Sx "On terminal control and line editor" )
1219 aims at making user experience with the many
1222 When reading the system
1228 specified a mailbox explicitly prefixed with the special
1230 modifier (propagating the mailbox to a
1232 .Sx "primary system mailbox" ) ,
1233 then messages which have been read will be moved to a
1235 .Sx "secondary mailbox" ,
1238 file, automatically when the mailbox is left, either by changing the
1239 active mailbox or by quitting \*(UA (also see
1240 .Sx "Message states" )
1241 \(en this automatic moving from a system or primary to the secondary
1242 mailbox is not performed when the variable
1247 After examining a message the user can also
1251 to the sender and all recipients or
1253 exclusively to the sender(s).
1254 Messages can also be
1256 ed (shorter alias is
1258 Note that when replying to or forwarding a message recipient addresses
1259 will be stripped from comments and names unless the internal variable
1262 Deletion causes \*(UA to forget about the message;
1263 This is not irreversible, though, one can
1265 the message by giving its number,
1266 or the \*(UA session can be ended by giving the
1271 To end a mail processing session one may either issue
1273 to cause a full program exit, which possibly includes
1274 automatic moving of read messages to
1276 as well as updating the \*(OPal line editor
1280 instead in order to prevent any of these actions.
1283 .\" .Ss "HTML mail and MIME attachments" {{{
1284 .Ss "HTML mail and MIME attachments"
1286 Messages which are HTML-only get more and more common and of course many
1287 messages come bundled with a bouquet of MIME attachments.
1288 Whereas \*(UA \*(OPally supports a simple HTML-to-text converter to deal
1289 with HTML messages (see
1290 .Sx "The mime.types files" ) ,
1291 it normally cannot deal with any of these itself, but instead programs
1292 need to become registered to deal with specific MIME types or file
1294 These programs may either prepare plain text versions of their input
1295 in order to enable \*(UA to display the content on the terminal,
1296 or display the content themselves, for example in a graphical window.
1299 To install an external handler program for a specific MIME type set an
1301 .Va pipe-TYPE/SUBTYPE
1302 variable; to instead define a handler for a specific file extension set
1305 variable \(en these handlers take precedence.
1306 \*(OPally \*(UA supports mail user agent configuration as defined in
1307 RFC 1524; this mechanism, documented in the section
1308 .Sx "The Mailcap files" ,
1309 will be queried for display or quote handlers if none of the former two
1310 .\" TODO v15-compat "will be" -> "is"
1311 did; it will be the sole source for handlers of other purpose.
1312 A last source for handlers may be the MIME type definition itself, if
1313 the \*(UA specific type-marker extension was used when defining the type
1316 (Many of the builtin MIME types do so by default.)
1320 .Va mime-counter-evidence
1321 can be set to improve dealing with faulty MIME part declarations as are
1322 often seen in real-life messages.
1323 E.g., to display a HTML message inline (that is, converted to a more
1324 fancy plain text representation than the builtin converter is capable to
1325 produce) with either of the text-mode browsers
1329 teach \*(UA about MathML documents and make it display them as plain
1330 text, and to open PDF attachments in an external PDF viewer,
1331 asynchronously and with some other magic attached:
1333 .Bd -literal -offset indent
1334 if [ "$features" !@ +filter-html-tagsoup ]
1335 #set pipe-text/html='elinks -force-html -dump 1'
1336 set pipe-text/html='lynx -stdin -dump -force_html'
1337 # Display HTML as plain text instead
1338 #set pipe-text/html=@
1340 mimetype '@ application/mathml+xml mathml'
1341 wysh set pipe-application/pdf='@&=@ \e
1342 trap "rm -f \e"${MAILX_FILENAME_TEMPORARY}\e"" EXIT;\e
1343 trap "trap \e"\e" INT QUIT TERM; exit 1" INT QUIT TERM;\e
1344 mupdf "${MAILX_FILENAME_TEMPORARY}"'
1348 Note: special care must be taken when using such commands as mail
1349 viruses may be distributed by this method: if messages of type
1350 .Ql application/x-sh
1351 or files with the extension
1353 were blindly filtered through the shell, for example, a message sender
1354 could easily execute arbitrary code on the system \*(UA is running on.
1355 For more on MIME, also in respect to sending of messages, see the
1357 .Sx "The mime.types files" ,
1358 .Sx "The Mailcap files"
1363 .\" .Ss "Mailing lists" {{{
1366 \*(UA offers some support to ease handling of mailing lists.
1369 promotes all given arguments to known mailing lists, and
1371 sets their subscription attribute, creating them first as necessary.
1376 automatically, but only resets the subscription attribute.)
1377 Using the commands without arguments will show (a subset of) all
1378 currently defined mailing lists.
1383 can be used to mark out messages with configured list addresses
1384 in the header display.
1387 \*(OPally mailing lists may also be specified as (extended) regular
1388 expressions, which allows matching of many addresses with a single
1390 However, all fully qualified list addresses are matched via a fast
1391 dictionary, whereas expressions are placed in (a) list(s) which is
1392 (are) matched sequentially.
1394 .Bd -literal -offset indent
1395 set followup-to followup-to-honour=ask-yes reply-to-honour=ask-yes
1396 wysh mlist a1@b1.c1 a2@b2.c2 '.*@lists\e.c3$'
1397 mlsubscribe a4@b4.c4 exact@lists.c3
1402 .Va followup-to-honour
1404 .Ql Mail-\:Followup-\:To:
1405 header is honoured when the message is being replied to (via
1411 controls whether this header is created when sending mails; it will be
1412 created automatically for a couple of reasons, too, like when the
1414 .Dq mailing list specific
1419 is used to respond to a message with its
1420 .Ql Mail-Followup-To:
1424 A difference in between the handling of known and subscribed lists is
1425 that the address of the sender is usually not part of a generated
1426 .Ql Mail-Followup-To:
1427 when addressing the latter, whereas it is for the former kind of lists.
1428 Usually because there are exceptions: say, if multiple lists are
1429 addressed and not all of them are subscribed lists.
1431 For convenience \*(UA will, temporarily, automatically add a list
1432 address that is presented in the
1434 header of a message that is being responded to to the list of known
1436 Shall that header have existed \*(UA will instead, dependent on the
1438 .Va reply-to-honour ,
1441 for this purpose in order to accept a list administrators' wish that
1442 is supposed to have been manifested like that (but only if it provides
1443 a single address which resides on the same domain as what is stated in
1447 .\" .Ss "Resource files" {{{
1448 .Ss "Resource files"
1450 Upon startup \*(UA reads in several resource files:
1452 .Bl -tag -width ".It Pa BaNg"
1455 System wide initialization file.
1456 Reading of this file can be suppressed, either by using the
1458 (and according argument) or
1460 command line options, or by setting the
1463 .Ev MAILX_NO_SYSTEM_RC .
1467 File giving initial commands.
1468 A different file can be chosen by setting the
1472 Reading of this file can be suppressed with the
1474 command line option.
1476 .It Va mailx-extra-rc
1477 Can be used to define an optional startup file to be read after all
1478 other resource files.
1479 It can be used to specify settings that are not understood by other
1481 implementations, for example.
1482 This variable is only honoured when defined in a resource file, e.g.,
1484 .Sx "INTERNAL VARIABLES" .
1488 The content of these files is interpreted as follows:
1491 .Bl -bullet -compact
1493 A lines' leading whitespace is removed.
1495 Empty lines are ignored.
1497 Any other line is interpreted as a command.
1498 It may be spread over multiple input lines if the newline character is
1500 by placing a reverse solidus character
1502 as the last character of the line; whereas any leading whitespace of
1503 follow lines is ignored, trailing whitespace before a escaped newline
1504 remains in the input.
1506 If the line (content) starts with the number sign
1508 then it is a comment-command \(en a real command! \(en and also ignored.
1509 This command is the only form of comment that is understood.
1513 Unless \*(UA is about to enter interactive mode syntax errors that occur
1514 while loading these files are treated as errors and cause program exit.
1515 More files with syntactically equal content can be
1517 The following, saved in a file, would be an examplary content:
1519 .Bd -literal -offset indent
1520 # This line is a comment command. And y\e
1521 es, it is really continued here.
1528 .\" .Ss "Character sets" {{{
1529 .Ss "Character sets"
1531 \*(OP \*(UA detects the character set of the terminal by using
1532 mechanisms that are controlled by the
1537 should give an overview); the \*(UA internal variable
1539 will be set to the detected terminal character set accordingly
1540 and will thus show up in the output of the commands
1546 However, a user supplied
1548 value is not overwritten by this detection mechanism: this
1550 must be used if the detection does not work properly,
1551 and it may be used to adjust the name of the locale character set.
1552 E.g., on BSD systems one may use a locale with the character set
1553 ISO8859-1, which is not a valid name for this character set; to be on
1554 the safe side, one may set
1556 to the correct name, which is ISO-8859-1.
1559 Note that changing the value does not mean much beside that,
1560 since several aspects of the real character set are implied by the
1561 locale environment of the system,
1562 and that stays unaffected by the content of an overwritten
1565 (This is mostly an issue when interactively using \*(UA, though.
1566 It is actually possible to send mail in a completely
1568 locale environment, an option that \*(UA's test-suite uses excessively.)
1571 If no character set conversion capabilities have been compiled into
1574 does not include the term
1578 will be the only supported character set,
1579 it is simply assumed that it can be used to exchange 8-bit messages
1580 (over the wire an intermediate
1581 .Pf content-transfer-\: Va encoding
1583 and the rest of this section does not apply;
1584 it may however still be necessary to explicitly set it if automatic
1585 detection fails, since in that case it defaults to the mentioned
1586 .\" (Keep in SYNC: ./nail.1:"Character sets", ./nail.h:CHARSET_*!)
1590 When reading messages, their text is converted into
1592 as necessary in order to display them on the users terminal.
1593 Unprintable characters and invalid byte sequences are detected
1594 and replaced by proper substitution characters (unless the variable
1596 was set once \*(UA was started).
1598 .Va charset-unknown-8bit
1599 to deal with another hairy aspect of message interpretation.
1602 When sending messages all their parts and attachments are classified.
1603 Whereas no character set conversion is performed on those parts which
1604 appear to be binary data,
1605 the character set being used must be declared within the MIME header of
1606 an outgoing text part if it contains characters that do not conform to
1607 the set of characters that are allowed by the email standards.
1608 Permissible values for character sets can be declared using the
1612 which defines a catch-all last-resort fallback character set that is
1613 implicitly appended to the list of character-sets in
1617 When replying to a message and the variable
1618 .Va reply-in-same-charset
1619 is set then the character set of the message being replied to is tried
1621 And it is also possible to make \*(UA work even more closely related to
1622 the current locale setting automatically by using the variable
1623 .Va sendcharsets-else-ttycharset ,
1624 please see there for more information.
1627 All the specified character sets are tried in order unless the
1628 conversion of the part or attachment succeeds.
1629 If none of the tried (8-bit) character sets is capable to represent the
1630 content of the part or attachment,
1631 then the message will not be sent and its text will optionally be
1635 In general, if the message
1636 .Dq Cannot convert from a to b
1637 appears, either some characters are not appropriate for the currently
1638 selected (terminal) character set,
1639 or the needed conversion is not supported by the system.
1640 In the first case, it is necessary to set an appropriate
1642 locale and/or the variable
1646 The best results are usually achieved when \*(UA is run in a UTF-8
1647 locale on a UTF-8 capable terminal, in which case the full Unicode
1648 spectrum of characters is available.
1649 In this setup characters from various countries can be displayed,
1650 while it is still possible to use more simple character sets for sending
1651 to retain maximum compatibility with older mail clients.
1654 On the other hand the POSIX standard defines a locale-independent 7-bit
1655 .Dq portable character set
1656 that should be used when overall portability is an issue, the even more
1657 restricted subset named
1658 .Dq portable filename character set
1659 consisting of A-Z, a-z, 0-9, period
1667 .\" .Ss "Message states" {{{
1668 .Ss "Message states"
1670 \*(UA differentiates in between several different message states;
1671 the current state will be reflected in header summary displays if
1673 is configured to do so (via the internal variable
1675 and messages can also be selected and be acted upon depending on their
1677 .Sx "Specifying messages" ) .
1678 When operating on the system
1682 .Sx "primary system mailbox" ,
1683 special actions, like the automatic moving of messages to the
1685 .Sx "secondary mailbox"
1687 may be applied when the mailbox is left (also implicitly via
1688 a successful exit of \*(UA, but not if the special command
1690 is used) \(en however, because this may be irritating to users which
1693 mail-user-agents, the default global
1699 variables in order to suppress this behaviour.
1701 .Bl -hang -width ".It Ql new"
1703 Message has neither been viewed nor moved to any other state.
1704 Such messages are retained even in the
1706 .Sx "primary system mailbox" .
1709 Message has neither been viewed nor moved to any other state, but the
1710 message was present already when the mailbox has been opened last:
1711 Such messages are retained even in the
1713 .Sx "primary system mailbox" .
1716 The message has been processed by one of the following commands:
1735 will always try to automatically
1741 logical message, and may thus mark multiple messages as read, the
1743 command will do so if the internal variable
1748 command is used, messages that are in a
1750 .Sx "primary system mailbox"
1753 state when the mailbox is left will be saved in
1755 unless the internal variable
1760 The message has been processed by one of the following commands:
1766 can be used to access such messages.
1769 The message has been processed by a
1771 command and it will be retained in its current location.
1774 The message has been processed by one of the following commands:
1780 command is used, messages that are in a
1782 .Sx "primary system mailbox"
1785 state when the mailbox is left will be deleted; they will be saved in
1787 when the internal variable
1793 In addition to these message states, flags which otherwise have no
1794 technical meaning in the mail system except allowing special ways of
1795 addressing them when
1796 .Sx "Specifying messages"
1797 can be set on messages.
1798 These flags are saved with messages and are thus persistent, and are
1799 portable between a set of widely used MUAs.
1801 .Bl -hang -width ".It Ic answered"
1803 Mark messages as having been answered.
1805 Mark messages as being a draft.
1807 Mark messages which need special attention.
1811 .\" .Ss "Specifying messages" {{{
1812 .Ss "Specifying messages"
1819 can be given a list of message numbers as arguments to apply to a number
1820 of messages at once.
1823 deletes messages 1 and 2,
1826 will delete the messages 1 through 5.
1827 In sorted or threaded mode (see the
1831 will delete the messages that are located between (and including)
1832 messages 1 through 5 in the sorted/threaded order, as shown in the
1835 The following special message names exist:
1838 .Bl -tag -width ".It Ar BaNg"
1840 The current message, the so-called
1844 The message that was previously the current message.
1847 The parent message of the current message,
1848 that is the message with the Message-ID given in the
1850 field or the last entry of the
1852 field of the current message.
1855 The next previous undeleted message,
1856 or the next previous deleted message for the
1859 In sorted/threaded mode,
1860 the next previous such message in the sorted/threaded order.
1863 The next undeleted message,
1864 or the next deleted message for the
1867 In sorted/threaded mode,
1868 the next such message in the sorted/threaded order.
1871 The first undeleted message,
1872 or the first deleted message for the
1875 In sorted/threaded mode,
1876 the first such message in the sorted/threaded order.
1880 In sorted/threaded mode,
1881 the last message in the sorted/threaded order.
1885 selects the message addressed with
1889 is any other message specification,
1890 and all messages from the thread that begins at it.
1891 Otherwise it is identical to
1896 the thread beginning with the current message is selected.
1901 All messages that were included in the
1902 .Sx "Message list arguments"
1903 of the previous command.
1906 An inclusive range of message numbers.
1907 Selectors that may also be used as endpoints include any of
1912 .Dq any substring matches
1915 header, which will match addresses (too) even if
1917 is set (and POSIX says
1918 .Dq any address as shown in a header summary shall be matchable in this form ) ;
1921 variable is set, only the local part of the address is evaluated
1922 for the comparison, not ignoring case, and the setting of
1924 is completely ignored.
1925 For finer control and match boundaries use the
1929 .It Ar / Ns Ar string
1930 All messages that contain
1932 in the subject field (case ignored).
1939 the string from the previous specification of that type is used again.
1941 .It Xo Op Ar @ Ns Ar name-list Ns
1944 All messages that contain the given case-insensitive search
1946 ession; if the \*(OPal regular expression (see
1948 support is available
1950 will be interpreted as (an extended) one if any of the
1952 (extended) regular expression characters is seen: in this case this
1953 should match strings correctly which are in the locale
1957 .Ar @ Ns Ar name-list
1958 part is missing, the search is restricted to the subject field body,
1961 specifies a comma-separated list of header fields to search, as in
1963 .Dl '@to,from,cc@Someone i ought to know'
1965 In order to search for a string that includes a
1967 (commercial at) character the
1969 is effectively non-optional, but may be given as the empty string.
1970 Some special header fields may be abbreviated:
1984 respectively and case-insensitively.
1989 can be used to search in (all of) the header(s) of the message, and the
1998 can be used to perform full text searches \(en whereas the former
1999 searches only the body, the latter also searches the message header.
2001 This message specification performs full text comparison, but even with
2002 regular expression support it is almost impossible to write a search
2003 expression that savely matches only a specific address domain.
2004 To request that the content of the header is treated as a list of
2005 addresses, and to strip those down to the plain email address which the
2006 search expression is to be matched against, prefix the header name
2007 (abbreviation) with a tilde
2010 .Dl @~f@@a\e.safe\e.domain\e.match$
2013 All messages of state
2017 is one or multiple of the following colon modifiers:
2019 .Bl -tag -compact -width ".It Ar :M"
2024 Old messages (any not in state
2046 messages (cf. the variable
2047 .Va markanswered ) .
2052 \*(OP Messages classified as spam (see
2053 .Sx "Handling spam" . )
2055 \*(OP Messages with unsure spam classification.
2061 \*(OP IMAP-style SEARCH expressions may also be used.
2062 This addressing mode is available with all types of folders;
2063 \*(UA will perform the search locally as necessary.
2064 Strings must be enclosed by double quotes
2066 in their entirety if they contain white space or parentheses;
2067 within the quotes, only reverse solidus
2069 is recognized as an escape character.
2070 All string searches are case-insensitive.
2071 When the description indicates that the
2073 representation of an address field is used,
2074 this means that the search string is checked against both a list
2077 .Bd -literal -offset indent
2078 (\*qname\*q \*qsource\*q \*qlocal-part\*q \*qdomain-part\*q)
2083 and the addresses without real names from the respective header field.
2084 These search expressions can be nested using parentheses, see below for
2088 .Bl -tag -compact -width ".It Ar _n_u"
2089 .It Ar ( criterion )
2090 All messages that satisfy the given
2092 .It Ar ( criterion1 criterion2 ... criterionN )
2093 All messages that satisfy all of the given criteria.
2095 .It Ar ( or criterion1 criterion2 )
2096 All messages that satisfy either
2101 To connect more than two criteria using
2103 specifications have to be nested using additional parentheses,
2105 .Ql (or a (or b c)) ,
2109 .Ql ((a or b) and c) .
2112 operation of independent criteria on the lowest nesting level,
2113 it is possible to achieve similar effects by using three separate
2117 .It Ar ( not criterion )
2118 All messages that do not satisfy
2120 .It Ar ( bcc \*q Ns Ar string Ns Ar \*q )
2121 All messages that contain
2123 in the envelope representation of the
2126 .It Ar ( cc \*q Ns Ar string Ns Ar \*q )
2127 All messages that contain
2129 in the envelope representation of the
2132 .It Ar ( from \*q Ns Ar string Ns Ar \*q )
2133 All messages that contain
2135 in the envelope representation of the
2138 .It Ar ( subject \*q Ns Ar string Ns Ar \*q )
2139 All messages that contain
2144 .It Ar ( to \*q Ns Ar string Ns Ar \*q )
2145 All messages that contain
2147 in the envelope representation of the
2150 .It Ar ( header name \*q Ns Ar string Ns Ar \*q )
2151 All messages that contain
2156 .It Ar ( body \*q Ns Ar string Ns Ar \*q )
2157 All messages that contain
2160 .It Ar ( text \*q Ns Ar string Ns Ar \*q )
2161 All messages that contain
2163 in their header or body.
2164 .It Ar ( larger size )
2165 All messages that are larger than
2168 .It Ar ( smaller size )
2169 All messages that are smaller than
2173 .It Ar ( before date )
2174 All messages that were received before
2176 which must be in the form
2180 denotes the day of the month as one or two digits,
2182 is the name of the month \(en one of
2183 .Ql Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec ,
2186 is the year as four digits, e.g.,
2190 All messages that were received on the specified date.
2191 .It Ar ( since date )
2192 All messages that were received since the specified date.
2193 .It Ar ( sentbefore date )
2194 All messages that were sent on the specified date.
2195 .It Ar ( senton date )
2196 All messages that were sent on the specified date.
2197 .It Ar ( sentsince date )
2198 All messages that were sent since the specified date.
2200 The same criterion as for the previous search.
2201 This specification cannot be used as part of another criterion.
2202 If the previous command line contained more than one independent
2203 criterion then the last of those criteria is used.
2207 .\" .Ss "On URL syntax and credential lookup" {{{
2208 .Ss "On URL syntax and credential lookup"
2210 \*(IN For accessing protocol-specific resources usage of Uniform
2211 Resource Locators (URL, RFC 1738) has become omnipresent.
2212 \*(UA expects and understands URLs in the following form;
2215 denote optional parts, optional either because there also exist other
2216 ways to define the information in question or because support of the
2217 part is protocol-specific (e.g.,
2219 is used by the IMAP protocol but not by POP3);
2224 are specified they must be given in URL percent encoded form (RFC 3986;
2230 .Dl PROTOCOL://[USER[:PASSWORD]@]server[:port][/path]
2233 Note that these \*(UA URLs most often do not conform to any real
2234 standard, but instead represent a normalized variant of RFC 1738 \(en
2235 they are not used in data exchange but only meant as a compact,
2236 easy-to-use way of defining and representing information in
2237 a well-known notation.
2240 Many internal variables of \*(UA exist in multiple versions, called
2241 variable chains for the rest of this document: the plain
2246 .Ql variable-USER@HOST .
2253 had been specified in the respective URL, otherwise it refers to the plain
2259 that had been found when doing the user chain lookup as is described
2262 will never be in URL percent encoded form, whether it came from an URL
2263 or not; i.e., variable chain name extensions of
2264 .Sx "INTERNAL VARIABLES"
2265 must not be URL percent encoded.
2268 For example, whether an hypothetical URL
2269 .Ql smtp://hey%3Ayou@our.house
2270 had been given that includes a user, or whether the URL was
2271 .Ql smtp://our.house
2272 and the user had been found differently, to lookup the variable chain
2273 .Va smtp-use-starttls
2274 \*(UA first looks for whether
2275 .Ql smtp-\:use-\:starttls-\:hey:you@our.house
2276 is defined, then whether
2277 .Ql smtp-\:use-\:starttls-\:our.house
2278 exists before finally ending up looking at the plain variable itself.
2281 \*(UA obeys the following logic scheme when dealing with the
2282 necessary credential information of an account:
2288 has been given in the URL the variables
2292 are looked up; if no such variable(s) can be found then \*(UA will,
2293 when enforced by the \*(OPal variables
2294 .Va netrc-lookup-HOST
2301 specific entry which provides a
2303 name: this lookup will only succeed if unambiguous (one possible matching
2306 It is possible to load encrypted
2311 If there is still no
2313 then \*(UA will fall back to the user who is supposed to run \*(UA,
2314 the identity of which has been fixated during \*(UA startup and is
2315 known to be a valid user on the current host.
2318 Authentication: unless otherwise noted this will lookup the
2319 .Va PROTOCOL-auth-USER@HOST , PROTOCOL-auth-HOST , PROTOCOL-auth
2320 variable chain, falling back to a protocol-specific default should this
2326 has been given in the URL, then if the
2328 has been found through the \*(OPal
2330 that may have already provided the password, too.
2331 Otherwise the variable chain
2332 .Va password-USER@HOST , password-HOST , password
2333 is looked up and used if existent.
2335 Afterwards the complete \*(OPal variable chain
2336 .Va netrc-lookup-USER@HOST , netrc-lookup-HOST , netrc-lookup
2340 cache is searched for a password only (multiple user accounts for
2341 a single machine may exist as well as a fallback entry without user
2342 but with a password).
2344 If at that point there is still no password available, but the
2345 (protocols') chosen authentication type requires a password, then in
2346 interactive mode the user will be prompted on the terminal.
2351 S/MIME verification works relative to the values found in the
2355 header field(s), which means that the values of
2356 .Va smime-sign , smime-sign-cert , smime-sign-include-certs
2358 .Va smime-sign-message-digest
2359 will not be looked up using the
2363 chains from above but instead use the corresponding values from the
2364 message that is being worked on.
2365 In unusual cases multiple and different
2369 combinations may therefore be involved \(en on the other hand those
2370 unusual cases become possible.
2371 The usual case is as short as:
2374 .Dl set mta=smtp://USER:PASS@HOST smtp-use-starttls \e
2375 .Dl \ \ \ \ smime-sign smime-sign-cert=+smime.pair
2380 contains complete example configurations.
2383 .\" .Ss "On terminal control and line editor" {{{
2384 .Ss "On terminal control and line editor"
2386 \*(OP Terminal control will be realized through one of the standard
2388 libraries, either the
2390 or, alternatively, the
2392 both of which will be initialized to work with the environment variable
2394 Terminal control will enhance or enable interactive usage aspects, e.g.,
2395 .Sx "Coloured display" ,
2396 and extend behaviour of the Mailx-Line-Editor (MLE), which may learn the
2397 byte-sequences of keys like the cursor and function keys, and which will
2398 automatically enter the so-called
2400 alternative screen shall the terminal support it.
2401 The internal variable
2403 can be used to overwrite settings or to learn (correct(ed)) keycodes.
2404 Actual interaction with the chosen library can be disabled completely by
2405 setting the internal variable
2406 .Va termcap-disable ;
2408 will be queried regardless, even if the \*(OPal support for the
2409 libraries has not been enabled at configuration time.
2412 \*(OP The builtin \*(UA Mailx-Line-Editor (MLE) should work in all
2413 environments which comply to the ISO C standard
2415 and will support wide glyphs if possible (the necessary functionality
2416 had been removed from ISO C, but was included in
2418 Prevent usage of a line editor in interactive mode by setting the
2420 .Va line-editor-disable .
2421 Especially if the \*(OPal terminal control support is missing setting
2422 entries in the internal variable
2424 will help shall the MLE misbehave, see there for more.
2425 The MLE can support a little bit of
2431 feature is available then input from line editor prompts will be saved
2432 in a history list that can be searched in and be expanded from.
2433 Such saving can be prevented by prefixing input with any amount of
2435 Aspects of history, like allowed content and maximum size, as well as
2436 whether history shall be saved persistently, can be configured with the
2440 .Va history-gabby-persist
2445 The MLE supports a set of editing and control commands.
2446 By default (as) many (as possible) of these will be assigned to a set of
2447 single-letter control codes, which should work on any terminal (and can
2448 be generated by holding the
2450 key while pressing the key of desire, e.g.,
2454 command is available then the MLE commands can also be accessed freely
2455 by assigning the command name, which is shown in parenthesis in the list
2456 below, to any desired key-sequence, and the MLE will instead and also use
2458 to establish its builtin key bindings
2459 (more of them if the \*(OPal terminal control is available),
2460 an action which can then be suppressed completely by setting
2461 .Va line-editor-no-defaults .
2462 .Sx "Shell-style argument quoting"
2463 notation is used in the following;
2464 combinations not mentioned either cause job control signals or do not
2465 generate a (unique) keycode:
2469 .Bl -tag -compact -width ".It Ql Ba"
2471 Go to the start of the line
2472 .Pf ( Cd mle-go-home ) .
2475 Move the cursor backward one character
2476 .Pf ( Cd mle-go-bwd ) .
2479 Forward delete the character under the cursor;
2480 quits \*(UA if used on the empty line unless the internal variable
2483 .Pf ( Cd mle-del-fwd ) .
2486 Go to the end of the line
2487 .Pf ( Cd mle-go-end ) .
2490 Move the cursor forward one character
2491 .Pf ( Cd mle-go-fwd ) .
2494 Cancel current operation, full reset.
2495 If there is an active history search or tabulator expansion then this
2496 command will first reset that, reverting to the former line content;
2497 thus a second reset is needed for a full reset in this case
2498 .Pf ( Cd mle-reset ) .
2501 Backspace: backward delete one character
2502 .Pf ( Cd mle-del-bwd ) .
2506 Horizontal tabulator:
2507 try to expand the word before the cursor, supporting the usual
2508 .Sx "Filename transformations"
2509 .Pf ( Cd mle-complete ) .
2511 .Cd mle-quote-rndtrip .
2515 commit the current line
2516 .Pf ( Cd mle-commit ) .
2519 Cut all characters from the cursor to the end of the line
2520 .Pf ( Cd mle-snarf-end ) .
2524 .Pf ( Cd mle-repaint ) .
2527 \*(OP Go to the next history entry
2528 .Pf ( Cd mle-hist-fwd ) .
2531 (\*(OPally context-dependent) Invokes the command
2535 \*(OP Go to the previous history entry
2536 .Pf ( Cd mle-hist-bwd ) .
2539 Toggle roundtrip mode shell quotes, where produced,
2541 .Pf ( Cd mle-quote-rndtrip ) .
2542 This setting is temporary, and will be forgotten once the command line
2546 \*(OP Complete the current line from (the remaining) older history entries
2547 .Pf ( Cd mle-hist-srch-bwd ) .
2550 \*(OP Complete the current line from (the remaining) newer history entries
2551 .Pf ( Cd mle-hist-srch-fwd ) .
2554 Paste the snarf buffer
2555 .Pf ( Cd mle-paste ) .
2562 .Pf ( Cd mle-snarf-line ) .
2565 Prompts for a Unicode character (its hexadecimal number) to be inserted
2566 .Pf ( Cd mle-prompt-char ) .
2567 Note this command needs to be assigned to a single-letter control code
2568 in order to become recognized and executed during input of
2569 a key-sequence (only three single-letter control codes can be used for
2570 that shortcut purpose); this control code is special-treated and cannot
2571 be part of any other sequence, because any occurrence will perform the
2573 function immediately.
2576 Cut the characters from the one preceding the cursor to the preceding
2578 .Pf ( Cd mle-snarf-word-bwd ) .
2581 Move the cursor forward one word boundary
2582 .Pf ( Cd mle-go-word-fwd ) .
2585 Move the cursor backward one word boundary
2586 .Pf ( Cd mle-go-word-bwd ) .
2589 Escape: reset a possibly used multibyte character input state machine
2590 and \*(OPally a lingering, incomplete key binding
2591 .Pf ( Cd mle-cancel ) .
2592 This command needs to be assigned to a single-letter control code in
2593 order to become recognized and executed during input of a key-sequence
2594 (only three single-letter control codes can be used for that shortcut
2596 This control code may also be part of a multi-byte sequence, but if
2597 a sequence is active and the very control code is currently also an
2598 expected input, then it will first be consumed by the active sequence.
2601 (\*(OPally context-dependent) Invokes the command
2605 (\*(OPally context-dependent) Invokes the command
2609 (\*(OPally context-dependent) Invokes the command
2613 Cut the characters from the one after the cursor to the succeeding word
2615 .Pf ( Cd mle-snarf-word-fwd ) .
2625 this will immediately reset a possibly active search etc.
2629 ring the audible bell.
2633 .\" .Ss "Coloured display" {{{
2634 .Ss "Coloured display"
2636 \*(OP \*(UA can be configured to support a coloured display and font
2637 attributes by emitting ANSI / ISO 6429 SGR (select graphic rendition)
2639 Usage of colours and font attributes solely depends upon the
2640 capability of the detected terminal type that is defined by the
2641 environment variable
2643 and which can be fine-tuned by the user via the internal variable
2647 On top of what \*(UA knows about the terminal the boolean variable
2649 defines whether the actually applicable colour and font attribute
2650 sequences should also be generated when output is going to be paged
2651 through the external program defined by the environment variable
2656 This is not enabled by default because different pager programs need
2657 different command line switches or other configuration in order to
2658 support those sequences.
2659 \*(UA however knows about some widely used pagers and in a clean
2660 environment it is often enough to simply set
2662 please refer to that variable for more on this topic.
2667 is set then any active usage of colour and font attribute sequences
2668 is suppressed, but without affecting possibly established
2673 To define and control colours and font attributes a single multiplexer
2674 command family exists:
2676 shows or defines colour mappings for the given colour type (e.g.,
2679 can be used to remove mappings of a given colour type.
2680 Since colours are only available in interactive mode, it may make
2681 sense to conditionalize the colour setup by encapsulating it with
2684 .Bd -literal -offset indent
2685 if terminal && $features =@ +colour
2686 colour iso view-msginfo ft=bold,fg=green
2687 colour iso view-header ft=bold,fg=red "from,subject"
2688 colour iso view-header fg=red
2690 uncolour iso view-header from,subject
2691 colour iso view-header ft=bold,fg=magenta,bg=cyan
2692 colour 256 view-header ft=bold,fg=208,bg=230 subject,from
2693 colour mono view-header ft=bold
2694 colour mono view-header ft=bold,ft=reverse subject,from
2698 .\" }}} (DESCRIPTION)
2701 .\" .Sh COMMANDS {{{
2704 Each command is typed on a line by itself,
2705 and may take arguments following the command word.
2706 An unquoted reverse solidus
2708 at the end of a command line
2710 the newline character: it is discarded and the next line of input is
2711 used as a follow-up line, with all leading whitespace removed;
2712 once the entire command line is completed, the processing that is
2713 documented in the following begins.
2716 Command names may be abbreviated, in which case the first command that
2717 matches the given prefix will be used.
2720 can be used to show the list of all commands, either alphabetically
2721 sorted or in prefix search order (these do not match, also because the
2722 POSIX standard prescribes a set of abbreviations).
2723 \*(OPally the command
2727 when given an argument, will show a documentation string for the
2728 command matching the expanded argument, as in
2730 which should be a shorthand of
2732 Both commands support a more
2734 listing mode which includes the argument type of the command,
2735 and other information which applies; a handy suggestion might be:
2737 .Bd -literal -offset indent
2739 # Be careful to choose sh(1)ell-style on _entire_ line!
2740 # Result status ends up in $!
2741 localopts 1;wysh set verbose;ignerr eval "${@}";return ${?}
2743 ? ghost xv '\ecall __xv'
2747 .\" .Ss "Command modifiers" {{{
2748 .Ss "Command modifiers"
2750 Commands may be prefixed by one or multiple command modifiers.
2755 The modifier reverse solidus
2758 to be placed first, prevents
2760 expansions on the remains of the line, e.g.,
2762 will always evaluate the command
2764 even if a ghost of the same name exists.
2766 content may itself contain further command modifiers, including
2767 an initial reverse solidus to prevent further expansions.
2773 indicates that any error generated by the following command should be
2774 ignored by the state machine, via, e.g.,
2775 .Va batch-exit-on-error .
2778 .Sx "INTERNAL VARIABLES" ,
2779 will be set to the real exit status of the command regardless.
2782 Some commands support the
2785 modifier: if used, they expect the name of a variable as their first
2786 argument, and will place their computation result in it instead of the
2787 default location (it is usually written to standard output).
2788 The given name will be tested for being a valid
2790 variable name, and may therefore only consist of upper- and lowercase
2791 characters, digits, and the underscore; the hyphen-minus may be used as
2792 a non-portable extension.
2793 In addition the name may either not be one of the known
2794 .Sx "INTERNAL VARIABLES" ,
2795 or must otherwise refer to a writable (non-boolean) value variable.
2796 It is a hard error that is tracked in
2798 if any of these tests fail.
2799 The actual put operation may fail nonetheless, e.g., if the variable
2800 expects a number argument only a number will be accepted.
2801 Some commands may report this as a hard failure in
2803 but most will use the soft exit status
2805 to indicate these failures.
2808 Last, but not least, the modifier
2811 can be used for some old and established commands to choose the new
2812 .Sx "Shell-style argument quoting"
2813 rules over the traditional
2814 .Sx "Old-style argument quoting" .
2818 .\" .Ss "Message list arguments" {{{
2819 .Ss "Message list arguments"
2821 Some commands expect arguments that represent messages (actually
2822 their symbolic message numbers), as has been documented above under
2823 .Sx "Specifying messages"
2825 If no explicit message list has been specified, the next message
2826 forward that satisfies the command's requirements will be used,
2827 and if there are no messages forward of the current message,
2828 the search proceeds backwards;
2829 if there are no good messages at all to be found, an error message is
2830 shown and the command is aborted.
2833 .\" .Ss "Old-style argument quoting" {{{
2834 .Ss "Old-style argument quoting"
2836 \*(ID This section documents the old, traditional style of quoting
2837 non-message-list arguments to commands which expect this type of
2838 arguments: whereas still used by the majority of such commands, the new
2839 .Sx "Shell-style argument quoting"
2840 may be available even for those via
2843 .Sx "Command modifiers" .
2844 Nonetheless care must be taken, because only new commands have been
2845 designed with all the capabilities of the new quoting rules in mind,
2846 which can, e.g., generate control characters.
2849 .Bl -bullet -offset indent
2851 An argument can be enclosed between paired double-quotes
2856 any white space, shell word expansion, or reverse solidus characters
2857 (except as described next) within the quotes are treated literally as
2858 part of the argument.
2859 A double-quote will be treated literally within single-quotes and vice
2861 Inside such a quoted string the actually used quote character can be
2862 used nonetheless by escaping it with a reverse solidus
2868 An argument that is not enclosed in quotes, as above, can usually still
2869 contain space characters if those spaces are reverse solidus escaped, as in
2873 A reverse solidus outside of the enclosing quotes is discarded
2874 and the following character is treated literally as part of the argument.
2878 .\" .Ss "Shell-style argument quoting" {{{
2879 .Ss "Shell-style argument quoting"
2881 Commands which don't expect message-list arguments use
2883 ell-style, and therefore POSIX standardized, argument parsing and
2885 \*(ID Most new commands only support these new rules and are flagged
2886 \*(NQ, some elder ones can use them with the command modifier
2888 in the future only this type of argument quoting will remain.
2891 A command line is parsed from left to right and an input token is
2892 completed whenever an unquoted, otherwise ignored, metacharacter is seen.
2893 Metacharacters are vertical bar
2900 .Cm space , tabulator , newline .
2901 The additional metacharacters left and right parenthesis
2903 and less-than and greater-than signs
2907 supports are not used, and are treated as ordinary characters: for one
2908 these characters are a vivid part of email addresses, and it also seems
2909 highly unlikely that their function will become meaningful to \*(UA.
2912 Any unquoted number sign
2914 at the beginning of new token starts a comment that extends to the end
2915 of the line, and therefore ends argument processing.
2918 will cause variable expansion of the given name:
2919 .Sx "INTERNAL VARIABLES"
2922 (shell) variables can be accessed through this mechanism, brace
2923 enclosing the name is supported (i.e., to subdivide a token).
2926 Whereas the metacharacters
2927 .Cm space , tabulator , newline
2928 only complete an input token, vertical bar
2934 also act as control operators and perform control functions.
2935 For now supported is semicolon
2937 which terminates a single command, therefore sequencing the command line
2938 and making the remainder of the line a subject to reevaluation.
2939 With sequencing, multiple command argument types and quoting rules may
2940 therefore apply to a single line, which can become problematic before
2941 v15: e.g., the first of the following will cause surprising results.
2944 .Dl ? echo one; set verbose; echo verbose=$verbose.
2945 .Dl ? echo one; wysh set verbose; echo verbose=$verbose.
2948 Quoting is a mechanism that will remove the special meaning of
2949 metacharacters and reserved words, and will prevent expansion.
2950 There are four quoting mechanisms: the escape character, single-quotes,
2951 double-quotes and dollar-single-quotes:
2954 .Bl -bullet -offset indent
2956 The literal value of any character can be preserved by preceding it
2957 with the escape character reverse solidus
2961 Arguments which are enclosed in
2962 .Ql 'single-\:quotes'
2963 retain their literal value.
2964 A single-quote cannot occur within single-quotes.
2967 The literal value of all characters enclosed in
2968 .Ql \(dqdouble-\:quotes\(dq
2969 is retained, with the exception of dollar
2971 which will cause variable expansion, as above, backquote (grave accent)
2973 (which not yet means anything special), reverse solidus
2975 which will escape any of the characters dollar
2977 (to prevent variable expansion), backquote (grave accent)
2981 (to prevent ending the quote) and reverse solidus
2983 (to prevent escaping, i.e., to embed a reverse solidus character as-is),
2984 but has no special meaning otherwise.
2987 Arguments enclosed in
2988 .Ql $'dollar-\:single-\:quotes'
2989 extend normal single quotes in that reverse solidus escape sequences are
2990 expanded as follows:
2992 .Bl -tag -compact -width "Ql \eNNN"
2998 an escape character.
3000 an escape character.
3012 emits a reverse solidus character.
3016 double quote (escaping is optional).
3018 eight-bit byte with the octal value
3020 (one to three octal digits), optionally prefixed by an additional
3022 A 0 byte will suppress further output for the quoted argument.
3024 eight-bit byte with the hexadecimal value
3026 (one or two hexadecimal characters).
3027 A 0 byte will suppress further output for the quoted argument.
3029 the Unicode / ISO-10646 character with the hexadecimal codepoint value
3031 (one to eight hexadecimal digits) \(em note that Unicode defines the
3032 maximum codepoint ever to be supported as
3037 This escape is only supported in locales which support Unicode (see
3038 .Sx "Character sets" ) ,
3039 in other cases the sequence will remain unexpanded unless the given code
3040 point is ASCII compatible or can be represented in the current locale.
3041 The character NUL will suppress further output for the quoted argument.
3045 except it takes only one to four hexadecimal digits.
3047 Emits the non-printable (ASCII and compatible) C0 control codes
3048 0 (NUL) to 31 (US), and 127 (DEL).
3049 Printable representations of ASCII control codes can be created by
3050 mapping them to a different part of the ASCII character set, which is
3051 possible by adding the number 64 for the codes 0 to 31, e.g., 7 (BEL) is
3052 .Ql 7 + 64 = 71 = G .
3053 The real operation is a bitwise logical XOR with 64 (bit 7 set, see
3055 thus also covering code 127 (DEL), which is mapped to 63 (question mark):
3056 .Ql ? vexpr ^ 127 64 .
3058 Whereas historically circumflex notation has often been used for
3059 visualization purposes of control codes, e.g.,
3061 the reverse solidus notation has been standardized:
3063 Some control codes also have standardized (ISO 10646, ISO C) aliases,
3064 as shown above (e.g.,
3068 whenever such an alias exists it will be used for display purposes.
3069 The control code NUL
3071 a non-standard extension) ends argument processing without producing
3074 Non-standard extension: expand the given variable name, as above.
3075 Brace enclosing the name is supported.
3077 Not yet supported, just to raise awareness: Non-standard extension.
3084 .Bd -literal -offset indent
3085 echo 'Quotes '${HOME}' and 'tokens" differ!"# no comment
3086 echo Quotes ${HOME} and tokens differ! # comment
3087 echo Don"'"t you worry$'\ex21' The sun shines on us. $'\eu263A'
3091 .\" .Ss "Filename transformations" {{{
3092 .Ss "Filename transformations"
3094 Filenames, where expected, and unless documented otherwise, are
3095 subsequently subject to the following filename transformations, in
3098 .Bl -bullet -offset indent
3100 If the given name is a registered
3102 it will be replaced with the expanded shortcut.
3105 The filename is matched against the following patterns or strings:
3107 .Bl -hang -compact -width ".Ar %user"
3109 (Number sign) is expanded to the previous file.
3111 (Percent sign) is replaced by the invoking
3112 .Mx -ix "primary system mailbox"
3113 user's primary system mailbox, which either is the (itself expandable)
3115 if that is set, the standardized absolute pathname indicated by
3117 if that is set, or a builtin compile-time default otherwise.
3119 Expands to the primary system mailbox of
3121 (and never the value of
3123 regardless of its actual setting).
3125 (Ampersand) is replaced with the invoking users
3126 .Mx -ix "secondary mailbox"
3127 secondary mailbox, the
3134 directory (if that variable is set).
3136 Expands to the same value as
3138 but has special meaning when used with, e.g., the command
3140 the file will be treated as a primary system mailbox by, e.g., the
3144 commands, meaning that messages that have been read in the current
3145 session will be moved to the
3147 mailbox instead of simply being flagged as read.
3151 Meta expansions are applied to the resulting filename, as applicable to
3152 the resulting file access protocol (also see
3153 .Sx "On URL syntax and credential lookup" ) .
3154 If the fully expanded filename results in multiple pathnames and the
3155 command is expecting only one file, an error results.
3157 For the file-protocol, a leading tilde
3159 character will be replaced by the expansion of
3161 except when followed by a valid user name, in which case the home
3162 directory of the given user is used instead.
3168 will be replaced by the expansion of the variable, if possible;
3169 .Sx "INTERNAL VARIABLES"
3172 (shell) variables can be accessed through this mechanism, and the usual
3173 escape mechanism has to be applied to prevent interpretation.
3175 In interactive context, in order to allow simple value acceptance (via
3177 arguments will usually be displayed in a properly quoted form, e.g., a file
3178 .Ql diet\e is \ecurd.txt
3180 .Ql 'diet\e is \ecurd.txt' .
3184 .\" .Ss "Commands" {{{
3187 The following commands are available:
3189 .Bl -tag -width ".It Ic BaNg"
3194 command which follows, replacing unescaped exclamation marks with the
3195 previously executed command if the internal variable
3201 The comment-command causes the entire line to be ignored.
3203 this really is a normal command which' purpose is to discard its
3206 indicating special character, which means that, e.g., trailing comments
3207 on a line are not possible.
3211 Goes to the next message in sequence and types it
3217 Display the preceding message, or the n'th previous message if given
3218 a numeric argument n.
3222 Show the current message number (the
3227 Show a brief summary of commands.
3228 \*(OP Given an argument a synopsis for the command in question is
3229 shown instead; commands can be abbreviated in general and this command
3230 can be used to see the full expansion of an abbreviation including the
3231 synopsis, try, e.g.,
3236 and see how the output changes.
3237 This mode also supports a more
3239 output, which will provide the informations documented for
3250 \*(NQ Interprets the remainder of the word as a macro name and passes
3255 is a shorter synonym for
3256 .Ql call Ar mymacro .
3260 (ac) Creates, selects or lists (an) account(s).
3261 Accounts are special incarnations of
3263 macros and group commands and variable settings which together usually
3264 arrange the environment for the purpose of creating an email account.
3265 Different to normal macros settings which are covered by
3267 \(en here by default enabled! \(en will not be reverted before the
3272 (case-insensitive) always exists, and all but it can be deleted via
3275 Without arguments a listing of all defined accounts is shown.
3276 With one argument the given account is activated: the system
3278 of that account will be activated (as via
3280 a possibly installed
3282 will be run, and the internal variable
3285 The two argument form is identical to defining a macro as via
3287 .Bd -literal -offset indent
3289 set folder=~/mail inbox=+syste.mbox record=+sent.mbox
3290 set from='myname@myisp.example (My Name)'
3291 set mta=smtp://mylogin@smtp.myisp.example
3297 \*(NQ Interprets the given line as an email address specification,
3298 formats it as induced by email standards and then shows the result.
3302 .Sx "Command modifiers" ) .
3303 The return status is tracked via
3305 \*(ID This is pretty restricted for now, and experience may vary.
3309 (a) With no arguments, shows all currently-defined aliases.
3310 With one argument, shows that alias.
3311 With more than one argument,
3312 creates a new alias or appends to an existing one.
3314 can be used to delete aliases.
3318 (alt) Manage a list of alternate addresses or names of the active user,
3319 members of which will be removed from recipient lists when replying to
3322 variable is not set).
3323 Without arguments the current set of alternates is displayed, otherwise
3324 the set of alternate names is replaced by the given arguments, and the
3327 is updated accordingly.
3331 Takes a message list and marks each message as having been answered.
3332 Messages will be marked answered when being
3334 to automatically if the
3338 .Sx "Message states" .
3343 \*(OP\*(NQ The bind command extends the MLE (see
3344 .Sx "On terminal control and line editor" )
3345 with freely configurable key bindings.
3346 With one argument all bindings for the given context are shown,
3347 specifying an asterisk
3349 will show the bindings of all contexts; a more verbose listing will be
3350 produced if either of
3355 With two or more arguments a binding is (re)established:
3356 the first argument is the context to which the binding shall apply,
3357 the second argument is a comma-separated list of the
3359 which form the binding, and any remaining arguments form the expansion.
3360 To indicate that a binding shall not be auto-committed, but that the
3361 expansion shall instead be furtherly editable by the user, an at-sign
3363 (that will be removed) can be placed last in the expansion, from which
3364 leading and trailing whitespace will finally be removed.
3365 Reverse solidus cannot be used as the last character of expansion.
3368 Contexts define when a binding applies, i.e., a binding will not be seen
3369 unless the context for which it is defined for is currently active.
3370 This is not true for the shared binding
3372 which is the foundation for all other bindings and as such always
3373 applies, its bindings, however, only apply secondarily.
3374 The available contexts are the shared
3378 context which is used in all not otherwise documented situations, and
3380 which applies to compose mode only.
3384 which form the binding are specified as a comma-separated list of
3385 byte-sequences, where each list entry corresponds to one key(press).
3386 \*(OPally a list entry may, indicated by a leading colon character
3388 also refer to the name of a terminal capability;
3389 several dozen names will be compiled into \*(UA and may be specified
3392 or, if existing, by their
3394 name, regardless of the actually used terminal control library.
3395 It is however possible to use any capability, as long as the name is
3396 resolvable by the control library or defined in the internal variable
3398 Input sequences are not case-normalized, so that an exact match is
3399 required to update or remove a binding.
3402 .Bd -literal -offset indent
3403 bind base $'\eE',d mle-snarf-word-fwd # Esc(ape)
3404 bind base $'\eE',$'\ec?' mle-snarf-word-bwd # Esc, Delete
3405 bind default $'\ecA',:khome,w 'echo An editable binding@'
3406 bind default a,b,c rm -rf / @ # Another editable binding
3407 bind default :kf1 File %
3408 bind compose :kf1 ~e
3412 Note that the entire comma-separated list is first parsed (over) as a
3413 shell-token with whitespace as the field separator, before being parsed
3414 and expanded for real with comma as the field separator, therefore
3415 whitespace needs to be properly quoted, see
3416 .Sx "Shell-style argument quoting" .
3417 Using Unicode reverse solidus escape sequences renders a binding
3418 defunctional if the locale does not support Unicode (see
3419 .Sx "Character sets" ) ,
3420 and using terminal capabilities does so if no terminal control support
3421 is (currently) available.
3424 The following terminal capability names are builtin and can be used in
3426 or (if available) the two-letter
3428 notation regardless of the actually used library.
3429 See the respective manual for a list of capabilities.
3432 can be used to show all the capabilities of
3434 or the given terminal type;
3437 flag will also show supported (non-standard) extensions.
3440 .Bl -tag -compact -width kcuuf_or_kcuuf
3441 .It Cd kbs Ns \0or Cd kb
3443 .It Cd kdch1 Ns \0or Cd kD
3445 .It Cd kDC Ns \0or Cd *4
3446 \(em shifted variant.
3447 .It Cd kel Ns \0or Cd kE
3448 Clear to end of line.
3449 .It Cd kext Ns \0or Cd @9
3451 .It Cd kich1 Ns \0or Cd kI
3453 .It Cd kIC Ns \0or Cd #3
3454 \(em shifted variant.
3455 .It Cd khome Ns \0or Cd kh
3457 .It Cd kHOM Ns \0or Cd #2
3458 \(em shifted variant.
3459 .It Cd kend Ns \0or Cd @7
3461 .It Cd knp Ns \0or Cd kN
3463 .It Cd kpp Ns \0or Cd kP
3465 .It Cd kcub1 Ns \0or Cd kl
3466 Left cursor (with more modifiers: see below).
3467 .It Cd kLFT Ns \0or Cd #4
3468 \(em shifted variant.
3469 .It Cd kcuf1 Ns \0or Cd kr
3470 Right cursor (ditto).
3471 .It Cd kRIT Ns \0or Cd %i
3472 \(em shifted variant.
3473 .It Cd kcud1 Ns \0or Cd kd
3474 Down cursor (ditto).
3476 \(em shifted variant (only terminfo).
3477 .It Cd kcuu1 Ns \0or Cd ku
3480 \(em shifted variant (only terminfo).
3481 .It Cd kf0 Ns \0or Cd k0
3483 Add one for each function key up to
3488 .It Cd kf10 Ns \0or Cd k;
3490 .It Cd kf11 Ns \0or Cd F1
3492 Add one for each function key up to
3500 Some terminals support key-modifier combination extensions, e.g.,
3502 For example, the delete key,
3504 in its shifted variant, the name is mutated to
3506 then a number is appended for the states
3518 .Ql Shift+Alt+Control
3520 The same for the left cursor key,
3522 .Cd KLFT , KLFT3 , KLFT4 , KLFT5 , KLFT6 , KLFT7 , KLFT8 .
3525 Key bindings can be removed with the command
3527 It is advisable to use an initial escape or other control character (e.g.,
3529 for bindings which describe user key combinations (as opposed to purely
3530 terminal capability based ones), in order to avoid ambiguities whether
3531 input belongs to key sequences or not; it also reduces search time.
3534 may help shall keys and sequences be falsely recognized.
3539 \*(NQ Calls the given macro, which must have been created via
3541 Parameters given to macros are implicitly local to the macro's scope, and
3542 may be accessed via the special parameter syntax that is known from the
3549 Positional parameters may be removed by
3551 ing them off the stack.
3552 Macro execution can be terminated at any time by calling
3554 Numeric and string operations can be performed via
3558 may be helpful to recreate argument lists.
3559 .Bd -literal -offset indent
3561 echo Parameter 1 of ${#} is ${1}, all: ${*} / ${@}
3564 call exmac Hello macro exmac!
3571 if the given macro has been created via
3573 but doesn't fail nor warn if the macro doesn't exist.
3577 (ch) Change the working directory to
3579 or the given argument.
3585 \*(OP Only applicable to S/MIME signed messages.
3586 Takes a message list and a file name and saves the certificates
3587 contained within the message signatures to the named file in both
3588 human-readable and PEM format.
3589 The certificates can later be used to send encrypted messages to the
3590 respective message senders by setting
3591 .Va smime-encrypt-USER@HOST
3596 (ch) Change the working directory to
3598 or the given argument.
3604 Only applicable to threaded mode.
3605 Takes a message list and makes all replies to these messages invisible
3606 in header summaries, unless they are in state
3612 \*(OP\*(NQ Manage colour mappings of and for a
3613 .Sx "Coloured display" .
3614 The type of colour is given as the (case-insensitive) first argument,
3615 which must be one of
3617 for 256-colour terminals,
3622 for the standard 8-colour ANSI / ISO 6429 color palette and
3626 for monochrome terminals.
3627 Monochrome terminals cannot deal with colours, but only (some) font
3631 Without further arguments the list of all currently defined mappings
3632 for the given colour type is shown (as a special case giving
3636 will show the mappings of all types).
3637 Otherwise the second argument defines the mappable slot, and the third
3638 argument a (comma-separated list of) colour and font attribute
3639 specification(s), and the optional fourth argument can be used to
3640 specify a precondition: if conditioned mappings exist they are tested in
3641 (creation) order unless a (case-insensitive) match has been found, and
3642 the default mapping (if any has been established) will only be chosen as
3644 The types of precondition available depend on the mappable slot (see
3645 .Sx "Coloured display"
3646 for some examples), the following of which exist:
3649 Mappings prefixed with
3651 are used for the \*(OPal builtin Mailx-Line-Editor (MLE, see
3652 .Sx "On terminal control and line editor" )
3653 and do not support preconditions.
3655 .Bl -tag -compact -width view-partinfo
3657 This mapping is used for the position indicator that is visible when
3658 a line cannot be fully displayed on the screen.
3665 Mappings prefixed with
3667 are used in header summaries, and they all understand the preconditions
3669 (the current message) and
3671 for elder messages (only honoured in conjunction with
3672 .Va datefield-markout-older ) .
3674 .Bl -tag -compact -width view-partinfo
3676 This mapping is used for the
3678 that can be created with the
3682 formats of the variable
3685 For the complete header summary line except the
3687 and the thread structure.
3689 For the thread structure which can be created with the
3691 format of the variable
3696 Mappings prefixed with
3698 are used when displaying messages.
3700 .Bl -tag -compact -width view-partinfo
3702 This mapping is used for so-called
3704 lines, which are MBOX file format specific header lines.
3707 A comma-separated list of headers to which the mapping applies may be
3708 given as a precondition; if the \*(OPal regular expression support is
3709 available then if any of the
3711 (extended) regular expression characters is seen the precondition will
3712 be evaluated as (an extended) one.
3714 For the introductional message info line.
3715 .It Ar view-partinfo
3716 For MIME part info lines.
3720 The following (case-insensitive) colour definitions and font attributes
3721 are understood, multiple of which can be specified in a comma-separated
3731 It is possible (and often applicable) to specify multiple font
3732 attributes for a single mapping.
3735 foreground colour attribute:
3745 To specify a 256-color mode a decimal number colour specification in
3746 the range 0 to 255, inclusive, is supported, and interpreted as follows:
3748 .Bl -tag -compact -width "999 - 999"
3750 the standard ISO 6429 colors, as above.
3752 high intensity variants of the standard colors.
3754 216 colors in tuples of 6.
3756 grayscale from black to white in 24 steps.
3758 .Bd -literal -offset indent
3760 fg() { printf "\e033[38;5;${1}m($1)"; }
3761 bg() { printf "\e033[48;5;${1}m($1)"; }
3763 while [ $i -lt 256 ]; do fg $i; i=$(($i + 1)); done
3764 printf "\e033[0m\en"
3766 while [ $i -lt 256 ]; do bg $i; i=$(($i + 1)); done
3767 printf "\e033[0m\en"
3771 background colour attribute (see
3773 for possible values).
3777 Mappings may be removed with the command
3779 For a generic overview see the section
3780 .Sx "Coloured display" .
3785 (C) Copy messages to files whose names are derived from the author of
3786 the respective message and do not mark them as being saved;
3787 otherwise identical to
3792 (c) Copy messages to the named file and do not mark them as being saved;
3793 otherwise identical to
3798 Show the name of the current working directory, as reported by
3803 .Sx "Command modifiers" ) .
3804 The return status is tracked via
3809 \*(OP For unencrypted messages this command is identical to
3811 Encrypted messages are first decrypted, if possible, and then copied.
3815 \*(OP For unencrypted messages this command is identical to
3817 Encrypted messages are first decrypted, if possible, and then copied.
3821 Without arguments the current list of macros, including their content,
3822 is shown, otherwise a macro is defined.
3823 A macro definition is a sequence of commands in the following form:
3824 .Bd -literal -offset indent
3833 A defined macro can be invoked explicitly by using the
3837 commands, or implicitly if a macro hook is triggered, e.g., a
3839 It is possible to localize adjustments, like creation, deletion and
3841 .Sx "INTERNAL VARIABLES" ,
3844 command; the scope which is localized depends on how (i.e.,
3846 normal macro, folder hook, hook,
3848 switch) the macro is invoked.
3849 Execution of a macro body can be stopped from within by calling
3853 ed macro, given positional parameters can be
3856 Macros can be deleted via
3861 (d) Marks the given message list as
3863 Deleted messages will neither be saved in
3865 nor will they be available for most other commands.
3868 variable is set, automatically
3881 Superseded by the multiplexer
3887 Delete the given messages and automatically
3891 if one exists, regardless of the setting of
3898 up or down by one message when given
3902 argument, respectively.
3906 Takes a message list and marks each given message as a draft.
3908 .Sx "Message states" .
3912 \*(NQ (ec) Echoes arguments to standard output and writes a trailing
3913 newline, whereas the otherwise identical
3916 .Sx "Shell-style argument quoting"
3918 .Sx "Filename transformations"
3919 are applied to the expanded arguments.
3925 except that is echoes to standard error.
3933 but does not write a trailing newline.
3939 but does not write a trailing newline.
3943 (e) Point the text editor (as defined in
3945 at each message from the given list in turn.
3946 Modified contents are discarded unless the
3953 .Ic if Ns / Ns Ic elif Ns / Ns Ic else Ns / Ns Ic endif
3954 conditional \(em if the condition of a preceding
3956 was false, check the following condition and execute the following block
3957 if it evaluates true.
3962 .Ic if Ns / Ns Ic elif Ns / Ns Ic else Ns / Ns Ic endif
3963 conditional \(em if none of the conditions of the preceding
3967 commands was true, the
3973 (en) Marks the end of an
3974 .Ic if Ns / Ns Ic elif Ns / Ns Ic else Ns / Ns Ic endif
3975 conditional execution block.
3980 \*(NQ \*(UA has a strict notion about which variables are
3981 .Sx "INTERNAL VARIABLES"
3982 and which are managed in the program
3984 Since some of the latter are a vivid part of \*(UAs functioning,
3985 however, they are transparently integrated into the normal handling of
3986 internal variables via
3990 To integrate other environment variables of choice into this
3991 transparent handling, and also to export internal variables into the
3992 process environment where they normally are not, a
3994 needs to become established with this command, as in, e.g.,
3997 .Dl environ link PERL5LIB from TZ
4000 Afterwards changing such variables with
4002 will cause automatic updates of the program environment, and therefore
4003 be inherited by newly created child processes.
4004 Sufficient system support provided (it was in BSD as early as 1987, and
4005 is standardized since Y2K) removing such variables with
4007 will remove them also from the program environment, but in any way
4008 the knowledge they ever have been
4011 Note this implies that
4013 may cause loss of links.
4018 will remove an existing link, but leaves the variables as such intact.
4019 Additionally the subcommands
4023 are provided, which work exactly the same as the documented commands
4027 but (additionally) link the variable(s) with the program environment and
4028 thus immediately export them to, or remove them from (if possible),
4029 respectively, the program environment.
4034 \*(OP Since \*(UA uses the console as a user interface it can happen
4035 that messages scroll by too fast to become recognized.
4036 Optionally an error message ring queue is available which stores
4037 duplicates of any error message and notifies the user in interactive
4038 sessions whenever a new error has occurred.
4039 The queue is finite: if its maximum size is reached any new message
4040 replaces the eldest.
4043 can be used to manage this message queue: if given
4045 or no argument the queue will be displayed and cleared,
4047 will only clear all messages from the queue.
4051 \*(NQ Construct a command by concatenating the arguments, separated with
4052 a single space character, and then evaluate the result.
4053 This command passes through the status of the evaluated command.
4056 .Bd -literal -offset indent
4058 # Like this, sh(1)ell-stylish from begin to end: works!
4059 # Result status ends up in $!, then
4060 localopts 1;wysh set verbose;ignerr eval "${@}";return ${?}
4062 ghost xv '\ecall xverbose'
4075 call yyy '~xxx' "b\e$'\et'u ' "
4083 (ex or x) Exit from \*(UA without changing the active mailbox and skip
4084 any saving of messages in
4086 as well as a possibly tracked line editor history file.
4092 but open the mailbox read-only.
4097 (fi) The file command switches to a new mailbox.
4098 Without arguments it shows status information of the current mailbox.
4099 If an argument is given, it will write out changes (such as deletions)
4100 the user has made and open a new mailbox.
4101 .Sx "Filename transformations"
4102 will be applied to the
4107 If the name ends with
4112 it is treated as being compressed with
4117 respectively, and transparently handled through an intermediate
4118 (un)compression step (using a temporary file) with the according
4119 facility, sufficient support provided.
4120 Likewise, if the named file does not exist, but a file with one of the
4121 mentioned compression extensions does, then the name is automatically
4122 expanded and the compressed file is used.
4125 Otherwise, if the name ends with an extension for which
4126 .Va file-hook-load-EXTENSION
4128 .Va file-hook-save-EXTENSION
4129 variables are set, then the given hooks will be used to load and save
4131 and \*(UA will work with an intermediate temporary file.
4133 MBOX files (flat file-based mailboxes) are generally locked during file
4134 operations in order to avoid inconsistencies due to concurrent
4136 \*(OPal Mailbox files which \*(UA treats as the system
4141 .Sx "primary system mailbox" Ns
4142 es in general will also be protected by so-called dotlock files, the
4143 traditional way of mail spool file locking: for any file
4147 will be created for the duration of the synchronization \(em
4148 as necessary a privilege-separated dotlock child process will be used
4149 to accommodate for necessary privilege adjustments in order to create
4150 the dotlock file in the same directory
4151 and with the same user and group identities as the file of interest.
4154 \*(UA by default uses tolerant POSIX rules when reading MBOX database
4155 files, but it will detect invalid message boundaries in this mode and
4156 complain (even more with
4158 if any is seen: in this case
4160 can be used to create a valid MBOX database from the invalid input.
4165 refers to a directory with the subdirectories
4170 then it is treated as a folder in
4172 format; \*(ID the variable
4174 can be used to control the format of yet non-existent folders.
4178 .Dl \*(IN protocol://[user[:password]@]host[:port][/path]
4179 .Dl \*(OU protocol://[user@]host[:port][/path]
4182 is taken as an Internet mailbox specification.
4183 The \*(OPally supported protocols are
4187 (POP3 with SSL/TLS encrypted transport).
4190 part is valid only for IMAP; there it defaults to
4192 Also see the section
4193 .Sx "On URL syntax and credential lookup" .
4198 contains special characters, in particular
4202 they must be escaped in URL notation \(en the command
4204 can be used to show the necessary conversion.
4209 Takes a message list and marks the messages as flagged for
4210 urgent/special attention.
4212 .Sx "Message states" .
4221 With no arguments, list the names of the folders in the folder directory.
4222 With an existing folder as an argument,
4223 lists the names of folders below the named folder.
4229 but saves the message in a file named after the local part of the first
4230 recipient's address (instead of in
4237 but saves the message in a file named after the local part of the first
4238 recipient's address (instead of in
4245 but responds to all recipients regardless of the
4250 .It Ic followupsender
4253 but responds to the sender only regardless of the
4269 (f) Takes a list of message specifications and displays a summary of
4270 their message headers, exactly as via
4272 An alias of this command is
4275 .Sx "Specifying messages" .
4281 but saves the message in a file named after the local part of the
4282 recipient's address (instead of in
4287 Takes a message and the address of a recipient
4288 and forwards the message to him.
4289 The text of the original message is included in the new one,
4290 with the value of the
4292 variable preceding it.
4293 To filter the included header fields to the desired subset use the
4295 slot of the white- and blacklisting command
4297 Only the first part of a multipart message is included unless
4298 .Va forward-as-attachment ,
4299 and recipient addresses will be stripped from comments, names etc.
4300 unless the internal variable
4306 \*(OB Superseded by the multiplexer
4311 \*(OB Superseded by the multiplexer
4316 Define or list command aliases, so-called ghosts.
4317 A ghost can be used everywhere a normal command can be used, but always
4318 takes precedence: any arguments that are given to the command alias are
4319 joined onto the alias content, and the resulting string forms the
4320 command line that is, in effect, executed.
4321 Command ghosts can be removed with
4323 Without arguments a list of all currently known aliases is shown.
4324 With one argument the expansion of the given alias is shown.
4326 With two or more arguments a command alias is defined or updated: the
4327 first argument is the name under which the remaining command line should
4328 be accessible, the content of which can be just about anything.
4329 A ghost may itself expand to another ghost, but to avoid expansion loops
4330 further expansion will be prevented if a ghost refers to itself or if an
4331 expansion depth limit is reached.
4332 Explicit expansion prevention is available via reverse solidus
4335 .Sx "Command modifiers" .
4336 .Bd -literal -offset indent
4338 \*(uA: `ghost': no such alias: xx
4341 ghost xx "echo hello,"
4351 \*(NQ Multiplexer command to establish white- and blacklisting
4352 selections of header fields for a variety of applications.
4353 Without arguments the set of contexts that have settings is displayed.
4354 When given arguments, the first argument is the context to which the
4355 command applies, one of (case-insensitively)
4357 for display purposes (via, e.g.,
4360 for selecting which headers shall be stored persistently when
4366 ing messages (note that MIME related etc. header fields should not be
4367 ignored in order to not destroy usability of the message in this case),
4369 for stripping down messages when
4371 ing message (has no effect if
4372 .Va forward-as-attachment
4375 for defining user-defined set of fields for the command
4379 The current settings of the given context are displayed if only the
4380 first argument is given.
4381 A second argument denotes the type of restriction that is to be chosen,
4382 it may be (a case-insensitive prefix of)
4386 for white- and blacklisting purposes, respectively.
4387 Establishing a whitelist suppresses inspection of the corresponding
4389 If no further argument is given the current settings of the given type
4393 With four or more arguments the third denotes the action to be applied,
4398 for addition of fields, and
4402 for removal of fields from the given type of the given context.
4403 The fourth, and any following arguments are expected to specify the
4404 fields of desire, or \*(OPally, regular expression matches ought to
4406 The special wildcard field (asterisk,
4408 will establish a (fast) shorthand setting which covers all fields, or
4409 remove all fields in one operation, respectively.
4414 (h) Show the current group of headers, the size of which depends on
4417 and the style of which can be adjusted with the variable
4419 If a message-specification is given the group of headers containing the
4420 first message therein is shown and the message at the top of the screen
4435 the list of history entries;
4438 argument selects and evaluates the respective history entry,
4439 which will become the new history top; a negative number is used as an
4440 offset to the current command, e.g.,
4442 will select the last command, the history top.
4443 The default mode if no arguments are given is
4450 Takes a message list and marks each message therein to be saved in the
4455 Does not override the
4458 \*(UA deviates from the POSIX standard with this command, because a
4460 command issued after
4462 will display the following message, not the current one.
4467 (i) Part of the nestable
4468 .Ic if Ns / Ns Ic elif Ns / Ns Ic else Ns / Ns Ic endif
4469 conditional execution construct \(em if the given condition is true then
4470 the encapsulated block is executed.
4471 POSIX only supports the (case-insensitive) conditions
4476 end, all remaining conditions are non-portable extensions; note that
4477 falsely specified conditions cause the execution of the entire
4478 conditional construct until the (matching) closing
4480 command to be suppressed.
4481 The syntax of the nestable
4483 conditional execution construct requires that each condition and syntax
4484 element is surrounded by whitespace.
4486 .Bd -literal -offset indent
4495 The (case-insensitive) condition
4497 erminal will evaluate to true if the standard input is a terminal, i.e.,
4498 in interactive sessions.
4499 Another condition can be any boolean value (see the section
4500 .Sx "INTERNAL VARIABLES"
4501 for textual boolean representations) to mark an enwrapped block as
4504 .Dq always execute .
4505 It is possible to check
4506 .Sx "INTERNAL VARIABLES"
4509 variables for existence or compare their expansion against a user given
4510 value or another variable by using the
4512 .Pf ( Dq variable next )
4513 conditional trigger character;
4514 a variable on the right hand side may be signalled using the same
4516 The variable names may be enclosed in a pair of matching braces.
4519 The available comparison operators are
4523 (less than or equal to),
4529 (greater than or equal to),
4533 (is substring of) and
4535 (is not substring of).
4536 The values of the left and right hand side are treated as strings and
4537 are compared 8-bit byte-wise, ignoring case according to the rules of
4538 the US-ASCII encoding (therefore, dependent on the active locale,
4539 possibly producing false results for strings in the locale encoding).
4540 Except for the substring checks the comparison will instead be performed
4541 arithmetically if both, the user given value as well as the variable
4542 content, can be parsed as numbers (integers).
4543 An unset variable is treated as the empty string.
4546 When the \*(OPal regular expression support is available, the additional
4552 They treat the right hand side as an extended regular expression that is
4553 matched case-insensitively and according to the active
4555 locale, meaning that strings in the locale encoding should be matched
4559 Conditions can be joined via AND-OR lists (where the AND operator is
4561 and the OR operator is
4563 which have equal precedence and will be evaluated with left
4564 associativity, thus using the same syntax that is known for the
4566 It is also possible to form groups of conditions and lists by enclosing
4567 them in pairs of brackets
4568 .Ql [\ \&.\&.\&.\ ] ,
4569 which may be interlocked within each other, and also be joined via
4573 The results of individual conditions and entire groups may be modified
4574 via unary operators: the unary operator
4576 will reverse the result.
4578 .Bd -literal -offset indent
4582 if [ "$ttycharset" == UTF-8 ] || [ "$ttycharset" == UTF8 ]
4583 echo *ttycharset* is set to UTF-8, case-insensitively
4586 if [ "${t1}" == "${t2}" ]
4587 echo These two variables are equal
4589 if [ "$version-major" >= 15 ]
4590 echo Running a new version..
4591 if [ "$features" =@ +regex ]
4592 if [ "$TERM" =~ "^xterm\&.*" ]
4593 echo ..in an X terminal
4596 if [ [ true ] && [ [ "${debug}" != '' ] || \e
4597 [ "$verbose" != '' ] ] ]
4600 if true && [ "$debug" != '' ] || [ "${verbose}" != '' ]
4601 echo Left associativity, as is known from the shell
4603 if ! ! true && ! [ ! "$debug" && ! "$verbose" ]
4604 echo Unary operator support
4614 Superseded by the multiplexer
4619 Shows the names of all available commands, alphabetically sorted.
4620 If given any non-whitespace argument the list will be shown in the order
4621 in which command prefixes are searched.
4622 In conjunction with a set variable
4624 additional information will be provided for each command: the argument
4625 type will be indicated, the \*(OPal documentation string will be shown,
4626 and the set of command flags will show up:
4628 .Bl -tag -compact -width ".It Ql BaNg"
4629 .It Ql "vput modifier"
4630 command supports the command modifier
4632 .It Ql "status in *!*"
4633 the soft exit status is tracked in
4636 commands needs an active mailbox, a
4638 .It Ql "ok: batch or interactive"
4639 command may only be used in interactive or
4642 .It Ql "ok: send mode"
4643 command can be used in send mode.
4644 .It Ql "not ok: compose mode"
4645 command is not available when in compose-mode.
4646 .It Ql "not ok: during startup"
4647 command cannot be used during program startup, e.g., while loading
4648 .Sx "Resource files" .
4649 .It Ql "ok: in subprocess"
4650 command is allowed to be used when running in a subprocess instance,
4651 e.g., from within a macro that is called via
4652 .Va on-compose-done .
4657 This command can be used to localize changes to variables, meaning that
4658 their state will be reverted to the former one once the covered scope
4660 It can only be used inside of macro definition blocks introduced by
4664 and is interpreted as a boolean (string, see
4665 .Sx "INTERNAL VARIABLES" ) ;
4668 of an account is left once it is switched off again.
4669 .Bd -literal -offset indent
4670 define temporary_settings {
4671 set possibly_global_option1
4676 set possibly_global_option2
4685 enables change localization and calls
4687 which explicitly resets localization, then any value changes within
4689 will still be reverted by
4691 \*(ID Once the outermost level, the one which enabled localization
4692 first, is left, but no earlier, all adjustments will be unrolled.
4693 \*(ID Likewise worth knowing, if in this example
4695 changes to a different
4697 which sets some variables that are yet covered by localizations, their
4698 scope will be extended, and in fact leaving the
4700 will (thus) restore settings in (likely) global scope which actually
4701 were defined in a local, private context.
4705 Reply to messages that come in via known
4708 .Pf ( Ic mlsubscribe )
4709 mailing lists, or pretend to do so (see
4710 .Sx "Mailing lists" ) :
4713 functionality this will actively resort and even remove message
4714 recipients in order to generate a message that is supposed to be sent to
4716 For example it will also implicitly generate a
4717 .Ql Mail-Followup-To:
4718 header if that seems useful, regardless of the setting of the variable
4725 but saves the message in a file named after the local part of the first
4726 recipient's address (instead of in
4731 (m) Takes a (list of) recipient address(es) as (an) argument(s),
4732 or asks on standard input if none were given;
4733 then collects the remaining mail content and sends it out.
4737 (mb) The given message list is to be sent to
4739 when \*(UA is quit; this is the default action unless the variable
4742 \*(ID This command can only be used in a
4744 .Sx "primary system mailbox" .
4748 Without any arguments the content of the MIME type cache will displayed.
4749 Otherwise each argument defines a complete MIME type specification of
4750 a type that shall be added (prepended) to the cache.
4751 In any event MIME type sources are loaded first as necessary \(en
4752 .Va mimetypes-load-control
4753 can be used to fine-tune which sources are actually loaded.
4754 Refer to the section on
4755 .Sx "The mime.types files"
4756 for more on MIME type specifications and this topic in general.
4757 MIME type unregistration and cache resets can be triggered with
4762 Without arguments the list of all currently defined mailing lists
4763 (and their attributes, if any) is shown; a more verbose listing will be
4764 produced if either of
4769 Otherwise all given arguments (which need not be quoted except for
4770 whitespace) will be added and henceforth be recognized as mailing lists.
4771 Mailing lists may be removed via the command
4774 If the \*(OPal regular expression support is available then mailing
4775 lists may also be specified as (extended) regular expressions (see
4781 Without arguments the list of all currently defined mailing lists which
4782 have a subscription attribute is shown; a more verbose listing will be
4783 produced if either of
4788 Otherwise this attribute will be set for all given mailing lists,
4789 newly creating them as necessary (as via
4791 Subscription attributes may be removed via the command
4800 but moves the messages to a file named after the local part of the
4801 sender address of the first message (instead of in
4808 but marks the messages for deletion if they were transferred
4815 but also displays header fields which would not pass the
4817 selection, and all MIME parts.
4825 on the given messages, even in non-interactive mode and as long as the
4826 standard output is a terminal.
4832 \*(OP When used without arguments or if
4834 has been given the content of the
4836 cache is shown, loading it first as necessary.
4839 then the cache will only be initialized and
4841 will remove its contents.
4842 Note that \*(UA will try to load the file only once, use
4843 .Ql Ic \&\&netrc Ns \:\0\:clear
4844 to unlock further attempts.
4849 .Sx "On URL syntax and credential lookup" ;
4851 .Sx "The .netrc file"
4852 documents the file format in detail.
4856 Checks for new mail in the current folder without committing any changes
4858 If new mail is present, a message is shown.
4862 the headers of each new message are also shown.
4863 This command is not available for all mailbox types.
4871 Goes to the next message in sequence and types it.
4872 With an argument list, types the next matching message.
4886 If the current folder is accessed via a network connection, a
4888 command is sent, otherwise no operation is performed.
4894 but also displays header fields which would not pass the
4896 selection, and all MIME parts.
4904 on the given messages, even in non-interactive mode and as long as the
4905 standard output is a terminal.
4913 but also pipes header fields which would not pass the
4915 selection, and all parts of MIME
4916 .Ql multipart/alternative
4921 (pi) Takes a message list and a shell command
4922 and pipes the messages through the command.
4923 Without an argument the current message is piped through the command
4930 every message is followed by a formfeed character.
4951 (q) Terminates the session, saving all undeleted, unsaved messages in
4954 preserving all messages marked with
4958 or never referenced in the system
4960 and removing all other messages from the
4962 .Sx "primary system mailbox" .
4963 If new mail has arrived during the session,
4965 .Dq You have new mail
4967 If given while editing a mailbox file with the command line option
4969 then the edit file is rewritten.
4970 A return to the shell is effected,
4971 unless the rewrite of edit file fails,
4972 in which case the user can escape with the exit command.
4976 \*(NQ Read a line from standard input, and assign the splitted and
4977 trimmed line data to the given variables.
4978 The variable names are check by the same rules as documented for
4980 If there are more fields than variables, assign successive fields to the
4981 last given variable.
4982 If there are less fields than variables, assign the empty string to the
4984 The return status is tracked via
4986 even though variable names are checked errors may still happen if it is
4987 tried to set, e.g., strings to variables which expect number settings;
4988 it thus only happens if names are used which have special meaning to \*(UA.
4989 \*(ID This command will likely be extended towards more
4991 compatibility: for now splitting always occurs at whitespace, reverse
4992 solidus newline escaping is always supported, and the \*(OPal line
4993 editing features are always available when on an interactive terminal.
4994 .Bd -literal -offset indent
4997 ? echo "<$a> <$b> <$c>"
5013 Removes the named files or directories.
5014 If a name refer to a mailbox, e.g., a Maildir mailbox, then a mailbox
5015 type specific removal will be performed, deleting the complete mailbox.
5016 The user is asked for confirmation in interactive mode.
5020 Takes the name of an existing folder
5021 and the name for the new folder
5022 and renames the first to the second one.
5023 Both folders must be of the same type.
5027 (R) Reply to originator.
5028 Does not reply to other recipients of the original message.
5030 will exchange this command with
5032 Unless the internal variable
5034 is set the recipient address will be stripped from comments, names etc.
5038 (r) Take a message and group-responds to it by addressing the sender
5041 .Va followup-to-honour ,
5044 .Va recipients-in-cc
5045 influence response behaviour.
5048 offers special support for replying to mailing lists.
5049 Unless the internal variable
5051 is set recipient addresses will be stripped from comments, names etc.
5064 but initiates a group-reply regardless of the value of
5071 but responds to the sender only regardless of the value of
5078 but does not add any header lines.
5079 This is not a way to hide the sender's identity,
5080 but useful for sending a message again to the same recipients.
5084 Takes a list of messages and a user name
5085 and sends each message to the named user.
5087 and related header fields are prepended to the new copy of the message.
5105 .It Ic respondsender
5111 (ret) Superseded by the multiplexer
5116 Only available inside the scope of a
5120 this will stop evaluation of any further macro content, and return
5121 execution control to the caller.
5122 If no arguments are specified, the return value, which will be stored in
5124 as well as the macro command exit status, which is made available in
5127 If only the return value is given the command exit status will be 0.
5128 Both optional parameters must be specified as unsigned (positive)
5131 \*(ID Notes: any non-0 command exit status is treated as a hard error
5132 by the state machinery, and will be propagated up and cause, e.g.,
5133 a file inclusion via
5135 to fail; this two argument form likely is a temporary hack that will
5142 but saves the messages in a file named after the local part of the
5143 sender of the first message instead of (in
5145 and) taking a filename argument.
5149 (s) Takes a message list and a filename and appends each message in turn
5150 to the end of the file.
5151 If no filename is given, the
5154 The filename in quotes, followed by the generated character count
5155 is echoed on the user's terminal.
5158 .Sx "primary system mailbox"
5159 the messages are marked for deletion.
5160 .Sx "Filename transformations"
5165 \*(OB Superseded by the multiplexer
5170 \*(OB Superseded by the multiplexer
5175 \*(OB Superseded by the multiplexer
5180 Takes a message specification (list) and displays a header summary of
5181 all matching messages, as via
5183 This command is an alias of
5186 .Sx "Specifying messages" .
5190 Takes a message list and marks all messages as having been read.
5194 (se) Without arguments this command shows all internal variables which
5195 are currently known to \*(UA (they have been set).
5196 A more verbose listing will be produced if either of
5200 are set, in which case variables may be preceded with a comment line
5201 that gives some context of what \*(UA knows about the given variable.
5203 Otherwise the given variables (and arguments) are set or adjusted.
5204 Arguments are of the form
5206 (no space before or after
5210 if there is no value, i.e., a boolean variable.
5211 Quotation marks may be placed around any part of the assignment
5212 statement to quote blanks or tabs, e.g.,
5214 .Dl set indentprefix='->'
5216 If an argument begins with
5220 the effect is the same as invoking the
5222 command with the remaining part of the variable
5223 .Pf ( Ql unset save ) .
5227 that is known to map to an environment variable will automatically cause
5228 updates in the program environment (unsetting a variable in the
5229 environment requires corresponding system support).
5230 Please use the command
5232 for further environmental control.
5237 .Sx "INTERNAL VARIABLES"
5243 (sh) Invokes an interactive version of the shell.
5247 Without arguments the list of all currently defined shortcuts is
5249 Otherwise all given arguments (which need not be quoted except for
5250 whitespace) are treated as pairs of shortcuts and their expansions,
5251 creating new or changing already existing shortcuts, as necessary.
5252 Shortcuts may be removed via the command
5257 Only available inside the scope of a
5259 ed macro, this will shift the positional parameters (starting at
5261 by the given number (which must be an unsigned, positive, decimal),
5262 or 1 if no argument has been given.
5263 It is an error if the value exceeds the number of positional parameters.
5264 If the given number is 0, no action is performed, successfully.
5270 but performs neither MIME decoding nor decryption, so that the raw
5271 message text is shown.
5275 (si) Shows the size in characters of each message of the given
5280 Shows the current sorting criterion when used without an argument.
5281 Otherwise creates a sorted representation of the current folder,
5284 command and the addressing modes such that they refer to messages in
5286 Message numbers are the same as in regular mode.
5290 a header summary in the new order is also displayed.
5291 Automatic folder sorting can be enabled by setting the
5293 variable, as in, e.g.,
5294 .Ql set autosort=thread .
5295 Possible sorting criterions are:
5297 .Bl -tag -compact -width "subject"
5299 Sort the messages by their
5301 field, that is by the time they were sent.
5303 Sort messages by the value of their
5305 field, that is by the address of the sender.
5308 variable is set, the sender's real name (if any) is used.
5310 Sort the messages by their size.
5312 \*(OP Sort the message by their spam score, as has been classified by
5315 Sort the messages by their message status.
5317 Sort the messages by their subject.
5319 Create a threaded display.
5321 Sort messages by the value of their
5323 field, that is by the address of the recipient.
5326 variable is set, the recipient's real name (if any) is used.
5331 (so) The source command reads commands from the given file.
5332 .Sx "Filename transformations"
5334 If the given expanded argument ends with a vertical bar
5336 then the argument will instead be interpreted as a shell command and
5337 \*(UA will read the output generated by it.
5338 Interpretation of commands read is stopped when an error is encountered.
5341 cannot be used from within macros that execute as
5342 .Va folder-hook Ns s
5345 i.e., it can only be called from macros that were
5352 (beside not supporting pipe syntax aka shell command input) is that
5353 this command will not generate an error nor warn if the given file
5354 argument cannot be opened successfully.
5358 \*(OP Takes a list of messages and clears their
5364 \*(OP Takes a list of messages and causes the
5366 to forget it has ever used them to train its Bayesian filter.
5367 Unless otherwise noted the
5369 flag of the message is inspected to chose whether a message shall be
5377 \*(OP Takes a list of messages and informs the Bayesian filter of the
5381 This also clears the
5383 flag of the messages in question.
5387 \*(OP Takes a list of messages and rates them using the configured
5388 .Va spam-interface ,
5389 without modifying the messages, but setting their
5391 flag as appropriate; because the spam rating headers are lost the rate
5392 will be forgotten once the mailbox is left.
5393 Refer to the manual section
5395 for the complete picture of spam handling in \*(UA.
5399 \*(OP Takes a list of messages and sets their
5405 \*(OP Takes a list of messages and informs the Bayesian filter of the
5411 flag of the messages in question.
5420 Create a threaded representation of the current folder,
5421 i.\|e. indent messages that are replies to other messages in the header
5422 display and change the
5424 command and the addressing modes such that they refer to messages in the
5426 Message numbers are the same as in unthreaded mode.
5430 a header summary in threaded order is also displayed.
5439 slot for white- and blacklisting header fields.
5443 (to) Takes a message list and types out the first
5445 lines of each message on the users' terminal.
5446 Unless a special selection has been established for the
5450 command, the only header fields that are displayed are
5461 It is possible to apply compression to what is displayed by setting
5463 Messages are decrypted and converted to the terminal character set
5468 (tou) Takes a message list and marks the messages for saving in
5470 \*(UA deviates from the POSIX standard with this command,
5473 command will display the following message instead of the current one.
5479 but also displays header fields which would not pass the
5481 selection, and all parts of MIME
5482 .Ql multipart/alternative
5487 (t) Takes a message list and types out each message on the users'
5491 For MIME multipart messages, all parts with a content type of
5495 are shown, the other are hidden except for their headers.
5496 Messages are decrypted and converted to the terminal character set
5501 Delete all given accounts.
5502 An error message is shown if a given account is not defined.
5505 will discard all existing accounts.
5509 (una) Takes a list of names defined by alias commands
5510 and discards the remembered groups of users.
5513 will discard all existing aliases.
5517 Takes a message list and marks each message as not having been answered.
5523 ing, specified by its context and input sequence, both of which may be
5524 specified as a wildcard (asterisk,
5528 will remove all bindings of all contexts.
5532 Only applicable to threaded mode.
5533 Takes a message list and makes the message and all replies to it visible
5534 in header summaries again.
5535 When a message becomes the current message,
5536 it is automatically made visible.
5537 Also when a message with collapsed replies is displayed,
5538 all of these are automatically uncollapsed.
5544 mapping for the given colour type (see
5546 for a list of types) and mapping; if the optional precondition argument
5547 is used then only the exact tuple of mapping and precondition is removed.
5550 will remove all mappings (no precondition allowed).
5552 .Sx "Coloured display"
5553 for the general picture.
5557 Undefine all given macros.
5558 An error message is shown if a given macro is not defined.
5561 will discard all existing macros.
5565 (u) Takes a message list and marks each message as not being deleted.
5568 variable is set, the last message restored will be
5570 d automatically; if no message list had been specified then the usual
5571 search for a visible message is performed, as documented for
5573 showing only the next input prompt if the search fails.
5581 Takes a message list and
5587 Takes a message list and marks each message as not being
5592 \*(OB Superseded by the multiplexer
5597 \*(OB Superseded by the multiplexer
5602 Remove all the given command
5606 will remove all ghosts.
5610 Superseded by the multiplexer
5615 Delete all given MIME types, e.g.,
5616 .Ql unmimetype text/plain
5617 will remove all registered specifications for the MIME type
5621 will discard all existing MIME types, just as will
5623 but which also reenables cache initialization via
5624 .Va mimetypes-load-control .
5628 Forget about all the given mailing lists.
5631 will remove all lists.
5636 .It Ic unmlsubscribe
5637 Remove the subscription attribute from all given mailing lists.
5640 will clear the attribute from all lists which have it set.
5651 Takes a message list and marks each message as not having been read.
5655 Superseded by the multiplexer
5660 \*(OB Superseded by the multiplexer
5665 \*(OB Superseded by the multiplexer
5670 (uns) Takes a list of internal variable names and discards their
5671 remembered values; the reverse of
5678 Deletes the shortcut names given as arguments.
5681 will remove all shortcuts.
5685 Disable sorted or threaded mode
5691 return to normal message order and,
5695 displays a header summary.
5705 \*(NQ Perform URL percent codec operations, rather according to RFC 3986.
5709 .Sx "Command modifiers" ) .
5710 The return status is tracked via
5712 This is a character set agnostic and thus locale dependent operation,
5713 and it may decode bytes which are invalid in the current locale, unless
5714 the input solely consists of characters in the portable character set, see
5715 .Sx "Character sets" .
5716 \*(ID This command does not about URLs beside that.
5718 The first argument specifies the operation:
5722 perform plain URL percent en- and decoding, respectively.
5726 perform a slightly modified operation which should be better for
5727 pathnames: it does not allow a tilde
5729 and will neither accept hyphen-minus
5733 as an initial character.
5734 The remaining arguments form the URL data which is to be converted.
5738 Edit the values of or create the given variable(s) in the
5740 Boolean variables cannot be edited.
5744 This command produces the same output as the listing mode of
5748 ity adjustments, but only for the given variables.
5752 \*(OP Takes a message list and verifies each message.
5753 If a message is not a S/MIME signed message,
5754 verification will fail for it.
5755 The verification process checks if the message was signed using a valid
5757 if the message sender's email address matches one of those contained
5758 within the certificate,
5759 and if the message content has been altered.
5772 \*(NQ Evaluate arguments according to a given operator.
5773 This is a multiplexer command which can be used to perform signed 64-bit
5774 numeric calculations as well as string operations.
5775 It uses polish notation, i.e., the operator is the first argument and
5776 defines the number and type, and the meaning of the remaining arguments.
5777 An empty argument is replaced with a 0 if a number is expected.
5781 .Sx "Command modifiers" ) .
5782 The return status is tracked via
5784 the result that is shown in case of (soft) errors is
5786 In general only invalid use cases cause hard errors which are reflected in
5788 and affect the state machine.
5791 Numeric operations work on one or two signed 64-bit integers.
5792 One integer is expected by assignment (equals sign
5794 which does nothing but parsing the argument, thus detecting validity and
5795 possible overflow conditions, and unary not (tilde
5797 which creates the bitwise complement.
5798 Two integers are used by addition (plus
5802 multiplication (asterisk
5808 as well as for the bitwise operators logical or (vertical bar
5811 bitwise and (ampersand
5814 bitwise xor (circumflex
5816 the bitwise signed left- and right shifts
5819 as well as for the unsigned right shift
5823 All numeric operators can be suffixed with an at sign
5827 this will turn the operation into a saturated one, which means that
5828 overflow errors and division and modulo by zero are still reflected in
5829 the return status, but the result will linger at the minimum or maximum
5830 possible value, instead of overflowing (or trapping).
5831 For the bitwise shifts, the saturated maximum is 63.
5832 If in saturated mode the overflow occurs during parsing the numbers,
5833 then the actual operation will not be performed but the given maximum
5834 value is used as the result immediately.
5837 String operations that take one argument are
5839 which queries the length of the given argument, and
5841 which performs the usual
5842 .Sx "Filename transformations" ,
5844 Two or more arguments are used by
5846 which searches in the first for the second argument, and shows the
5847 resulting 0-based offset shall it have been found,
5849 which is identical to
5851 but works case-insensitively according to the rules of the ASCII
5854 will show a substring of its first argument:
5855 the second argument is the 0-based starting offset, the optional third
5856 argument can be used to specify the length of the desired substring,
5857 by default the entire string is used;
5858 this operation tries to work around faulty arguments, but the (soft)
5859 return status will still reflect them (set
5866 will try to match the first argument with the regular expression given
5867 in the second argument, as does
5869 but which is case-insensitive.
5870 These operators match according to the active
5872 locale and thus should match correctly strings in the locale encoding.
5873 If the optional third argument has been given then instead of showing
5874 the match offset a replacement operation is performed:
5875 the third argument is treated as if specified via dollar-single-quote
5877 .Sx "Shell-style argument quoting" ) ,
5878 and any occurrence of a positional parameter, e.g.,
5880 is replaced by the corresponding match group of the regular expression.
5882 .Bd -literal -offset indent
5883 ? vexpr -@ +1 -9223372036854775808
5884 ? vput vexpr res ir bananarama (.*)nana(.*) '\e${1}au\e$2'
5891 (v) Takes a message list and invokes the display editor on each message.
5892 Modified contents are discarded unless the
5898 (w) For conventional messages the body without all headers is written.
5899 The original message is never marked for deletion in the originating
5901 The output is decrypted and converted to its native format as necessary.
5902 If the output file exists, the text is appended.
5903 If a message is in MIME multipart format its first part is written to
5904 the specified file as for conventional messages, handling of the remains
5905 depends on the execution mode.
5906 No special handling of compressed files is performed.
5908 In interactive mode the user is consecutively asked for the filenames of
5909 the processed parts.
5910 For convience saving of each part may be skipped by giving an empty
5911 value, the same result as writing it to
5913 Shell piping the part content by specifying a leading vertical bar
5915 character for the filename is supported.
5916 Other user input undergoes the usual
5917 .Sx "Filename transformations" ,
5918 and contents of the destination file are overwritten if the file
5921 \*(ID In non-interactive mode any part which does not specify a filename
5922 is ignored, and suspicious parts of filenames of the remaining parts are
5923 URL percent encoded (as via
5925 to prevent injection of malicious character sequences, resulting in
5926 a filename that will be written into the current directory.
5927 Existing files will not be overwritten, instead the part number or
5928 a dot are appended after a number sign
5930 to the name until file creation succeeds (or fails due to other
5940 \*(UA presents message headers in
5942 fuls as described under the
5945 Without arguments this command scrolls to the next window of messages,
5946 likewise if the argument is
5950 scrolls to the last,
5952 scrolls to the first, and
5957 A number argument prefixed by
5961 indicates that the window is calculated in relation to the current
5962 position, and a number without a prefix specifies an absolute position.
5968 but scrolls to the next or previous window that contains at least one
5978 .\" .Sh COMMAND ESCAPES {{{
5979 .Sh "COMMAND ESCAPES"
5981 Here is a summary of the command escapes available in compose mode,
5982 which are used to perform special functions when composing messages.
5983 Command escapes are only recognized at the beginning of lines.
5984 The actual escape character can be set via the internal variable
5986 it defaults to the tilde
5990 .Bl -tag -width ".It Ic BaNg"
5993 Insert the string of text in the message prefaced by a single
5995 (If the escape character has been changed,
5996 that character must be doubled
5997 in order to send it at the beginning of a line.)
6000 .It Ic ~! Ar command
6001 Execute the indicated shell
6003 which follows, replacing unescaped exclamation marks with the previously
6004 executed command if the internal variable
6006 is set, then return to the message.
6010 Same effect as typing the end-of-file character.
6013 .It Ic ~: Ar \*(UA-command Ns \0or Ic ~_ Ar \*(UA-command
6014 Execute the given \*(UA command.
6015 Not all commands, however, are allowed.
6019 Write a summary of command escapes.
6022 .It Ic ~< Ar filename
6027 .It Ic ~<! Ar command
6029 is executed using the shell.
6030 Its standard output is inserted into the message.
6033 .It Ic ~@ Op Ar filename...
6034 Append or edit the list of attachments.
6037 arguments is expected (see
6038 .Sx "Shell-style argument quoting" ;
6039 any token-separating commas are ignored), to be
6040 interpreted as documented for the command line option
6042 with the message number exception as below.
6045 arguments the attachment list is edited, entry by entry;
6046 if a filename is left empty, that attachment is deleted from the list;
6047 once the end of the list is reached either new attachments may be
6048 entered or the session can be quit by committing an empty
6051 For each mode, if a given file name solely consists of the number sign
6053 followed by a valid message number of the currently active mailbox, then
6054 the given message is attached as a MIME
6056 part (note the number sign is the comment character and must be quoted).
6060 Inserts the string contained in the
6063 .Ql Ic ~i Ns \0Sign ) .
6068 ting the variable(s) instead!) The escape sequences tabulator
6076 Inserts the string contained in the
6079 .Ql Ic ~i Ns \0sign ) .
6084 ting the variable(s) instead!) The escape sequences tabulator
6091 .It Ic ~b Ar name ...
6092 Add the given names to the list of blind carbon copy recipients.
6095 .It Ic ~c Ar name ...
6096 Add the given names to the list of carbon copy recipients.
6100 Read the file specified by the
6102 variable into the message.
6106 Invoke the text editor on the message collected so far.
6107 After the editing session is finished,
6108 the user may continue appending text to the message.
6111 .It Ic ~F Ar messages
6112 Read the named messages into the message being sent, including all
6113 message headers and MIME parts.
6114 If no messages are specified, read in the current message.
6117 .It Ic ~f Ar messages
6118 Read the named messages into the message being sent.
6119 If no messages are specified, read in the current message.
6120 Strips down the list of header fields according to the
6122 white- and blacklist selection of
6124 For MIME multipart messages,
6125 only the first displayable part is included.
6129 Edit the message header fields
6134 by typing each one in turn and allowing the user to edit the field.
6135 The default values for these fields originate from the
6143 Edit the message header fields
6149 by typing each one in turn and allowing the user to edit the field.
6152 .It Ic ~i Ar variable
6153 Insert the value of the specified variable into the message,
6154 adding a newline character at the end.
6155 The message remains unaltered if the variable is unset or empty.
6160 ting the variable(s) instead!) The escape sequences tabulator
6167 .It Ic ~M Ar messages
6168 Read the named messages into the message being sent,
6171 If no messages are specified, read the current message.
6174 .It Ic ~m Ar messages
6175 Read the named messages into the message being sent,
6178 If no messages are specified, read the current message.
6179 Strips down the list of header fields according to the
6181 white- and blacklist selection of
6183 For MIME multipart messages,
6184 only the first displayable part is included.
6188 Display the message collected so far,
6189 prefaced by the message header fields
6190 and followed by the attachment list, if any.
6194 Abort the message being sent,
6195 copying it to the file specified by the
6202 .It Ic ~R Ar filename
6203 Read the named file into the message, indented by
6207 .It Ic ~r Ar filename
6208 Read the named file into the message.
6212 Cause the named string to become the current subject field.
6213 Newline (NL) and carriage-return (CR) bytes are invalid and will be
6214 normalized to space (SP) characters.
6217 .It Ic ~t Ar name ...
6218 Add the given name(s) to the direct recipient list.
6221 .It Ic ~U Ar messages
6222 Read in the given / current message(s) excluding all headers, indented by
6226 .It Ic ~u Ar messages
6227 Read in the given / current message(s), excluding all headers.
6231 Invoke an alternate editor (defined by the
6233 environment variable) on the message collected so far.
6234 Usually, the alternate editor will be a screen editor.
6235 After the editor is quit,
6236 the user may resume appending text to the end of the message.
6239 .It Ic ~w Ar filename
6240 Write the message onto the named file.
6242 the message is appended to it.
6248 except that the message is not saved at all.
6251 .It Ic ~| Ar command
6252 Pipe the message through the specified filter command.
6253 If the command gives no output or terminates abnormally,
6254 retain the original text of the message.
6257 is often used as a rejustifying filter.
6261 .It Ic ~^ Ar cmd Op Ar subcmd Op Ar arg3 Op Ar arg4
6262 Low-level command ment for scripted message access, i.e., for
6263 .Va on-compose-done-shell
6265 .Va on-compose-done .
6266 The used protocol is likely subject to changes, and therefore the
6267 mentioned hooks receive the used protocol version as an initial line.
6268 In general the first field of a response line represents a status code
6269 which specifies whether a command was successful or not, whether result
6270 data is to be expected, and if, the format of the result data.
6271 The status codes are:
6274 .Bl -tag -compact -width _210_
6276 Status ok; the remains of the line are the result.
6278 Status ok; the rest of the line is optionally used for more status.
6279 What follows are lines of result addresses, terminated by an empty line.
6280 The address lines consist of two fields, the first of which is the
6281 plain address, e.g.,
6283 separated by a single ASCII SP space from the second which contains the
6284 unstripped address, even if that is identical to the first field, e.g.,
6285 .Ql (Lovely) Bob <bob@exam.ple> .
6287 Status ok; the rest of the line is optionally used for more status.
6288 What follows are lines of furtherly unspecified string content,
6289 terminated by an empty line.
6290 (All the input, including the empty line, must be consumed before
6291 further commands can be issued.)
6293 Syntax error; invalid command.
6295 Syntax error in parameters or arguments.
6297 Error: an argument fails verification.
6298 For example an invalid address has been specified.
6300 Error: an otherwise valid argument is rendered invalid due to context.
6301 For example, a second address is added to a header which may consist of
6302 a single address only.
6306 If a command indicates failure then the message will have remained
6308 Most commands can fail with
6310 if required arguments are missing (false command usage).
6311 The following commands are supported, and, as usual, case-insensitive:
6314 .Bl -hang -width header
6316 This command allows listing, inspection, and editing of message headers.
6317 The second argument specifies the subcommand to apply, one of:
6320 .Bl -hang -compact -width remove
6322 Without a third argument a list of all yet existing headers is given via
6324 this command is the default command of
6326 if no second argument has been given.
6327 A third argument restricts output to the given header only, which may
6330 if no such field is defined.
6333 Shows the content of the header given as the third argument.
6334 Dependent on the header type this may respond with
6338 any failure results in
6342 This will remove all instances of the header given as the third
6347 if no such header can be found.
6350 Create a new or an additional instance of the header given in the third
6351 argument, with the header body content as given in the fourth argument
6352 (the remains of the line).
6355 if the third argument specifies a free-form header field name that is
6356 invalid, or if body content extraction fails to succeed,
6358 if any extracted address does not pass syntax and/or security checks, and
6360 to indicate prevention of excessing a single-instance header \(em note that
6362 can be appended to (a space separator will be added automatically first).
6364 is returned upon success.
6369 This command allows listing, removal and addition of message attachments.
6370 The second argument specifies the subcommand to apply, one of:
6373 .Bl -hang -compact -width remove
6375 List all attachments via
6379 if no attachments exist.
6380 This command is the default command of
6382 if no second argument has been given.
6385 This will remove the attachment given as the third argument, and report
6389 if no such attachment can be found.
6390 If there exists any path component in the given argument, then an exact
6391 match of the path which has been used to create the attachment is used
6392 directly, but if only the basename of that path matches then all
6393 attachments are traversed to find an exact match first, and the removal
6394 occurs afterwards; if multiple basenames match, a
6397 Message attachments are treated as absolute pathnames.
6399 If no path component exists in the given argument, then all attachments
6400 will be searched for
6402 parameter matches as well as for matches of the basename of the path
6403 which has been used when the attachment has been created; multiple
6408 This will interpret the third argument as a number and remove the
6409 attachment at that list position (counting from one!), reporting
6413 if the argument is not a number or
6415 if no such attachment exists.
6418 Adds the attachment given as the third argument, specified exactly as
6419 documented for the command line option
6421 and supporting the message number extension as documented for
6425 upon success, with the index of the new attachment following,
6427 if the given file cannot be opened,
6429 if an on-the-fly performed character set conversion fails, otherwise
6431 is reported; this is also reported if character-set conversion is
6432 requested but not available.
6435 This uses the same search mechanism as described for
6437 and prints any known attributes of the first found attachment via
6441 if no such attachment can be found.
6442 The attributes are written as lines of keyword and value tuples, the
6443 keyword being separated from the rest of the line with an ASCII SP space
6447 This uses the same search mechanism as described for
6449 and is otherwise identical to
6452 .It Ar attribute-set
6453 This uses the same search mechanism as described for
6455 and will assign the attribute given as the fourth argument, which is
6456 expected to be a value tuple of keyword and other data, separated by
6457 a ASCII SP space or TAB tabulator character.
6458 If the value part is empty, then the given attribute is removed, or
6459 reset to a default value if existence of the attribute is crucial.
6462 upon success, with the index of the found attachment following,
6464 for message attachments or if the given keyword is invalid, and
6466 if no such attachment can be found.
6467 The following keywords may be used (case-insensitively):
6469 .Bl -hang -compact -width ".Ql filename"
6471 Sets the filename of the MIME part, i.e., the name that is used for
6472 display and when (suggesting a name for) saving (purposes).
6473 .It Ql content-description
6474 Associate some descriptive information to the attachment's content, used
6475 in favour of the plain filename by some MUAs.
6477 May be used for uniquely identifying MIME entities in several contexts;
6478 this expects a special reference address format as defined in RFC 2045
6481 upon address content verification failure.
6483 Specifies the media type and subtype of the part; managed automatically.
6484 .It Ql content-disposition
6485 Automatically set to the string
6489 .It Ar attribute-set-at
6490 This uses the same search mechanism as described for
6492 and is otherwise identical to
6502 .\" .Sh INTERNAL VARIABLES {{{
6503 .Sh "INTERNAL VARIABLES"
6505 Internal \*(UA variables are controlled via the
6509 commands; prefixing a variable name with the string
6513 has the same effect as using
6519 Creation or editing of variables can be performed in the
6524 will give more insight on the given variable(s), and
6526 when called without arguments, will show a listing of all variables.
6527 Both commands support a more
6530 Some well-known variables will also become inherited from the
6533 implicitly, others can be explicitly imported with the command
6535 and henceforth share said properties.
6538 Two different kind of internal variables exist.
6539 There are boolean variables, which can only be in one of the two states
6543 and value variables with a(n optional) string value.
6544 For the latter proper quoting is necessary upon assignment time, the
6545 introduction of the section
6547 documents the supported quoting rules.
6549 .Bd -literal -offset indent
6550 wysh set one=val\e 1 two="val 2" \e
6551 three='val "3"' four=$'val \e'4\e''
6552 varshow one two three four
6553 unset one two three four
6557 Dependent upon the actual option the string values will be interpreted
6558 as numbers, colour names, normal text etc., but there also exists
6559 a special kind of string value, the
6560 .Dq boolean string ,
6561 which must either be a decimal integer (in which case
6565 and any other value is true) or any of the (case-insensitive) strings
6571 for a false boolean and
6577 for a true boolean; a special kind of boolean string is the
6579 which is a boolean string that can optionally be prefixed with the
6580 (case-insensitive) term
6584 which causes prompting of the user in interactive mode, with the given
6585 boolean as the default value.
6587 .\" .Ss "Initial settings" {{{
6588 .\" (Keep in SYNC: ./nail.h:okeys, ./nail.rc, ./nail.1:"Initial settings")
6589 .Ss "Initial Settings"
6591 The standard POSIX 2008/Cor 2-2016 mandates the following initial
6597 .Pf no Va autoprint ,
6611 .Pf no Va ignoreeof ,
6613 .Pf no Va keepsave ,
6615 .Pf no Va outfolder ,
6623 .Pf no Va sendwait ,
6632 Notes: \*(UA does not support the
6634 variable \(en use command line options or
6636 to pass options through to a
6638 And the default global
6640 file, which is loaded unless the
6642 (with according argument) or
6644 command line options have been used, or the
6645 .Ev MAILX_NO_SYSTEM_RC
6646 environment variable is set, see
6647 .Sx "Resource files" )
6648 bends those initial settings a bit, e.g., it sets the variables
6653 to name a few, establishes a default
6655 selection etc., and should thus be taken into account.
6658 .\" .Ss "Variables" {{{
6661 .Bl -tag -width ".It Va BaNg"
6665 \*(RO The exit status of the last command.
6666 This exit status has a meaning for the state machine, e.g., for
6667 .Va batch-exit-on-error ,
6668 which is why \*(UA also knows about a return status, tracked in
6673 \*(RO This is a global variable which stores the last
6681 In addition an increasing number of \*(UA commands use it to indicate a
6683 exit status, since the normal exit status of a command
6685 has a meaning for the state machine.
6689 \*(RO Only available inside the scope of a
6691 ed macro, this will expand to all parameters of the macro, separated by
6693 \*(ID The special semantics of the equally named special parameter of the
6695 are not yet supported.
6699 \*(RO Only available inside the scope of a
6701 ed macro, this will expand to all parameters of the macro, separated by
6703 \*(ID The special semantics of the equally named special parameter of the
6705 are not yet supported.
6709 \*(RO Only available inside the scope of a
6711 ed macro, this will expand to the number of positional parameters in
6716 \*(RO Available inside the scope of a
6720 ed macro, this expands to the name of the calling macro, or to the empty
6721 string if the macro is running from top-level.
6722 For the \*(OPal regular expression search and replace operator of
6724 this expands to the entire matching expression.
6728 \*(RO Available inside the scope of a
6732 ed macro, this will access the first positional parameter passed.
6733 All further parameters can be accessed with this syntax, too, e.g.,
6736 etc.; positional parameters can be shifted off the stack by calling
6738 Positional parameters are also accessible in the \*(OPal regular
6739 expression search and replace expression of
6744 \*(RO Is set to the active
6749 \*(RO Is set to the list of
6753 .It Va -folder-resolved
6754 \*(RO Set to the fully resolved path of
6756 once that evaluation has occurred; rather internal.
6759 .It Va -mailbox-display
6760 \*(RO The name of the current mailbox
6762 possibly abbreviated for display purposes.
6765 .It Va -mailbox-resolved
6766 \*(RO The fully resolved path of the current mailbox.
6769 .It Va add-file-recipients
6770 \*(BO When file or pipe recipients have been specified,
6771 mention them in the corresponding address fields of the message instead
6772 of silently stripping them from their recipient list.
6773 By default such addressees are not mentioned.
6777 \*(BO Causes only the local part to be evaluated
6778 when comparing addresses.
6782 \*(BO Causes messages saved in
6784 to be appended to the end rather than prepended.
6785 This should always be set.
6789 \*(BO Causes \*(UA to prompt for the subject of each message sent.
6790 If the user responds with simply a newline,
6791 no subject field will be sent.
6795 \*(BO Causes the prompts for
6799 lists to appear after the message has been edited.
6803 \*(BO If set, \*(UA asks for files to attach at the end of each message,
6804 shall the list be found empty at that time.
6805 An empty line finalizes the list.
6809 \*(BO Causes the user to be prompted for carbon copy recipients
6810 (at the end of each message if
6814 are set) shall the list be found empty (at that time).
6815 An empty line finalizes the list.
6819 \*(BO Causes the user to be prompted for blind carbon copy
6820 recipients (at the end of each message if
6824 are set) shall the list be found empty (at that time).
6825 An empty line finalizes the list.
6829 \*(BO\*(OP Causes the user to be prompted if the message is to be
6830 signed at the end of each message.
6833 variable is ignored when this variable is set.
6837 \*(BO Alternative name for
6842 A sequence of characters to display in the
6846 as shown in the display of
6848 each for one type of messages (see
6849 .Sx "Message states" ) ,
6850 with the default being
6853 .Ql NU\ \ *HMFAT+\-$~
6856 variable is set, in the following order:
6858 .Bl -tag -compact -width ".It Ql _"
6880 start of a collapsed thread.
6882 an uncollapsed thread (TODO ignored for now).
6886 classified as possible spam.
6892 Specifies a list of recipients to which a blind carbon copy of each
6893 outgoing message will be sent automatically.
6897 Specifies a list of recipients to which a carbon copy of each outgoing
6898 message will be sent automatically.
6902 \*(BO Causes threads to be collapsed automatically when threaded mode
6909 \*(BO Enable automatic
6911 ing of a(n existing)
6917 commands, e.g., the message that becomes the new
6919 is shown automatically, as via
6926 \*(BO\*(OB Causes threaded mode (see the
6928 command) to be entered automatically when a folder is opened.
6930 .Ql autosort=thread .
6934 Causes sorted mode (see the
6936 command) to be entered automatically with the value of this variable as
6937 sorting method when a folder is opened, e.g.,
6938 .Ql set autosort=thread .
6942 \*(BO Enables the substitution of all not (reverse-solidus) escaped
6945 characters by the contents of the last executed command for the
6947 shell escape command and
6949 one of the compose mode
6950 .Sx "COMMAND ESCAPES" .
6951 If this variable is not set no reverse solidus stripping is performed.
6954 .It Va batch-exit-on-error
6955 If the batch mode has been enabled via the
6957 command line option, then this variable will be consulted whenever \*(UA
6958 completes one operation.
6959 It is ment as a convenient alternative to manually testing
6961 If any value is set, a number is expected; if it is
6963 then each failed operation will cause \*(UA to exit.
6965 \*(ID If it is set without a value, then only top-level operations that
6967 .Dq on the command-prompt ,
6968 i.e., neither in running macros nor from within source files etc., are
6969 considered, unless a main operation that directly affects the return
6970 value, like, e.g., a failed
6972 command, is affected; this mode of operation is likely to change in v15,
6973 and tests should be performed to see whether the desired effect is seen.
6977 \*(OP Terminals generate multi-byte sequences for certain forms of
6978 input, for example for function and other special keys.
6979 Some terminals however do not write these multi-byte sequences as
6980 a whole, but byte-by-byte, and the latter is what \*(UA actually reads.
6981 This variable specifies the timeout in milliseconds that the MLE (see
6982 .Sx "On terminal control and line editor" )
6983 waits for more bytes to arrive unless it considers a sequence
6989 \*(BO Causes automatic display of a header summary after executing a
6991 command, and thus complements the standard variable
6993 which controls header summary display on program startup.
6994 It is only meaningful if
7000 \*(BO Sets some cosmetical features to traditional BSD style;
7001 has the same affect as setting
7003 and all other variables prefixed with
7005 it also changes the behaviour of
7007 (which does not exist in BSD).
7011 \*(BO Changes the letters shown in the first column of a header
7012 summary to traditional BSD style.
7016 \*(BO Changes the display of columns in a header summary to traditional
7021 \*(BO Changes some informational messages to traditional BSD style.
7027 field to appear immediately after the
7029 field in message headers and with the
7031 .Sx "COMMAND ESCAPES" .
7035 The value that should appear in the
7039 MIME header fields when no character set conversion of the message data
7041 This defaults to US-ASCII, and the chosen character set should be
7042 US-ASCII compatible.
7046 \*(OP The default 8-bit character set that is used as an implicit last
7047 member of the variable
7049 This defaults to UTF-8 if character-set conversion capabilities are
7050 available, and to ISO-8859-1 otherwise, in which case the only supported
7053 and this variable is effectively ignored.
7054 Refer to the section
7055 .Sx "Character sets"
7056 for the complete picture of character set conversion in \*(UA.
7059 .It Va charset-unknown-8bit
7060 \*(OP RFC 1428 specifies conditions when internet mail gateways shall
7062 the content of a mail message by using a character set with the name
7064 Because of the unclassified nature of this character set \*(UA will not
7065 be capable to convert this character set to any other character set.
7066 If this variable is set any message part which uses the character set
7068 is assumed to really be in the character set given in the value,
7069 otherwise the (final) value of
7071 is used for this purpose.
7073 This variable will also be taken into account if a MIME type (see
7074 .Sx "The mime.types files" )
7075 of a MIME message part that uses the
7077 character set is forcefully treated as text.
7081 The default value for the
7086 .It Va colour-disable
7087 \*(BO\*(OP Forcefully disable usage of colours.
7088 Also see the section
7089 .Sx "Coloured display" .
7093 \*(BO\*(OP Whether colour shall be used for output that is paged through
7095 Note that pagers may need special command line options, e.g.,
7103 in order to support colours.
7104 Often doing manual adjustments is unnecessary since \*(UA may perform
7105 adjustments dependent on the value of the environment variable
7107 (see there for more).
7111 In a(n interactive) terminal session, then if this valued variable is
7112 set it will be used as a threshold to determine how many lines the given
7113 output has to span before it will be displayed via the configured
7117 can be forced by setting this to the value
7119 setting it without a value will deduce the current height of the
7120 terminal screen to compute the treshold (see
7125 \*(ID At the moment this uses the count of lines of the message in wire
7126 format, which, dependent on the
7128 of the message, is unrelated to the number of display lines.
7129 (The software is old and historically the relation was a given thing.)
7133 Define a set of custom headers to be injected into newly composed or
7134 forwarded messages; it is also possible to create custom headers in
7137 which can be automated by setting one of the hooks
7138 .Va on-compose-done-shell
7140 .Va on-compose-done .
7141 The value is interpreted as a comma-separated list of custom headers to
7142 be injected, to include commas in the header bodies escape them with
7144 \*(ID Overwriting of automatically managed headers is neither supported
7147 .Dl set customhdr='Hdr1: Body1-1\e, Body1-2, Hdr2: Body2'
7153 the message date, if any is to be displayed according to the format of
7155 is by default taken from the
7157 line of the message.
7158 If this variable is set the date as given in the
7160 header field is used instead, converted to local time.
7161 To control the display format of the date assign a valid
7166 format should not be used, because \*(UA does not take embedded newlines
7167 into account when calculating how many lines fit onto the screen.)
7169 .Va datefield-markout-older .
7172 .It Va datefield-markout-older
7173 This variable, when set in addition to
7177 messages (concept is rather comparable to the
7179 option of the POSIX utility
7181 The content interpretation is identical to
7186 \*(BO Enables debug messages and obsoletion warnings, disables the
7187 actual delivery of messages and also implies
7193 .It Va disposition-notification-send
7195 .Ql Disposition-Notification-To:
7196 header (RFC 3798) with the message.
7200 .\" TODO .It Va disposition-notification-send-HOST
7202 .\".Va disposition-notification-send
7203 .\" for SMTP accounts on a specific host.
7204 .\" TODO .It Va disposition-notification-send-USER@HOST
7206 .\".Va disposition-notification-send
7207 .\"for a specific account.
7211 \*(BO When dot is set, a period
7213 on a line by itself during message input in (interactive) compose mode
7214 will be treated as end-of-message (in addition to the normal end-of-file
7223 .It Va dotlock-ignore-error
7224 \*(BO\*(OP Synchronization of mailboxes which \*(UA treats as
7226 .Sx "primary system mailbox" Ns
7227 es (see, e.g., the notes on
7228 .Sx "Filename transformations" ,
7229 as well as the documentation of
7231 will be protected with so-called dotlock files\(emthe traditional mail
7232 spool file locking method\(emin addition to system file locking.
7233 Because \*(UA ships with a privilege-separated dotlock creation program
7234 that should always be able to create such a dotlock file there is no
7235 good reason to ignore dotlock file creation errors, and thus these are
7236 fatal unless this variable is set.
7240 \*(BO If this variable is set then the editor is started automatically
7241 when a message is composed in interactive mode, as if the
7243 .Sx "COMMAND ESCAPES"
7247 variable is implied for this automatically spawned editor session.
7251 \*(BO When a message is edited while being composed,
7252 its header is included in the editable text.
7262 fields are accepted within the header, other fields are ignored.
7266 \*(BO When entering interactive mode \*(UA normally writes
7267 .Dq \&No mail for user
7268 and exits immediately if a mailbox is empty or does not exist.
7269 If this variable is set \*(UA starts even with an empty or nonexistent
7270 mailbox (the latter behaviour furtherly depends upon
7277 .Ql Content-Transfer-Encoding
7278 to use in outgoing text messages and message parts, where applicable.
7279 (7-bit clean text messages are sent as-is, without a transfer encoding.)
7282 .Bl -tag -compact -width "_%%_"
7285 8-bit transport effectively causes the raw data be passed through
7286 unchanged, but may cause problems when transferring mail messages over
7287 channels that are not ESMTP (RFC 1869) compliant.
7288 Also, several input data constructs are not allowed by the
7289 specifications and may cause a different transfer-encoding to be used.
7290 .It Ql quoted-printable
7292 Quoted-printable encoding is 7-bit clean and has the property that ASCII
7293 characters are passed through unchanged, so that an english message can
7294 be read as-is; it is also acceptible for other single-byte locales that
7295 share many characters with ASCII, like, e.g., ISO-8859-1.
7296 The encoding will cause a large overhead for messages in other character
7297 sets: e.g., it will require up to twelve (12) bytes to encode a single
7298 UTF-8 character of four (4) bytes.
7300 .Pf (Or\0 Ql b64 . )
7301 The default encoding, it is 7-bit clean and will always be used for
7303 This encoding has a constant input:output ratio of 3:4, regardless of
7304 the character set of the input data it will encode three bytes of input
7305 to four bytes of output.
7306 This transfer-encoding is not human readable without performing
7312 If defined, the first character of the value of this variable
7313 gives the character to use in place of tilde
7316 .Sx "COMMAND ESCAPES" .
7317 If set to the empty string, command escapes are disabled.
7321 If not set then file and command pipeline targets are not allowed,
7322 and any such address will be filtered out, giving a warning message.
7323 If set without a value then all possible recipient address
7324 specifications will be accepted \(en see the section
7325 .Sx "On sending mail, and non-interactive mode"
7327 To accept them, but only in interactive mode, or when tilde commands
7328 were enabled explicitly by using one of the command line options
7332 set this to the (case-insensitive) value
7334 (it actually acts like
7335 .Ql restrict,-all,+name,+addr ,
7336 so that care for ordering issues must be taken) .
7338 In fact the value is interpreted as a comma-separated list of values.
7341 then the existence of disallowed specifications is treated as a hard
7342 send error instead of only filtering them out.
7343 The remaining values specify whether a specific type of recipient
7344 address specification is allowed (optionally indicated by a plus sign
7346 prefix) or disallowed (prefixed with a hyphen-minus
7350 addresses all possible address specifications,
7354 command pipeline targets,
7356 plain user names and (MTA) aliases (\*(OB
7358 may be used as an alternative syntax to
7363 These kind of values are interpreted in the given order, so that
7364 .Ql restrict,\:fail,\:+file,\:-all,\:+addr
7365 will cause hard errors for any non-network address recipient address
7366 unless \*(UA is in interactive mode or has been started with the
7370 command line option; in the latter case(s) any address may be used, then.
7372 Historically invalid network addressees are silently stripped off.
7373 To change this and ensure that any encountered invalid email address
7374 instead causes a hard error, ensure the string
7376 is an entry in the above list.
7377 Setting this automatically enables network addressees
7378 (it actually acts like
7379 .Ql failinvaddr,+addr ,
7380 so that care for ordering issues must be taken) .
7384 Unless this variable is set additional
7386 (Mail-Transfer-Agent)
7387 arguments from the command line, as can be given after a
7389 separator, are ignored due to safety reasons.
7390 However, if set to the special (case-insensitive) value
7392 then the presence of additional MTA arguments is treated as a hard
7393 error that causes \*(UA to exit with failure status.
7394 A lesser strict variant is the otherwise identical
7396 which does accept such arguments in interactive mode, or if tilde
7397 commands were enabled explicitly by using one of the command line options
7404 \*(RO String giving a list of features \*(UA, preceded with a plus-sign
7406 if the feature is available, and a minus-sign
7409 The output of the command
7411 will include this information.
7415 \*(BO This setting reverses the meanings of a set of reply commands,
7416 turning the lowercase variants, which by default address all recipients
7417 included in the header of a message
7418 .Pf ( Ic reply , respond , followup )
7419 into the uppercase variants, which by default address the sender only
7420 .Pf ( Ic Reply , Respond , Followup )
7423 .Ic replysender , respondsender , followupsender
7425 .Ic replyall , respondall , followupall
7426 are not affected by the current setting of
7431 .It Va file-hook-load-EXTENSION , file-hook-save-EXTENSION
7432 It is possible to install file hooks which will be used by the
7434 command in order to be able to transparently handle (through an
7435 intermediate temporary file) files with specific
7437 s: the variable values can include shell snippets and are expected to
7438 write data to standard output / read data from standard input,
7440 \*(ID The variables may not be changed while there is a mailbox
7442 .Bd -literal -offset indent
7443 set file-hook-load-xy='echo >&2 XY-LOAD; gzip -cd' \e
7444 file-hook-save-xy='echo >&2 XY-SAVE; gzip -c' \e
7445 record=+null-sent.xy
7450 The default path under which mailboxes are to be saved:
7451 file names that begin with the plus-sign
7453 will have the plus-sign replaced with the value of this variable if set,
7454 otherwise the plus-sign will remain unchanged when doing
7455 .Sx "Filename transformations" ;
7458 for more on this topic.
7459 The value supports a subset of transformations itself, and if the
7460 non-empty value does not start with a solidus
7464 will be prefixed automatically.
7468 This variable can be set to the name of a
7470 macro which will be called whenever a
7473 The macro will also be invoked when new mail arrives,
7474 but message lists for commands executed from the macro
7475 only include newly arrived messages then.
7477 are activated by default in a folder hook, causing the covered settings
7478 to be reverted once the folder is left again.
7481 Macro behaviour, including option localization, will change in v15.
7482 One should be aware of that and possibly embed version checks in the
7483 used resource file(s).
7486 .It Va folder-hook-FOLDER
7491 Unlike other folder specifications, the fully expanded name of a folder,
7492 without metacharacters, is used to avoid ambiguities.
7493 However, if the mailbox resides under
7497 specification is tried in addition, e.g., if
7501 (and thus relative to the user's home directory) then
7502 .Pa /home/usr1/mail/sent
7504 .Ql folder-hook-/home/usr1/mail/sent
7505 first, but then followed by
7506 .Ql folder-hook-+sent .
7510 \*(BO Controls whether a
7511 .Ql Mail-Followup-To:
7512 header is generated when sending messages to known mailing lists.
7514 .Va followup-to-honour
7516 .Ic mlist , mlsubscribe , reply
7521 .It Va followup-to-honour
7523 .Ql Mail-Followup-To:
7524 header is honoured when group-replying to a message via
7528 This is a quadoption; if set without a value it defaults to
7538 .It Va forward-as-attachment
7539 \*(BO Original messages are normally sent as inline text with the
7542 and only the first part of a multipart message is included.
7543 With this setting enabled messages are sent as unmodified MIME
7545 attachments with all of their parts included.
7549 The address (or a list of addresses) to put into the
7551 field of the message header, quoting RFC 5322:
7552 the author(s) of the message, that is, the mailbox(es) of the person(s)
7553 or system(s) responsible for the writing of the message.
7556 ing to messages these addresses are handled as if they were in the
7560 If the machine's hostname is not valid at the Internet (for example at
7561 a dialup machine) then either this variable or
7563 (\*(IN and with a defined SMTP protocol in
7566 adds even more fine-tuning capabilities),
7570 contains more than one address,
7573 variable is required (according to the standard RFC 5322).
7575 If a file-based MTA is used, then
7577 (or, if that contains multiple addresses,
7579 can nonetheless be enforced to appear as the envelope sender address at
7580 the MTA protocol level (the RFC 5321 reverse-path), either by using the
7582 command line option (with an empty argument; see there for the complete
7583 picture on this topic), or by setting the internal variable
7584 .Va r-option-implicit .
7588 \*(BO When replying to or forwarding a message \*(UA normally removes
7589 the comment and name parts of email addresses.
7590 If this variable is set such stripping is not performed,
7591 and comments, names etc. are retained.
7595 The string to put before the text of a message with the
7599 .Va forward-as-attachment
7602 .Dq -------- Original Message --------
7603 if unset; No heading is put if it is set to the empty string.
7607 \*(BO Causes the header summary to be written at startup and after
7608 commands that affect the number of messages or the order of messages in
7609 the current folder; enabled by default.
7610 The command line option
7616 complements this and controls header summary display on folder changes.
7621 A format string to use for the summary of
7623 similar to the ones used for
7626 Format specifiers in the given string start with a percent character
7628 and may be followed by an optional decimal number indicating the field
7629 width \(em if that is negative, the field is to be left-aligned.
7630 Valid format specifiers are:
7633 .Bl -tag -compact -width "_%%_"
7635 A plain percent character.
7638 a space character but for the current message
7640 for which it expands to
7644 a space character but for the current message
7646 for which it expands to
7649 \*(OP The spam score of the message, as has been classified via the
7652 Shows only a replacement character if there is no spam support.
7654 Message attribute character (status flag); the actual content can be
7658 The date when the message was received, or the date found in the
7662 variable is set (optionally to a date display format string).
7664 The indenting level in threaded mode.
7666 The address of the message sender.
7668 The message thread tree structure.
7669 (Note that this format does not support a field width.)
7671 The number of lines of the message, if available.
7675 The number of octets (bytes) in the message, if available.
7677 Message subject (if any).
7679 Message subject (if any) in double quotes.
7681 Message recipient flags: is the addressee of the message a known or
7682 subscribed mailing list \(en see
7687 The position in threaded/sorted order.
7691 .Ql %>\&%a\&%m\ %-18f\ %16d\ %4l/%\-5o\ %i%-s ,
7693 .Ql %>\&%a\&%m\ %20-f\ \ %16d\ %3l/%\-5o\ %i%-S
7704 .It Va headline-bidi
7705 Bidirectional text requires special treatment when displaying headers,
7706 because numbers (in dates or for file sizes etc.) will not affect the
7707 current text direction, in effect resulting in ugly line layouts when
7708 arabic or other right-to-left text is to be displayed.
7709 On the other hand only a minority of terminals is capable to correctly
7710 handle direction changes, so that user interaction is necessary for
7712 Note that extended host system support is required nonetheless, e.g.,
7713 detection of the terminal character set is one precondition;
7714 and this feature only works in an Unicode (i.e., UTF-8) locale.
7716 In general setting this variable will cause \*(UA to encapsulate text
7717 fields that may occur when displaying
7719 (and some other fields, like dynamic expansions in
7721 with special Unicode control sequences;
7722 it is possible to fine-tune the terminal support level by assigning
7724 no value (or any value other than
7729 will make \*(UA assume that the terminal is capable to properly deal
7730 with Unicode version 6.3, in which case text is embedded in a pair of
7731 U+2068 (FIRST STRONG ISOLATE) and U+2069 (POP DIRECTIONAL ISOLATE)
7733 In addition no space on the line is reserved for these characters.
7735 Weaker support is chosen by using the value
7737 (Unicode 6.3, but reserve the room of two spaces for writing the control
7738 sequences onto the line).
7743 select Unicode 1.1 support (U+200E, LEFT-TO-RIGHT MARK); the latter
7744 again reserves room for two spaces in addition.
7748 \*(OP If a line editor is available then this can be set to
7749 name the (expandable) path of the location of a permanent history file.
7754 .It Va history-gabby
7755 \*(BO\*(OP Add more entries to the history as is normally done.
7758 .It Va history-gabby-persist
7759 \*(BO\*(OP \*(UA's own MLE will not save the additional
7761 entries in persistent storage unless this variable is set.
7762 On the other hand it will not loose the knowledge of whether
7763 a persistent entry was gabby or not.
7769 \*(OP Setting this variable imposes a limit on the number of concurrent
7771 If set to the value 0 then no further history entries will be added, and
7772 loading and incorporation of the
7774 upon program startup can also be suppressed by doing this.
7775 Runtime changes will not be reflected, but will affect the number of
7776 entries saved to permanent storage.
7780 \*(BO This setting controls whether messages are held in the system
7782 and it is set by default.
7786 Use this string as hostname when expanding local addresses instead of
7787 the value obtained from
7791 It is used, e.g., in
7795 fields, as well as when generating
7797 MIME part related unique ID fields.
7798 Setting it to the empty string will cause the normal hostname to be
7799 used, but nonetheless enables creation of said ID fields.
7800 \*(IN in conjunction with the builtin SMTP
7803 also influences the results:
7804 one should produce some test messages with the desired combination of
7813 \*(BO\*(OP Can be used to turn off the automatic conversion of domain
7814 names according to the rules of IDNA (internationalized domain names
7816 Since the IDNA code assumes that domain names are specified with the
7818 character set, an UTF-8 locale charset is required to represent all
7819 possible international domain names (before conversion, that is).
7823 \*(BO Ignore interrupt signals from the terminal while entering
7824 messages; instead echo them as
7826 characters and discard the current line.
7830 \*(BO Ignore end-of-file conditions
7831 .Pf ( Ql control-D )
7832 in compose mode on message input and in interactive command input.
7833 If set an interactive command input session can only be left by
7834 explicitly using one of the commands
7838 and message input in compose mode can only be terminated by entering
7841 on a line by itself or by using the
7843 .Sx "COMMAND ESCAPES" ;
7845 overrides a setting of
7850 If this is set to a non-empty string it will specify the users
7852 .Sx "primary system mailbox" ,
7855 and the system-dependent default, and (thus) be used to replace
7858 .Sx "Filename transformations" ;
7861 for more on this topic.
7862 The value supports a subset of transformations itself.
7870 .Sx "COMMAND ESCAPES"
7873 option for indenting messages,
7874 in place of the normal tabulator character
7876 which is the default.
7877 Be sure to quote the value if it contains spaces or tabs.
7881 \*(BO If set, an empty system (MBOX) mailbox file is not removed.
7882 Note that, in conjunction with
7885 .Ev POSIXLY_CORRECT )
7886 any empty file will be removed unless this variable is set.
7887 This may improve the interoperability with other mail user agents
7888 when using a common folder directory, and prevents malicious users
7889 from creating fake mailboxes in a world-writable spool directory.
7890 \*(ID Only local regular (MBOX) files are covered, Maildir or other
7891 mailbox types will never be removed, even if empty.
7894 .It Va keep-content-length
7895 \*(BO When (editing messages and) writing
7897 mailbox files \*(UA can be told to keep the
7901 header fields that some MUAs generate by setting this variable.
7902 Since \*(UA does neither use nor update these non-standardized header
7903 fields (which in itself shows one of their conceptual problems),
7904 stripping them should increase interoperability in between MUAs that
7905 work with with same mailbox files.
7906 Note that, if this is not set but
7907 .Va writebackedited ,
7908 as below, is, a possibly performed automatic stripping of these header
7909 fields already marks the message as being modified.
7913 \*(BO When a message is saved it is usually discarded from the
7914 originating folder when \*(UA is quit.
7915 This setting causes all saved message to be retained.
7918 .It Va line-editor-disable
7919 \*(BO Turn off any enhanced line editing capabilities (see
7920 .Sx "On terminal control and line editor"
7924 .It Va line-editor-no-defaults
7925 \*(BO\*(OP Do not establish any default key binding.
7928 .It Va mailx-extra-rc
7929 An additional startup file that is loaded as the last of the
7930 .Sx "Resource files" .
7931 Use this file for commands that are not understood by other POSIX
7937 \*(BO When a message is replied to and this variable is set,
7938 it is marked as having been
7941 .Sx "Message states" .
7945 \*(BO If this is set then when opening MBOX mailbox files \*(UA will not
7946 use the tolerant POSIX rules for detecting message boundaries (so-called
7948 lines), as it does by default for compatibility reasons, but the more
7949 strict rules that have been defined in RFC 4155.
7950 When saving to MBOX mailboxes this indicates when so-called
7952 quoting is to be applied \(em note this is never necessary for any
7953 message newly generated by \*(UA, it only applies to messages generated
7954 by buggy or malicious MUAs.
7955 (\*(UA will use a proper
7959 lines cannot be misinterpreted as message boundaries.)
7961 This should not be set normally, but may be handy when \*(UA complains
7962 about having seen invalid
7964 lines when opening a MBOX: in this case temporarily setting this
7965 variable, re-opening the mailbox in question, unsetting this variable
7966 again and then invoking
7967 .Ql copy * SOME-FILE
7968 will perform proper, POSIX-compliant
7970 quoting for all detected messages, resulting in a valid MBOX mailbox.
7974 \*(BO Internal development variable.
7977 .It Va message-id-disable
7978 \*(BO By setting this variable the generation of
7980 can be completely suppressed, effectively leaving this task up to the
7982 (Mail-Transfer-Agent) or the SMTP server.
7983 (According to RFC 5321 a SMTP server is not required to add this
7984 field by itself, so it should be ensured that it accepts messages without
7986 This variable also affects automatic generation of
7991 .It Va message-inject-head
7992 A string to put at the beginning of each new message.
7993 The escape sequences tabulator
8000 .It Va message-inject-tail
8001 A string to put at the end of each new message.
8002 The escape sequences tabulator
8010 \*(BO Usually, when an
8012 expansion contains the sender, the sender is removed from the expansion.
8013 Setting this option suppresses these removals.
8018 option to be passed through to the
8020 (Mail-Transfer-Agent); though most of the modern MTAs no longer document
8021 this flag, no MTA is known which does not support it (for historical
8025 .It Va mime-allow-text-controls
8026 \*(BO When sending messages, each part of the message is MIME-inspected
8027 in order to classify the
8030 .Ql Content-Transfer-Encoding:
8033 that is required to send this part over mail transport, i.e.,
8034 a computation rather similar to what the
8036 command produces when used with the
8040 This classification however treats text files which are encoded in
8041 UTF-16 (seen for HTML files) and similar character sets as binary
8042 octet-streams, forcefully changing any
8047 .Ql application/octet-stream :
8048 If that actually happens a yet unset charset MIME parameter is set to
8050 effectively making it impossible for the receiving MUA to automatically
8051 interpret the contents of the part.
8053 If this variable is set, and the data was unambiguously identified as
8054 text data at first glance (by a
8058 file extension), then the original
8060 will not be overwritten.
8063 .It Va mime-alternative-favour-rich
8064 \*(BO If this variable is set then rich MIME alternative parts (e.g.,
8065 HTML) will be preferred in favour of included plain text versions when
8066 displaying messages, provided that a handler exists which produces
8067 output that can be (re)integrated into \*(UA's normal visual display.
8068 (E.g., at the time of this writing some newsletters ship their full
8069 content only in the rich HTML part, whereas the plain text part only
8070 contains topic subjects.)
8073 .It Va mime-counter-evidence
8076 field is used to decide how to handle MIME parts.
8077 Some MUAs however do not use
8079 or a similar mechanism to correctly classify content, but simply specify
8080 .Ql application/octet-stream ,
8081 even for plain text attachments like
8083 If this variable is set then \*(UA will try to classify such MIME
8084 message parts on its own, if possible, for example via a possibly
8085 existing attachment filename.
8086 A non-empty value may also be given, in which case a number is expected,
8087 actually a carrier of bits.
8088 Creating the bit-carrying number is a simple addition:
8089 .Bd -literal -offset indent
8090 ? !echo Value should be set to $((2 + 4 + 8))
8091 Value should be set to 14
8094 .Bl -bullet -compact
8096 If bit two is set (2) then the detected
8098 content-type will be carried along with the message and be used for
8100 .Va pipe-TYPE/SUBTYPE
8101 is responsible for the MIME part, shall that question arise;
8102 when displaying such a MIME part the part-info will indicate the
8103 overridden content-type by showing a plus-sign
8106 If bit three is set (4) then the counter-evidence is always produced
8107 and a positive result will be used as the MIME type, even forcefully
8108 overriding the parts given MIME type.
8110 If bit four is set (8) then as a last resort the actual content of
8111 .Ql application/octet-stream
8112 parts will be inspected, so that data which looks like plain text can be
8117 .It Va mimetypes-load-control
8118 Can be used to control which of the
8120 databases are loaded by \*(UA, as furtherly described in the section
8121 .Sx "The mime.types files" .
8124 is part of the option value, then the user's personal
8126 file will be loaded (if it exists); likewise the letter
8128 controls loading of the system wide
8129 .Pa /etc/mime.types ;
8130 directives found in the user file take precedence, letter matching is
8132 If this variable is not set \*(UA will try to load both files.
8133 Incorporation of the \*(UA-builtin MIME types cannot be suppressed,
8134 but they will be matched last (the order can be listed via
8137 More sources can be specified by using a different syntax: if the
8138 value string contains an equals sign
8140 then it is instead parsed as a comma-separated list of the described
8143 pairs; the given filenames will be expanded and loaded, and their
8144 content may use the extended syntax that is described in the section
8145 .Sx "The mime.types files" .
8146 Directives found in such files always take precedence (are prepended to
8147 the MIME type cache).
8152 To choose an alternate Mail-Transfer-Agent, set this option to either
8153 the full pathname of an executable (optionally prefixed with a
8155 protocol indicator), or \*(OPally a SMTP protocol URL, e.g., \*(IN
8157 .Dl smtps?://[user[:password]@]server[:port]
8160 .Ql [smtp://]server[:port] . )
8161 The default has been chosen at compie time.
8162 All supported data transfers are executed in child processes, which
8163 run asynchronously, and without supervision, unless either the
8168 If such a child receives a TERM signal, it will abort and
8175 For a file-based MTA it may be necessary to set
8177 in in order to choose the right target of a modern
8180 It will be passed command line arguments from several possible sources:
8183 if set, from the command line if given and the variable
8186 Argument processing of the MTA will be terminated with a
8191 The otherwise occurring implicit usage of the following MTA command
8192 line arguments can be disabled by setting the boolean variable
8193 .Va mta-no-default-arguments
8194 (which will also disable passing
8198 (for not treating a line with only a dot
8200 character as the end of input),
8208 variable is set); in conjunction with the
8210 command line option \*(UA will also (not) pass
8216 \*(OP \*(UA can send mail over SMTP network connections to a single
8217 defined SMTP smarthost, the access URL of which has to be assigned to
8219 To use this mode it is helpful to read
8220 .Sx "On URL syntax and credential lookup" .
8221 It may be necessary to set the
8223 variable in order to use a specific combination of
8228 with some mail providers.
8231 .Bl -bullet -compact
8233 The plain SMTP protocol (RFC 5321) that normally lives on the
8234 server port 25 and requires setting the
8235 .Va smtp-use-starttls
8236 variable to enter a SSL/TLS encrypted session state.
8237 Assign a value like \*(IN
8238 .Ql smtp://[user[:password]@]server[:port]
8240 .Ql smtp://server[:port] )
8241 to choose this protocol.
8243 The so-called SMTPS which is supposed to live on server port 465
8244 and is automatically SSL/TLS secured.
8245 Unfortunately it never became a standardized protocol and may thus not
8246 be supported by your hosts network service database
8247 \(en in fact the port number has already been reassigned to other
8250 SMTPS is nonetheless a commonly offered protocol and thus can be
8251 chosen by assigning a value like \*(IN
8252 .Ql smtps://[user[:password]@]server[:port]
8254 .Ql smtps://server[:port] ) ;
8255 due to the mentioned problems it is usually necessary to explicitly
8260 Finally there is the SUBMISSION protocol (RFC 6409), which usually
8261 lives on server port 587 and is practically identically to the SMTP
8262 protocol from \*(UA's point of view beside that; it requires setting the
8263 .Va smtp-use-starttls
8264 variable to enter a SSL/TLS secured session state.
8265 Assign a value like \*(IN
8266 .Ql submission://[user[:password]@]server[:port]
8268 .Ql submission://server[:port] ) .
8273 .It Va mta-arguments
8274 Arguments to pass through to a file-based
8276 can be given via this variable, the content of which will be split up in
8277 a vector of arguments, to be joined onto other possible MTA options:
8279 .Dl set mta-arguments='-t -X \&"/tmp/my log\&"'
8282 .It Va mta-no-default-arguments
8283 \*(BO Unless this variable is set \*(UA will pass some well known
8284 standard command line options to a file-based
8286 (Mail-Transfer-Agent), see there for more.
8290 Many systems use a so-called
8292 environment to ensure compatibility with
8294 This works by inspecting the name that was used to invoke the mail
8296 If this variable is set then the mailwrapper (the program that is
8297 actually executed when calling the file-based
8299 will treat its contents as that name.
8304 .It Va netrc-lookup-USER@HOST , netrc-lookup-HOST , netrc-lookup
8305 \*(BO\*(IN\*(OP Used to control usage of the users
8307 file for lookup of account credentials, as documented in the section
8308 .Sx "On URL syntax and credential lookup"
8312 .Sx "The .netrc file"
8313 documents the file format.
8325 then \*(UA will read the output of a shell pipe instead of the users
8327 file if this variable is set (to the desired shell command).
8328 This can be used to, e.g., store
8332 .Dl set netrc-pipe='gpg -qd ~/.netrc.pgp'
8336 If this variable has the value
8338 newly created local folders will be in Maildir format.
8342 Checks for new mail in the current folder each time the prompt is shown.
8343 A Maildir folder must be re-scanned to determine if new mail has arrived.
8344 If this variable is set to the special value
8346 then a Maildir folder will not be rescanned completely, but only
8347 timestamp changes are detected.
8351 .It Va on-compose-done-shell , on-compose-done
8352 These hooks run once the normal compose mode is finished, but before the
8353 .Va on-compose-leave
8354 macro hook is called, the
8357 Both hooks will be executed in a subprocess, with their input and output
8358 connected to \*(UA such that they can act as if they would be an
8360 The difference in between them is that the former is a
8362 command, whereas the latter is a normal \*(UA macro, but which is
8363 restricted to a small set of commands (the
8367 will indicate said capability), just enough for the purpose of
8368 controlling the real \*(UA instance sufficiently.
8370 are enabled for these hooks (in the parent process), causing any setting
8371 to be forgotten after the message has been sent.
8373 During execution of these hook \*(UA will temporarily forget whether it
8374 has been started in interactive mode, (a restricted set of)
8375 .Sx "COMMAND ESCAPES"
8376 will always be available, and for guaranteed reproduceabilities sake
8378 will be set to its default.
8379 The compose mode command
8381 has been especially designed for scriptability (via these hooks).
8382 The first line the hook will read on its standard input is the protocol
8383 version of said command escape, currently
8385 backward incompatible protocol changes are to be expected in the
8386 future, and it is advisable to make use of the protocol version.
8387 \*(ID because most \*(UA commands do not take this new functionality
8388 into account but are ment for human interaction special care must be
8389 taken to avoid deadlocks because of unexpected control flow; i.e., that
8390 both involved processes wait for more input to happen at the same time,
8391 or one doesn't expect more input but the other is stuck waiting for
8392 consumation of its output.
8393 .Bd -literal -offset indent
8394 wysh set on-compose-done-shell=$'\e
8396 printf "hello $version! Headers: ";\e
8397 echo \e'~^header list\e';\e
8398 read status result;\e
8399 echo "status=$status result=$result";\e
8402 set on-compose-done=ocdm
8405 echo version is $ver, escape=$escape
8406 if [ "$features" !@ +regex ]
8407 echoerr 'Need regular-expression support, aborting send'
8410 echo '~^header list'
8413 echoerr 'Failed to read header list, bailing out'
8416 if [ "$hl" !@ ' cc' ]
8417 echo '~^header insert cc Diet is your <mirr.or>'
8420 echoerr 'Failed to insert Cc: header, bailing out'
8424 echo '~:set from="Hoola Hoop <hh@exam.ple>"'
8430 .It Va on-compose-enter , on-compose-leave
8431 Macro hooks which will be executed before compose mode is entered, and
8432 after composing has been finished (but before the
8434 is injected, etc.), respectively.
8436 are enabled for these hooks, causing any setting to be forgotten after
8437 the message has been sent.
8438 The following (read-only) variables will be set temporarily during
8439 execution of the macros:
8441 .Bl -tag -compact -width ".It Va compose_subject"
8444 .It Va compose-sender
8446 .It Va compose-to , compose-cc , compose-bcc
8447 The list of receiver addresses as a space-separated list.
8448 .It Va compose-subject
8454 \*(BO Causes the filename given in the
8457 and the sender-based filenames for the
8461 commands to be interpreted relative to the directory given in the
8463 variable rather than to the current directory,
8464 unless it is set to an absolute pathname.
8468 \*(BO If set, each message feed through the command given for
8470 is followed by a formfeed character
8474 .It Va password-USER@HOST , password-HOST , password
8475 \*(IN Variable chain that sets a password, which is used in case none has
8476 been given in the protocol and account-specific URL;
8477 as a last resort \*(UA will ask for a password on the user's terminal if
8478 the authentication method requires a password.
8479 Specifying passwords in a startup file is generally a security risk;
8480 the file should be readable by the invoking user only.
8482 .It Va password-USER@HOST
8483 \*(OU (see the chain above for \*(IN)
8484 Set the password for
8488 If no such variable is defined for a host,
8489 the user will be asked for a password on standard input.
8490 Specifying passwords in a startup file is generally a security risk;
8491 the file should be readable by the invoking user only.
8495 \*(BO Send messages to the
8497 command without performing MIME and character set conversions.
8501 .It Va pipe-TYPE/SUBTYPE
8502 When a MIME message part of type
8504 (case-insensitive) is displayed or quoted,
8505 its text is filtered through the value of this variable interpreted as
8509 forces interpretation of the message part as plain text, e.g.,
8510 .Ql set pipe-application/xml=@
8511 will henceforth display XML
8513 (The same could also be achieved by adding a MIME type marker with the
8516 And \*(OPally MIME type handlers may be defined via
8517 .Sx "The Mailcap files"
8518 \(em corresponding flag strings are shown in parenthesis below.)
8523 can in fact be used to adjust usage and behaviour of a following shell
8524 command specification by appending trigger characters to it, e.g., the
8525 following hypothetical command specification could be used:
8526 .Bd -literal -offset indent
8527 set pipe-X/Y='@*!++=@vim ${MAILX_FILENAME_TEMPORARY}'
8531 .Bl -tag -compact -width ".It Ql __"
8533 Simply by using the special
8535 prefix the MIME type (shell command) handler will only be invoked to
8536 display or convert the MIME part if the message is addressed directly
8537 and alone by itself.
8538 Use this trigger to disable this and always invoke the handler
8539 .Pf ( Cd x-mailx-always ) .
8542 If set the handler will not be invoked when a message is to be quoted,
8543 but only when it will be displayed
8544 .Pf ( Cd x-mailx-noquote ) .
8547 The command will be run asynchronously, i.e., without blocking \*(UA,
8548 which may be a handy way to display a, e.g., PDF file while also
8549 continuing to read the mail message
8550 .Pf ( Cd x-mailx-async ) .
8551 Asynchronous execution implies
8555 The command must be run on an interactive terminal, \*(UA will
8556 temporarily release the terminal to it
8557 .Pf ( Cd needsterminal ) .
8558 This flag is mutual exclusive with
8560 will only be used in interactive mode and implies
8564 Request creation of a zero-sized temporary file, the absolute pathname
8565 of which will be made accessible via the environment variable
8566 .Ev MAILX_FILENAME_TEMPORARY
8567 .Pf ( Cd x-mailx-tmpfile ) .
8568 If this trigger is given twice then the file will be unlinked
8569 automatically by \*(UA when the command loop is entered again at latest
8570 .Pf ( Cd x-mailx-tmpfile-unlink ) .
8571 (Do not use this for asynchronous handlers.)
8574 Normally the MIME part content is passed to the handler via standard
8575 input; if this flag is set then the data will instead be written into
8576 .Ev MAILX_FILENAME_TEMPORARY
8577 .Pf ( Cd x-mailx-tmpfile-fill ) ,
8578 the creation of which is implied; note however that in order to cause
8579 deletion of the temporary file you still have to use two plus signs
8584 To avoid ambiguities with normal shell command content you can use
8585 another at-sign to forcefully terminate interpretation of remaining
8587 (Any character not in this list will have the same effect.)
8591 Some information about the MIME part to be displayed is embedded into
8592 the environment of the shell command:
8595 .Bl -tag -compact -width ".It Ev _AIL__ILENAME__ENERATED"
8597 .It Ev MAILX_CONTENT
8598 The MIME content-type of the part, if known, the empty string otherwise.
8601 .It Ev MAILX_CONTENT_EVIDENCE
8603 .Va mime-counter-evidence
8604 includes the carry-around-bit (2), then this will be set to the detected
8605 MIME content-type; not only then identical to
8606 .Ev \&\&MAILX_CONTENT
8610 .It Ev MAILX_FILENAME
8611 The filename, if any is set, the empty string otherwise.
8614 .It Ev MAILX_FILENAME_GENERATED
8618 .It Ev MAILX_FILENAME_TEMPORARY
8619 If temporary file creation has been requested through the command prefix
8620 this variable will be set and contain the absolute pathname of the
8626 .It Va pipe-EXTENSION
8627 This is identical to
8628 .Va pipe-TYPE/SUBTYPE
8631 (normalized to lowercase using character mappings of the ASCII charset)
8632 names a file extension, e.g.,
8634 Handlers registered using this method take precedence.
8637 .It Va pop3-auth-USER@HOST , pop3-auth-HOST , pop3-auth
8638 \*(OP\*(IN Variable chain that sets the POP3 authentication method.
8639 The only possible value as of now is
8641 which is thus the default.
8644 .Mx Va pop3-bulk-load
8645 .It Va pop3-bulk-load-USER@HOST , pop3-bulk-load-HOST , pop3-bulk-load
8646 \*(BO\*(OP When accessing a POP3 server \*(UA loads the headers of
8647 the messages, and only requests the message bodies on user request.
8648 For the POP3 protocol this means that the message headers will be
8650 If this variable is set then \*(UA will download only complete messages
8651 from the given POP3 server(s) instead.
8653 .Mx Va pop3-keepalive
8654 .It Va pop3-keepalive-USER@HOST , pop3-keepalive-HOST , pop3-keepalive
8655 \*(OP POP3 servers close the connection after a period of inactivity;
8656 the standard requires this to be at least 10 minutes,
8657 but practical experience may vary.
8658 Setting this variable to a numeric value greater than
8662 command to be sent each value seconds if no other operation is performed.
8665 .It Va pop3-no-apop-USER@HOST , pop3-no-apop-HOST , pop3-no-apop
8666 \*(BO\*(OP Unless this variable is set the
8668 authentication method will be used when connecting to a POP3 server that
8672 is that the password is not sent in clear text over the wire and that
8673 only a single packet is sent for the user/password tuple.
8675 .Va pop3-no-apop-HOST
8678 .Mx Va pop3-use-starttls
8679 .It Va pop3-use-starttls-USER@HOST , pop3-use-starttls-HOST , pop3-use-starttls
8680 \*(BO\*(OP Causes \*(UA to issue a
8682 command to make an unencrypted POP3 session SSL/TLS encrypted.
8683 This functionality is not supported by all servers,
8684 and is not used if the session is already encrypted by the POP3S method.
8686 .Va pop3-use-starttls-HOST
8691 \*(BO This flag enables POSIX mode, which changes behaviour of \*(UA
8692 where that deviates from standardized behaviour.
8693 It will be set implicitly before the
8694 .Sx "Resource files"
8695 are loaded if the environment variable
8697 is set, and adjusting any of those two will be reflected by the other
8701 .It Va print-alternatives
8702 \*(BO When a MIME message part of type
8703 .Ql multipart/alternative
8704 is displayed and it contains a subpart of type
8706 other parts are normally discarded.
8707 Setting this variable causes all subparts to be displayed,
8708 just as if the surrounding part was of type
8709 .Ql multipart/mixed .
8713 The string used as a prompt in interactive mode.
8714 Whenever the variable is evaluated the value is expanded as via
8715 dollar-single-quote expansion (see
8716 .Sx "Shell-style argument quoting" ) .
8717 This (post-assignment, i.e., second) expansion can be used to embed
8718 status information, for example
8723 .Va -mailbox-display .
8725 In order to embed characters which should not be counted when
8726 calculating the visual width of the resulting string, enclose the
8727 characters of interest in a pair of reverse solidus escaped brackets:
8729 a slot for coloured prompts is also available with the \*(OPal command
8731 Prompting may be prevented by setting this to the null string
8733 .Ql set noprompt ) .
8737 This string is used for secondary prompts, but is otherwise identical to
8744 \*(BO Suppresses the printing of the version when first invoked.
8748 If set, \*(UA starts a replying message with the original message
8749 prefixed by the value of the variable
8751 Normally, a heading consisting of
8752 .Dq Fromheaderfield wrote:
8753 is put before the quotation.
8758 variable, this heading is omitted.
8761 is assigned, only the headers selected by the
8764 selection are put above the message body,
8767 acts like an automatic
8769 .Sx "COMMAND ESCAPES"
8773 is assigned, all headers are put above the message body and all MIME
8774 parts are included, making
8776 act like an automatic
8779 .Va quote-as-attachment .
8782 .It Va quote-as-attachment
8783 \*(BO Add the original message in its entirety as a
8785 MIME attachment when replying to a message.
8786 Note this works regardless of the setting of
8791 \*(OP Can be set in addition to
8793 Setting this turns on a more fancy quotation algorithm in that leading
8794 quotation characters are compressed and overlong lines are folded.
8796 can be set to either one or two (space separated) numeric values,
8797 which are interpreted as the maximum (goal) and the minimum line length,
8798 respectively, in a spirit rather equal to the
8800 program, but line-, not paragraph-based.
8801 If not set explicitly the minimum will reflect the goal algorithmically.
8802 The goal cannot be smaller than the length of
8804 plus some additional pad.
8805 Necessary adjustments take place silently.
8808 .It Va r-option-implicit
8809 \*(BO Setting this option evaluates the contents of
8811 (or, if that contains multiple addresses,
8813 and passes the results onto the used (file-based) MTA as described for the
8815 option (empty argument case).
8818 .It Va recipients-in-cc
8819 \*(BO On group replies, specify only the sender of the original mail in
8821 and mention the other recipients in the secondary
8823 By default all recipients of the original mail will be addressed via
8828 If defined, gives the pathname of the folder used to record all outgoing
8830 If not defined, then outgoing mail is not saved.
8831 When saving to this folder fails the message is not sent,
8832 but instead saved to
8836 .It Va record-resent
8837 \*(BO If both this variable and the
8844 commands save messages to the
8846 folder as it is normally only done for newly composed messages.
8849 .It Va reply-in-same-charset
8850 \*(BO If this variable is set \*(UA first tries to use the same
8851 character set of the original message for replies.
8852 If this fails, the mechanism described in
8853 .Sx "Character sets"
8854 is evaluated as usual.
8857 .It Va reply-strings
8858 Can be set to a comma-separated list of (case-insensitive according to
8859 ASCII rules) strings which shall be recognized in addition to the
8862 reply message indicators \(en builtin are
8864 which is mandated by RFC 5322, as well as the german
8869 which often has been seen in the wild;
8870 I.e., the separating colon has to be specified explicitly.
8874 A list of addresses to put into the
8876 field of the message header.
8877 Members of this list are handled as if they were in the
8882 .It Va reply-to-honour
8885 header is honoured when replying to a message via
8889 This is a quadoption; if set without a value it defaults to
8893 .It Va rfc822-body-from_
8894 \*(BO This variable can be used to force displaying a so-called
8896 line for messages that are embedded into an envelope mail via the
8898 MIME mechanism, for more visual convenience.
8902 \*(BO Enable saving of (partial) messages in
8904 upon interrupt or delivery error.
8908 The number of lines that represents a
8917 line display and scrolling via
8919 If this variable is not set \*(UA falls back to a calculation based upon
8920 the detected terminal window size and the baud rate: the faster the
8921 terminal, the more will be shown.
8922 Overall screen dimensions and pager usage is influenced by the
8923 environment variables
8931 .It Va searchheaders
8932 \*(BO Expand message-list specifiers in the form
8934 to all messages containing the substring
8938 The string search is case insensitive.
8942 \*(OP A comma-separated list of character set names that can be used in
8943 outgoing internet mail.
8944 The value of the variable
8946 is automatically appended to this list of character-sets.
8947 If no character set conversion capabilities are compiled into \*(UA then
8948 the only supported charset is
8951 .Va sendcharsets-else-ttycharset
8952 and refer to the section
8953 .Sx "Character sets"
8954 for the complete picture of character set conversion in \*(UA.
8957 .It Va sendcharsets-else-ttycharset
8958 \*(BO\*(OP If this variable is set, but
8960 is not, then \*(UA acts as if
8962 had been set to the value of the variable
8964 In effect this combination passes through the message data in the
8965 character set of the current locale (given that
8967 has not been set manually), i.e., without converting it to the
8969 fallback character set.
8970 Thus, mail message text will be in ISO-8859-1 encoding when send from
8971 within a ISO-8859-1 locale, and in UTF-8 encoding when send from within
8973 If no character set conversion capabilities are available in \*(UA then
8974 the only supported character set is
8979 An address that is put into the
8981 field of outgoing messages, quoting RFC 5322: the mailbox of the agent
8982 responsible for the actual transmission of the message.
8983 This field should normally not be used unless the
8985 field contains more than one address, on which case it is required.
8988 address is handled as if it were in the
8992 .Va r-option-implicit .
8996 \*(OB Predecessor of
9000 .It Va sendmail-arguments
9001 \*(OB Predecessor of
9005 .It Va sendmail-no-default-arguments
9006 \*(OB\*(BO Predecessor of
9007 .Va mta-no-default-arguments .
9010 .It Va sendmail-progname
9011 \*(OB Predecessor of
9016 \*(BO When sending a message wait until the
9018 (including the builtin SMTP one) exits before accepting further commands.
9020 with this variable set errors reported by the MTA will be recognizable!
9021 If the MTA returns a non-zero exit status,
9022 the exit status of \*(UA will also be non-zero.
9026 \*(BO This setting causes \*(UA to start at the last message
9027 instead of the first one when opening a mail folder.
9031 \*(BO Causes \*(UA to use the sender's real name instead of the plain
9032 address in the header field summary and in message specifications.
9036 \*(BO Causes the recipient of the message to be shown in the header
9037 summary if the message was sent by the user.
9041 The string to expand
9044 .Sx "COMMAND ESCAPES" ) .
9048 The string to expand
9051 .Sx "COMMAND ESCAPES" ) .
9055 Must correspond to the name of a readable file if set.
9056 The file's content is then appended to each singlepart message
9057 and to the first part of each multipart message.
9058 Be warned that there is no possibility to edit the signature for an
9062 .It Va skipemptybody
9063 \*(BO If an outgoing message does not contain any text in its first or
9064 only message part, do not send it but discard it silently (see also the
9070 \*(OP Specifies a directory with CA certificates in PEM (Privacy
9071 Enhanced Mail) format for verification of S/MIME signed messages.
9074 .It Va smime-ca-file
9075 \*(OP Specifies a file with CA certificates in PEM format for
9076 verification of S/MIME signed messages.
9079 .It Va smime-cipher-USER@HOST , smime-cipher
9080 \*(OP Specifies the cipher to use when generating S/MIME encrypted
9081 messages (for the specified account).
9082 RFC 5751 mandates a default of
9085 Possible values are (case-insensitive and) in decreasing cipher strength:
9093 (DES EDE3 CBC, 168 bits; default if
9095 is not available) and
9099 The actually available cipher algorithms depend on the cryptographic
9100 library that \*(UA uses.
9101 \*(OP Support for more cipher algorithms may be available through
9102 dynamic loading via, e.g.,
9103 .Xr EVP_get_cipherbyname 3
9104 (OpenSSL) if \*(UA has been compiled to support this.
9107 .It Va smime-crl-dir
9108 \*(OP Specifies a directory that contains files with CRLs in PEM format
9109 to use when verifying S/MIME messages.
9112 .It Va smime-crl-file
9113 \*(OP Specifies a file that contains a CRL in PEM format to use when
9114 verifying S/MIME messages.
9117 .It Va smime-encrypt-USER@HOST
9118 \*(OP If this variable is set, messages send to the given receiver are
9119 encrypted before sending.
9120 The value of the variable must be set to the name of a file that
9121 contains a certificate in PEM format.
9123 If a message is sent to multiple recipients,
9124 each of them for whom a corresponding variable is set will receive an
9125 individually encrypted message;
9126 other recipients will continue to receive the message in plain text
9128 .Va smime-force-encryption
9130 It is recommended to sign encrypted messages, i.e., to also set the
9135 .It Va smime-force-encryption
9136 \*(BO\*(OP Causes \*(UA to refuse sending unencrypted messages.
9139 .It Va smime-no-default-ca
9140 \*(BO\*(OP Do not load default CA locations when verifying S/MIME
9145 \*(BO\*(OP S/MIME sign outgoing messages with the user's private key
9146 and include the user's certificate as a MIME attachment.
9147 Signing a message enables a recipient to verify that the sender used
9148 a valid certificate,
9149 that the email addresses in the certificate match those in the message
9150 header and that the message content has not been altered.
9151 It does not change the message text,
9152 and people will be able to read the message as usual.
9154 .Va smime-sign-cert , smime-sign-include-certs
9156 .Va smime-sign-message-digest .
9158 .Mx Va smime-sign-cert
9159 .It Va smime-sign-cert-USER@HOST , smime-sign-cert
9160 \*(OP Points to a file in PEM format.
9161 For the purpose of signing and decryption this file needs to contain the
9162 user's private key as well as his certificate.
9166 is always derived from the value of
9168 (or, if that contains multiple addresses,
9170 For the purpose of encryption the recipient's public encryption key
9171 (certificate) is expected; the command
9173 can be used to save certificates of signed messages (the section
9174 .Sx "Signed and encrypted messages with S/MIME"
9175 gives some details).
9176 This mode of operation is usually driven by the specialized form.
9178 When decrypting messages the account is derived from the recipient
9183 of the message, which are searched for addresses for which such
9185 \*(UA always uses the first address that matches,
9186 so if the same message is sent to more than one of the user's addresses
9187 using different encryption keys, decryption might fail.
9189 For signing and decryption purposes it is possible to use encrypted
9190 keys, and the pseudo-host(s)
9191 .Ql USER@HOST.smime-cert-key
9194 .Ql USER@HOST.smime-cert-cert
9195 for the certificate stored in the same file)
9196 will be used for performing any necessary password lookup,
9197 therefore the lookup can be automatized via the mechanisms described in
9198 .Sx "On URL syntax and credential lookup" .
9199 For example, the hypothetical address
9201 could be driven with a private key / certificate pair path defined in
9202 .Va \&\&smime-sign-cert-bob@exam.ple ,
9203 and needed passwords would then be looked up via the pseudo hosts
9204 .Ql bob@exam.ple.smime-cert-key
9206 .Ql bob@exam.ple.smime-cert-cert ) .
9207 To include intermediate certificates, use
9208 .Va smime-sign-include-certs .
9210 .Mx Va smime-sign-include-certs
9211 .It Va smime-sign-include-certs-USER@HOST , smime-sign-include-certs
9212 \*(OP If used, this is supposed to a consist of a comma-separated list
9213 of files, each of which containing a single certificate in PEM format to
9214 be included in the S/MIME message in addition to the
9217 This can be used to include intermediate certificates of the certificate
9218 authority, in order to allow the receiver's S/MIME implementation to
9219 perform a verification of the entire certificate chain, starting from
9220 a local root certificate, over the intermediate certificates, down to the
9221 .Va smime-sign-cert .
9222 Even though top level certificates may also be included in the chain,
9223 they won't be used for the verification on the receiver's side.
9225 For the purpose of the mechanisms involved here,
9227 refers to the content of the internal variable
9229 (or, if that contains multiple addresses,
9232 .Ql USER@HOST.smime-include-certs
9233 will be used for performing password lookups for these certificates,
9234 shall they have been given one, therefore the lookup can be automatized
9235 via the mechanisms described in
9236 .Sx "On URL syntax and credential lookup" .
9238 .Mx Va smime-sign-message-digest
9239 .It Va smime-sign-message-digest-USER@HOST , smime-sign-message-digest
9240 \*(OP Specifies the message digest to use when signing S/MIME messages.
9241 RFC 5751 mandates a default of
9243 Possible values are (case-insensitive and) in decreasing cipher strength:
9251 The actually available message digest algorithms depend on the
9252 cryptographic library that \*(UA uses.
9253 \*(OP Support for more message digest algorithms may be available
9254 through dynamic loading via, e.g.,
9255 .Xr EVP_get_digestbyname 3
9256 (OpenSSL) if \*(UA has been compiled to support this.
9257 Remember that for this
9259 refers to the variable
9261 (or, if that contains multiple addresses,
9266 \*(OB\*(OP To use the builtin SMTP transport, specify a SMTP URL in
9268 \*(ID For compatibility reasons a set
9270 is used in preference of
9274 .It Va smtp-auth-USER@HOST , smtp-auth-HOST , smtp-auth
9275 \*(OP Variable chain that controls the SMTP
9277 authentication method, possible values are
9283 as well as the \*(OPal methods
9289 method does not need any user credentials,
9291 requires a user name and all other methods require a user name and
9299 .Va smtp-auth-password
9301 .Va smtp-auth-user ) .
9306 .Va smtp-auth-USER@HOST :
9307 may override dependent on sender address in the variable
9310 .It Va smtp-auth-password
9311 \*(OP\*(OU Sets the global fallback password for SMTP authentication.
9312 If the authentication method requires a password, but neither
9313 .Va smtp-auth-password
9315 .Va smtp-auth-password-USER@HOST
9317 \*(UA will ask for a password on the user's terminal.
9319 .It Va smtp-auth-password-USER@HOST
9321 .Va smtp-auth-password
9322 for specific values of sender addresses, dependent upon the variable
9325 .It Va smtp-auth-user
9326 \*(OP\*(OU Sets the global fallback user name for SMTP authentication.
9327 If the authentication method requires a user name, but neither
9330 .Va smtp-auth-user-USER@HOST
9332 \*(UA will ask for a user name on the user's terminal.
9334 .It Va smtp-auth-user-USER@HOST
9337 for specific values of sender addresses, dependent upon the variable
9341 .It Va smtp-hostname
9342 \*(OP\*(IN Normally \*(UA uses the variable
9344 to derive the necessary
9346 information in order to issue a
9353 can be used to use the
9355 from the SMTP account
9362 from the content of this variable (or, if that is the empty string,
9364 or the local hostname as a last resort).
9365 This often allows using an address that is itself valid but hosted by
9366 a provider other than which (in
9368 is about to send the message.
9369 Setting this variable also influences generated
9375 .Mx Va smtp-use-starttls
9376 .It Va smtp-use-starttls-USER@HOST , smtp-use-starttls-HOST , smtp-use-starttls
9377 \*(BO\*(OP Causes \*(UA to issue a
9379 command to make an SMTP
9381 session SSL/TLS encrypted, i.e., to enable transport layer security.
9385 .It Va spam-interface
9386 \*(OP In order to use any of the spam-related commands (like, e.g.,
9388 the desired spam interface must be defined by setting this variable.
9389 Please refer to the manual section
9391 for the complete picture of spam handling in \*(UA.
9392 All or none of the following interfaces may be available:
9394 .Bl -tag -width ".It Ql _ilte_"
9400 .Pf ( Lk http://spamassassin.apache.org SpamAssassin )
9402 Different to the generic filter interface \*(UA will automatically add
9403 the correct arguments for a given command and has the necessary
9404 knowledge to parse the program's output.
9407 will have been compiled into the \*(UA binary if
9412 Shall it be necessary to define a specific connection type (rather than
9413 using a configuration file for that), the variable
9415 can be used as in, e.g.,
9416 .Ql -d server.example.com -p 783 .
9417 It is also possible to specify a per-user configuration via
9419 Note that this interface does not inspect the
9421 flag of a message for the command
9425 generic spam filter support via freely configurable hooks.
9426 This interface is meant for programs like
9428 and requires according behaviour in respect to the hooks' exit
9429 status for at least the command
9432 meaning a message is spam,
9436 for unsure and any other return value indicating a hard error);
9437 since the hooks can include shell code snippets diverting behaviour
9438 can be intercepted as necessary.
9440 .Va spamfilter-ham , spamfilter-noham , spamfilter-nospam , \
9443 .Va spamfilter-spam ;
9446 contains examples for some programs.
9447 The process environment of the hooks will have the variable
9448 .Ev MAILX_FILENAME_GENERATED
9450 Note that spam score support for
9452 is not supported unless the \*(OPtional regular expression support is
9454 .Va spamfilter-rate-scanscore
9461 \*(OP Messages that exceed this size will not be passed through to the
9463 .Va spam-interface .
9464 If unset or 0, the default of 420000 bytes is used.
9467 .It Va spamc-command
9468 \*(OP The path to the
9472 .Va spam-interface .
9473 Note that the path is not expanded, but used
9475 A fallback path will have been compiled into the \*(UA binary if the
9476 executable had been found during compilation.
9479 .It Va spamc-arguments
9480 \*(OP Even though \*(UA deals with most arguments for the
9483 automatically, it may at least sometimes be desirable to specify
9484 connection-related ones via this variable, e.g.,
9485 .Ql -d server.example.com -p 783 .
9489 \*(OP Specify a username for per-user configuration files for the
9491 .Va spam-interface .
9492 If this is set to the empty string then \*(UA will use the name of the
9501 .It Va spamfilter-ham , spamfilter-noham , \
9502 spamfilter-nospam , spamfilter-rate , spamfilter-spam
9503 \*(OP Command and argument hooks for the
9505 .Va spam-interface .
9508 contains examples for some programs.
9511 .It Va spamfilter-rate-scanscore
9512 \*(OP Because of the generic nature of the
9515 spam scores are not supported for it by default, but if the \*(OPtional
9516 regular expression support is available then setting this variable can
9517 be used to overcome this restriction.
9518 It is interpreted as follows: first a number (digits) is parsed that
9519 must be followed by a semicolon
9521 and an extended regular expression.
9522 Then the latter is used to parse the first output line of the
9524 hook, and, in case the evaluation is successful, the group that has been
9525 specified via the number is interpreted as a floating point scan score.
9529 \*(OP Specifies a directory with CA certificates in PEM (Pricacy
9530 Enhanced Mail) for verification of of SSL/TLS server certificates.
9532 .Xr SSL_CTX_load_verify_locations 3
9533 for more information.
9537 \*(OP Specifies a file with CA certificates in PEM format for
9538 verification of SSL/TLS server certificates.
9540 .Xr SSL_CTX_load_verify_locations 3
9541 for more information.
9544 .It Va ssl-cert-USER@HOST , ssl-cert-HOST , ssl-cert
9545 \*(OP Variable chain that sets the file name for a SSL/TLS client
9546 certificate required by some servers.
9547 This is a direct interface to the
9551 function of the OpenSSL library, if available.
9553 .Mx Va ssl-cipher-list
9554 .It Va ssl-cipher-list-USER@HOST , ssl-cipher-list-HOST , ssl-cipher-list
9555 \*(OP Specifies a list of ciphers for SSL/TLS connections.
9556 This is a direct interface to the
9560 function of the OpenSSL library, if available; see
9562 for more information.
9563 By default \*(UA does not set a list of ciphers, in effect using a
9565 specific cipher (protocol standards ship with a list of acceptable
9566 ciphers), possibly cramped to what the actually used SSL/TLS library
9567 supports \(en the manual section
9568 .Sx "An example configuration"
9569 also contains a SSL/TLS use case.
9572 .It Va ssl-config-file
9573 \*(OP If this variable is set \*(UA will call
9574 .Xr CONF_modules_load_file 3
9575 to allow OpenSSL to be configured according to the host system wide
9577 If a non-empty value is given then this will be used to specify the
9578 configuration file to be used instead of the global OpenSSL default;
9579 note that in this case it is an error if the file cannot be loaded.
9580 The application name will always be passed as
9585 \*(OP Specifies a file that contains a CRL in PEM format to use when
9586 verifying SSL/TLS server certificates.
9590 \*(OP Specifies a directory that contains files with CRLs in PEM format
9591 to use when verifying SSL/TLS server certificates.
9594 .It Va ssl-key-USER@HOST , ssl-key-HOST , ssl-key
9595 \*(OP Variable chain that sets the file name for the private key of
9596 a SSL/TLS client certificate.
9597 If unset, the name of the certificate file is used.
9598 The file is expected to be in PEM format.
9599 This is a direct interface to the
9603 function of the OpenSSL library, if available.
9606 .It Va ssl-method-USER@HOST , ssl-method-HOST , ssl-method
9607 \*(OB\*(OP Please use the newer and more flexible
9609 instead: if both values are set,
9611 will take precedence!
9612 Can be set to the following values, the actually used
9614 specification to which it is mapped is shown in parenthesis:
9616 .Pf ( Ql -ALL, TLSv1.2 ) ,
9618 .Pf ( Ql -ALL, TLSv1.1 ) ,
9620 .Pf ( Ql -ALL, TLSv1 )
9623 .Pf ( Ql -ALL, SSLv3 ) ;
9628 and thus includes the SSLv3 protocol.
9629 Note that SSLv2 is no longer supported at all.
9632 .It Va ssl-no-default-ca
9633 \*(BO\*(OP Do not load default CA locations to verify SSL/TLS server
9637 .It Va ssl-protocol-USER@HOST , ssl-protocol-HOST , ssl-protocol
9638 \*(OP Specify the used SSL/TLS protocol.
9639 This is a direct interface to the
9643 function of the OpenSSL library, if available;
9644 otherwise an \*(UA internal parser is used which understands the
9645 following subset of (case-insensitive) command strings:
9651 as well as the special value
9653 Multiple specifications may be given via a comma-separated list which
9654 ignores any whitespace.
9657 plus prefix will enable a protocol, a
9659 minus prefix will disable it, so that
9661 will enable only the TLSv1.2 protocol.
9663 It depends upon the used TLS/SSL library which protocols are actually
9664 supported and which protocols are used if
9666 is not set, but note that SSLv2 is no longer supported at all and
9668 Especially for older protocols explicitly securing
9670 may be worthwile, see
9671 .Sx "An example configuration" .
9675 \*(OP Gives the pathname to an entropy daemon socket, see
9677 Not all SSL/TLS libraries support this.
9680 .It Va ssl-rand-file
9681 \*(OP Gives the filename to a file with random entropy data, see
9682 .Xr RAND_load_file 3 .
9683 If this variable is not set, or set to the empty string, or if the
9684 .Sx "Filename transformations"
9686 .Xr RAND_file_name 3
9687 will be used to create the filename if, and only if,
9689 documents that the SSL PRNG is not yet sufficiently seeded.
9690 If \*(UA successfully seeded the SSL PRNG then it will update the file
9691 .Pf ( Xr RAND_write_file 3 ) .
9692 This variable is only used if
9694 is not set (or not supported by the SSL/TLS library).
9697 .It Va ssl-verify-USER@HOST , ssl-verify-HOST , ssl-verify
9698 \*(OP Variable chain that sets the action to be performed if an error
9699 occurs during SSL/TLS server certificate validation.
9700 Valid (case-insensitive) values are
9702 (fail and close connection immediately),
9704 (ask whether to continue on standard input),
9706 (show a warning and continue),
9708 (do not perform validation).
9714 If only set without an assigned value, then this setting inhibits the
9720 header fields that include obvious references to \*(UA.
9721 There are two pitfalls associated with this:
9722 First, the message id of outgoing messages is not known anymore.
9723 Second, an expert may still use the remaining information in the header
9724 to track down the originating mail user agent.
9731 suppression does not occur.
9736 (\*(OP) This specifies a comma-separated list of
9741 .Sx "On terminal control and line editor" ,
9742 escape commas with reverse solidus) to be used to overwrite or define
9744 Note that this variable will only be queried once at program startup and
9745 can thus only be specified in resource files or on the command line.
9748 String capabilities form
9750 pairs and are expected unless noted otherwise.
9751 Numerics have to be notated as
9753 where the number is expected in normal decimal notation.
9754 Finally, booleans do not have any value but indicate a true or false
9755 state simply by being defined or not; this indeed means that \*(UA
9756 does not support undefining an existing boolean.
9757 String capability values will undergo some expansions before use:
9758 for one notations like
9761 .Ql control-LETTER ,
9762 and for clarification purposes
9764 can be used to specify
9766 (the control notation
9768 could lead to misreadings when a left bracket follows, which it does for
9769 the standard CSI sequence);
9770 finally three letter octal sequences, as in
9773 To specify that a terminal supports 256-colours, and to define sequences
9774 that home the cursor and produce an audible bell, one might write:
9776 .Bd -literal -offset indent
9777 set termcap='Co#256,home=\eE[H,bel=^G'
9781 The following terminal capabilities are or may be meaningful for the
9782 operation of the builtin line editor or \*(UA in general:
9785 .Bl -tag -compact -width yay
9787 .It Cd colors Ns \0or Cd Co
9789 numeric capability specifying the maximum number of colours.
9790 Note that \*(UA does not actually care about the terminal beside that,
9791 but always emits ANSI / ISO 6429 escape sequences.
9794 .It Cd rmcup Ns \0or Cd te Ns \0/ Cd smcup Ns \0or Cd ti
9798 respectively: exit and enter the alternative screen
9800 effectively turning \*(UA into a fullscreen application.
9801 To disable that, set (at least) one to the empty string.
9803 .It Cd smkx Ns \0or Cd ks Ns \0/ Cd rmkx Ns \0or Cd ke
9807 respectively: enable and disable the keypad.
9808 This is always enabled if available, because it seems even keyboards
9809 without keypads generate other key codes for, e.g., cursor keys in that
9810 case, and only if enabled we see the codes that we are interested in.
9812 .It Cd ed Ns \0or Cd cd
9816 .It Cd clear Ns \0or Cd cl
9818 clear the screen and home cursor.
9819 (Will be simulated via
9824 .It Cd home Ns \0or Cd ho
9829 .It Cd el Ns \0or Cd ce
9831 clear to the end of line.
9832 (Will be simulated via
9834 plus repetitions of space characters.)
9836 .It Cd hpa Ns \0or Cd ch
9837 .Cd column_address :
9838 move the cursor (to the given column parameter) in the current row.
9839 (Will be simulated via
9845 .Cd carriage_return :
9846 move to the first column in the current row.
9847 The default builtin fallback is
9850 .It Cd cub1 Ns \0or Cd le
9852 move the cursor left one space (non-destructively).
9853 The default builtin fallback is
9856 .It Cd cuf1 Ns \0or Cd nd
9858 move the cursor right one space (non-destructively).
9859 The default builtin fallback is
9861 which is used by most terminals.
9869 Many more capabilities which describe key-sequences are documented for
9873 .It Va termcap-disable
9874 \*(OP Disable any interaction with a terminal control library.
9875 If set only some generic fallback builtins and possibly the content of
9877 describe the terminal to \*(UA.
9879 that this variable will only be queried once at program startup and can
9880 thus only be specified in resource files or on the command line.
9884 If defined, gives the number of lines of a message to be displayed
9887 if unset, the first five lines are printed, if set to 0 the variable
9890 If the value is negative then its absolute value will be used for right
9893 height; (shifting bitwise is like dividing algorithmically, but since
9894 it takes away bits the value decreases pretty fast).
9898 \*(BO If set then the
9900 command series will strip adjacent empty lines and quotations.
9904 The character set of the terminal \*(UA operates on,
9905 and the one and only supported character set that \*(UA can use if no
9906 character set conversion capabilities have been compiled into it,
9907 in which case it defaults to ISO-8859-1 unless it can deduce a value
9911 It defaults to UTF-8 if conversion is available.
9912 Refer to the section
9913 .Sx "Character sets"
9914 for the complete picture about character sets.
9917 .It Va typescript-mode
9918 \*(BO A special multiplex variable that disables all variables and
9919 settings which result in behaviour that interferes with running \*(UA in
9922 .Va colour-disable ,
9923 .Va line-editor-disable
9924 and (before startup completed only)
9925 .Va termcap-disable .
9926 Unsetting it does not restore the former state of the covered settings.
9930 For a safety-by-default policy \*(UA sets its process
9934 but this variable can be used to override that:
9935 set it to an empty value to do not change the (current) setting,
9936 otherwise the process file mode creation mask is updated to the new value.
9937 Child processes inherit the process file mode creation mask.
9940 .It Va user-HOST , user
9941 \*(IN Variable chain that sets a global fallback user name, which is
9942 used in case none has been given in the protocol and account-specific
9944 This variable defaults to the name of the user who runs \*(UA.
9948 \*(BO Setting this enables upward compatibility with \*(UA
9949 version 15.0 in respect to which configuration options are available and
9950 how they are handled.
9951 This manual uses \*(IN and \*(OU to refer to the new and the old way of
9952 doing things, respectively.
9956 \*(BO This setting, also controllable via the command line option
9958 causes \*(UA to be more verbose, e.g., it will display obsoletion
9959 warnings and SSL/TLS certificate chains.
9960 Even though marked \*(BO this option may be set twice in order to
9961 increase the level of verbosity even more, in which case even details of
9962 the actual message delivery and protocol conversations are shown.
9965 is sufficient to disable verbosity as such.
9971 .It Va version , version-major , version-minor , version-update
9972 \*(RO \*(UA version information: the first variable contains a string
9973 containing the complete version identification, the latter three contain
9974 only digits: the major, minor and update version numbers.
9975 The output of the command
9977 will include this information.
9980 .It Va writebackedited
9981 If this variable is set messages modified using the
9985 commands are written back to the current folder when it is quit;
9986 it is only honoured for writable folders in MBOX format, though.
9987 Note that the editor will be pointed to the raw message content in that
9988 case, i.e., neither MIME decoding nor decryption will have been
9989 performed, and proper RFC 4155
9991 quoting of newly added or edited content is also left as an excercise to
9995 .\" }}} (INTERNAL VARIABLES)
9998 .\" .Sh ENVIRONMENT {{{
10002 .Dq environment variable
10003 should be considered an indication that these variables are either
10004 standardized as vivid parts of process environments, or that they are
10005 commonly found in there.
10006 The process environment is inherited from the
10008 once \*(UA is started, and unless otherwise explicitly noted handling of
10009 the following variables transparently integrates into that of the
10010 .Sx "INTERNAL VARIABLES"
10011 from \*(UA's point of view.
10012 This means that, e.g., they can be managed via
10016 causing automatic program environment updates (to be inherited by
10017 newly created child processes).
10020 In order to transparently integrate other environment variables equally
10021 they need to be imported (linked) with the command
10023 This command can also be used to set and unset non-integrated
10024 environment variables from scratch, sufficient system support provided.
10025 The following example, applicable to a POSIX shell, sets the
10027 environment variable for \*(UA only, and beforehand exports the
10029 in order to affect any further processing in the running shell:
10031 .Bd -literal -offset indent
10032 $ EDITOR="vim -u ${HOME}/.vimrc"
10034 $ COLUMNS=80 \*(uA -R
10037 .Bl -tag -width ".It Ev BaNg"
10040 The user's preferred width in column positions for the terminal screen
10042 Queried and used once on program startup, actively managed for child
10043 processes and the MLE (see
10044 .Sx "On terminal control and line editor" )
10045 in interactive mode thereafter.
10049 The name of the (mailbox)
10051 to use for saving aborted messages if
10053 is set; this defaults to
10060 is set no output will be generated, otherwise the contents of the file
10065 Pathname of the text editor to use in the
10069 .Sx "COMMAND ESCAPES" .
10070 A default editor is used if this value is not defined.
10074 The user's home directory.
10075 This variable is only used when it resides in the process environment.
10082 .It Ev LANG , LC_ALL , LC_COLLATE , LC_CTYPE , LC_MESSAGES
10086 .Sx "Character sets" .
10090 The user's preferred number of lines on a page or the vertical screen
10091 or window size in lines.
10092 Queried and used once on program startup, actively managed for child
10093 processes in interactive mode thereafter.
10097 Pathname of the directory lister to use in the
10099 command when operating on local mailboxes.
10102 (path search through
10107 Upon startup \*(UA will actively ensure that this variable refers to the
10108 name of the user who runs \*(UA, in order to be able to pass a verified
10109 name to any newly created child process.
10113 Is used as the users
10115 .Sx "primary system mailbox"
10119 This is assumed to be an absolute pathname.
10123 \*(OP Overrides the default path search for
10124 .Sx "The Mailcap files" ,
10125 which is defined in the standard RFC 1524 as
10126 .Ql ~/.mailcap:\:/etc/mailcap:\:/usr/etc/mailcap:\:/usr/local/etc/mailcap .
10127 .\" TODO we should have a mailcaps-default virtual RDONLY option!
10128 (\*(UA makes it a configuration option, however.)
10129 Note this is not a search path, but a path search.
10133 Is used as a startup file instead of
10136 When \*(UA scripts are invoked on behalf of other users,
10137 either this variable should be set to
10141 command line option should be used in order to avoid side-effects from
10142 reading their configuration files.
10143 This variable is only used when it resides in the process environment.
10146 .It Ev MAILX_NO_SYSTEM_RC
10147 If this variable is set then reading of
10149 at startup is inhibited, i.e., the same effect is achieved as if \*(UA
10150 had been started up with the option
10152 (and according argument) or
10154 This variable is only used when it resides in the process environment.
10158 The name of the users mbox file.
10159 A logical subset of the special
10160 .Sx "Filename transformations"
10164 The fallback default is
10171 .Sx "secondary mailbox"
10172 is used as the file to save messages from the
10174 .Sx "primary system mailbox"
10175 that have been read.
10177 .Sx "Message states" .
10181 \*(IN\*(OP This variable overrides the default location of the user's
10187 Pathname of the program to use for backing the command
10191 variable enforces usage of a pager for output.
10192 The default paginator is
10194 (path search through
10197 \*(UA inspects the contents of this variable: if its contains the string
10199 then a non-existing environment variable
10206 dependent on whether terminal control support is available and whether
10207 that supports full (alternative) screen mode or not (also see
10208 .Sx "On terminal control and line editor" ) .
10212 will optionally be set to
10219 A colon-separated list of directories that is searched by the shell when
10220 looking for commands, e.g.,
10221 .Ql /bin:/usr/bin:/usr/local/bin .
10224 .It Ev POSIXLY_CORRECT
10225 This variable is automatically looked for upon startup, see
10231 The shell to use for the commands
10236 .Sx "COMMAND ESCAPES"
10237 and when starting subprocesses.
10238 A default shell is used if this environment variable is not defined.
10241 .It Ev SOURCE_DATE_EPOCH
10242 If set, this specifies a time in seconds since the Unix epoch
10243 (1970-01-01) to be used in place of the current time.
10244 This is for the sake of reproduceability of tests, to be used during
10245 development or by software packagers.
10249 \*(OP The terminal type for which output is to be prepared.
10250 For extended colour and font control please refer to
10251 .Sx "Coloured display" ,
10252 and for terminal management in general to
10253 .Sx "On terminal control and line editor" .
10257 Used as directory for temporary files instead of
10260 This variable is only used when it resides in the process environment,
10261 but \*(UA will ensure at startup that this environment variable is
10262 updated to contain a usable temporary directory.
10268 (see there), but this variable is not standardized, should therefore not
10269 be used, and is only corrected if already set.
10273 Pathname of the text editor to use in the
10277 .Sx "COMMAND ESCAPES" .
10285 .Bl -tag -width ".It Pa BaNg"
10287 File giving initial commands.
10290 System wide initialization file.
10294 \*(OP Personal MIME type handler definition file, see
10295 .Sx "The Mailcap files" .
10296 (RFC 1524 location, the actual path is a configuration option.)
10299 .It Pa /etc/mailcap
10300 \*(OP System wide MIME type handler definition file, see
10301 .Sx "The Mailcap files" .
10302 (RFC 1524 location, the actual path is a configuration option.)
10305 .It Pa ~/.mime.types
10306 Personal MIME types, see
10307 .Sx "The mime.types files" .
10310 .It Pa /etc/mime.types
10311 System wide MIME types, see
10312 .Sx "The mime.types files" .
10316 \*(IN\*(OP The default location of the users
10318 file \(en the section
10319 .Sx "The .netrc file"
10320 documents the file format.
10323 .\" .Ss "The mime.types files" {{{
10324 .Ss "The mime.types files"
10326 When sending messages \*(UA tries to determine the content type of all
10328 When displaying message content or attachments \*(UA uses the content
10329 type to decide whether it can directly display data or whether it needs
10330 to deal with content handlers.
10331 It learns about M(ultipurpose) I(nternet) M(ail) E(xtensions) types and
10332 how to treat them by reading
10334 files, the loading of which can be controlled by setting the variable
10335 .Va mimetypes-load-control .
10338 can also be used to deal with MIME types.)
10340 files have the following syntax:
10343 .Dl type/subtype extension [extension ...]
10348 are strings describing the file contents, and one or multiple
10350 s, separated by whitespace, name the part of a filename starting after
10351 the last dot (of interest).
10352 Comments may be introduced anywhere on a line with a number sign
10354 causing the remaining line to be discarded.
10356 \*(UA also supports an extended, non-portable syntax in specially
10357 crafted files, which can be loaded via the alternative value syntax of
10358 .Va mimetypes-load-control
10359 and prepends an optional
10363 .Dl [type-marker ]type/subtype extension [extension ...]
10366 The following type markers are supported:
10369 .Bl -tag -compact -width ".It Ar _n_u"
10371 Treat message parts with this content as plain text.
10376 Treat message parts with this content as HTML tagsoup.
10377 If the \*(OPal HTML-tagsoup-to-text converter is not available treat
10378 the content as plain text instead.
10382 but instead of falling back to plain text require an explicit content
10383 handler to be defined.
10388 for sending messages:
10390 .Va mime-allow-text-controls ,
10391 .Va mimetypes-load-control .
10392 For reading etc. messages:
10393 .Sx "HTML mail and MIME attachments" ,
10394 .Sx "The Mailcap files" ,
10396 .Va mime-counter-evidence ,
10397 .Va mimetypes-load-control ,
10398 .Va pipe-TYPE/SUBTYPE ,
10399 .Va pipe-EXTENSION .
10402 .\" .Ss "The Mailcap files" {{{
10403 .Ss "The Mailcap files"
10405 .\" TODO MAILCAP DISABLED
10406 .Sy This feature is not available in v14.9.0, sorry!
10408 .Dq User Agent Configuration Mechanism
10409 which \*(UA \*(OPally supports.
10410 It defines a file format to be used to inform mail user agent programs
10411 about the locally-installed facilities for handling various data
10412 formats, i.e., about commands and how they can be used to display, edit
10413 etc. MIME part contents, as well as a default path search that includes
10414 multiple possible locations of
10418 environment variable that can be used to overwrite that (repeating here
10419 that it is not a search path, but instead a path search specification).
10420 Any existing files will be loaded in sequence, appending any content to
10421 the list of MIME type handler directives.
10425 files consist of a set of newline separated entries.
10426 Comment lines start with a number sign
10428 (in the first column!) and are ignored.
10429 Empty lines are also ignored.
10430 All other lines form individual entries that must adhere to the syntax
10432 To extend a single entry (not comment) its line can be continued on
10433 follow lines if newline characters are
10435 by preceding them with the reverse solidus character
10437 The standard does not specify how leading whitespace of follow lines
10438 is to be treated, therefore \*(UA retains it.
10442 entries consist of a number of semicolon
10444 separated fields, and the reverse solidus
10446 character can be used to escape any following character including
10447 semicolon and itself.
10448 The first two fields are mandatory and must occur in the specified
10449 order, the remaining fields are optional and may appear in any order.
10450 Leading and trailing whitespace of content is ignored (removed).
10453 The first field defines the MIME
10455 the entry is about to handle (case-insensitively, and no reverse solidus
10456 escaping is possible in this field).
10457 If the subtype is specified as an asterisk
10459 the entry is meant to match all subtypes of the named type, e.g.,
10461 would match any audio type.
10462 The second field defines the shell command which shall be used to
10464 MIME parts of the given type; it is implicitly called the
10471 shell commands message (MIME part) data is passed via standard input
10472 unless the given shell command includes one or more instances of the
10475 in which case these instances will be replaced with a temporary filename
10476 and the data will have been stored in the file that is being pointed to.
10479 shell commands data is assumed to be generated on standard output unless
10480 the given command includes (one ore multiple)
10482 In any case any given
10484 format is replaced with a(n already) properly quoted filename.
10485 Note that when a command makes use of a temporary file via
10487 then \*(UA will remove it again, as if the
10488 .Cd x-mailx-tmpfile ,
10489 .Cd x-mailx-tmpfile-fill
10491 .Cd x-mailx-tmpfile-unlink
10492 flags had been set; see below for more.
10495 The optional fields either define a shell command or an attribute (flag)
10496 value, the latter being a single word and the former being a keyword
10497 naming the field followed by an equals sign
10499 succeeded by a shell command, and as usual for any
10501 content any whitespace surrounding the equals sign will be removed, too.
10502 Optional fields include the following:
10505 .Bl -tag -width ".It Cd BaNg"
10507 A program that can be used to compose a new body or body part in the
10509 (Currently unused.)
10511 .It Cd composetyped
10514 field, but is to be used when the composing program needs to specify the
10516 header field to be applied to the composed data.
10517 (Currently unused.)
10520 A program that can be used to edit a body or body part in the given
10522 (Currently unused.)
10525 A program that can be used to print a message or body part in the given
10527 (Currently unused.)
10530 Specifies a program to be run to test some condition, e.g., the machine
10531 architecture, or the window system in use, to determine whether or not
10532 this mailcap entry applies.
10533 If the test fails, a subsequent mailcap entry should be sought; also see
10534 .Cd x-mailx-test-once .
10536 .It Cd needsterminal
10537 This flag field indicates that the given shell command must be run on
10538 an interactive terminal.
10539 \*(UA will temporarily release the terminal to the given command in
10540 interactive mode, in non-interactive mode this entry will be entirely
10541 ignored; this flag implies
10542 .Cd x-mailx-noquote .
10544 .It Cd copiousoutput
10545 A flag field which indicates that the output of the
10547 command will be an extended stream of textual output that can be
10548 (re)integrated into \*(UA's normal visual display.
10549 It is mutually exclusive with
10552 .Cd x-mailx-always .
10554 .It Cd textualnewlines
10555 A flag field which indicates that this type of data is line-oriented and
10556 that, if encoded in
10558 all newlines should be converted to canonical form (CRLF) before
10559 encoding, and will be in that form after decoding.
10560 (Currently unused.)
10562 .It Cd nametemplate
10563 This field gives a file name format, in which
10565 will be replaced by a random string, the joined combination of which
10566 will be used as the filename denoted by
10567 .Ev MAILX_FILENAME_TEMPORARY .
10568 One could specify that a GIF file being passed to an image viewer should
10569 have a name ending in
10572 .Ql nametemplate=%s.gif .
10573 Note that \*(UA ignores the name template unless that solely specifies
10574 a filename suffix that consists of (ASCII) alphabetic and numeric
10575 characters, the underscore and dot only.
10578 Names a file, in X11 bitmap (xbm) format, which points to an appropriate
10579 icon to be used to visually denote the presence of this kind of data.
10580 This field is not used by \*(UA.
10583 A textual description that describes this type of data.
10585 .It Cd x-mailx-always
10586 Extension flag field that denotes that the given
10588 command shall be executed even if multiple messages will be displayed
10590 Normally messages which require external viewers that produce output
10591 which does not integrate into \*(UA's visual display (i.e., do not have
10593 set) have to be addressed directly and individually.
10594 (To avoid cases where, e.g., a thousand PDF viewer instances are spawned
10597 .It Cd x-mailx-even-if-not-interactive
10598 An extension flag test field \(em by default handlers without
10600 are entirely ignored in non-interactive mode, but if this flag is set
10601 then their use will be considered.
10602 It is an error if this flag is set for commands that use the flag
10603 .Cd needsterminal .
10605 .It Cd x-mailx-noquote
10606 An extension flag field that indicates that even a
10609 command shall not be used to generate message quotes
10610 (as it would be by default).
10612 .It Cd x-mailx-async
10613 Extension flag field that denotes that the given
10615 command shall be executed asynchronously, without blocking \*(UA.
10616 Cannot be used in conjunction with
10617 .Cd needsterminal .
10619 .It Cd x-mailx-test-once
10620 Extension flag which denotes whether the given
10622 command shall be evaluated once only and the (boolean) result be cached.
10623 This is handy if some global unchanging condition is to be queried, like
10624 .Dq running under the X Window System .
10626 .It Cd x-mailx-tmpfile
10627 Extension flag field that requests creation of a zero-sized temporary
10628 file, the name of which is to be placed in the environment variable
10629 .Ev MAILX_FILENAME_TEMPORARY .
10630 It is an error to use this flag with commands that include a
10634 .It Cd x-mailx-tmpfile-fill
10635 Normally the MIME part content is passed to the handler via standard
10636 input; if this flag is set then the data will instead be written into
10638 .Cd x-mailx-tmpfile .
10639 In order to cause deletion of the temporary file you will have to set
10640 .Cd x-mailx-tmpfile-unlink
10642 It is an error to use this flag with commands that include a
10646 .It Cd x-mailx-tmpfile-unlink
10647 Extension flag field that requests that the temporary file shall be
10648 deleted automatically when the command loop is entered again at latest.
10649 (Do not use this for asynchronous handlers.)
10650 It is an error to use this flag with commands that include a
10652 format, or without also setting
10653 .Cd x-mailx-tmpfile
10655 .Cd x-mailx-tmpfile-fill .
10657 .It Cd x-mailx-tmpfile-keep
10660 implies the three tmpfile related flags above, but if you want, e.g.,
10662 and deal with the temporary file yourself, you can add in this flag to
10664 .Cd x-mailx-tmpfile-unlink .
10669 The standard includes the possibility to define any number of additional
10670 entry fields, prefixed by
10672 Flag fields apply to the entire
10674 entry \(em in some unusual cases, this may not be desirable, but
10675 differentiation can be accomplished via separate entries, taking
10676 advantage of the fact that subsequent entries are searched if an earlier
10677 one does not provide enough information.
10680 command needs to specify the
10684 command shall not, the following will help out the latter (with enabled
10688 level \*(UA will show information about handler evaluation):
10690 .Bd -literal -offset indent
10691 application/postscript; ps-to-terminal %s; needsterminal
10692 application/postscript; ps-to-terminal %s; compose=idraw %s
10696 In fields any occurrence of the format string
10698 will be replaced by the
10701 Named parameters from the
10703 field may be placed in the command execution line using
10705 followed by the parameter name and a closing
10708 The entire parameter should appear as a single command line argument,
10709 regardless of embedded spaces; thus:
10711 .Bd -literal -offset indent
10713 Content-type: multipart/mixed; boundary=42
10716 multipart/*; /usr/local/bin/showmulti \e
10717 %t %{boundary} ; composetyped = /usr/local/bin/makemulti
10719 # Executed shell command
10720 /usr/local/bin/showmulti multipart/mixed 42
10724 .\" TODO v15: Mailcap: %n,%F
10725 Note that \*(UA does not support handlers for multipart MIME parts as
10726 shown in this example (as of today).
10727 \*(UA does not support the additional formats
10731 An example file, also showing how to properly deal with the expansion of
10733 which includes any quotes that are necessary to make it a valid shell
10734 argument by itself and thus will cause undesired behaviour when placed
10735 in additional user-provided quotes:
10737 .Bd -literal -offset indent
10739 text/richtext; richtext %s; copiousoutput
10741 text/x-perl; perl -cWT %s
10743 application/pdf; \e
10745 trap "rm -f ${infile}" EXIT\e; \e
10746 trap "exit 75" INT QUIT TERM\e; \e
10748 x-mailx-async; x-mailx-tmpfile-keep
10750 application/*; echo "This is \e"%t\e" but \e
10751 is 50 \e% Greek to me" \e; < %s head -c 1024 | cat -vET; \e
10752 copiousoutput; x-mailx-noquote
10757 .Sx "HTML mail and MIME attachments" ,
10758 .Sx "The mime.types files" ,
10761 .Va mime-counter-evidence ,
10762 .Va pipe-TYPE/SUBTYPE ,
10763 .Va pipe-EXTENSION .
10766 .\" .Ss "The .netrc file" {{{
10767 .Ss "The .netrc file"
10771 file contains user credentials for machine accounts.
10772 The default location in the user's
10774 directory may be overridden by the
10776 environment variable.
10777 The file consists of space, tabulator or newline separated tokens.
10778 \*(UA implements a parser that supports a superset of the original BSD
10779 syntax, but users should nonetheless be aware of portability glitches
10780 of that file format, shall their
10782 be usable across multiple programs and platforms:
10785 .Bl -bullet -compact
10787 BSD does not support single, but only double quotation marks, e.g.,
10788 .Ql password="pass with spaces" .
10790 BSD (only?) supports escaping of single characters via a reverse solidus
10791 (e.g., a space can be escaped via
10793 in- as well as outside of a quoted string.
10795 BSD does not require a final quotation mark of the last user input token.
10797 The original BSD (Berknet) parser also supported a format which allowed
10798 tokens to be separated with commas \(en whereas at least Hewlett-Packard
10799 still seems to support this syntax, \*(UA does not!
10801 As a non-portable extension some widely-used programs support
10802 shell-style comments: if an input line starts, after any amount of
10803 whitespace, with a number sign
10805 then the rest of the line is ignored.
10807 Whereas other programs may require that the
10809 file is accessible by only the user if it contains a
10811 token for any other
10815 \*(UA will always require these strict permissions.
10819 Of the following list of supported tokens \*(UA only uses (and caches)
10824 At runtime the command
10826 can be used to control \*(UA's
10830 .Bl -tag -width ".It Cd BaNg"
10831 .It Cd machine Ar name
10832 The hostname of the entries' machine, lowercase-normalized by \*(UA
10834 Any further file content, until either end-of-file or the occurrence
10839 first-class token is bound (only related) to the machine
10842 As an extension that should not be the cause of any worries
10843 \*(UA supports a single wildcard prefix for
10845 .Bd -literal -offset indent
10846 machine *.example.com login USER password PASS
10847 machine pop3.example.com login USER password PASS
10848 machine smtp.example.com login USER password PASS
10854 .Ql pop3.example.com ,
10858 .Ql local.smtp.example.com .
10859 Note that in the example neither
10860 .Ql pop3.example.com
10862 .Ql smtp.example.com
10863 will be matched by the wildcard, since the exact matches take
10864 precedence (it is however faster to specify it the other way around).
10867 This is the same as
10869 except that it is a fallback entry that is used shall none of the
10870 specified machines match; only one default token may be specified,
10871 and it must be the last first-class token.
10873 .It Cd login Ar name
10874 The user name on the remote machine.
10876 .It Cd password Ar string
10877 The user's password on the remote machine.
10879 .It Cd account Ar string
10880 Supply an additional account password.
10881 This is merely for FTP purposes.
10883 .It Cd macdef Ar name
10885 A macro is defined with the specified
10887 it is formed from all lines beginning with the next line and continuing
10888 until a blank line is (consecutive newline characters are) encountered.
10891 entries cannot be utilized by multiple machines, too, but must be
10892 defined following the
10894 they are intended to be used with.)
10897 exists, it is automatically run as the last step of the login process.
10898 This is merely for FTP purposes.
10905 .\" .Sh EXAMPLES {{{
10908 .\" .Ss "An example configuration" {{{
10909 .Ss "An example configuration"
10911 .Bd -literal -offset indent
10912 # This example assumes v15.0 compatibility mode
10915 # Where are the up-to-date SSL certificates?
10916 #set ssl-ca-dir=/etc/ssl/certs
10917 set ssl-ca-file=/etc/ssl/certs/ca-certificates.crt
10919 # (Since we manage up-to-date ones explicitly, do not use any,
10920 # possibly outdated, default certificates shipped with OpenSSL)
10921 set ssl-no-default-ca
10923 # Do not use protocols older than TLS v1.2.
10924 # Change this only when the remote server does not support it:
10925 # maybe use ssl-protocol-HOST (or -USER@HOST) syntax to define
10926 # such explicit exceptions, then
10927 set ssl-protocol='-ALL,+TLSv1.2'
10929 # Explicitly define the list of ciphers, which may improve security,
10930 # especially with protocols older than TLS v1.2. See ciphers(1).
10931 # Including "@STRENGTH" will sort the final list by algorithm strength.
10932 # In reality it is possibly best to only use ssl-cipher-list-HOST
10933 # (or -USER@HOST), as necessary, again..
10934 set ssl-cipher-list=TLSv1.2:!aNULL:!eNULL:@STRENGTH
10935 # TLSv1.2:!aNULL:!eNULL:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:\e
10936 DHE-RSA-AES256-SHA:@STRENGTH
10937 # ALL:!aNULL:!MEDIUM:!LOW:!MD5:!RC4:!EXPORT:@STRENGTH
10939 # Request strict transport security checks!
10940 set ssl-verify=strict
10942 # Essential setting: select allowed character sets
10943 set sendcharsets=utf-8,iso-8859-1
10945 # A very kind option: when replying to a message, first try to
10946 # use the same encoding that the original poster used herself!
10947 set reply-in-same-charset
10949 # When replying to or forwarding a message the comment and name
10950 # parts of email addresses are removed unless this variable is set
10953 # When sending messages, wait until the Mail-Transfer-Agent finishs.
10954 # Only like this you will be able to see errors reported through the
10955 # exit status of the MTA (including the builtin SMTP one)!
10958 # Only use builtin MIME types, no mime.types(5) files
10959 set mimetypes-load-control
10961 # Default directory where we act in (relative to $HOME)
10963 # A leading "+" (often) means: under *folder*
10964 # *record* is used to save copies of sent messages
10965 set MBOX=+mbox.mbox record=+sent.mbox DEAD=+dead.txt
10967 # Make "file mymbox" and "file myrec" go to..
10968 shortcut mymbox %:+mbox.mbox myrec +sent.mbox
10970 # Not really optional, e.g., for S/MIME
10971 set from='Your Name <address@exam.ple>'
10973 # It may be necessary to set hostname and/or smtp-hostname
10974 # if the "SERVER" of mta and "domain" of from do not match.
10975 # The `urlencode' command can be used to encode USER and PASS
10976 set mta=(smtps?|submission)://[USER[:PASS]@]SERVER[:PORT] \e
10977 smtp-auth=login/plain... \e
10980 # Never refuse to start into interactive mode, and more
10982 colour-pager crt= \e
10983 followup-to followup-to-honour=ask-yes \e
10984 history-file=+.\*(uAhist history-size=-1 history-gabby \e
10985 mime-counter-evidence=0xE \e
10986 prompt='?\e?!\e![\e${-account}#\e${-mailbox-display}]? ' \e
10987 reply-to-honour=ask-yes \e
10990 # Only include the selected header fields when typing messages
10991 headerpick type retain add from_ date from to cc subject \e
10992 message-id mail-followup-to reply-to
10993 # ...when forwarding messages
10994 headerpick forward retain add subject date from to cc
10995 # ...when saving message, etc.
10996 #headerpick save ignore add ^Original-.*$ ^X-.*$
10998 # Some mailing lists
10999 mlist '@xyz-editor\e.xyz$' '@xyzf\e.xyz$'
11000 mlsubscribe '^xfans@xfans\e.xyz$'
11002 # A real life example of a very huge free mail provider
11004 set folder=~/spool/XooglX inbox=+syste.mbox sent=+sent
11005 set from='Your Name <address@examp.ple>'
11006 set mta=smtp://USER:PASS@smtp.gmXil.com smtp-use-starttls
11009 # Here is a pretty large one which does not allow sending mails
11010 # if there is a domain name mismatch on the SMTP protocol level,
11011 # which would bite us if the value of from does not match, e.g.,
11012 # for people who have a sXXXXeforge project and want to speak
11013 # with the mailing list under their project account (in from),
11014 # still sending the message through their normal mail provider
11016 set folder=~/spool/XandeX inbox=+syste.mbox sent=+sent
11017 set from='Your Name <address@exam.ple>'
11018 set mta=smtps://USER:PASS@smtp.yaXXex.ru:465 \e
11019 hostname=yaXXex.com smtp-hostname=
11022 # Create some new commands so that, e.g., `ls /tmp' will..
11023 wysh ghost lls '!ls ${LS_COLOR_FLAG} -aFlrS'
11024 wysh ghost llS '!ls ${LS_COLOR_FLAG} -aFlS'
11025 wysh ghost ls '!ls ${LS_COLOR_FLAG} -aFrS'
11026 wysh ghost lS '!ls ${LS_COLOR_FLAG} -aFS'
11027 wysh ghost lla '!ls ${LS_COLOR_FLAG} -aFlr'
11028 wysh ghost llA '!ls ${LS_COLOR_FLAG} -aFl'
11029 wysh ghost la '!ls ${LS_COLOR_FLAG} -aFr'
11030 wysh ghost lA '!ls ${LS_COLOR_FLAG} -aF'
11031 wysh ghost ll '!ls ${LS_COLOR_FLAG} -aFltr'
11032 wysh ghost lL '!ls ${LS_COLOR_FLAG} -aFlt'
11033 wysh ghost l '!ls ${LS_COLOR_FLAG} -aFtr'
11034 wysh ghost L '!ls ${LS_COLOR_FLAG} -aFt'
11036 # We do not support gpg(1) directly yet. But simple --clearsign'd
11037 # message parts can be dealt with as follows:
11039 wysh set pipe-text/plain=$'@*#++=@\e
11040 < "${MAILX_FILENAME_TEMPORARY}" awk \e
11041 -v TMPFILE="${MAILX_FILENAME_TEMPORARY}" \e'\e
11043 /^-----BEGIN PGP SIGNED MESSAGE-----/,/^$/{\e
11046 print "--- GPG --verify ---";\e
11047 system("gpg --verify " TMPFILE " 2>&1");\e
11048 print "--- GPG --verify ---";\e
11052 /^-----BEGIN PGP SIGNATURE-----/,\e
11053 /^-----END PGP SIGNATURE-----/{\e
11063 !printf 'Key IDs to gpg --recv-keys: ';\e
11065 gpg --recv-keys ${keyids};
11071 When storing passwords in
11073 appropriate permissions should be set on this file with
11074 .Ql $ chmod 0600 \*(ur .
11077 is available user credentials can be stored in the central
11079 file instead; e.g., here is a different version of the example account
11080 that sets up SMTP and POP3:
11082 .Bd -literal -offset indent
11087 set folder=~/spool/XandeX inbox=+syste.mbox sent=+sent
11088 set from='Your Name <address@exam.ple>'
11090 # Load an encrypted ~/.netrc by uncommenting the next line
11091 #set netrc-pipe='gpg -qd ~/.netrc.pgp'
11093 set mta=smtps://smtp.yXXXXx.ru:465 \e
11094 smtp-hostname= hostname=yXXXXx.com
11095 set pop3-keepalive=240 pop3-no-apop-pop.yXXXXx.ru
11096 ghost xp fi pop3s://pop.yXXXXx.ru
11105 .Bd -literal -offset indent
11106 machine *.yXXXXx.ru login USER password PASS
11110 This configuration should now work just fine:
11113 .Dl $ echo text | \*(uA -vv -AXandeX -s Subject user@exam.ple
11116 .\" .Ss "Signed and encrypted messages with S/MIME" {{{
11117 .Ss "Signed and encrypted messages with S/MIME"
11119 \*(OP S/MIME provides two central mechanisms:
11120 message signing and message encryption.
11121 A signed message contains some data in addition to the regular text.
11122 The data can be used to verify that the message was sent using a valid
11123 certificate, that the sender's address in the message header matches
11124 that in the certificate, and that the message text has not been altered.
11125 Signing a message does not change its regular text;
11126 it can be read regardless of whether the recipient's software is able to
11130 It is thus usually possible to sign all outgoing messages if so desired.
11131 Encryption, in contrast, makes the message text invisible for all people
11132 except those who have access to the secret decryption key.
11133 To encrypt a message, the specific recipient's public encryption key
11135 It is therefore not possible to send encrypted mail to people unless their
11136 key has been retrieved from either previous communication or public key
11138 A message should always be signed before it is encrypted.
11139 Otherwise, it is still possible that the encrypted message text is
11143 A central concept to S/MIME is that of the certification authority (CA).
11144 A CA is a trusted institution that issues certificates.
11145 For each of these certificates it can be verified that it really
11146 originates from the CA, provided that the CA's own certificate is
11148 A set of CA certificates is usually delivered with OpenSSL and installed
11150 If you trust the source of your OpenSSL software installation,
11151 this offers reasonable security for S/MIME on the Internet.
11153 .Va smime-no-default-ca
11154 to avoid using the default certificate and point
11158 to a trusted pool of certificates.
11159 In general, a certificate cannot be more secure than the method its CA
11160 certificate has been retrieved with.
11163 The first thing you need for participating in S/MIME message exchange is
11164 your personal certificate, including a private key.
11165 The certificate contains public information, in particular your name and
11166 your email address(es), and the public key that is used by others to
11167 encrypt messages for you,
11168 and to verify signed messages they supposedly received from you.
11169 The certificate is included in each signed message you send.
11170 The private key must be kept secret.
11171 It is used to decrypt messages that were previously encrypted with your
11172 public key, and to sign messages.
11175 For personal use it is recommended that you get a S/MIME certificate
11176 from one of the major CAs on the Internet using your WWW browser.
11177 Many CAs offer such certificates for free.
11179 .Lk https://www.CAcert.org
11180 which issues client and server certificates to members of their
11181 community for free; their root certificate
11182 .Pf ( Lk https://\:www.cacert.org/\:certs/\:root.crt )
11183 is often not in the default set of trusted CA root certificates, though,
11184 which means you will have to download their root certificate separately
11185 and ensure it is part of our S/MIME certificate validation chain by
11188 or as a vivid member of the
11189 .Va smime-ca-file .
11190 But let us take a step-by-step tour on how to setup S/MIME with
11191 a certificate from CAcert.org despite this situation!
11194 First of all you will have to become a member of the CAcert.org
11195 community, simply by registrating yourself via the web interface.
11196 Once you are, create and verify all email addresses you want to be able
11197 to create signed and encrypted messages for/with using the corresponding
11198 entries of the web interface.
11199 Now ready to create S/MIME certificates, so let us create a new
11200 .Dq client certificate ,
11201 ensure to include all email addresses that should be covered by the
11202 certificate in the following web form, and also to use your name as the
11206 Create a private key and a certificate request on your local computer
11207 (please see the manual pages of the used commands for more in-depth
11208 knowledge on what the used arguments etc. do):
11211 .Dl openssl req -nodes -newkey rsa:4096 -keyout key.pem -out creq.pem
11214 Afterwards copy-and-paste the content of
11216 into the certificate-request (CSR) field of the web form on the
11217 CAcert.org website (you may need to unfold some
11218 .Dq advanced options
11219 to see the corresponding text field).
11220 This last step will ensure that your private key (which never left your
11221 box) and the certificate belong together (through the public key that
11222 will find its way into the certificate via the certificate-request).
11223 You are now ready and can create your CAcert certified certificate.
11224 Download and store or copy-and-paste it as
11229 In order to use your new S/MIME setup a combined private key/public key
11230 (certificate) file has to be created:
11233 .Dl cat key.pem pub.crt > ME@HERE.com.paired
11236 This is the file \*(UA will work with.
11237 If you have created your private key with a passphrase then \*(UA will
11238 ask you for it whenever a message is signed or decrypted.
11239 Set the following variables to henceforth use S/MIME (setting
11241 is of interest for verification only):
11243 .Bd -literal -offset indent
11244 set smime-ca-file=ALL-TRUSTED-ROOT-CERTS-HERE \e
11245 smime-sign-cert=ME@HERE.com.paired \e
11246 smime-sign-message-digest=SHA256 \e
11251 From each signed message you send, the recipient can fetch your
11252 certificate and use it to send encrypted mail back to you.
11253 Accordingly if somebody sends you a signed message, you can do the same,
11256 command to check the validity of the certificate.
11259 Variables of interest for S/MIME signing:
11261 .Va smime-ca-file ,
11262 .Va smime-crl-dir ,
11263 .Va smime-crl-file ,
11264 .Va smime-no-default-ca ,
11266 .Va smime-sign-cert ,
11267 .Va smime-sign-include-certs
11269 .Va smime-sign-message-digest .
11272 After it has been verified save the certificate via
11274 and tell \*(UA that it should use it for encryption for further
11275 communication with that somebody:
11277 .Bd -literal -offset indent
11279 set smime-encrypt-USER@HOST=FILENAME \e
11280 smime-cipher-USER@HOST=AES256
11284 Additional variables of interest for S/MIME en- and decryption:
11287 .Va smime-encrypt-USER@HOST .
11290 You should carefully consider if you prefer to store encrypted messages
11292 If you do, anybody who has access to your mail folders can read them,
11293 but if you do not, you might be unable to read them yourself later if
11294 you happen to lose your private key.
11297 command saves messages in decrypted form, while the
11301 commands leave them encrypted.
11304 Note that neither S/MIME signing nor encryption applies to message
11305 subjects or other header fields yet.
11306 Thus they may not contain sensitive information for encrypted messages,
11307 and cannot be trusted even if the message content has been verified.
11308 When sending signed messages,
11309 it is recommended to repeat any important header information in the
11313 .\" .Ss "Using CRLs with S/MIME or SSL/TLS" {{{
11314 .Ss "Using CRLs with S/MIME or SSL/TLS"
11316 \*(OP Certification authorities (CAs) issue certificate revocation
11317 lists (CRLs) on a regular basis.
11318 These lists contain the serial numbers of certificates that have been
11319 declared invalid after they have been issued.
11320 Such usually happens because the private key for the certificate has
11322 because the owner of the certificate has left the organization that is
11323 mentioned in the certificate, etc.
11324 To seriously use S/MIME or SSL/TLS verification,
11325 an up-to-date CRL is required for each trusted CA.
11326 There is otherwise no method to distinguish between valid and
11327 invalidated certificates.
11328 \*(UA currently offers no mechanism to fetch CRLs, nor to access them on
11329 the Internet, so they have to be retrieved by some external mechanism.
11332 \*(UA accepts CRLs in PEM format only;
11333 CRLs in DER format must be converted, like, e.\|g.:
11336 .Dl $ openssl crl \-inform DER \-in crl.der \-out crl.pem
11339 To tell \*(UA about the CRLs, a directory that contains all CRL files
11340 (and no other files) must be created.
11345 variables, respectively, must then be set to point to that directory.
11346 After that, \*(UA requires a CRL to be present for each CA that is used
11347 to verify a certificate.
11350 .\" .Ss "Handling spam" {{{
11351 .Ss "Handling spam"
11353 \*(OP \*(UA can make use of several spam interfaces for the purpose of
11354 identification of, and, in general, dealing with spam messages.
11355 A precondition of most commands in order to function is that the
11357 variable is set to one of the supported interfaces.
11358 Once messages have been identified as spam their (volatile)
11360 state can be prompted: the
11364 message specifications will address respective messages and their
11366 entries will be used when displaying the
11368 in the header display.
11373 rates the given messages and sets their
11376 If the spam interface offers spam scores those can also be displayed in
11377 the header display by including the
11387 will interact with the Bayesian filter of the chosen interface and learn
11388 the given messages as
11392 respectively; the last command can be used to cause
11394 of messages; it adheres to their current
11396 state and thus reverts previous teachings.
11401 will simply set and clear, respectively, the mentioned volatile
11403 message flag, without any interface interaction.
11412 requires a running instance of the
11414 server in order to function, started with the option
11416 shall Bayesian filter learning be possible.
11418 .Bd -literal -offset indent
11419 $ spamd -i localhost:2142 -i /tmp/.spamsock -d [-L] [-l]
11420 $ spamd --listen=localhost:2142 --listen=/tmp/.spamsock \e
11421 --daemonize [--local] [--allow-tell]
11425 Thereafter \*(UA can make use of these interfaces:
11427 .Bd -literal -offset indent
11428 $ \*(uA -Sspam-interface=spamc -Sspam-maxsize=500000 \e
11429 -Sspamc-command=/usr/local/bin/spamc \e
11430 -Sspamc-arguments="-U /tmp/.spamsock" -Sspamc-user=
11432 $ \*(uA -Sspam-interface=spamc -Sspam-maxsize=500000 \e
11433 -Sspamc-command=/usr/local/bin/spamc \e
11434 -Sspamc-arguments="-d localhost -p 2142" -Sspamc-user=
11438 Using the generic filter approach allows usage of programs like
11440 Here is an example, requiring it to be accessible via
11443 .Bd -literal -offset indent
11444 $ \*(uA -Sspam-interface=filter -Sspam-maxsize=500000 \e
11445 -Sspamfilter-ham="bogofilter -n" \e
11446 -Sspamfilter-noham="bogofilter -N" \e
11447 -Sspamfilter-nospam="bogofilter -S" \e
11448 -Sspamfilter-rate="bogofilter -TTu 2>/dev/null" \e
11449 -Sspamfilter-spam="bogofilter -s" \e
11450 -Sspamfilter-rate-scanscore="1;^(.+)$"
11454 Because messages must exist on local storage in order to be scored (or
11455 used for Bayesian filter training), it is possibly a good idea to
11456 perform the local spam check last:
11458 .Bd -literal -offset indent
11459 define spamdelhook {
11461 spamset (header x-dcc-brand-metrics "bulk")
11462 # Server-side spamassassin(1)
11463 spamset (header x-spam-flag "YES")
11464 del :s # TODO we HAVE to be able to do `spamrate :u ! :sS'
11465 move :S +maybe-spam
11468 move :S +maybe-spam
11470 set folder-hook-FOLDER=spamdelhook
11474 See also the documentation for the variables
11475 .Va spam-interface , spam-maxsize ,
11476 .Va spamc-command , spamc-arguments , spamc-user ,
11477 .Va spamfilter-ham , spamfilter-noham , spamfilter-nospam , \
11480 .Va spamfilter-rate-scanscore .
11488 In general it is a good idea to turn on
11494 twice) if something does not work well.
11495 Very often a diagnostic message can be produced that leads to the
11496 problems' solution.
11498 .\" .Ss "\*(UA shortly hangs on startup" {{{
11499 .Ss "\*(UA shortly hangs on startup"
11501 This can have two reasons, one is the necessity to wait for a file lock
11502 and cannot be helped, the other being that \*(UA calls the function
11504 in order to query the nodename of the box (sometimes the real one is
11505 needed instead of the one represented by the internal variable
11507 One may have varying success by ensuring that the real hostname and
11511 or, more generally, that the name service is properly setup \(en
11514 return the expected value?
11515 Does this local hostname has a domain suffix?
11516 RFC 6762 standardized the link-local top-level domain
11518 try again after adding an (additional) entry with this extension.
11521 .\" .Ss "\*(UA exits quick, and output is cleared away" {{{
11522 .Ss "\*(UA exits quick, and output is cleared away"
11524 When this happens even with
11526 set, then this most likely indicates a problem with the creation of
11527 so-called dotlock files: setting
11528 .Va dotlock-ignore-error
11529 should overcome this situation.
11530 This only avoids symptoms, it does not address the problem, though.
11531 Since the output is cleared away \*(UA has support for
11532 .Sx "On terminal control and line editor" ,
11533 and switches to the
11535 which causes the output clearance: by doing
11536 .Ql set termcap='smcup='
11537 this mode can be suppressed, and by setting
11539 (twice) the actual problem should be reported.
11542 .\" .Ss "I cannot login to Google mail aka GMail" {{{
11543 .Ss "I cannot login to Google mail aka GMail"
11545 Since 2014 some free service providers classify programs as
11547 unless they use a special authentification method (OAuth 2.0) which
11548 was not standardized for non-HTTP protocol authentication token query
11549 until August 2015 (RFC 7628).
11552 Different to Kerberos / GSSAPI, which is developed since the mid of the
11553 1980s, where a user can easily create a local authentication ticket for
11554 her- and himself with the locally installed
11556 program, that protocol has no such local part but instead requires
11557 a world-wide-web query to create or fetch a token; since there is no
11558 local cache this query would have to be performed whenever \*(UA is
11559 invoked (in interactive sessions situation may differ).
11562 \*(UA does not support OAuth.
11563 Because of this it is necessary to declare \*(UA a
11564 .Dq less secure app
11565 (on the providers account web page) in order to read and send mail.
11566 However, it also seems possible to take the following steps instead:
11571 give the provider the number of a mobile phone,
11574 .Dq 2-Step Verification ,
11576 create an application specific password (16 characters), and
11578 use that special password instead of the real Google account password in
11579 \*(UA (for more on that see the section
11580 .Sx "On URL syntax and credential lookup" ) .
11584 .\" .Ss "Not \(dqdefunctional\(dq, but the editor key does not work" {{{
11585 .Ss "Not \(dqdefunctional\(dq, but the editor key does not work"
11587 It can happen that the terminal library (see
11588 .Sx "On terminal control and line editor",
11591 reports different codes than the terminal really sends, in which case
11592 \*(UA will tell that a key binding is functional, but will not be able to
11593 recognize it because the received data does not match anything expected.
11598 ings will show the byte sequences that are expected.
11601 To overcome the situation, use, e.g., the program
11603 in conjunction with the command line option
11605 if available, to see the byte sequences which are actually produced
11606 by keypresses, and use the variable
11608 to make \*(UA aware of them.
11609 E.g., the terminal this is typed on produces some false sequences, here
11610 an example showing the shifted home key:
11612 .Bd -literal -offset indent
11615 # 1B 5B=[ 31=1 3B=; 32=2 48=H
11620 ? \*(uA -v -Stermcap='kHOM=\eE[H'
11629 .\" .Sh "SEE ALSO" {{{
11639 .Xr spamassassin 1 ,
11648 .Xr mailwrapper 8 ,
11653 .\" .Sh HISTORY {{{
11656 M. Douglas McIlroy writes in his article
11657 .Dq A Research UNIX Reader: Annotated Excerpts \
11658 from the Programmer's Manual, 1971-1986
11661 command already appeared in First Edition
11665 .Bd -ragged -offset indent
11666 Electronic mail was there from the start.
11667 Never satisfied with its exact behavior, everybody touched it at one
11668 time or another: to assure the safety of simultaneous access, to improve
11669 privacy, to survive crashes, to exploit uucp, to screen out foreign
11670 freeloaders, or whatever.
11671 Not until v7 did the interface change (Thompson).
11672 Later, as mail became global in its reach, Dave Presotto took charge and
11673 brought order to communications with a grab-bag of external networks
11679 Mail was written in 1978 by Kurt Shoens and developed as part of the
11682 distribution until 1995.
11683 Mail has then seen further development in open source
11685 variants, noticeably by Christos Zoulas in
11687 Based upon this Nail, later Heirloom Mailx, was developed by Gunnar
11688 Ritter in the years 2000 until 2008.
11689 Since 2012 S-nail is maintained by Steffen (Daode) Nurpmeso.
11690 This man page is derived from
11691 .Dq The Mail Reference Manual
11692 that was originally written by Kurt Shoens.
11698 .An "Kurt Shoens" ,
11699 .An "Edward Wang" ,
11700 .An "Keith Bostic" ,
11701 .An "Christos Zoulas" ,
11702 .An "Gunnar Ritter" ,
11703 .An "Steffen Nurpmeso" Aq Mt s-nail-users@lists.sourceforge.net
11705 .Mt s-mailx@sdaoden.eu ) .
11708 .\" .Sh CAVEATS {{{
11711 \*(ID Interrupting an operation via
11715 is often problematic: many library functions cannot deal with the
11717 that this software (still) performs.
11720 The SMTP and POP3 protocol support of \*(UA is very basic.
11721 Also, if it fails to contact its upstream SMTP server, it will not make
11722 further attempts to transfer the message at a later time (setting
11727 If this is a concern, it might be better to set up a local SMTP server
11728 that is capable of message queuing.
11734 After deleting some message of a POP3 mailbox the header summary falsely
11735 claims that there are no messages to display, one needs to perform
11736 a scroll or dot movement to restore proper state.
11738 In threaded display a power user may encounter crashes very
11739 occasionally (this is may and very).
11743 in the source repository lists future directions.