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 / 2017-07-16
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()
79 .Op : Ns Fl a Ar attachment Ns \&:
80 .Op : Ns Fl b Ar bcc-addr Ns \&:
81 .Op : Ns Fl c Ar cc-addr Ns \&:
82 .Op Fl M Ar type | Fl m Ar file | Fl q Ar file | Fl t
85 .Fl S Ar var Ns Op Ns = Ns Ar value Ns
88 .Op : Ns Fl X Ar cmd Ns \&:
90 .Pf : Ar to-addr Ns \&:
91 .Op Fl Fl \~ Ns : Ns Ar mta-option Ns \&:
100 .Op Fl r Ar from-addr
102 .Fl S Ar var Ns Op Ns = Ns Ar value Ns
105 .Op : Ns Fl X Ar cmd Ns \&:
106 .Op Fl Fl \~ Ns : Ns Ar mta-option Ns \&:
115 .Op Fl r Ar from-addr
117 .Fl S Ar var Ns Op Ns = Ns Ar value Ns
119 .Op : Ns Fl X Ar cmd Ns \&:
121 .Op Fl Fl \~ Ns : Ns Ar mta-option Ns \&:
127 .Mx -toc -tree html pdf ps xhtml
130 .\" .Sh DESCRIPTION {{{
133 .Bd -filled -compact -offset indent
134 .Sy Compatibility note:
135 S-nail (\*(UA) will wrap up into \%S-mailx in v15.0 (circa 2019).
136 Backward incompatibility has to be expected \(en
139 .Sx "Shell-style argument quoting"
140 rules, for example, and shell metacharacters will become meaningful.
141 New and old behaviour is flagged \*(IN and \*(OU, and setting
144 .Sx "INTERNAL VARIABLES" ,
145 will choose new behaviour when applicable.
146 \*(OB flags what will vanish, and enabling
150 enables obsoletion warnings.
154 \*(UA provides a simple and friendly environment for sending and
156 It is intended to provide the functionality of the POSIX
158 command, but is MIME capable and optionally offers extensions for
159 line editing, S/MIME, SMTP and POP3, among others.
160 \*(UA divides incoming mail into its constituent messages and allows
161 the user to deal with them in any order.
165 .Sx "INTERNAL VARIABLES"
166 for manipulating messages and sending mail.
167 It provides the user simple editing capabilities to ease the composition
168 of outgoing messages, and increasingly powerful and reliable
169 non-interactive scripting capabilities.
171 .\" .Ss "Options" {{{
174 .Bl -tag -width ".It Fl BaNg"
177 Explicitly control which of the
179 shall be loaded: if the letter
181 is (case-insensitively) part of the
185 is loaded, likewise the letter
187 controls loading of the user's personal
189 file, whereas the letters
193 explicitly forbid loading of any resource files.
194 This option should be used by scripts: to avoid environmental noise they
197 from any configuration files and create a script-local environment,
198 explicitly setting any of the desired
199 .Sx "INTERNAL VARIABLES"
202 This option overrides
209 command for the given user email
211 after program startup is complete (all resource files are loaded, any
213 setting is being established; only
215 commands have not been evaluated yet).
216 Being a special incarnation of
218 macros for the purpose of bundling longer-lived
220 tings, activating such an email account also switches to the accounts
222 .Sx "primary system mailbox"
227 .It Fl a Ar file Ns Op Ar =input-charset Ns Op Ar #output-charset
230 to the message (for compose mode opportunities refer to
234 .Sx "Filename transformations"
237 will be performed, but shell word expansion is restricted to the tilde
241 not be accessible but contain a
243 character, then anything before the
245 will be used as the filename, anything thereafter as a character set
248 If an input character set is specified,
249 .Mx -ix "character set specification"
250 but no output character set, then the given input character set is fixed
251 as-is, and no conversion will be applied;
252 giving the empty string or the special string hyphen-minus
254 will be treated as if
256 has been specified (the default).
258 If an output character set has also been given then the conversion will
259 be performed exactly as specified and on-the-fly, not considering the
260 file's type and content.
261 As an exception, if the output character set is specified as the empty
262 string or hyphen-minus
264 then the default conversion algorithm (see
265 .Sx "Character sets" )
266 is applied (therefore no conversion is performed on-the-fly,
268 will be MIME-classified and its contents will be inspected first) \(em
269 without support for character set conversions
271 does not include the term
273 only this argument is supported.
276 (\*(OB: \*(UA will always use line-buffered output, to gain
277 line-buffered input even in batch mode enable batch mode via
282 Send a blind carbon copy to
289 .Sx "INTERNAL VARIABLES" ,
291 The option may be used multiple times.
293 .Sx "On sending mail, and non-interactive mode" .
297 Send carbon copies to the given receiver, if so allowed by
299 May be used multiple times.
304 the internal variable
306 which enables debug messages and disables message delivery,
307 among others; effectively turns almost any operation into a dry-run.
313 and thus discard messages with an empty message part body.
314 This command line option is \*(OB.
318 Just check if mail is present (in the system
320 or the one specified via
322 if yes, return an exit status of zero, a non-zero value otherwise.
323 To restrict the set of mails to consider in this evaluation a message
324 specification can be added with the option
329 Save the message to send in a file named after the local part of the
330 first recipient's address (instead of in
335 Read in the contents of the user's
337 .Sx "secondary mailbox"
339 (or the specified file) for processing;
340 when \*(UA is quit, it writes undeleted messages back to this file
346 argument will undergo some special
347 .Sx "Filename transformations"
352 is not an argument to the flag
354 but is instead taken from the command line after option processing has
358 that starts with a hyphen-minus, prefix with a relative path, as in
359 .Ql ./-hyphenbox.mbox .
365 and exit; a configurable summary view is available via the
371 Show a short usage summary.
377 to ignore tty interrupt signals.
383 of all messages that match the given
387 .Sx "Specifying messages"
392 option has been given in addition no header summary is produced,
393 but \*(UA will instead indicate via its exit status whether
399 note that any verbose output is suppressed in this mode and must instead
400 be enabled explicitly (e.g., by using the option
405 Special send mode that will flag standard input with the MIME
409 and use it as the main message body.
410 \*(ID Using this option will bypass processing of
411 .Va message-inject-head ,
414 .Va message-inject-tail .
420 Special send mode that will MIME classify the specified
422 and use it as the main message body.
423 \*(ID Using this option will bypass processing of
424 .Va message-inject-head ,
427 .Va message-inject-tail .
433 inhibit the initial display of message headers when reading mail or
438 for the internal variable
443 Standard flag that inhibits reading the system wide
448 allows more control over the startup sequence; also see
449 .Sx "Resource files" .
453 Special send mode that will initialize the message body with the
454 contents of the specified
456 which may be standard input
458 only in non-interactive context.
466 opened will be in read-only mode.
470 .It Fl r Ar from-addr
471 Whereas the source address that appears in the
473 header of a message (or in the
475 header if the former contains multiple addresses) is honoured by the
476 builtin SMTP transport, it is not used by a file-based
478 (Mail-Transfer-Agent) for the RFC 5321 reverse-path used for relaying
479 and delegating a message to its destination(s), for delivery errors
480 etc., but it instead uses the local identity of the initiating user.
483 When this command line option is used the given
485 will be assigned to the internal variable
487 but in addition the command line option
488 .Fl \&\&f Ar from-addr
489 will be passed to a file-based
491 whenever a message is sent.
494 include a user name the address components will be separated and
495 the name part will be passed to a file-based
501 If an empty string is passed as
503 then the content of the variable
505 (or, if that contains multiple addresses,
507 will be evaluated and used for this purpose whenever the file-based
516 command line options are used when contacting a file-based MTA, unless
517 this automatic deduction is enforced by
519 ing the internal variable
520 .Va r-option-implicit .
523 Remarks: many default installations and sites disallow overriding the
524 local user identity like this unless either the MTA has been configured
525 accordingly or the user is member of a group with special privileges.
529 .It Fl S Ar var Ns Op = Ns value
533 iable and, in case of a non-boolean variable which has a value, assign
537 .Sx "INTERNAL VARIABLES"
541 may be overwritten from within resource files,
542 the command line setting will be reestablished after all resource files
544 (\*(ID In the future such a setting may instead become
546 until the startup is complete.)
550 Specify the subject of the message to be sent.
551 Newline (NL) and carriage-return (CR) bytes are invalid and will be
552 normalized to space (SP) characters.
556 The message given (on standard input) is expected to contain, separated
557 from the message body by an empty line, a message header with
562 fields giving its recipients, which will be added to any recipients
563 specified on the command line.
564 If a message subject is specified via
566 then it will be used in favour of one given on the command line.
582 .Ql Mail-Followup-To: ,
583 by default created automatically dependent on message context, will
584 be used if specified (a special address massage will however still occur
586 Any other custom header field (also see
590 is passed through entirely
591 unchanged, and in conjunction with the options
595 it is possible to embed
596 .Sx "COMMAND ESCAPES" .
604 .Sx "primary system mailbox"
607 appropriate privileges presumed; effectively identical to
608 .Ql Fl \&\&f Ns \0%user .
617 will also show the list of
619 .Ql $ \*(uA -Xversion -Xx .
624 ting the internal variable
626 enables display of some informational context messages.
627 Using it twice increases the level of verbosity.
631 Add the given (or multiple for a multiline argument)
633 to the list of commands to be executed,
634 as a last step of program startup, before normal operation starts.
635 This is the only possibility to execute commands in non-interactive mode
636 when reading startup files is actively prohibited.
637 The commands will be evaluated as a unit, just as via
647 .Sx "COMMAND ESCAPES"
648 in compose mode even in non-interactive use cases.
649 This can be used to, e.g., automatically format the composed message
650 text before sending the message:
651 .Bd -literal -offset indent
652 $ ( echo 'line one. Word. Word2.';\e
653 echo '~| /usr/bin/fmt -tuw66' ) |\e
654 LC_ALL=C \*(uA -d~:/ -Sttycharset=utf-8 bob@exam.ple
659 Enables batch mode: standard input is made line buffered, the complete
660 set of (interactive) commands is available, processing of
661 .Sx "COMMAND ESCAPES"
662 is enabled in compose mode, and diverse
663 .Sx "INTERNAL VARIABLES"
664 are adjusted for batch necessities, exactly as if done via
680 The following prepares an email message in a batched dry run:
681 .Bd -literal -offset indent
682 $ LC_ALL=C printf 'm bob\en~s ubject\enText\en~.\enx\en' |\e
683 LC_ALL=C \*(uA -d#:/ -X'alias bob bob@exam.ple'
688 This flag forces termination of option processing in order to prevent
691 It also forcefully puts \*(UA into send mode, see
692 .Sx "On sending mail, and non-interactive mode" .
698 arguments and all receivers established via
702 are subject to the checks established by
705 .Sx "INTERNAL VARIABLES" .
708 allows their recognition all
710 arguments given at the end of the command line after a
712 separator will be passed through to a file-based
714 (Mail-Transfer-Agent) and persist for the entire session.
716 constraints do not apply to the content of
720 .\" .Ss "A starter" {{{
723 \*(UA is a direct descendant of
725 Mail, itself a successor of the Research
728 .Dq was there from the start
731 It thus represents the user side of the
733 mail system, whereas the system side (Mail-Transfer-Agent, MTA) was
734 traditionally taken by
736 and most MTAs provide a binary of this name for compatibility purposes.
741 of \*(UA then the system side is not a mandatory precondition for mail
745 Because \*(UA strives for compliance with POSIX
747 it is likely that some configuration settings have to be adjusted before
748 using it is a smooth experience.
749 (Rather complete configuration examples can be found in the section
753 resource file bends those standard imposed settings of the
754 .Sx "INTERNAL VARIABLES"
755 a bit towards more user friendliness and safety already.
763 in order to suppress the automatic moving of messages to the
765 .Sx "secondary mailbox"
767 that would otherwise occur (see
768 .Sx "Message states" ) ,
771 to not remove empty system MBOX mailbox files in order not to mangle
772 file permissions when files eventually get recreated (all empty (MBOX)
773 mailbox files will be removed unless this variable is set whenever
775 mode has been enabled).
780 in order to synchronize \*(UA with the exit status report of the used
787 to enter interactive startup even if the initial mailbox is empty,
789 to allow editing of headers as well as
791 to not strip down addresses in compose mode, and
793 to include the message that is being responded to when
798 It should be remarked that the file mode creation mask can be
799 explicitly managed via the variable
801 \*(UA will not follow symbolic links when opening files for writing,
802 sufficient system support provided.
805 .\" .Ss "On sending mail, and non-interactive mode" {{{
806 .Ss "On sending mail, and non-interactive mode"
808 To send a message to one or more people, using a local or a built-in
810 (Mail-Transfer-Agent) transport to actually deliver the generated mail
811 message, \*(UA can be invoked with arguments which are the names of
812 people to whom the mail will be sent, and the command line options
816 can be used to add (blind) carbon copy receivers:
818 .Bd -literal -offset indent
820 $ \*(uA -s ubject -a ttach.txt bill@exam.ple
822 # But... try it in an isolated dry-run mode (-d) first
823 $ LC_ALL=C \*(uA -d -:/ -Ssendwait -Sttycharset=utf8 \e
824 -b bcc@exam.ple -c cc@exam.ple \e
825 -. '(Lovely) Bob <bob@exam.ple>' eric@exam.ple
828 $ LC_ALL=C \*(uA -d -:/ -Sv15-compat -Ssendwait -Sttycharset=utf8 \e
829 -S mta=smtps://mylogin@exam.ple:465 -Ssmtp-auth=none \e
830 -S from=scriptreply@exam.ple \e
836 If standard input is a terminal rather than the message to be sent,
837 the user is expected to type in the message contents.
838 In this compose mode \*(UA treats lines beginning with the character
840 special \(en these are so-called
841 .Sx "COMMAND ESCAPES" ,
842 which can be used to read in files, process shell commands, add and edit
843 attachments and more; e.g., the command escape
845 will start the text editor to revise the message in its current state,
847 allows editing of the most important message headers, with
849 custom headers can be created (more specifically than with
852 gives an overview of most other available command escapes.
856 at the beginning of an empty line leaves compose mode and causes the
857 message to be sent, whereas typing
860 twice will abort the current letter (saving its contents in the file
871 .Sx "INTERNAL VARIABLES"
872 can be used to alter default behavior.
873 E.g., messages are sent asynchronously, without supervision, unless the
876 is set, therefore send errors will not be recognizable until then.
881 will automatically startup a text editor when compose mode is entered,
883 allows editing of headers additionally to plain body content, whereas
887 will cause the user to be prompted actively for (blind) carbon-copy
888 recipients, respectively, if the given list is empty.
891 Especially when using public mail provider accounts with the SMTP
893 it is often necessary to set
897 (even finer control via
898 .Va smtp-hostname ) ,
899 which (even if empty) also causes creation of
906 Saving a copy of sent messages in a
908 mailbox may be desirable \(en as for most mailbox
910 targets the value will undergo
911 .Sx "Filename transformations" .
914 for the purpose of arranging a complete environment of settings that can
915 be switched to with a single command or command line option may be
918 has example configurations for some of the well-known public mail
919 providers, and also gives a compact overview on how to setup a secure
920 SSL/TLS environment.)
925 sandbox dry-run tests will prove correctness.
929 .Sx "On URL syntax and credential lookup"
930 will spread light on the different ways of how to specify user email
931 account credentials, the
933 variable chains, and accessing protocol-specific resources,
936 goes into the details of character encodings, and how to use them for
937 interpreting the input data given in
939 and representing messages and MIME part contents in
941 and reading the section
942 .Sx "The mime.types files"
943 should help to understand how the MIME-type of outgoing attachments are
944 classified, and what can be done for fine-tuning.
945 Over the wire a configurable
947 .Pf ( Ql Content-Transfer-Encoding: )
948 may be applied to the message data.
951 Message recipients (as specified on the command line or defined in
956 may not only be email addressees but can also be names of mailboxes and
957 even complete shell command pipe specifications.
960 is not set then only network addresses (see
962 for a description of mail addresses) and plain user names (including MTA
963 aliases) may be used, other types will be filtered out, giving a warning
967 can be used to generate standard compliant network addresses.
969 .\" When changing any of the following adjust any RECIPIENTADDRSPEC;
970 .\" grep the latter for the complete picture
974 is set then extended recipient addresses will optionally be accepted:
975 Any name which starts with a vertical bar
977 character specifies a command pipe \(en the command string following the
979 is executed and the message is sent to its standard input;
980 Likewise, any name that starts with the character solidus
982 or the character sequence dot solidus
984 is treated as a file, regardless of the remaining content;
985 likewise a name that solely consists of a hyphen-minus
987 Any other name which contains a commercial at
989 character is treated as a network address;
990 Any other name which starts with a plus sign
992 character specifies a mailbox name;
993 Any other name which contains a solidus
995 character but no exclamation mark
999 character before also specifies a mailbox name;
1000 What remains is treated as a network address.
1002 .Bd -literal -offset indent
1003 $ echo bla | \*(uA -Sexpandaddr -s test ./mbox.mbox
1004 $ echo bla | \*(uA -Sexpandaddr -s test '|cat >> ./mbox.mbox'
1005 $ echo safe | LC_ALL=C \e
1006 \*(uA -:/ -Sv15-compat -Ssendwait -Sttycharset=utf8 \e
1007 -Sexpandaddr=fail,-all,+addr,failinvaddr -s test \e
1012 It is possible to create personal distribution lists via the
1014 command, so that, for instance, the user can send mail to
1016 and have it go to a group of people.
1017 These aliases have nothing in common with the system wide aliases that
1018 may be used by the MTA, which are subject to the
1022 and are often tracked in a file
1028 Personal aliases will be expanded by \*(UA before the message is sent,
1029 and are thus a convenient alternative to specifying each addressee by
1030 itself; they correlate with the active set of
1037 .Dl alias cohorts bill jkf mark kridle@ucbcory ~/mail/cohorts.mbox
1040 .Va on-compose-enter , on-compose-leave
1042 .Va on-compose-cleanup
1043 hook variables may be set to
1045 d macros to automatically adjust some settings dependent
1046 on receiver, sender or subject contexts, and via the
1047 .Va on-compose-splice
1049 .Va on-compose-splice-shell
1050 variables, the former also to be set to a
1052 d macro, increasingly powerful mechanisms to perform automated message
1053 adjustments are available.
1054 (\*(ID These hooks work for commands which newly create messages, namely
1055 .Ic forward , mail , reply
1060 for now provide only the hooks
1063 .Va on-resend-cleanup . )
1066 To avoid environmental noise scripts should
1068 \*(UA from any configuration files and create a script-local
1069 environment, ideally with the command line options
1071 to disable any configuration file in conjunction with repetitions of
1073 to specify variables:
1075 .Bd -literal -offset indent
1076 $ env LC_ALL=C \*(uA -:/ \e
1077 -Sv15-compat -Ssendwait -Sttycharset=utf-8 \e
1078 -Sexpandaddr=fail,-all,failinvaddr \e
1079 -S mta=smtps://mylogin@exam.ple:465 -Ssmtp-auth=login \e
1080 -S from=scriptreply@exam.ple \e
1081 -s 'Subject to go' -a attachment_file \e
1082 -. 'Recipient 1 <rec1@exam.ple>' rec2@exam.ple \e
1087 As shown, scripts can
1089 a locale environment, the above specifies the all-compatible 7-bit clean
1092 but will nonetheless take and send UTF-8 in the message text by using
1094 In interactive mode, which is introduced in the next section, messages
1095 can be sent by calling the
1097 command with a list of recipient addresses:
1099 .Bd -literal -offset indent
1100 $ \*(uA -d -Squiet -Semptystart
1101 "/var/spool/mail/user": 0 messages
1102 ? mail "Recipient 1 <rec1@exam.ple>", rec2@exam.ple
1104 ? # Will do the right thing (tm)
1105 ? m rec1@exam.ple rec2@exam.ple
1109 .\" .Ss "On reading mail, and interactive mode" {{{
1110 .Ss "On reading mail, and interactive mode"
1112 When invoked without addressees \*(UA enters interactive mode in which
1114 When used like that the user's system
1116 (for more on mailbox types please see the command
1118 is read in and a one line header of each message therein is displayed if
1122 The visual style of this summary of
1124 can be adjusted through the variable
1126 and the possible sorting criterion via
1132 can be performed with the command
1134 If the initially opened mailbox is empty \*(UA will instead exit
1135 immediately (after displaying a message) unless the variable
1144 will give a listing of all available commands and
1146 will give a summary of some common ones.
1147 If the \*(OPal documentation strings are available one can type
1150 and see the actual expansion of
1152 and what its purpose is, i.e., commands can be abbreviated
1153 (note that POSIX defines some abbreviations, so that the alphabetical
1154 order of commands does not necessarily relate to the abbreviations; it is
1155 however possible to define overwrites with
1156 .Ic commandalias ) .
1157 These commands can also produce a more
1162 Messages are given numbers (starting at 1) which uniquely identify
1163 messages; the current message \(en the
1165 \(en will either be the first new message, or the first unread message,
1166 or the first message of the mailbox; the internal variable
1168 will instead cause usage of the last message for this purpose.
1173 ful of header summaries containing the
1177 will display only the summaries of the given messages, defaulting to the
1181 Message content can be displayed with the command
1188 controls whether and when \*(UA will use the configured
1190 for display instead of directly writing to the user terminal
1192 the sole difference to the command
1194 which will always use the
1198 will instead only show the first
1200 of a message (maybe even compressed if
1203 Message display experience may improve by setting and adjusting
1204 .Va mime-counter-evidence ,
1206 .Sx "HTML mail and MIME attachments" .
1209 By default the current message
1211 is displayed, but like with many other commands it is possible to give
1212 a fancy message specification (see
1213 .Sx "Specifying messages" ) ,
1216 will display all unread messages,
1221 will type the messages 1 and 5,
1223 will type the messages 1 through 5, and
1227 will display the last and the next message, respectively.
1230 (a more substantial alias for
1232 will display a header summary of the given message specification list
1233 instead of their content, e.g., the following will search for subjects:
1236 .Dl ? from "'@Some subject to search for'"
1239 In the default setup all header fields of a message will be
1241 d, but fields can be white- or blacklisted for a variety of
1242 applications by using the command
1244 e.g., to restrict their display to a very restricted set for
1246 .Ql Ic \:headerpick Cd \:type retain Ar \:from to cc subject .
1247 In order to display all header fields of a message regardless of
1248 currently active ignore or retain lists, use the commands
1253 will show the raw message content.
1254 Note that historically the global
1256 not only adjusts the list of displayed headers, but also sets
1260 Dependent upon the configuration a line editor (see the section
1261 .Sx "On terminal control and line editor" )
1262 aims at making the user experience with the many
1265 When reading the system
1271 specified a mailbox explicitly prefixed with the special
1273 modifier (propagating the mailbox to a
1275 .Sx "primary system mailbox" ) ,
1276 then messages which have been read will be automatically moved to a
1278 .Sx "secondary mailbox" ,
1281 file, when the mailbox is left, either by changing the
1282 active mailbox or by quitting \*(UA (also see
1283 .Sx "Message states" )
1284 \(en this automatic moving from a system or primary to the secondary
1285 mailbox is not performed when the variable
1288 Messages can also be explicitly
1290 d to other mailboxes, whereas
1292 keeps the original message.
1294 can be used to write out data content of specific parts of messages.
1297 After examining a message the user can
1299 to the sender and all recipients (which will also be placed in
1302 .Va recipients-in-cc
1305 exclusively to the sender(s).
1307 ing a message will allow editing the new message: the original message
1308 will be contained in the message body, adjusted according to
1310 When replying to or forwarding a message recipient addresses will be
1311 stripped from comments and names unless the internal variable
1318 messages: the former will add a series of
1320 headers, whereas the latter will not; different to newly created
1321 messages editing is not possible and no copy will be saved even with
1323 unless the additional variable
1326 Of course messages can be
1328 and they can spring into existence again via
1330 or when the \*(UA session is ended via the
1335 To end a mail processing session one may either issue
1337 to cause a full program exit, which possibly includes
1338 automatic moving of read messages to the
1340 .Sx "secondary mailbox"
1342 as well as updating the \*(OPal line editor
1346 instead in order to prevent any of these actions.
1349 .\" .Ss "HTML mail and MIME attachments" {{{
1350 .Ss "HTML mail and MIME attachments"
1352 Messages which are HTML-only become more and more common and of course
1353 many messages come bundled with a bouquet of MIME (Multipurpose Internet
1354 Mail Extensions) parts for, e.g., attachments.
1355 To get a notion of MIME types, \*(UA will first read
1356 .Sx "The mime.types files"
1357 (as configured and allowed by
1358 .Va mimetypes-load-control ) ,
1359 and then add onto that types registered directly with
1361 It (normally) has a default set of types built-in, too.
1362 To improve interaction with faulty MIME part declarations which are
1363 often seen in real-life messages, setting
1364 .Va mime-counter-evidence
1365 will allow \*(UA to verify the given assertion and possibly provide
1366 an alternative MIME type.
1369 Whereas \*(UA \*(OPally supports a simple HTML-to-text converter for
1370 HTML messages, it cannot handle MIME types other than plain text itself.
1371 Instead programs need to become registered to deal with specific MIME
1372 types or file extensions.
1373 These programs may either prepare plain text versions of their input in
1374 order to enable \*(UA to integrate their output neatlessly in its own
1375 message visualization (a mode which is called
1376 .Cd copiousoutput ) ,
1377 or display the content themselves, for example in an external graphical
1378 window: such handlers will only be considered by and for the command
1382 To install a handler program for a specific MIME type an according
1383 .Va pipe-TYPE/SUBTYPE
1384 variable needs to be set; to instead define a handler for a specific
1385 file extension the respective
1387 variable can be used \(en these handlers take precedence.
1388 \*(OPally \*(UA supports mail user agent configuration as defined in
1389 RFC 1524; this mechanism (see
1390 .Sx "The Mailcap files" )
1391 will be queried for display or quote handlers if none of the former two
1392 .\" TODO v15-compat "will be" -> "is"
1393 did; it will be the sole source for handlers of other purpose.
1394 A last source for handlers is the MIME type definition itself, when
1395 a (\*(UA specific) type-marker was registered with the command
1397 (which many built-in MIME types do).
1400 E.g., to display a HTML message inline (that is, converted to a more
1401 fancy plain text representation than the built-in converter is capable to
1402 produce) with either of the text-mode browsers
1406 teach \*(UA about MathML documents and make it display them as plain
1407 text, and to open PDF attachments in an external PDF viewer,
1408 asynchronously and with some other magic attached:
1410 .Bd -literal -offset indent
1411 ? if [ "$features" !% +filter-html-tagsoup ]
1412 ? #set pipe-text/html='@* elinks -force-html -dump 1'
1413 ? set pipe-text/html='@* lynx -stdin -dump -force_html'
1414 ? # Display HTML as plain text instead
1415 ? #set pipe-text/html=@
1417 ? mimetype @ application/mathml+xml mathml
1418 ? wysh set pipe-application/pdf='@&=@ \e
1419 trap "rm -f \e"${MAILX_FILENAME_TEMPORARY}\e"" EXIT;\e
1420 trap "trap \e"\e" INT QUIT TERM; exit 1" INT QUIT TERM;\e
1421 mupdf "${MAILX_FILENAME_TEMPORARY}"'
1425 .\" .Ss "Mailing lists" {{{
1428 \*(UA offers some support to ease handling of mailing lists.
1431 promotes all given arguments to known mailing lists, and
1433 sets their subscription attribute, creating them first as necessary.
1438 automatically, but only resets the subscription attribute.)
1439 Using the commands without arguments will show (a subset of) all
1440 currently defined mailing lists.
1445 can be used to mark out messages with configured list addresses
1446 in the header display.
1449 \*(OPally mailing lists may also be specified as (extended) regular
1450 expressions, which allows matching of many addresses with a single
1452 However, all fully qualified list addresses are matched via a fast
1453 dictionary, whereas expressions are placed in (a) list(s) which is
1454 (are) matched sequentially.
1456 .Bd -literal -offset indent
1457 ? set followup-to followup-to-honour=ask-yes \e
1458 reply-to-honour=ask-yes
1459 ? wysh mlist a1@b1.c1 a2@b2.c2 '.*@lists\e.c3$'
1460 ? mlsubscribe a4@b4.c4 exact@lists.c3
1465 .Va followup-to-honour
1467 .Ql Mail-\:Followup-\:To:
1468 header is honoured when the message is being replied to (via
1474 controls whether this header is created when sending mails; it will be
1475 created automatically for a couple of reasons, too, like when the
1477 .Dq mailing list specific
1482 is used to respond to a message with its
1483 .Ql Mail-Followup-To:
1487 A difference in between the handling of known and subscribed lists is
1488 that the address of the sender is usually not part of a generated
1489 .Ql Mail-Followup-To:
1490 when addressing the latter, whereas it is for the former kind of lists.
1491 Usually because there are exceptions: say, if multiple lists are
1492 addressed and not all of them are subscribed lists.
1494 For convenience \*(UA will, temporarily, automatically add a list
1495 address that is presented in the
1497 header of a message that is being responded to to the list of known
1499 Shall that header have existed \*(UA will instead, dependent on the
1501 .Va reply-to-honour ,
1504 for this purpose in order to accept a list administrators' wish that
1505 is supposed to have been manifested like that (but only if it provides
1506 a single address which resides on the same domain as what is stated in
1510 .\" .Ss "Signed and encrypted messages with S/MIME" {{{
1511 .Ss "Signed and encrypted messages with S/MIME"
1513 \*(OP S/MIME provides two central mechanisms:
1514 message signing and message encryption.
1515 A signed message contains some data in addition to the regular text.
1516 The data can be used to verify that the message was sent using a valid
1517 certificate, that the sender's address in the message header matches
1518 that in the certificate, and that the message text has not been altered.
1519 Signing a message does not change its regular text;
1520 it can be read regardless of whether the recipient's software is able to
1522 It is thus usually possible to sign all outgoing messages if so desired.
1525 Encryption, in contrast, makes the message text invisible for all people
1526 except those who have access to the secret decryption key.
1527 To encrypt a message, the specific recipient's public encryption key
1529 It is therefore not possible to send encrypted mail to people unless their
1530 key has been retrieved from either previous communication or public key
1532 A message should always be signed before it is encrypted.
1533 Otherwise, it is still possible that the encrypted message text is
1537 A central concept to S/MIME is that of the certification authority (CA).
1538 A CA is a trusted institution that issues certificates.
1539 For each of these certificates it can be verified that it really
1540 originates from the CA, provided that the CA's own certificate is
1542 A set of CA certificates is usually delivered with OpenSSL and installed
1544 If you trust the source of your OpenSSL software installation,
1545 this offers reasonable security for S/MIME on the Internet.
1547 .Va smime-ca-no-defaults
1548 to avoid using the default certificates and point
1552 to a trusted pool of certificates.
1553 In general, a certificate cannot be more secure than the method its CA
1554 certificate has been retrieved with.
1557 This trusted pool of certificates is used by the command
1559 to ensure that the given S/MIME messages can be trusted.
1560 If so, verified sender certificates that were embedded in signed
1561 messages can be saved locally with the command
1563 and used by \*(UA to encrypt further communication with these senders:
1565 .Bd -literal -offset indent
1567 ? set smime-encrypt-USER@HOST=FILENAME \e
1568 smime-cipher-USER@HOST=AES256
1572 To sign outgoing messages in order to allow receivers to verify the
1573 origin of these messages a personal S/MIME certificate is required.
1574 \*(UA supports password-protected personal certificates (and keys),
1575 for more on this, and its automatization, please see the section
1576 .Sx "On URL syntax and credential lookup" .
1578 .Sx "S/MIME step by step"
1579 shows examplarily how such a private certificate can be obtained.
1580 In general, if such a private key plus certificate
1582 is available, all that needs to be done is to set some variables:
1584 .Bd -literal -offset indent
1585 ? set smime-sign-cert=ME@HERE.com.paired \e
1586 smime-sign-message-digest=SHA256 \e
1591 Variables of interest for S/MIME in general are
1594 .Va smime-ca-flags ,
1595 .Va smime-ca-no-defaults ,
1597 .Va smime-crl-file .
1598 For S/MIME signing of interest are
1600 .Va smime-sign-cert ,
1601 .Va smime-sign-include-certs
1603 .Va smime-sign-message-digest .
1604 Additional variables of interest for S/MIME en- and decryption:
1607 .Va smime-encrypt-USER@HOST .
1610 \*(ID Note that neither S/MIME signing nor encryption applies to
1611 message subjects or other header fields yet.
1612 Thus they may not contain sensitive information for encrypted messages,
1613 and cannot be trusted even if the message content has been verified.
1614 When sending signed messages,
1615 it is recommended to repeat any important header information in the
1619 .\" .Ss "On URL syntax and credential lookup" {{{
1620 .Ss "On URL syntax and credential lookup"
1622 \*(IN For accessing protocol-specific resources usage of Uniform
1623 Resource Locators (URL, RFC 1738) has become omnipresent.
1624 \*(UA expects and understands URLs in the following form;
1627 denote optional parts, optional either because there also exist other
1628 ways to define the information in question or because support of the
1629 part is protocol-specific (e.g.,
1631 is used by the local maildir and the IMAP protocol, but not by POP3);
1636 are specified they must be given in URL percent encoded form (RFC 3986;
1642 .Dl PROTOCOL://[USER[:PASSWORD]@]server[:port][/path]
1645 Note that these \*(UA URLs most often do not conform to any real
1646 standard, but instead represent a normalized variant of RFC 1738 \(en
1647 they are not used in data exchange but only meant as a compact,
1648 easy-to-use way of defining and representing information in
1649 a well-known notation.
1652 Many internal variables of \*(UA exist in multiple versions, called
1653 variable chains for the rest of this document: the plain
1658 .Ql variable-USER@HOST .
1665 had been specified in the respective URL, otherwise it refers to the plain
1671 that had been found when doing the user chain lookup as is described
1674 will never be in URL percent encoded form, whether it came from an URL
1675 or not; i.e., variable chain name extensions of
1676 .Sx "INTERNAL VARIABLES"
1677 must not be URL percent encoded.
1680 For example, whether an hypothetical URL
1681 .Ql smtp://hey%3Ayou@our.house
1682 had been given that includes a user, or whether the URL was
1683 .Ql smtp://our.house
1684 and the user had been found differently, to lookup the variable chain
1685 .Va smtp-use-starttls
1686 \*(UA first looks for whether
1687 .Ql smtp-\:use-\:starttls-\:hey:you@our.house
1688 is defined, then whether
1689 .Ql smtp-\:use-\:starttls-\:our.house
1690 exists before finally ending up looking at the plain variable itself.
1693 \*(UA obeys the following logic scheme when dealing with the
1694 necessary credential information of an account:
1700 has been given in the URL the variables
1704 are looked up; if no such variable(s) can be found then \*(UA will,
1705 when enforced by the \*(OPal variables
1706 .Va netrc-lookup-HOST
1713 specific entry which provides a
1715 name: this lookup will only succeed if unambiguous (one possible matching
1718 It is possible to load encrypted
1723 If there is still no
1725 then \*(UA will fall back to the user who is supposed to run \*(UA,
1726 the identity of which has been fixated during \*(UA startup and is
1727 known to be a valid user on the current host.
1730 Authentication: unless otherwise noted this will lookup the
1731 .Va PROTOCOL-auth-USER@HOST , PROTOCOL-auth-HOST , PROTOCOL-auth
1732 variable chain, falling back to a protocol-specific default should this
1738 has been given in the URL, then if the
1740 has been found through the \*(OPal
1742 that may have already provided the password, too.
1743 Otherwise the variable chain
1744 .Va password-USER@HOST , password-HOST , password
1745 is looked up and used if existent.
1747 Afterwards the complete \*(OPal variable chain
1748 .Va netrc-lookup-USER@HOST , netrc-lookup-HOST , netrc-lookup
1752 cache is searched for a password only (multiple user accounts for
1753 a single machine may exist as well as a fallback entry without user
1754 but with a password).
1756 If at that point there is still no password available, but the
1757 (protocols') chosen authentication type requires a password, then in
1758 interactive mode the user will be prompted on the terminal.
1763 S/MIME verification works relative to the values found in the
1767 header field(s), which means that the values of
1768 .Va smime-sign , smime-sign-cert , smime-sign-include-certs
1770 .Va smime-sign-message-digest
1771 will not be looked up using the
1775 chains from above but instead use the corresponding values from the
1776 message that is being worked on.
1777 In unusual cases multiple and different
1781 combinations may therefore be involved \(en on the other hand those
1782 unusual cases become possible.
1783 The usual case is as short as:
1786 .Dl set mta=smtp://USER:PASS@HOST smtp-use-starttls \e
1787 .Dl \ \ \ \ smime-sign smime-sign-cert=+smime.pair
1792 contains complete example configurations.
1795 .\" .Ss "Character sets" {{{
1796 .Ss "Character sets"
1798 \*(OP \*(UA detects the character set of the terminal by using
1799 mechanisms that are controlled by the
1801 environment variable
1806 in that order, see there).
1807 The internal variable
1809 will be set to the detected terminal character set accordingly,
1810 and will thus show up in the output of commands like, e.g.,
1816 However, the user may give a value for
1818 during startup, so that it is possible to send mail in a completely
1820 locale environment, an option which can be used to generate and send,
1821 e.g., 8-bit UTF-8 input data in a pure 7-bit US-ASCII
1823 environment (an example of this can be found in the section
1824 .Sx "On sending mail, and non-interactive mode" ) .
1825 Changing the value does not mean much beside that, because several
1826 aspects of the real character set are implied by the locale environment
1827 of the system, which stays unaffected by
1831 If the \*(OPal character set conversion capabilities are not available
1833 does not include the term
1837 will be the only supported character set,
1838 it is simply assumed that it can be used to exchange 8-bit messages
1839 (over the wire an intermediate, configurable
1842 and the rest of this section does not apply;
1843 it may however still be necessary to explicitly set it if automatic
1844 detection fails, since in that case it defaults to
1845 .\" (Keep in SYNC: ./nail.1:"Character sets", ./config.h:CHARSET_*!)
1846 LATIN1 a.k.a. ISO-8859-1.
1849 \*(OP When reading messages, their text is converted into
1851 as necessary in order to display them on the users terminal.
1852 Unprintable characters and invalid byte sequences are detected
1853 and replaced by proper substitution characters.
1854 Character set mappings for source character sets can be established with
1857 which may be handy to work around faulty character set catalogues (e.g.,
1858 to add a missing LATIN1 to ISO-8859-1 mapping), or to enforce treatment
1859 of one character set as another one (e.g., to interpret LATIN1 as CP1252).
1861 .Va charset-unknown-8bit
1862 to deal with another hairy aspect of message interpretation.
1865 When sending messages all their parts and attachments are classified.
1866 Whereas no character set conversion is performed on those parts which
1867 appear to be binary data,
1868 the character set being used must be declared within the MIME header of
1869 an outgoing text part if it contains characters that do not conform to
1870 the set of characters that are allowed by the email standards.
1871 Permissible values for character sets used in outgoing messages can be
1876 which defines a catch-all last-resort fallback character set that is
1877 implicitly appended to the list of character sets in
1881 When replying to a message and the variable
1882 .Va reply-in-same-charset
1883 is set, then the character set of the message being replied to
1884 is tried first (still being a subject of
1885 .Ic charsetalias ) .
1886 And it is also possible to make \*(UA work even more closely related to
1887 the current locale setting automatically by using the variable
1888 .Va sendcharsets-else-ttycharset ,
1889 please see there for more information.
1892 All the specified character sets are tried in order unless the
1893 conversion of the part or attachment succeeds.
1894 If none of the tried (8-bit) character sets is capable to represent the
1895 content of the part or attachment,
1896 then the message will not be sent and its text will optionally be
1900 In general, if a message saying
1901 .Dq cannot convert from a to b
1902 appears, either some characters are not appropriate for the currently
1903 selected (terminal) character set,
1904 or the needed conversion is not supported by the system.
1905 In the first case, it is necessary to set an appropriate
1907 locale and/or the variable
1911 The best results are usually achieved when \*(UA is run in a UTF-8
1912 locale on an UTF-8 capable terminal, in which case the full Unicode
1913 spectrum of characters is available.
1914 In this setup characters from various countries can be displayed,
1915 while it is still possible to use more simple character sets for sending
1916 to retain maximum compatibility with older mail clients.
1919 On the other hand the POSIX standard defines a locale-independent 7-bit
1920 .Dq portable character set
1921 that should be used when overall portability is an issue, the even more
1922 restricted subset named
1923 .Dq portable filename character set
1924 consists of A-Z, a-z, 0-9, period
1932 .\" .Ss "Message states" {{{
1933 .Ss "Message states"
1935 \*(UA differentiates in between several different message states;
1936 the current state will be reflected in header summary displays if
1938 is configured to do so (via the internal variable
1940 and messages can also be selected and be acted upon depending on their
1942 .Sx "Specifying messages" ) .
1943 When operating on the system
1947 .Sx "primary system mailbox" ,
1948 special actions, like the automatic moving of messages to the
1950 .Sx "secondary mailbox"
1952 may be applied when the mailbox is left (also implicitly via
1953 a successful exit of \*(UA, but not if the special command
1955 is used) \(en however, because this may be irritating to users which
1958 mail-user-agents, the default global
1964 variables in order to suppress this behaviour.
1966 .Bl -hang -width ".It Ql new"
1968 Message has neither been viewed nor moved to any other state.
1969 Such messages are retained even in the
1971 .Sx "primary system mailbox" .
1974 Message has neither been viewed nor moved to any other state, but the
1975 message was present already when the mailbox has been opened last:
1976 Such messages are retained even in the
1978 .Sx "primary system mailbox" .
1981 The message has been processed by one of the following commands:
2000 will always try to automatically
2006 logical message, and may thus mark multiple messages as read, the
2008 command will do so if the internal variable
2013 command is used, messages that are in a
2015 .Sx "primary system mailbox"
2018 state when the mailbox is left will be saved in the
2020 .Sx "secondary mailbox"
2022 unless the internal variable
2027 The message has been processed by one of the following commands:
2033 can be used to access such messages.
2036 The message has been processed by a
2038 command and it will be retained in its current location.
2041 The message has been processed by one of the following commands:
2047 command is used, messages that are in a
2049 .Sx "primary system mailbox"
2052 state when the mailbox is left will be deleted; they will be saved in the
2054 .Sx "secondary mailbox"
2056 when the internal variable
2062 In addition to these message states, flags which otherwise have no
2063 technical meaning in the mail system except allowing special ways of
2064 addressing them when
2065 .Sx "Specifying messages"
2066 can be set on messages.
2067 These flags are saved with messages and are thus persistent, and are
2068 portable between a set of widely used MUAs.
2070 .Bl -hang -width ".It Ic answered"
2072 Mark messages as having been answered.
2074 Mark messages as being a draft.
2076 Mark messages which need special attention.
2080 .\" .Ss "Specifying messages" {{{
2081 .Ss "Specifying messages"
2088 can be given a list of message numbers as arguments to apply to a number
2089 of messages at once.
2092 deletes messages 1 and 2,
2095 will delete the messages 1 through 5.
2096 In sorted or threaded mode (see the
2100 will delete the messages that are located between (and including)
2101 messages 1 through 5 in the sorted/threaded order, as shown in the
2104 The following special message names exist:
2107 .Bl -tag -width ".It Ar BaNg"
2109 The current message, the so-called
2113 The message that was previously the current message.
2116 The parent message of the current message,
2117 that is the message with the Message-ID given in the
2119 field or the last entry of the
2121 field of the current message.
2124 The next previous undeleted message,
2125 or the next previous deleted message for the
2128 In sorted/threaded mode,
2129 the next previous such message in the sorted/threaded order.
2132 The next undeleted message,
2133 or the next deleted message for the
2136 In sorted/threaded mode,
2137 the next such message in the sorted/threaded order.
2140 The first undeleted message,
2141 or the first deleted message for the
2144 In sorted/threaded mode,
2145 the first such message in the sorted/threaded order.
2149 In sorted/threaded mode,
2150 the last message in the sorted/threaded order.
2154 selects the message addressed with
2158 is any other message specification,
2159 and all messages from the thread that begins at it.
2160 Otherwise it is identical to
2165 the thread beginning with the current message is selected.
2170 All messages that were included in the
2171 .Sx "Message list arguments"
2172 of the previous command.
2175 An inclusive range of message numbers.
2176 Selectors that may also be used as endpoints include any of
2181 .Dq any substring matches
2184 header, which will match addresses (too) even if
2186 is set (and POSIX says
2187 .Dq any address as shown in a header summary shall be matchable in this form ) ;
2190 variable is set, only the local part of the address is evaluated
2191 for the comparison, not ignoring case, and the setting of
2193 is completely ignored.
2194 For finer control and match boundaries use the
2198 .It Ar / Ns Ar string
2199 All messages that contain
2201 in the subject field (case ignored).
2208 the string from the previous specification of that type is used again.
2210 .It Xo Op Ar @ Ns Ar name-list Ns
2213 All messages that contain the given case-insensitive search
2215 ession; if the \*(OPal regular expression (see
2217 support is available
2219 will be interpreted as (an extended) one if any of the
2221 (extended) regular expression characters is seen: in this case this
2222 should match strings correctly which are in the locale
2226 .Ar @ Ns Ar name-list
2227 part is missing, the search is restricted to the subject field body,
2230 specifies a comma-separated list of header fields to search, as in
2232 .Dl '@to,from,cc@Someone i ought to know'
2234 In order to search for a string that includes a
2236 (commercial at) character the
2238 is effectively non-optional, but may be given as the empty string.
2239 Some special header fields may be abbreviated:
2253 respectively and case-insensitively.
2258 can be used to search in (all of) the header(s) of the message, and the
2267 can be used to perform full text searches \(en whereas the former
2268 searches only the body, the latter also searches the message header.
2270 This message specification performs full text comparison, but even with
2271 regular expression support it is almost impossible to write a search
2272 expression that savely matches only a specific address domain.
2273 To request that the content of the header is treated as a list of
2274 addresses, and to strip those down to the plain email address which the
2275 search expression is to be matched against, prefix the header name
2276 (abbreviation) with a tilde
2279 .Dl @~f@@a\e.safe\e.domain\e.match$
2282 All messages of state
2286 is one or multiple of the following colon modifiers:
2288 .Bl -tag -compact -width ".It Ar :M"
2293 Old messages (any not in state
2315 messages (cf. the variable
2316 .Va markanswered ) .
2321 \*(OP Messages classified as spam (see
2322 .Sx "Handling spam" . )
2324 \*(OP Messages with unsure spam classification.
2330 \*(OP IMAP-style SEARCH expressions may also be used.
2331 This addressing mode is available with all types of mailbox
2333 s; \*(UA will perform the search locally as necessary.
2334 Strings must be enclosed by double quotes
2336 in their entirety if they contain whitespace or parentheses;
2337 within the quotes, only reverse solidus
2339 is recognized as an escape character.
2340 All string searches are case-insensitive.
2341 When the description indicates that the
2343 representation of an address field is used,
2344 this means that the search string is checked against both a list
2347 .Bd -literal -offset indent
2348 (\*qname\*q \*qsource\*q \*qlocal-part\*q \*qdomain-part\*q)
2353 and the addresses without real names from the respective header field.
2354 These search expressions can be nested using parentheses, see below for
2358 .Bl -tag -compact -width ".It Ar _n_u"
2359 .It Ar ( criterion )
2360 All messages that satisfy the given
2362 .It Ar ( criterion1 criterion2 ... criterionN )
2363 All messages that satisfy all of the given criteria.
2365 .It Ar ( or criterion1 criterion2 )
2366 All messages that satisfy either
2371 To connect more than two criteria using
2373 specifications have to be nested using additional parentheses,
2375 .Ql (or a (or b c)) ,
2379 .Ql ((a or b) and c) .
2382 operation of independent criteria on the lowest nesting level,
2383 it is possible to achieve similar effects by using three separate
2387 .It Ar ( not criterion )
2388 All messages that do not satisfy
2390 .It Ar ( bcc \*q Ns Ar string Ns Ar \*q )
2391 All messages that contain
2393 in the envelope representation of the
2396 .It Ar ( cc \*q Ns Ar string Ns Ar \*q )
2397 All messages that contain
2399 in the envelope representation of the
2402 .It Ar ( from \*q Ns Ar string Ns Ar \*q )
2403 All messages that contain
2405 in the envelope representation of the
2408 .It Ar ( subject \*q Ns Ar string Ns Ar \*q )
2409 All messages that contain
2414 .It Ar ( to \*q Ns Ar string Ns Ar \*q )
2415 All messages that contain
2417 in the envelope representation of the
2420 .It Ar ( header name \*q Ns Ar string Ns Ar \*q )
2421 All messages that contain
2426 .It Ar ( body \*q Ns Ar string Ns Ar \*q )
2427 All messages that contain
2430 .It Ar ( text \*q Ns Ar string Ns Ar \*q )
2431 All messages that contain
2433 in their header or body.
2434 .It Ar ( larger size )
2435 All messages that are larger than
2438 .It Ar ( smaller size )
2439 All messages that are smaller than
2443 .It Ar ( before date )
2444 All messages that were received before
2446 which must be in the form
2450 denotes the day of the month as one or two digits,
2452 is the name of the month \(en one of
2453 .Ql Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec ,
2456 is the year as four digits, e.g.,
2460 All messages that were received on the specified date.
2461 .It Ar ( since date )
2462 All messages that were received since the specified date.
2463 .It Ar ( sentbefore date )
2464 All messages that were sent on the specified date.
2465 .It Ar ( senton date )
2466 All messages that were sent on the specified date.
2467 .It Ar ( sentsince date )
2468 All messages that were sent since the specified date.
2470 The same criterion as for the previous search.
2471 This specification cannot be used as part of another criterion.
2472 If the previous command line contained more than one independent
2473 criterion then the last of those criteria is used.
2477 .\" .Ss "On terminal control and line editor" {{{
2478 .Ss "On terminal control and line editor"
2480 \*(OP Terminal control will be realized through one of the standard
2482 libraries, either the
2484 or, alternatively, the
2486 both of which will be initialized to work with the environment variable
2488 Terminal control will enhance or enable interactive usage aspects, e.g.,
2489 .Sx "Coloured display" ,
2490 and extend behaviour of the Mailx-Line-Editor (MLE), which may learn the
2491 byte-sequences of keys like the cursor and function keys.
2494 The internal variable
2496 can be used to overwrite settings or to learn (correct(ed)) keycodes.
2497 \*(UA may also become a fullscreen application by entering the
2498 so-called ca-mode and switching to an alternative exclusive screen
2499 (content) shall the terminal support it and the internal variable
2501 has been set explicitly.
2502 Actual interaction with the chosen library can be disabled completely by
2503 setting the internal variable
2504 .Va termcap-disable ;
2506 will be queried regardless, which is true even if the \*(OPal library
2507 support has not been enabled at configuration time as long as some other
2508 \*(OP which (may) query terminal control sequences has been enabled.
2511 \*(OP The built-in Mailx-Line-Editor (MLE) should work in all
2512 environments which comply to the ISO C standard
2514 and will support wide glyphs if possible (the necessary functionality
2515 had been removed from ISO C, but was included in
2517 Prevent usage of a line editor in interactive mode by setting the
2519 .Va line-editor-disable .
2520 Especially if the \*(OPal terminal control support is missing setting
2521 entries in the internal variable
2523 will help shall the MLE misbehave, see there for more.
2524 The MLE can support a little bit of
2530 feature is available then input from line editor prompts will be saved
2531 in a history list that can be searched in and be expanded from.
2532 Such saving can be prevented by prefixing input with any amount of
2534 Aspects of history, like allowed content and maximum size, as well as
2535 whether history shall be saved persistently, can be configured with the
2539 .Va history-gabby-persist
2544 The MLE supports a set of editing and control commands.
2545 By default (as) many (as possible) of these will be assigned to a set of
2546 single-letter control codes, which should work on any terminal (and can
2547 be generated by holding the
2549 key while pressing the key of desire, e.g.,
2553 command is available then the MLE commands can also be accessed freely
2554 by assigning the command name, which is shown in parenthesis in the list
2555 below, to any desired key-sequence, and the MLE will instead and also use
2557 to establish its built-in key bindings
2558 (more of them if the \*(OPal terminal control is available),
2559 an action which can then be suppressed completely by setting
2560 .Va line-editor-no-defaults .
2561 .Sx "Shell-style argument quoting"
2562 notation is used in the following;
2563 combinations not mentioned either cause job control signals or do not
2564 generate a (unique) keycode:
2568 .Bl -tag -compact -width ".It Ql \eBa"
2570 Go to the start of the line
2572 .Pf ( Cd mle-go-home ) .
2575 Move the cursor backward one character
2577 .Pf ( Cd mle-go-bwd ) .
2580 Forward delete the character under the cursor;
2581 quits \*(UA if used on the empty line unless the internal variable
2585 .Pf ( Cd mle-del-fwd ) .
2588 Go to the end of the line
2590 .Pf ( Cd mle-go-end ) .
2593 Move the cursor forward one character
2595 .Pf ( Cd mle-go-fwd ) .
2598 Cancel current operation, full reset.
2599 If there is an active history search or tabulator expansion then this
2600 command will first reset that, reverting to the former line content;
2601 thus a second reset is needed for a full reset in this case
2603 .Pf ( Cd mle-reset ) .
2606 Backspace: backward delete one character
2608 .Pf ( Cd mle-del-bwd ) .
2612 Horizontal tabulator:
2613 try to expand the word before the cursor, supporting the usual
2614 .Sx "Filename transformations"
2616 .Pf ( Cd mle-complete ) .
2618 .Cd mle-quote-rndtrip .
2622 commit the current line
2624 .Pf ( Cd mle-commit ) .
2627 Cut all characters from the cursor to the end of the line
2629 .Pf ( Cd mle-snarf-end ) .
2634 .Pf ( Cd mle-repaint ) .
2637 \*(OP Go to the next history entry
2639 .Pf ( Cd mle-hist-fwd ) .
2642 (\*(OPally context-dependent) Invokes the command
2646 \*(OP Go to the previous history entry
2648 .Pf ( Cd mle-hist-bwd ) .
2651 Toggle roundtrip mode shell quotes, where produced,
2654 .Pf ( Cd mle-quote-rndtrip ) .
2655 This setting is temporary, and will be forgotten once the command line
2656 is committed; also see
2660 \*(OP Complete the current line from (the remaining) older history entries
2662 .Pf ( Cd mle-hist-srch-bwd ) .
2665 \*(OP Complete the current line from (the remaining) newer history entries
2667 .Pf ( Cd mle-hist-srch-fwd ) .
2670 Paste the snarf buffer
2672 .Pf ( Cd mle-paste ) .
2680 .Pf ( Cd mle-snarf-line ) .
2683 Prompts for a Unicode character (its hexadecimal number) to be inserted
2685 .Pf ( Cd mle-prompt-char ) .
2686 Note this command needs to be assigned to a single-letter control code
2687 in order to become recognized and executed during input of
2688 a key-sequence (only three single-letter control codes can be used for
2689 that shortcut purpose); this control code is special-treated and cannot
2690 be part of any other sequence, because any occurrence will perform the
2692 function immediately.
2695 Cut the characters from the one preceding the cursor to the preceding
2698 .Pf ( Cd mle-snarf-word-bwd ) .
2701 Move the cursor forward one word boundary
2703 .Pf ( Cd mle-go-word-fwd ) .
2706 Move the cursor backward one word boundary
2708 .Pf ( Cd mle-go-word-bwd ) .
2711 Escape: reset a possibly used multibyte character input state machine
2712 and \*(OPally a lingering, incomplete key binding
2714 .Pf ( Cd mle-cancel ) .
2715 This command needs to be assigned to a single-letter control code in
2716 order to become recognized and executed during input of a key-sequence
2717 (only three single-letter control codes can be used for that shortcut
2719 This control code may also be part of a multi-byte sequence, but if
2720 a sequence is active and the very control code is currently also an
2721 expected input, then it will first be consumed by the active sequence.
2724 (\*(OPally context-dependent) Invokes the command
2728 (\*(OPally context-dependent) Invokes the command
2732 (\*(OPally context-dependent) Invokes the command
2736 Cut the characters from the one after the cursor to the succeeding word
2739 .Pf ( Cd mle-snarf-word-fwd ) .
2750 this will immediately reset a possibly active search etc.
2755 ring the audible bell.
2759 .\" .Ss "Coloured display" {{{
2760 .Ss "Coloured display"
2762 \*(OP \*(UA can be configured to support a coloured display and font
2763 attributes by emitting ANSI a.k.a. ISO 6429 SGR (select graphic
2764 rendition) escape sequences.
2765 Usage of colours and font attributes solely depends upon the
2766 capability of the detected terminal type that is defined by the
2767 environment variable
2769 and which can be fine-tuned by the user via the internal variable
2773 On top of what \*(UA knows about the terminal the boolean variable
2775 defines whether the actually applicable colour and font attribute
2776 sequences should also be generated when output is going to be paged
2777 through the external program defined by the environment variable
2782 This is not enabled by default because different pager programs need
2783 different command line switches or other configuration in order to
2784 support those sequences.
2785 \*(UA however knows about some widely used pagers and in a clean
2786 environment it is often enough to simply set
2788 please refer to that variable for more on this topic.
2793 is set then any active usage of colour and font attribute sequences
2794 is suppressed, but without affecting possibly established
2799 To define and control colours and font attributes a single multiplexer
2800 command family exists:
2802 shows or defines colour mappings for the given colour type (e.g.,
2805 can be used to remove mappings of a given colour type.
2806 Since colours are only available in interactive mode, it may make
2807 sense to conditionalize the colour setup by encapsulating it with
2810 .Bd -literal -offset indent
2811 if terminal && [ "$features" =% +colour ]
2812 colour iso view-msginfo ft=bold,fg=green
2813 colour iso view-header ft=bold,fg=red from,subject
2814 colour iso view-header fg=red
2816 uncolour iso view-header from,subject
2817 colour iso view-header ft=bold,fg=magenta,bg=cyan
2818 colour 256 view-header ft=bold,fg=208,bg=230 "subject,from"
2819 colour mono view-header ft=bold
2820 colour mono view-header ft=bold,ft=reverse subject,from
2825 .\" .Ss "Handling spam" {{{
2828 \*(OP \*(UA can make use of several spam interfaces for the purpose of
2829 identification of, and, in general, dealing with spam messages.
2830 A precondition of most commands in order to function is that the
2832 variable is set to one of the supported interfaces.
2833 Once messages have been identified as spam their (volatile)
2835 state can be prompted: the
2839 message specifications will address respective messages and their
2841 entries will be used when displaying the
2843 in the header display.
2848 rates the given messages and sets their
2851 If the spam interface offers spam scores those can also be displayed in
2852 the header display by including the
2862 will interact with the Bayesian filter of the chosen interface and learn
2863 the given messages as
2867 respectively; the last command can be used to cause
2869 of messages; it adheres to their current
2871 state and thus reverts previous teachings.
2876 will simply set and clear, respectively, the mentioned volatile
2878 message flag, without any interface interaction.
2887 requires a running instance of the
2889 server in order to function, started with the option
2891 shall Bayesian filter learning be possible.
2893 .Bd -literal -offset indent
2894 $ spamd -i localhost:2142 -i /tmp/.spamsock -d [-L] [-l]
2895 $ spamd --listen=localhost:2142 --listen=/tmp/.spamsock \e
2896 --daemonize [--local] [--allow-tell]
2900 Thereafter \*(UA can make use of these interfaces:
2902 .Bd -literal -offset indent
2903 $ \*(uA -Sspam-interface=spamc -Sspam-maxsize=500000 \e
2904 -Sspamc-command=/usr/local/bin/spamc \e
2905 -Sspamc-arguments="-U /tmp/.spamsock" -Sspamc-user=
2907 $ \*(uA -Sspam-interface=spamc -Sspam-maxsize=500000 \e
2908 -Sspamc-command=/usr/local/bin/spamc \e
2909 -Sspamc-arguments="-d localhost -p 2142" -Sspamc-user=
2913 Using the generic filter approach allows usage of programs like
2915 Here is an example, requiring it to be accessible via
2918 .Bd -literal -offset indent
2919 $ \*(uA -Sspam-interface=filter -Sspam-maxsize=500000 \e
2920 -Sspamfilter-ham="bogofilter -n" \e
2921 -Sspamfilter-noham="bogofilter -N" \e
2922 -Sspamfilter-nospam="bogofilter -S" \e
2923 -Sspamfilter-rate="bogofilter -TTu 2>/dev/null" \e
2924 -Sspamfilter-spam="bogofilter -s" \e
2925 -Sspamfilter-rate-scanscore="1;^(.+)$"
2929 Because messages must exist on local storage in order to be scored (or
2930 used for Bayesian filter training), it is possibly a good idea to
2931 perform the local spam check last:
2933 .Bd -literal -offset indent
2934 define spamdelhook {
2936 spamset (header x-dcc-brand-metrics "bulk")
2937 # Server-side spamassassin(1)
2938 spamset (header x-spam-flag "YES")
2939 del :s # TODO we HAVE to be able to do `spamrate :u ! :sS'
2945 set folder-hook-FOLDER=spamdelhook
2949 See also the documentation for the variables
2950 .Va spam-interface , spam-maxsize ,
2951 .Va spamc-command , spamc-arguments , spamc-user ,
2952 .Va spamfilter-ham , spamfilter-noham , spamfilter-nospam , \
2955 .Va spamfilter-rate-scanscore .
2958 .\" }}} (DESCRIPTION)
2961 .\" .Sh COMMANDS {{{
2964 Each command is typed on a line by itself,
2965 and may take arguments following the command word.
2966 An unquoted reverse solidus
2968 at the end of a command line
2970 the newline character: it is discarded and the next line of input is
2971 used as a follow-up line, with all leading whitespace removed;
2972 once the entire command line is completed, and after removal of the
2973 whitespace characters
2974 .Cm space , tabulator , newline
2975 as well as those defined by the variable
2977 from the beginning and end of the line, the processing documented in the
2979 Placing any whitespace characters at the beginning of a line will
2980 prevent a possible addition of the command line to the \*(OPal
2984 Apart from this generic cleanup mechanism \*(UA uses command-specific
2985 syntax rules for command line arguments, documented in the following.
2986 This is a completely different approach to the
2988 ell, which implements a standardized (programming) language, and
2989 performs several successive transformation steps after decomposing the
2990 given command line into tokens adhering standardized syntax guidelines.
2991 This sometimes has side-effects for shell-style arguments, for example
2993 without positional parameters is not collapsed to nothing, as can be
2994 seen in the example shown for the command
2998 Command names may be abbreviated, in which case the first command that
2999 matches the given prefix will be used.
3002 can be used to show the list of all commands, either alphabetically
3003 sorted or in prefix search order (these do not match, also because the
3004 POSIX standard prescribes a set of abbreviations).
3005 \*(OPally the command
3009 when given an argument, will show a documentation string for the
3010 command matching the expanded argument, as in
3012 which should be a shorthand of
3014 with these documentation strings both commands support a more
3016 listing mode which includes the argument type of the command and other
3017 information which applies; a handy suggestion might thus be:
3019 .Bd -literal -offset indent
3021 # Before v15: need to enable sh(1)ell-style on _entire_ line!
3022 localopts 1;wysh set verbose;ignerr eval "${@}";return ${?}
3024 ? commandalias xv '\ecall __xv'
3028 .\" .Ss "Command modifiers" {{{
3029 .Ss "Command modifiers"
3031 Commands may be prefixed by one or multiple command modifiers.
3035 The modifier reverse solidus
3038 to be placed first, prevents
3040 expansions on the remains of the line, e.g.,
3042 will always evaluate the command
3044 even if an (command)alias of the same name exists.
3046 content may itself contain further command modifiers, including
3047 an initial reverse solidus to prevent further expansions.
3053 indicates that any error generated by the following command should be
3054 ignored by the state machine and not cause a program exit with enabled
3056 or for the standardized exit cases in
3061 .Sx "INTERNAL VARIABLES" ,
3062 will be set to the real exit status of the command regardless.
3065 Some commands support the
3068 modifier: if used, they expect the name of a variable, which can itself
3069 be a variable, i.e., shell expansion is applied, as their first
3070 argument, and will place their computation result in it instead of the
3071 default location (it is usually written to standard output).
3073 The given name will be tested for being a valid
3075 variable name, and may therefore only consist of upper- and lowercase
3076 characters, digits, and the underscore; the hyphen-minus may be used as
3077 a non-portable extension; digits may not be used as first, hyphen-minus
3078 may not be used as last characters.
3079 In addition the name may either not be one of the known
3080 .Sx "INTERNAL VARIABLES" ,
3081 or must otherwise refer to a writable (non-boolean) value variable.
3082 The actual put operation may fail nonetheless, e.g., if the variable
3083 expects a number argument only a number will be accepted.
3084 Any error during these operations causes the command as such to fail,
3085 and the error number
3088 .Va ^ERR Ns -NOTSUP ,
3095 Last, but not least, the modifier
3098 can be used for some old and established commands to choose the new
3099 .Sx "Shell-style argument quoting"
3100 rules over the traditional
3101 .Sx "Old-style argument quoting" .
3105 .\" .Ss "Message list arguments" {{{
3106 .Ss "Message list arguments"
3108 Some commands expect arguments that represent messages (actually
3109 their symbolic message numbers), as has been documented above under
3110 .Sx "Specifying messages"
3112 If no explicit message list has been specified, the next message
3113 forward that satisfies the command's requirements will be used,
3114 and if there are no messages forward of the current message,
3115 the search proceeds backwards;
3116 if there are no good messages at all to be found, an error message is
3117 shown and the command is aborted.
3120 .\" .Ss "Old-style argument quoting" {{{
3121 .Ss "Old-style argument quoting"
3123 \*(ID This section documents the old, traditional style of quoting
3124 non-message-list arguments to commands which expect this type of
3125 arguments: whereas still used by the majority of such commands, the new
3126 .Sx "Shell-style argument quoting"
3127 may be available even for those via
3130 .Sx "Command modifiers" .
3131 Nonetheless care must be taken, because only new commands have been
3132 designed with all the capabilities of the new quoting rules in mind,
3133 which can, e.g., generate control characters.
3136 .Bl -bullet -offset indent
3138 An argument can be enclosed between paired double-quotes
3143 any whitespace, shell word expansion, or reverse solidus characters
3144 (except as described next) within the quotes are treated literally as
3145 part of the argument.
3146 A double-quote will be treated literally within single-quotes and vice
3148 Inside such a quoted string the actually used quote character can be
3149 used nonetheless by escaping it with a reverse solidus
3155 An argument that is not enclosed in quotes, as above, can usually still
3156 contain space characters if those spaces are reverse solidus escaped, as in
3160 A reverse solidus outside of the enclosing quotes is discarded
3161 and the following character is treated literally as part of the argument.
3165 .\" .Ss "Shell-style argument quoting" {{{
3166 .Ss "Shell-style argument quoting"
3168 Commands which don't expect message-list arguments use
3170 ell-style, and therefore POSIX standardized, argument parsing and
3172 \*(ID Most new commands only support these new rules and are flagged
3173 \*(NQ, some elder ones can use them with the command modifier
3175 in the future only this type of argument quoting will remain.
3178 A command line is parsed from left to right and an input token is
3179 completed whenever an unquoted, otherwise ignored, metacharacter is seen.
3180 Metacharacters are vertical bar
3186 as well as all characters from the variable
3189 .Cm space , tabulator , newline .
3190 The additional metacharacters left and right parenthesis
3192 and less-than and greater-than signs
3196 supports are not used, and are treated as ordinary characters: for one
3197 these characters are a vivid part of email addresses, and it seems
3198 highly unlikely that their function will become meaningful to \*(UA.
3200 .Bd -filled -offset indent
3201 .Sy Compatibility note:
3202 \*(ID Please note that even many new-style commands do not yet honour
3204 to parse their arguments: whereas the
3206 ell is a language with syntactic elements of clearly defined semantics,
3207 \*(UA parses entire input lines and decides on a per-command base what
3208 to do with the rest of the line.
3209 This also means that whenever an unknown command is seen all that \*(UA
3210 can do is cancellation of the processing of the remains of the line.
3212 It also often depends on an actual subcommand of a multiplexer command
3213 how the rest of the line should be treated, and until v15 we are not
3214 capable to perform this deep inspection of arguments.
3215 Nonetheless, at least the following commands which work with positional
3216 parameters fully support
3218 for an almost shell-compatible field splitting:
3219 .Ic call , call_if , read , vpospar , xcall .
3223 Any unquoted number sign
3225 at the beginning of a new token starts a comment that extends to the end
3226 of the line, and therefore ends argument processing.
3227 An unquoted dollar sign
3229 will cause variable expansion of the given name, which must be a valid
3231 ell-style variable name (see
3233 .Sx "INTERNAL VARIABLES"
3236 (shell) variables can be accessed through this mechanism, brace
3237 enclosing the name is supported (i.e., to subdivide a token).
3240 Whereas the metacharacters
3241 .Cm space , tabulator , newline
3242 only complete an input token, vertical bar
3248 also act as control operators and perform control functions.
3249 For now supported is semicolon
3251 which terminates a single command, therefore sequencing the command line
3252 and making the remainder of the line a subject to reevaluation.
3253 With sequencing, multiple command argument types and quoting rules may
3254 therefore apply to a single line, which can become problematic before
3255 v15: e.g., the first of the following will cause surprising results.
3258 .Dl ? echo one; set verbose; echo verbose=$verbose.
3259 .Dl ? echo one; wysh set verbose; echo verbose=$verbose.
3262 Quoting is a mechanism that will remove the special meaning of
3263 metacharacters and reserved words, and will prevent expansion.
3264 There are four quoting mechanisms: the escape character, single-quotes,
3265 double-quotes and dollar-single-quotes:
3268 .Bl -bullet -offset indent
3270 The literal value of any character can be preserved by preceding it
3271 with the escape character reverse solidus
3275 Arguments which are enclosed in
3276 .Ql 'single-\:quotes'
3277 retain their literal value.
3278 A single-quote cannot occur within single-quotes.
3281 The literal value of all characters enclosed in
3282 .Ql \(dqdouble-\:quotes\(dq
3283 is retained, with the exception of dollar sign
3285 which will cause variable expansion, as above, backquote (grave accent)
3287 (which not yet means anything special), reverse solidus
3289 which will escape any of the characters dollar sign
3291 (to prevent variable expansion), backquote (grave accent)
3295 (to prevent ending the quote) and reverse solidus
3297 (to prevent escaping, i.e., to embed a reverse solidus character as-is),
3298 but has no special meaning otherwise.
3301 Arguments enclosed in
3302 .Ql $'dollar-\:single-\:quotes'
3303 extend normal single quotes in that reverse solidus escape sequences are
3304 expanded as follows:
3306 .Bl -tag -compact -width "Ql \eNNN"
3308 bell control character (ASCII and ISO-10646 BEL).
3310 backspace control characer (ASCII and ISO-10646 BS).
3312 escape control character (ASCII and ISO-10646 ESC).
3316 form feed control character (ASCII and ISO-10646 FF).
3318 line feed control character (ASCII and ISO-10646 LF).
3320 carriage return control character (ASCII and ISO-10646 CR).
3322 horizontal tabulator control character (ASCII and ISO-10646 HT).
3324 vertical tabulator control character (ASCII and ISO-10646 VT).
3326 emits a reverse solidus character.
3330 double quote (escaping is optional).
3332 eight-bit byte with the octal value
3334 (one to three octal digits), optionally prefixed by an additional
3336 A 0 byte will suppress further output for the quoted argument.
3338 eight-bit byte with the hexadecimal value
3340 (one or two hexadecimal characters).
3341 A 0 byte will suppress further output for the quoted argument.
3343 the Unicode / ISO-10646 character with the hexadecimal codepoint value
3345 (one to eight hexadecimal digits) \(em note that Unicode defines the
3346 maximum codepoint ever to be supported as
3351 This escape is only supported in locales that support Unicode (see
3352 .Sx "Character sets" ) ,
3353 in other cases the sequence will remain unexpanded unless the given code
3354 point is ASCII compatible or (if the \*(OPal character set conversion is
3355 available) can be represented in the current locale.
3356 The character NUL will suppress further output for the quoted argument.
3360 except it takes only one to four hexadecimal digits.
3362 Emits the non-printable (ASCII and compatible) C0 control codes
3363 0 (NUL) to 31 (US), and 127 (DEL).
3364 Printable representations of ASCII control codes can be created by
3365 mapping them to a different part of the ASCII character set, which is
3366 possible by adding the number 64 for the codes 0 to 31, e.g., 7 (BEL) is
3367 .Ql 7 + 64 = 71 = G .
3368 The real operation is a bitwise logical XOR with 64 (bit 7 set, see
3370 thus also covering code 127 (DEL), which is mapped to 63 (question mark):
3371 .Ql ? vexpr ^ 127 64 .
3373 Whereas historically circumflex notation has often been used for
3374 visualization purposes of control codes, e.g.,
3376 the reverse solidus notation has been standardized:
3378 Some control codes also have standardized (ISO-10646, ISO C) aliases,
3379 as shown above (e.g.,
3383 whenever such an alias exists it will be used for display purposes.
3384 The control code NUL
3386 a non-standard extension) will suppress further output for the remains
3387 of the token (which may extend beyond the current quote), or, depending
3388 on the context, the remains of all arguments for the current command.
3390 Non-standard extension: expand the given variable name, as above.
3391 Brace enclosing the name is supported.
3393 Not yet supported, just to raise awareness: Non-standard extension.
3400 .Bd -literal -offset indent
3401 ? echo 'Quotes '${HOME}' and 'tokens" differ!"# no comment
3402 ? echo Quotes ${HOME} and tokens differ! # comment
3403 ? echo Don"'"t you worry$'\ex21' The sun shines on us. $'\eu263A'
3407 .\" .Ss "Raw data arguments for codec commands" {{{
3408 .Ss "Raw data arguments for codec commands"
3410 A special set of commands, which all have the string
3412 in their name, e.g.,
3416 take raw string data as input, which means that the content of the
3417 command input line is passed completely unexpanded and otherwise
3418 unchanged: like this the effect of the actual codec is visible without
3419 any noise of possible shell quoting rules etc., i.e., the user can input
3420 one-to-one the desired or questionable data.
3421 To gain a level of expansion, the entire command line can be
3425 .Bd -literal -offset indent
3426 ? vput shcodec res encode /usr/Sch\[:o]nes Wetter/heute.txt
3428 $'/usr/Sch\eu00F6nes Wetter/heute.txt'
3430 $'/usr/Sch\eu00F6nes Wetter/heute.txt'
3431 ? eval shcodec d $res
3432 /usr/Sch\[:o]nes Wetter/heute.txt
3436 .\" .Ss "Filename transformations" {{{
3437 .Ss "Filename transformations"
3439 Filenames, where expected, and unless documented otherwise, are
3440 subsequently subject to the following filename transformations, in
3443 .Bl -bullet -offset indent
3445 If the given name is a registered
3447 it will be replaced with the expanded shortcut.
3450 The filename is matched against the following patterns or strings:
3452 .Bl -hang -compact -width ".Ar %user"
3454 (Number sign) is expanded to the previous file.
3456 (Percent sign) is replaced by the invoking
3457 .Mx -ix "primary system mailbox"
3458 user's primary system mailbox, which either is the (itself expandable)
3460 if that is set, the standardized absolute pathname indicated by
3462 if that is set, or a built-in compile-time default otherwise.
3464 Expands to the primary system mailbox of
3466 (and never the value of
3468 regardless of its actual setting).
3470 (Ampersand) is replaced with the invoking users
3471 .Mx -ix "secondary mailbox"
3472 secondary mailbox, the
3479 directory (if that variable is set).
3481 Expands to the same value as
3483 but has special meaning when used with, e.g., the command
3485 the file will be treated as a primary system mailbox by, e.g., the
3489 commands, meaning that messages that have been read in the current
3490 session will be moved to the
3492 mailbox instead of simply being flagged as read.
3496 Meta expansions are applied to the resulting filename, as applicable to
3497 the resulting file access protocol (also see
3498 .Sx "On URL syntax and credential lookup" ) .
3499 If the fully expanded filename results in multiple pathnames and the
3500 command is expecting only one file, an error results.
3502 For the file-protocol, a leading tilde
3504 character will be replaced by the expansion of
3506 except when followed by a valid user name, in which case the home
3507 directory of the given user is used instead.
3509 In addition a shell expansion as if specified in double-quotes (see
3510 .Sx "Shell-style argument quoting" )
3511 is applied, so that any occurrence of
3515 will be replaced by the expansion of the variable, if possible;
3516 .Sx "INTERNAL VARIABLES"
3519 (shell) variables can be accessed through this mechanism.
3521 In interactive context, in order to allow simple value acceptance (via
3523 arguments will usually be displayed in a properly quoted form, e.g., a file
3524 .Ql diet\e is \ecurd.txt
3526 .Ql 'diet\e is \ecurd.txt' .
3530 .\" .Ss "Commands" {{{
3533 The following commands are available:
3535 .Bl -tag -width ".It Ic BaNg"
3542 command which follows, replacing unescaped exclamation marks with the
3543 previously executed command if the internal variable
3546 This command supports
3549 .Sx "Command modifiers" ,
3550 and manages the error number
3552 A 0 or positive exit status
3554 reflects the exit status of the command, negative ones that
3555 an error happened before the command was executed, or that the program
3556 did not exit cleanly, but, e.g., due to a signal: the error number is
3557 .Va ^ERR Ns -CHILD ,
3561 In conjunction with the
3563 modifier the following special cases exist:
3564 a negative exit status occurs if the collected data could not be stored
3565 in the given variable, which is a
3567 error that should otherwise not occur.
3568 .Va ^ERR Ns -CANCELED
3569 indicates that no temporary file could be created to collect the command
3570 output at first glance.
3571 In case of catchable out-of-memory situations
3573 will occur and \*(UA will try to store the empty string, just like with
3574 all other detected error conditions.
3579 The comment-command causes the entire line to be ignored.
3581 this really is a normal command which' purpose is to discard its
3584 indicating special character, which means that, e.g., trailing comments
3585 on a line are not possible.
3589 Goes to the next message in sequence and types it
3595 Display the preceding message, or the n'th previous message if given
3596 a numeric argument n.
3600 Show the current message number (the
3605 Show a brief summary of commands.
3606 \*(OP Given an argument a synopsis for the command in question is
3607 shown instead; commands can be abbreviated in general and this command
3608 can be used to see the full expansion of an abbreviation including the
3609 synopsis, try, e.g.,
3614 and see how the output changes.
3615 This mode also supports a more
3617 output, which will provide the informations documented for
3628 .It Ic account , unaccount
3629 (ac, una) Creates, selects or lists (an) account(s).
3630 Accounts are special incarnations of
3632 macros and group commands and variable settings which together usually
3633 arrange the environment for the purpose of creating an email account.
3634 Different to normal macros settings which are covered by
3636 \(en here by default enabled! \(en will not be reverted before the
3641 (case-insensitive) always exists, and all but it can be deleted by the
3642 latter command, and in one operation with the special name
3645 Without arguments a listing of all defined accounts is shown.
3646 With one argument the given account is activated: the system
3648 of that account will be activated (as via
3650 a possibly installed
3652 will be run, and the internal variable
3655 The two argument form is identical to defining a macro as via
3657 .Bd -literal -offset indent
3659 set folder=~/mail inbox=+syste.mbox record=+sent.mbox
3660 set from='(My Name) myname@myisp.example'
3661 set mta=smtp://mylogin@smtp.myisp.example
3668 Perform email address codec transformations on raw-data argument, rather
3669 according to email standards (RFC 5322; \*(ID will furtherly improve).
3673 .Sx "Command modifiers" ) ,
3674 and manages the error number
3676 The first argument must be either
3677 .Ar [+[+[+]]]e[ncode] ,
3681 and specifies the operation to perform on the rest of the line.
3684 Decoding will show how a standard-compliant MUA will display the given
3685 argument, which should be an email address.
3686 Please be aware that most MUAs have difficulties with the address
3687 standards, and vary wildly when (comments) in parenthesis,
3689 strings, or quoted-pairs, as below, become involved.
3690 \*(ID \*(UA currently does not perform decoding when displaying addresses.
3693 Skinning is identical to decoding but only outputs the plain address,
3694 without any string, comment etc. components.
3695 Another difference is that it may fail with the error number
3699 if decoding fails to find a(n) (valid) email address, in which case the
3700 unmodified input will be output again.
3703 Encoding supports four different modes, lesser automated versions can be
3704 chosen by prefixing one, two or three plus signs: the standard imposes
3705 a special meaning on some characters, which thus have to be transformed
3706 to so-called quoted-pairs by pairing them with a reverse solidus
3708 in order to remove the special meaning; this might change interpretation
3709 of the entire argument from what has been desired, however!
3710 Specify one plus sign to remark that parenthesis shall be left alone,
3711 two for not turning double quotation marks into quoted-pairs, and three
3712 for also leaving any user-specified reverse solidus alone.
3713 The result will always be valid, if a successful exit status is reported.
3714 \*(ID Addresses need to be specified in between angle brackets
3717 if the construct becomes more difficult, otherwise the current parser
3718 will fail; it is not smart enough to guess right.
3720 .Bd -literal -offset indent
3721 ? addrc enc "Hey, you",<diet@exam.ple>\e out\e there
3722 "\e"Hey, you\e", \e\e out\e\e there" <diet@exam.ple>
3723 ? addrc d "\e"Hey, you\e", \e\e out\e\e there" <diet@exam.ple>
3724 "Hey, you", \e out\e there <diet@exam.ple>
3725 ? addrc s "\e"Hey, you\e", \e\e out\e\e there" <diet@exam.ple>
3732 .It Ic alias , unalias
3733 (a, una) Aliases are a method of creating personal distribution lists
3734 that map a single alias name to none to multiple real receivers;
3735 these aliases become expanded after message composing is completed.
3736 The latter command removes the given list of aliases, the special name
3738 will discard all existing aliases.
3739 The former command shows all currently defined aliases when used without
3740 arguments, and with one argument the expansion of the given alias.
3741 With more than one argument, creates or appends to the alias name given
3742 as the first argument the remaining arguments.
3743 Alias names are restricted to alphabetic characters, digits, the
3744 underscore, hyphen-minus, the number sign, colon, commercial at and
3745 period, the last character can also be the dollar sign:
3746 .Ql [[:alnum:]_#:@.-]+$? .
3750 .It Ic alternates , unalternates
3751 \*(NQ (alt) Manage a list of alternate addresses or names of the active user,
3752 members of which will be removed from recipient lists.
3753 The latter command removes the given list of alternates, the special name
3755 will discard all existing aliases.
3756 The former command manages the error number
3758 and shows the current set of alternates when used without arguments; in
3759 this mode it supports
3762 .Sx "Command modifiers" ) .
3763 Otherwise the given arguments (after being checked for validity) are
3764 appended to the list of alternate names; in
3766 mode they replace that list instead.
3767 There is a set of implicit alternates which is formed of the values of
3776 .It Ic answered , unanswered
3777 Take a message lists and mark each message as having been answered,
3778 having not been answered, respectively.
3779 Messages will be marked answered when being
3781 to automatically if the
3785 .Sx "Message states" .
3790 .It Ic bind , unbind
3791 \*(OP\*(NQ The bind command extends the MLE (see
3792 .Sx "On terminal control and line editor" )
3793 with freely configurable key bindings.
3794 The latter command removes from the given context the given key binding,
3795 both of which may be specified as a wildcard
3799 will remove all bindings of all contexts.
3800 Due to initialization order unbinding will not work for built-in key
3801 bindings upon program startup, however: please use
3802 .Va line-editor-no-defaults
3803 for this purpose instead.
3806 With one argument the former command shows all key bindings for the
3807 given context, specifying an asterisk
3809 will show the bindings of all contexts; a more verbose listing will be
3810 produced if either of
3815 With two or more arguments a binding is (re)established:
3816 the first argument is the context to which the binding shall apply,
3817 the second argument is a comma-separated list of the
3819 which form the binding, and any remaining arguments form the expansion.
3820 To indicate that a binding shall not be auto-committed, but that the
3821 expansion shall instead be furtherly editable by the user, a commercial at
3823 (that will be removed) can be placed last in the expansion, from which
3824 leading and trailing whitespace will finally be removed.
3825 Reverse solidus cannot be used as the last character of expansion.
3828 Contexts define when a binding applies, i.e., a binding will not be seen
3829 unless the context for which it is defined for is currently active.
3830 This is not true for the shared binding
3832 which is the foundation for all other bindings and as such always
3833 applies, its bindings, however, only apply secondarily.
3834 The available contexts are the shared
3838 context which is used in all not otherwise documented situations, and
3840 which applies to compose mode only.
3844 which form the binding are specified as a comma-separated list of
3845 byte-sequences, where each list entry corresponds to one key(press).
3846 A list entry may, indicated by a leading colon character
3848 also refer to the name of a terminal capability; several dozen names
3849 will be compiled in and may be specified either by their
3851 or, if existing, by their
3853 name, regardless of the actually used \*(OPal terminal control library.
3854 It is possible to use any capability, as long as the name is resolvable
3855 by the \*(OPal control library or was defined via the internal variable
3857 Input sequences are not case-normalized, so that an exact match is
3858 required to update or remove a binding.
3861 .Bd -literal -offset indent
3862 ? bind base $'\eE',d mle-snarf-word-fwd # Esc(ape)
3863 ? bind base $'\eE',$'\ec?' mle-snarf-word-bwd # Esc, Delete
3864 ? bind default $'\ecA',:khome,w 'echo An editable binding@'
3865 ? bind default a,b,c rm -irf / @ # Another editable binding
3866 ? bind default :kf1 File %
3867 ? bind compose :kf1 ~e
3871 Note that the entire comma-separated list is first parsed (over) as a
3872 shell-token with whitespace as the field separator, before being parsed
3873 and expanded for real with comma as the field separator, therefore
3874 whitespace needs to be properly quoted, see
3875 .Sx "Shell-style argument quoting" .
3876 Using Unicode reverse solidus escape sequences renders a binding
3877 defunctional if the locale does not support Unicode (see
3878 .Sx "Character sets" ) ,
3879 and using terminal capabilities does so if no (corresponding) terminal
3880 control support is (currently) available.
3883 The following terminal capability names are built-in and can be used in
3885 or (if available) the two-letter
3888 See the respective manual for a list of capabilities.
3891 can be used to show all the capabilities of
3893 or the given terminal type;
3896 flag will also show supported (non-standard) extensions.
3899 .Bl -tag -compact -width kcuuf_or_kcuuf
3900 .It Cd kbs Ns \0or Cd kb
3902 .It Cd kdch1 Ns \0or Cd kD
3904 .It Cd kDC Ns \0or Cd *4
3905 \(em shifted variant.
3906 .It Cd kel Ns \0or Cd kE
3907 Clear to end of line.
3908 .It Cd kext Ns \0or Cd @9
3910 .It Cd kich1 Ns \0or Cd kI
3912 .It Cd kIC Ns \0or Cd #3
3913 \(em shifted variant.
3914 .It Cd khome Ns \0or Cd kh
3916 .It Cd kHOM Ns \0or Cd #2
3917 \(em shifted variant.
3918 .It Cd kend Ns \0or Cd @7
3920 .It Cd knp Ns \0or Cd kN
3922 .It Cd kpp Ns \0or Cd kP
3924 .It Cd kcub1 Ns \0or Cd kl
3925 Left cursor (with more modifiers: see below).
3926 .It Cd kLFT Ns \0or Cd #4
3927 \(em shifted variant.
3928 .It Cd kcuf1 Ns \0or Cd kr
3929 Right cursor (ditto).
3930 .It Cd kRIT Ns \0or Cd %i
3931 \(em shifted variant.
3932 .It Cd kcud1 Ns \0or Cd kd
3933 Down cursor (ditto).
3935 \(em shifted variant (only terminfo).
3936 .It Cd kcuu1 Ns \0or Cd ku
3939 \(em shifted variant (only terminfo).
3940 .It Cd kf0 Ns \0or Cd k0
3942 Add one for each function key up to
3947 .It Cd kf10 Ns \0or Cd k;
3949 .It Cd kf11 Ns \0or Cd F1
3951 Add one for each function key up to
3959 Some terminals support key-modifier combination extensions, e.g.,
3961 For example, the delete key,
3963 in its shifted variant, the name is mutated to
3965 then a number is appended for the states
3977 .Ql Shift+Alt+Control
3979 The same for the left cursor key,
3981 .Cd KLFT , KLFT3 , KLFT4 , KLFT5 , KLFT6 , KLFT7 , KLFT8 .
3984 It is advisable to use an initial escape or other control character (e.g.,
3986 for bindings which describe user key combinations (as opposed to purely
3987 terminal capability based ones), in order to avoid ambiguities whether
3988 input belongs to key sequences or not; it also reduces search time.
3991 may help shall keys and sequences be falsely recognized.
3996 \*(NQ Calls the given macro, which must have been created via
4001 Parameters given to macros are implicitly local to the macro's scope, and
4002 may be accessed via special (positional) parameters, e.g.,
4007 The positional parameters may be removed by
4009 ing them off the stack (exceeding the supported number of arguments
4011 .Va ^ERR Ns -OVERFLOW ) ,
4012 and are otherwise controllable via
4017 .Sx "INTERNAL VARIABLES"
4018 can be reverted before the current level regains control by setting
4020 for called macro(s) (or in them, of course).
4021 Macro execution can be terminated at any time by calling
4025 Calling macros recursively will at some time excess the stack size
4026 limit, causing a hard program abortion; if recursively calling a macro
4027 is the last command of the current macro, consider to use the command
4029 which will first release all resources of the current macro before
4030 replacing the current macro with the called one.
4031 Numeric and string operations can be performed via
4035 may be helpful to recreate argument lists.
4037 .Bd -literal -offset indent
4039 echo Parameter 1 of ${#} is ${1}, all: ${*} / ${@}
4042 call exmac Hello macro exmac!
4046 Caveats: \*(UA parses entire input lines and decides on a per-command
4047 base what to do with the rest of the line, different to the
4049 ell, which implements a standardized (programming) language, and
4050 performs several successive transformation steps after decomposing the
4051 given command line into tokens adhering standardized syntax guidelines.
4052 E.g., in the following code snippets of otherwise identical meaning,
4053 a shell will see zero arguments, whereas \*(UA sees one, unless an
4054 additional expansion (via
4058 .Bd -literal -offset indent
4059 $ cat > t.sh << '___'; cat > t.rc << '___'
4071 $ sh t.sh; \*(uA -X'source t.rc' -Xx
4082 if the given macro has been created via
4084 but doesn't fail nor warn if the macro doesn't exist.
4088 (ch) Change the working directory to
4090 or the given argument.
4096 \*(OP Only applicable to S/MIME signed messages.
4097 Takes a message list and a filename and saves the certificates
4098 contained within the message signatures to the named file in both
4099 human-readable and PEM format.
4100 The certificates can later be used to send encrypted messages to the
4101 respective message senders by setting
4102 .Va smime-encrypt-USER@HOST
4107 .It Ic charsetalias , uncharsetalias
4108 \*(NQ Manage (character set conversion) character set alias mappings,
4109 as documented in the section
4110 .Sx "Character sets" .
4111 Character set aliases are expanded recursively, but no expansion is
4112 performed on values of the user-settable variables, e.g.,
4114 These are effectively no-operations if character set conversion
4115 is not available (i.e., no
4119 Without arguments the list of all currently defined aliases is shown,
4120 with one argument the expansion of the given alias.
4121 Otherwise all given arguments are treated as pairs of character sets and
4122 their desired target alias name, creating new or changing already
4123 existing aliases, as necessary.
4125 The latter deletes all aliases given as arguments, the special argument
4127 will remove all aliases.
4131 (ch) Change the working directory to
4133 or the given argument.
4139 .It Ic collapse , uncollapse
4140 Only applicable to threaded mode.
4141 Takes a message list and makes all replies to these messages invisible
4142 in header summaries, except for
4146 Also when a message with collapsed replies is displayed,
4147 all of these are automatically uncollapsed.
4148 The latter command undoes collapsing.
4153 .It Ic colour , uncolour
4154 \*(OP\*(NQ Manage colour mappings of and for a
4155 .Sx "Coloured display" .
4156 The type of colour is given as the (case-insensitive) first argument,
4157 which must be one of
4159 for 256-colour terminals,
4164 for the standard 8-colour ANSI / ISO 6429 color palette and
4168 for monochrome terminals.
4169 Monochrome terminals cannot deal with colours, but only (some) font
4173 Without further arguments the list of all currently defined mappings
4174 for the given colour type is shown (as a special case giving
4178 will show the mappings of all types).
4179 Otherwise the second argument defines the mappable slot, and the third
4180 argument a (comma-separated list of) colour and font attribute
4181 specification(s), and the optional fourth argument can be used to
4182 specify a precondition: if conditioned mappings exist they are tested in
4183 (creation) order unless a (case-insensitive) match has been found, and
4184 the default mapping (if any has been established) will only be chosen as
4186 The types of precondition available depend on the mappable slot (see
4187 .Sx "Coloured display"
4188 for some examples), the following of which exist:
4191 Mappings prefixed with
4193 are used for the \*(OPal built-in Mailx-Line-Editor (MLE, see
4194 .Sx "On terminal control and line editor" )
4195 and do not support preconditions.
4197 .Bl -tag -compact -width view-partinfo
4199 This mapping is used for the position indicator that is visible when
4200 a line cannot be fully displayed on the screen.
4207 Mappings prefixed with
4209 are used in header summaries, and they all understand the preconditions
4211 (the current message) and
4213 for elder messages (only honoured in conjunction with
4214 .Va datefield-markout-older ) .
4216 .Bl -tag -compact -width view-partinfo
4218 This mapping is used for the
4220 that can be created with the
4224 formats of the variable
4227 For the complete header summary line except the
4229 and the thread structure.
4231 For the thread structure which can be created with the
4233 format of the variable
4238 Mappings prefixed with
4240 are used when displaying messages.
4242 .Bl -tag -compact -width view-partinfo
4244 This mapping is used for so-called
4246 lines, which are MBOX file format specific header lines.
4249 A comma-separated list of headers to which the mapping applies may be
4250 given as a precondition; if the \*(OPal regular expression support is
4251 available then if any of the
4253 (extended) regular expression characters is seen the precondition will
4254 be evaluated as (an extended) one.
4256 For the introductional message info line.
4257 .It Ar view-partinfo
4258 For MIME part info lines.
4262 The following (case-insensitive) colour definitions and font attributes
4263 are understood, multiple of which can be specified in a comma-separated
4273 It is possible (and often applicable) to specify multiple font
4274 attributes for a single mapping.
4277 foreground colour attribute:
4287 To specify a 256-color mode a decimal number colour specification in
4288 the range 0 to 255, inclusive, is supported, and interpreted as follows:
4290 .Bl -tag -compact -width "999 - 999"
4292 the standard ISO 6429 colors, as above.
4294 high intensity variants of the standard colors.
4296 216 colors in tuples of 6.
4298 grayscale from black to white in 24 steps.
4300 .Bd -literal -offset indent
4302 fg() { printf "\e033[38;5;${1}m($1)"; }
4303 bg() { printf "\e033[48;5;${1}m($1)"; }
4305 while [ $i -lt 256 ]; do fg $i; i=$(($i + 1)); done
4306 printf "\e033[0m\en"
4308 while [ $i -lt 256 ]; do bg $i; i=$(($i + 1)); done
4309 printf "\e033[0m\en"
4313 background colour attribute (see
4315 for possible values).
4321 will remove for the given colour type (the special type
4323 selects all) the given mapping; if the optional precondition argument is
4324 given only the exact tuple of mapping and precondition is removed.
4327 will remove all mappings (no precondition allowed), thus
4329 will remove all established mappings.
4334 .It Ic commandalias , uncommandalias
4335 \*(NQ Define or list, and remove, respectively, command aliases.
4336 An (command)alias can be used everywhere a normal command can be used,
4337 but always takes precedence: any arguments that are given to the command
4338 alias are joined onto the alias expansion, and the resulting string
4339 forms the command line that is, in effect, executed.
4340 The latter command removes all given aliases, the special name
4342 will remove all existing aliases.
4343 When used without arguments the former shows a list of all currently
4344 known aliases, with one argument only the expansion of the given one.
4346 With two or more arguments a command alias is defined or updated: the
4347 first argument is the name under which the remaining command line should
4348 be accessible, the content of which can be just about anything.
4349 An alias may itself expand to another alias, but to avoid expansion loops
4350 further expansion will be prevented if an alias refers to itself or if
4351 an expansion depth limit is reached.
4352 Explicit expansion prevention is available via reverse solidus
4355 .Sx "Command modifiers" .
4356 .Bd -literal -offset indent
4358 \*(uA: `commandalias': no such alias: xx
4359 ? commandalias xx echo hello,
4361 commandalias xx 'echo hello,'
4370 (C) Copy messages to files whose names are derived from the author of
4371 the respective message and do not mark them as being saved;
4372 otherwise identical to
4377 (c) Copy messages to the named file and do not mark them as being saved;
4378 otherwise identical to
4383 Show the name of the current working directory, as reported by
4388 .Sx "Command modifiers" ) .
4389 The return status is tracked via
4394 \*(OP For unencrypted messages this command is identical to
4396 Encrypted messages are first decrypted, if possible, and then copied.
4400 \*(OP For unencrypted messages this command is identical to
4402 Encrypted messages are first decrypted, if possible, and then copied.
4406 .It Ic define , undefine
4407 Without arguments the current list of macros, including their content,
4408 is shown, otherwise a macro is defined, replacing an existing macro of
4410 A macro definition is a sequence of commands in the following form:
4411 .Bd -literal -offset indent
4420 A defined macro can be invoked explicitly by using the
4425 commands, or implicitly if a macro hook is triggered, e.g., a
4427 It is possible to localize adjustments, like creation, deletion and
4429 .Sx "INTERNAL VARIABLES" ,
4432 command; the scope which is localized depends on how (i.e.,
4434 normal macro, folder hook, hook,
4436 switch) the macro is invoked.
4437 Execution of a macro body can be stopped from within by calling
4441 ed macro, given positional parameters can be
4443 ed, or become completely replaced, removed etc. via
4446 The latter command deletes the given macro, the special name
4448 will discard all existing macros.
4449 Creation and deletion of (a) macro(s) can be performed from within
4454 .It Ic delete , undelete
4455 (d, u) Marks the given message list as being or not being
4457 respectively; if no argument has been specified then the usual search
4458 for a visible message is performed, as documented for
4459 .Sx "Message list arguments" ,
4460 showing only the next input prompt if the search fails.
4461 Deleted messages will neither be saved in the
4463 .Sx "secondary mailbox"
4465 nor will they be available for most other commands.
4468 variable is set, the new
4470 or the last message restored, respectively, is automatically
4480 Superseded by the multiplexer
4486 Delete the given messages and automatically
4490 if one exists, regardless of the setting of
4497 up or down by one message when given
4501 argument, respectively.
4505 .It Ic draft , undraft
4506 Take message lists and mark each given message as being draft, or not
4507 being draft, respectively, as documented in the section
4508 .Sx "Message states" .
4512 \*(NQ (ec) Echoes arguments to standard output and writes a trailing
4513 newline, whereas the otherwise identical
4516 .Sx "Shell-style argument quoting"
4518 .Sx "Filename transformations"
4519 are applied to the expanded arguments.
4525 except that is echoes to standard error.
4528 In interactive sessions the \*(OPal message ring queue for
4530 will be used instead, if available.
4536 but does not write a trailing newline.
4542 but does not write a trailing newline.
4546 (e) Point the text editor (as defined in
4548 at each message from the given list in turn.
4549 Modified contents are discarded unless the
4551 variable is set, and are not used unless the mailbox can be written to
4552 and the editor returns a successful exit status.
4557 .Ic if Ns \0/\: Ic elif Ns \0/\: Ic else Ns \0/\: Ic endif
4558 conditional \(em if the condition of a preceding
4560 was false, check the following condition and execute the following block
4561 if it evaluates true.
4566 .Ic if Ns \0/\: Ic elif Ns \0/\: Ic else Ns \0/\: Ic endif
4567 conditional \(em if none of the conditions of the preceding
4571 commands was true, the
4577 (en) Marks the end of an
4578 .Ic if Ns \0/\: Ic elif Ns \0/\: Ic else Ns \0/\: Ic endif
4579 conditional execution block.
4584 \*(NQ \*(UA has a strict notion about which variables are
4585 .Sx "INTERNAL VARIABLES"
4586 and which are managed in the program
4588 Since some of the latter are a vivid part of \*(UAs functioning,
4589 however, they are transparently integrated into the normal handling of
4590 internal variables via
4594 To integrate other environment variables of choice into this
4595 transparent handling, and also to export internal variables into the
4596 process environment where they normally are not, a
4598 needs to become established with this command, as in, e.g.,
4601 .Dl environ link PERL5LIB TZ
4604 Afterwards changing such variables with
4606 will cause automatic updates of the program environment, and therefore
4607 be inherited by newly created child processes.
4608 Sufficient system support provided (it was in BSD as early as 1987, and
4609 is standardized since Y2K) removing such variables with
4611 will remove them also from the program environment, but in any way
4612 the knowledge they ever have been
4615 Note that this implies that
4617 may cause loss of such links.
4622 will remove an existing link, but leaves the variables as such intact.
4623 Additionally the subcommands
4627 are provided, which work exactly the same as the documented commands
4631 but (additionally un)link the variable(s) with the program environment
4632 and thus immediately export them to, or remove them from (if possible),
4633 respectively, the program environment.
4638 \*(OP Since \*(UA uses the console as a user interface it can happen
4639 that messages scroll by too fast to become recognized.
4640 An error message ring queue is available which stores duplicates of any
4641 error message and notifies the user in interactive sessions whenever
4642 a new error has occurred.
4643 The queue is finite: if its maximum size is reached any new message
4644 replaces the eldest.
4647 can be used to manage this message queue: if given
4649 or no argument the queue will be displayed and cleared,
4651 will only clear all messages from the queue.
4655 \*(NQ Construct a command by concatenating the arguments, separated with
4656 a single space character, and then evaluate the result.
4657 This command passes through the exit status
4661 of the evaluated command; also see
4663 .Bd -literal -offset indent
4674 call yyy '\ecall xxx' "b\e$'\et'u ' "
4682 (ex or x) Exit from \*(UA without changing the active mailbox and skip
4683 any saving of messages in the
4685 .Sx "secondary mailbox"
4687 as well as a possibly tracked line editor
4689 The optional status number argument will be passed through to
4691 \*(ID For now it can happen that the given status will be overwritten,
4692 later this will only occur if a later error needs to be reported onto an
4693 otherwise success indicating status.
4699 but open the mailbox read-only.
4704 (fi) The file command switches to a new mailbox.
4705 Without arguments it shows status information of the current mailbox.
4706 If an argument is given, it will write out changes (such as deletions)
4707 the user has made, open a new mailbox, update the internal variables
4708 .Va mailbox-resolved
4710 .Va mailbox-display ,
4711 and optionally display a summary of
4718 .Sx "Filename transformations"
4719 will be applied to the
4723 prefixes are, i.e., URL syntax is understood, e.g.,
4724 .Ql maildir:///tmp/mdirbox :
4725 if a protocol prefix is used the mailbox type is fixated and neither
4726 the auto-detection (read on) nor the
4729 \*(OPally URLs can also be used to access network resources, and it is
4730 possible to proxy all network traffic over a SOCKS5 server given via
4734 .Dl \*(IN protocol://[user[:password]@]host[:port][/path]
4735 .Dl \*(OU protocol://[user@]host[:port][/path]
4738 \*(OPally supported network protocols are
4742 (POP3 with SSL/TLS encrypted transport),
4748 part is valid only for IMAP; there it defaults to
4750 Network URLs require a special encoding as documented in the section
4751 .Sx "On URL syntax and credential lookup" .
4754 If the resulting file protocol (MBOX database)
4756 is located on a local filesystem then the list of all registered
4758 s is traversed in order to see whether a transparent intermediate
4759 conversion step is necessary to handle the given mailbox, in which case
4760 \*(UA will use the found hook to load and save data into and from
4761 a temporary file, respectively.
4762 Changing hooks will not affect already opened mailboxes.
4763 For example, the following creates hooks for the
4765 compression tool and a combined compressed and encrypted format:
4767 .Bd -literal -offset indent
4769 gzip 'gzip -dc' 'gzip -c' \e
4770 zst.pgp 'gpg -d | zstd -dc' 'zstd -19 -zc | gpg -e'
4774 MBOX database files are generally locked during file operations in order
4775 to avoid inconsistencies due to concurrent modifications.
4776 \*(OPal Mailbox files which \*(UA treats as the system
4781 .Sx "primary system mailbox" Ns
4782 es in general will also be protected by so-called dotlock files, the
4783 traditional way of mail spool file locking: for any file
4787 will be created for the duration of the synchronization \(em
4788 as necessary a privilege-separated dotlock child process will be used
4789 to accommodate for necessary privilege adjustments in order to create
4790 the dotlock file in the same directory
4791 and with the same user and group identities as the file of interest.
4794 \*(UA by default uses tolerant POSIX rules when reading MBOX database
4795 files, but it will detect invalid message boundaries in this mode and
4796 complain (even more with
4798 if any is seen: in this case
4800 can be used to create a valid MBOX database from the invalid input.
4803 If no protocol has been fixated, and
4805 refers to a directory with the subdirectories
4810 then it is treated as a folder in
4813 The maildir format stores each message in its own file, and has been
4814 designed so that file locking is not necessary when reading or writing
4818 \*(ID If no protocol has been fixated and no existing file has
4819 been found, the variable
4821 controls the format of mailboxes yet to be created.
4826 .It Ic filetype , unfiletype
4827 \*(NQ Define or list, and remove, respectively, file handler hooks,
4828 which provide (shell) commands that enable \*(UA to load and save MBOX
4829 files from and to files with the registered file extensions;
4830 it will use an intermediate temporary file to store the plain data.
4831 The latter command removes the hooks for all given extensions,
4833 will remove all existing handlers.
4835 When used without arguments the former shows a list of all currently
4836 defined file hooks, with one argument the expansion of the given alias.
4837 Otherwise three arguments are expected, the first specifying the file
4838 extension for which the hook is meant, and the second and third defining
4839 the load- and save commands, respectively, to deal with the file type,
4840 both of which must read from standard input and write to standard
4842 Changing hooks will not affect already opened mailboxes (\*(ID except below).
4843 \*(ID For now too much work is done, and files are oftened read in twice
4844 where once would be sufficient: this can cause problems if a filetype is
4845 changed while such a file is opened; this was already so with the
4846 built-in support of .gz etc. in Heirloom, and will vanish in v15.
4847 \*(ID For now all handler strings are passed to the
4848 .Ev SHELL for evaluation purposes; in the future a
4850 prefix to load and save commands may mean to bypass this shell instance:
4851 placing a leading space will avoid any possible misinterpretations.
4852 .Bd -literal -offset indent
4853 ? filetype bz2 'bzip2 -dc' 'bzip2 -zc' \e
4854 gz 'gzip -dc' 'gzip -c' xz 'xz -dc' 'xz -zc' \e
4855 zst 'zstd -dc' 'zstd -19 -zc' \e
4856 zst.pgp 'gpg -d | zstd -dc' 'zstd -19 -zc | gpg -e'
4857 ? set record=+sent.zst.pgp
4862 .It Ic flag , unflag
4863 Take message lists and mark the messages as being flagged, or not being
4864 flagged, respectively, for urgent/special attention.
4866 .Sx "Message states" .
4875 With no arguments, list the names of the folders in the folder directory.
4876 With an existing folder as an argument,
4877 lists the names of folders below the named folder.
4883 but saves the message in a file named after the local part of the first
4884 recipient's address (instead of in
4891 but saves the message in a file named after the local part of the first
4892 recipient's address (instead of in
4899 but responds to all recipients regardless of the
4904 .It Ic followupsender
4907 but responds to the sender only regardless of the
4915 but saves the message in a file named after the local part of the
4916 recipient's address (instead of in
4921 Takes a message and the address of a recipient
4922 and forwards the message to him.
4923 The text of the original message is included in the new one,
4924 with the value of the
4925 .Va forward-inject-head
4926 variable preceding it.
4927 To filter the included header fields to the desired subset use the
4929 slot of the white- and blacklisting command
4931 Only the first part of a multipart message is included unless
4932 .Va forward-as-attachment ,
4933 and recipient addresses will be stripped from comments, names etc.
4934 unless the internal variable
4940 (f) Takes a list of message specifications and displays a summary of
4941 their message headers, exactly as via
4943 An alias of this command is
4946 .Sx "Specifying messages" .
4957 \*(OB Superseded by the multiplexer
4961 \*(OB Superseded by the multiplexer
4964 .It Ic ghost , unghost
4967 .Ic uncommandalias .
4971 .It Ic headerpick , unheaderpick
4972 \*(NQ Multiplexer command to manage white- and blacklisting
4973 selections of header fields for a variety of applications.
4974 Without arguments the set of contexts that have settings is displayed.
4975 When given arguments, the first argument is the context to which the
4976 command applies, one of (case-insensitive)
4978 for display purposes (via, e.g.,
4981 for selecting which headers shall be stored persistently when
4987 ing messages (note that MIME related etc. header fields should not be
4988 ignored in order to not destroy usability of the message in this case),
4990 for stripping down messages when
4992 ing message (has no effect if
4993 .Va forward-as-attachment
4996 for defining user-defined set of fields for the command
4999 The current settings of the given context are displayed if it is the
5001 A second argument denotes the type of restriction that is to be chosen,
5002 it may be (a case-insensitive prefix of)
5006 for white- and blacklisting purposes, respectively.
5007 Establishing a whitelist suppresses inspection of the corresponding
5010 If no further argument is given the current settings of the given type
5011 will be displayed, otherwise the remaining arguments specify header
5012 fields, which \*(OPally may be given as regular expressions, to be added
5014 The special wildcard field (asterisk,
5016 will establish a (fast) shorthand setting which covers all fields.
5018 The latter command always takes three or more arguments and can be used
5019 to remove selections, i.e., from the given context, the given type of
5020 list, all the given headers will be removed, the special argument
5022 will remove all headers.
5026 (h) Show the current group of headers, the size of which depends on
5029 and the style of which can be adjusted with the variable
5031 If a message-specification is given the group of headers containing the
5032 first message therein is shown and the message at the top of the screen
5045 (this mode also supports a more
5049 the list of history entries;
5052 argument selects and evaluates the respective history entry,
5053 which will become the new history top; a negative number is used as an
5054 offset to the current command, e.g.,
5056 will select the last command, the history top.
5057 The default mode if no arguments are given is
5060 .Sx "On terminal control and line editor"
5061 for more on this topic.
5067 Takes a message list and marks each message therein to be saved in the
5072 .Sx "secondary mailbox"
5074 Does not override the
5077 \*(UA deviates from the POSIX standard with this command, because a
5079 command issued after
5081 will display the following message, not the current one.
5086 (i) Part of the nestable
5087 .Ic if Ns \0/\: Ic elif Ns \0/\: Ic else Ns \0/\: Ic endif
5088 conditional execution construct \(em if the given condition is true then
5089 the encapsulated block is executed.
5090 The POSIX standards supports the (case-insensitive) conditions
5095 end, all remaining conditions are non-portable extensions.
5096 \*(ID These commands do not yet use
5097 .Sx "Shell-style argument quoting"
5098 and therefore do not know about input tokens, so that syntax
5099 elements have to be surrounded by whitespace; in v15 \*(UA will inspect
5100 all conditions bracket group wise and consider the tokens, representing
5101 values and operators, therein, which also means that variables will
5102 already have been expanded at that time (just like in the shell).
5104 .Bd -literal -offset indent
5113 The (case-insensitive) condition
5115 erminal will evaluate to true if the standard input is a terminal, i.e.,
5116 in interactive sessions.
5117 Another condition can be any boolean value (see the section
5118 .Sx "INTERNAL VARIABLES"
5119 for textual boolean representations) to mark an enwrapped block as
5122 .Dq always execute .
5123 (It shall be remarked that a faulty condition skips all branches until
5128 .Sx "Shell-style argument quoting"
5129 will be used, and this command will simply interpret expanded tokens.)
5130 It is possible to check
5131 .Sx "INTERNAL VARIABLES"
5134 variables for existence or compare their expansion against a user given
5135 value or another variable by using the
5137 .Pf ( Dq variable next )
5138 conditional trigger character;
5139 a variable on the right hand side may be signalled using the same
5141 Variable names may be enclosed in a pair of matching braces.
5142 When this mode has been triggered, several operators are available:
5145 Integer operators treat the arguments on the left and right hand side of
5146 the operator as integral numbers and compare them arithmetically.
5147 It is an error if any of the operands is not a valid integer, an empty
5148 argument (which implies it had been quoted) is treated as if it were 0.
5149 Available operators are
5153 (less than or equal to),
5159 (greater than or equal to), and
5164 String data operators compare the left and right hand side according to
5165 their textual content.
5166 Unset variables are treated as the empty string.
5167 The behaviour of string operators can be adjusted by prefixing the
5168 operator with the modifier trigger commercial at
5170 followed by none to multiple modifiers: for now supported is
5172 which turns the comparison into a case-insensitive one: this is
5173 implied if no modifier follows the trigger.
5176 Available string operators are
5180 (less than or equal to),
5186 (greater than or equal to),
5190 (is substring of) and
5192 (is not substring of).
5193 By default these operators work on bytes and (therefore) do not take
5194 into account character set specifics.
5195 If the case-insensitivity modifier has been used, case is ignored
5196 according to the rules of the US-ASCII encoding, i.e., bytes are
5200 When the \*(OPal regular expression support is available, the additional
5206 They treat the right hand side as an extended regular expression that is
5207 matched according to the active locale (see
5208 .Sx "Character sets" ) ,
5209 i.e., character sets should be honoured correctly.
5212 Conditions can be joined via AND-OR lists (where the AND operator is
5214 and the OR operator is
5216 which have equal precedence and will be evaluated with left
5217 associativity, thus using the same syntax that is known for the
5219 It is also possible to form groups of conditions and lists by enclosing
5220 them in pairs of brackets
5221 .Ql [\ \&.\&.\&.\ ] ,
5222 which may be interlocked within each other, and also be joined via
5226 The results of individual conditions and entire groups may be modified
5227 via unary operators: the unary operator
5229 will reverse the result.
5231 .Bd -literal -offset indent
5232 # (This not in v15, there [ -n "$debug"]!)
5236 if [ "$ttycharset" == UTF-8 ] || [ "$ttycharset" @i== UTF8 ]
5237 echo *ttycharset* is UTF-8, the former case-sensitive!
5240 if [ "${t1}" == "${t2}" ]
5241 echo These two variables are equal
5243 if [ "$features" =% +regex ] && [ "$TERM" @i=~ "^xterm\&.*" ]
5244 echo ..in an X terminal
5246 if [ [ true ] && [ [ "${debug}" != '' ] || \e
5247 [ "$verbose" != '' ] ] ]
5250 if true && [ "$debug" != '' ] || [ "${verbose}" != '' ]
5251 echo Left associativity, as is known from the shell
5260 Superseded by the multiplexer
5265 Shows the names of all available commands, alphabetically sorted.
5266 If given any non-whitespace argument the list will be shown in the order
5267 in which command prefixes are searched.
5268 \*(OP In conjunction with a set variable
5270 additional information will be provided for each command: the argument
5271 type will be indicated, the documentation string will be shown,
5272 and the set of command flags will show up:
5274 .Bl -tag -compact -width ".It Ql BaNg"
5275 .It Ql "vput modifier"
5276 command supports the command modifier
5278 .It Ql "errno in *!*"
5279 the error number is tracked in
5282 commands needs an active mailbox, a
5284 .It Ql "ok: batch or interactive"
5285 command may only be used in interactive or
5288 .It Ql "ok: send mode"
5289 command can be used in send mode.
5290 .It Ql "not ok: compose mode"
5291 command is not available when in compose mode.
5292 .It Ql "not ok: during startup"
5293 command cannot be used during program startup, e.g., while loading
5294 .Sx "Resource files" .
5295 .It Ql "ok: in subprocess"
5296 command is allowed to be used when running in a subprocess instance,
5297 e.g., from within a macro that is called via
5298 .Va on-compose-splice .
5304 This command can be used to localize changes to (linked)
5307 .Sx "INTERNAL VARIABLES" ,
5308 meaning that their state will be reverted to the former one once the
5311 It can only be used inside of macro definition blocks introduced by
5315 The covered scope of an
5317 is left once a different account is activated, and some macros, notably
5318 .Va folder-hook Ns s ,
5319 use their own specific notion of covered scope, here it will be extended
5320 until the folder is left again.
5323 This setting stacks up: i.e., if
5325 enables change localization and calls
5327 which explicitly resets localization, then any value changes within
5329 will still be reverted when the scope of
5332 (Caveats: if in this example
5334 changes to a different
5336 which sets some variables that are already covered by localizations,
5337 their scope will be extended, and in fact leaving the
5339 will (thus) restore settings in (likely) global scope which actually
5340 were defined in a local, macro private context!)
5343 This command takes one or two arguments, the optional first one
5344 specifies an attribute that may be one of
5346 which refers to the current scope and is thus the default,
5348 which causes any macro that is being
5350 ed to be started with localization enabled by default, as well as
5352 which (if enabled) disallows any called macro to turn off localization:
5353 like this it can be ensured that once the current scope regains control,
5354 any changes made in deeper levels have been reverted.
5355 The latter two are mutually exclusive.
5356 The (second) argument is interpreted as a boolean (string, see
5357 .Sx "INTERNAL VARIABLES" )
5358 and states whether the given attribute shall be turned on or off.
5360 .Bd -literal -offset indent
5361 define temporary_settings {
5362 set possibly_global_option1
5367 set possibly_global_option2
5374 Reply to messages that come in via known
5377 .Pf ( Ic mlsubscribe )
5378 mailing lists, or pretend to do so (see
5379 .Sx "Mailing lists" ) :
5382 functionality this will actively resort and even remove message
5383 recipients in order to generate a message that is supposed to be sent to
5385 For example it will also implicitly generate a
5386 .Ql Mail-Followup-To:
5387 header if that seems useful, regardless of the setting of the variable
5389 For more documentation please refer to
5390 .Sx "On sending mail, and non-interactive mode" .
5396 but saves the message in a file named after the local part of the first
5397 recipient's address (instead of in
5402 (m) Takes a (list of) recipient address(es) as (an) argument(s),
5403 or asks on standard input if none were given;
5404 then collects the remaining mail content and sends it out.
5405 For more documentation please refer to
5406 .Sx "On sending mail, and non-interactive mode" .
5410 (mb) The given message list is to be sent to the
5412 .Sx "secondary mailbox"
5414 when \*(UA is quit; this is the default action unless the variable
5417 \*(ID This command can only be used in a
5419 .Sx "primary system mailbox" .
5423 .It Ic mimetype , unmimetype
5424 Without arguments the content of the MIME type cache will displayed;
5425 a more verbose listing will be produced if either of
5430 When given arguments they will be joined, interpreted as shown in
5431 .Sx "The mime.types files"
5433 .Sx "HTML mail and MIME attachments" ) ,
5434 and the resulting entry will be added (prepended) to the cache.
5435 In any event MIME type sources are loaded first as necessary \(en
5436 .Va mimetypes-load-control
5437 can be used to fine-tune which sources are actually loaded.
5439 The latter command deletes all specifications of the given MIME type, thus
5440 .Ql ? unmimetype text/plain
5441 will remove all registered specifications for the MIME type
5445 will discard all existing MIME types, just as will
5447 but which also reenables cache initialization via
5448 .Va mimetypes-load-control .
5452 .It Ic mlist , unmlist
5453 The latter command removes all given mailing-lists, the special name
5455 can be used to remove all registered lists.
5456 The former will list all currently defined mailing lists (and their
5457 attributes, if any) when used without arguments; a more verbose listing
5458 will be produced if either of
5463 Otherwise all given arguments will be added and henceforth be recognized
5465 If the \*(OPal regular expression support is available then mailing
5466 lists may also be specified as (extended) regular expressions (see
5472 \*(ID Only available in interactive mode, this command allows to display
5473 MIME parts which require external MIME handler programs to run which do
5474 not integrate in \*(UAs normal
5477 .Sx "HTML mail and MIME attachments" ) .
5478 (\*(ID No syntax to directly address parts, this restriction may vanish.)
5479 The user will be asked for each non-text part of the given message in
5480 turn whether the registered handler shall be used to display the part.
5484 .It Ic mlsubscribe , unmlsubscribe
5485 The latter command removes the subscription attribute from all given
5486 mailing-lists, the special name
5488 can be used to do so for any registered list.
5489 The former will list all currently defined mailing lists which have
5490 a subscription attribute when used without arguments; a more verbose
5491 listing will be produced if either of
5496 Otherwise this attribute will be set for all given mailing lists,
5497 newly creating them as necessary (as via
5506 but moves the messages to a file named after the local part of the
5507 sender address of the first message (instead of in
5514 but marks the messages for deletion if they were transferred
5521 but also displays header fields which would not pass the
5523 selection, and all MIME parts.
5531 on the given messages, even in non-interactive mode and as long as the
5532 standard output is a terminal.
5538 \*(OP When used without arguments or if
5540 has been given the content of the
5542 cache is shown, loading it first as necessary.
5545 then the cache will only be initialized and
5547 will remove its contents.
5548 Note that \*(UA will try to load the file only once, use
5549 .Ql Ic \&\&netrc Ns \:\0\:clear
5550 to unlock further attempts.
5555 .Sx "On URL syntax and credential lookup" ;
5557 .Sx "The .netrc file"
5558 documents the file format in detail.
5562 Checks for new mail in the current folder without committing any changes
5564 If new mail is present, a message is shown.
5568 the headers of each new message are also shown.
5569 This command is not available for all mailbox types.
5577 Goes to the next message in sequence and types it.
5578 With an argument list, types the next matching message.
5592 If the current folder is accessed via a network connection, a
5594 command is sent, otherwise no operation is performed.
5600 but also displays header fields which would not pass the
5602 selection, and all MIME parts.
5610 on the given messages, even in non-interactive mode and as long as the
5611 standard output is a terminal.
5619 but also pipes header fields which would not pass the
5621 selection, and all parts of MIME
5622 .Ql multipart/alternative
5627 (pi) Takes a message list and a shell command
5628 and pipes the messages through the command.
5629 Without an argument the current message is piped through the command
5636 every message is followed by a formfeed character.
5657 (q) Terminates the session, saving all undeleted, unsaved messages in
5660 .Sx "secondary mailbox"
5662 preserving all messages marked with
5666 or never referenced in the system
5668 and removing all other messages from the
5670 .Sx "primary system mailbox" .
5671 If new mail has arrived during the session,
5673 .Dq You have new mail
5675 If given while editing a mailbox file with the command line option
5677 then the edit file is rewritten.
5678 A return to the shell is effected,
5679 unless the rewrite of edit file fails,
5680 in which case the user can escape with the exit command.
5681 The optional status number argument will be passed through to
5683 \*(ID For now it can happen that the given status will be overwritten,
5684 later this will only occur if a later error needs to be reported onto an
5685 otherwise success indicating status.
5689 \*(NQ Read a line from standard input, or the channel set active via
5691 and assign the data, which will be splitted as indicated by
5693 to the given variables.
5694 The variable names are checked by the same rules as documented for
5696 and the same error codes will be seen in
5700 indicates the number of bytes read, it will be
5702 with the error number
5706 in case of I/O errors, or
5709 If there are more fields than variables, assigns successive fields to the
5710 last given variable.
5711 If there are less fields than variables, assigns the empty string to the
5713 .Bd -literal -offset indent
5716 ? echo "<$a> <$b> <$c>"
5718 ? wysh set ifs=:; read a b c;unset ifs
5719 hey2.0,:"'you ",:world!:mars.:
5720 ? echo $?/$^ERRNAME / <$a><$b><$c>
5721 0/NONE / <hey2.0,><"'you ",><world!:mars.:><><>
5726 \*(NQ Manages input channels for
5728 to be used to avoid complicated or impracticable code, like calling
5730 from within a macro in non-interactive mode.
5731 Without arguments, or when the first argument is
5733 a listing of all known channels is printed.
5734 Channels can otherwise be
5736 d, and existing channels can be
5740 d by giving the string used for creation.
5742 The channel name is expected to be a file descriptor number, or,
5743 if parsing the numeric fails, an input file name that undergoes
5744 .Sx "Filename transformations" .
5745 E.g. (this example requires a modern shell):
5746 .Bd -literal -offset indent
5747 $ LC_ALL=C printf 'echon "hey, "\enread a\enyou\enecho $a' |\e
5750 $ LC_ALL=C printf 'echon "hey, "\enread a\enecho $a' |\e
5751 LC_ALL=C 6<<< 'you' \*(uA -R#X'readctl create 6'
5765 Removes the named files or directories.
5766 If a name refer to a mailbox, e.g., a Maildir mailbox, then a mailbox
5767 type specific removal will be performed, deleting the complete mailbox.
5768 The user is asked for confirmation in interactive mode.
5772 Takes the name of an existing folder
5773 and the name for the new folder
5774 and renames the first to the second one.
5775 Both folders must be of the same type.
5779 (R) Replies to only the sender of each message of the given message
5780 list, by using the first message as the template to quote, for the
5784 will exchange this command with
5786 Unless the internal variable
5788 is set the recipient address will be stripped from comments, names etc.
5792 (r) Take a message and group-responds to it by addressing the sender
5793 and all recipients, subject to
5797 .Va followup-to-honour ,
5800 .Va recipients-in-cc
5801 influence response behaviour.
5802 Unless the internal variable
5804 is set recipient addresses will be stripped from comments, names etc.
5814 offers special support for replying to mailing lists.
5815 For more documentation please refer to
5816 .Sx "On sending mail, and non-interactive mode" .
5822 but initiates a group-reply regardless of the value of
5829 but responds to the sender only regardless of the value of
5836 but does not add any header lines.
5837 This is not a way to hide the sender's identity,
5838 but useful for sending a message again to the same recipients.
5842 Takes a list of messages and a user name
5843 and sends each message to the named user.
5845 and related header fields are prepended to the new copy of the message.
5848 is only performed if
5868 .It Ic respondsender
5874 (ret) Superseded by the multiplexer
5879 Only available inside the scope of a
5883 this will stop evaluation of any further macro content, and return
5884 execution control to the caller.
5885 The two optional parameters must be specified as positive decimal
5886 numbers and default to the value 0:
5887 the first argument specifies the signed 32-bit return value (stored in
5889 \*(ID and later extended to signed 64-bit),
5890 the second the signed 32-bit error number (stored in
5894 a non-0 exit status may cause the program to exit.
5900 but saves the messages in a file named after the local part of the
5901 sender of the first message instead of (in
5903 and) taking a filename argument; the variable
5905 is inspected to decide on the actual storage location.
5909 (s) Takes a message list and a filename and appends each message in turn
5910 to the end of the file.
5911 If no filename is given, the
5913 .Sx "secondary mailbox"
5916 The filename in quotes, followed by the generated character count
5917 is echoed on the user's terminal.
5920 .Sx "primary system mailbox"
5921 the messages are marked for deletion.
5922 .Sx "Filename transformations"
5926 \*(OB Superseded by the multiplexer
5930 \*(OB Superseded by the multiplexer
5934 \*(OB Superseded by the multiplexer
5939 Takes a message specification (list) and displays a header summary of
5940 all matching messages, as via
5942 This command is an alias of
5945 .Sx "Specifying messages" .
5949 Takes a message list and marks all messages as having been read.
5955 (se, \*(NQ uns) The latter command will delete all given variables,
5956 the former, when used without arguments, will show all variables which
5957 are currently known to \*(UA.
5958 A more verbose listing will be produced if
5964 Remarks: the list mode will not automatically link-in known
5966 variables, but only explicit addressing will, e.g., via
5968 using a variable in an
5970 condition or a string passed to
5974 ting, as well as some program-internal use cases.
5977 Otherwise the given variables (and arguments) are set or adjusted.
5978 Arguments are of the form
5980 (no space before or after
5984 if there is no value, i.e., a boolean variable.
5985 \*(ID In conjunction with the
5988 .Sx "Shell-style argument quoting"
5989 can be used to quote arguments as necessary.
5990 \*(ID Otherwise quotation marks may be placed around any part of the
5991 assignment statement to quote blanks or tabs.
5994 .Dl ? wysh set indentprefix=' -> '
5997 If an argument begins with
6001 the effect is the same as invoking the
6003 command with the remaining part of the variable
6004 .Pf ( Ql unset save ) .
6009 that is known to map to an environment variable will automatically cause
6010 updates in the program environment (unsetting a variable in the
6011 environment requires corresponding system support) \(em use the command
6013 for further environmental control.
6018 .Sx "INTERNAL VARIABLES"
6025 Apply shell quoting rules to the given raw-data arguments.
6029 .Sx "Command modifiers" ) .
6030 The first argument specifies the operation:
6034 cause shell quoting to be applied to the remains of the line, and
6035 expanded away thereof, respectively.
6036 If the former is prefixed with a plus-sign, the quoted result will not
6037 be roundtrip enabled, and thus can be decoded only in the very same
6038 environment that was used to perform the encode; also see
6039 .Cd mle-quote-rndtrip .
6040 If the coding operation fails the error number
6043 .Va ^ERR Ns -CANCELED ,
6044 and the unmodified input is used as the result; the error number may
6045 change again due to output or result storage errors.
6049 \*(NQ (sh) Invokes an interactive version of the shell,
6050 and returns its exit status.
6054 .It Ic shortcut , unshortcut
6055 Without arguments the list of all currently defined shortcuts is
6056 shown, with one argument the expansion of the given shortcut.
6057 Otherwise all given arguments are treated as pairs of shortcuts and
6058 their expansions, creating new or changing already existing shortcuts,
6060 The latter command will remove all given shortcuts, the special name
6062 will remove all registered shortcuts.
6066 \*(NQ Shift the positional parameter stack (starting at
6068 by the given number (which must be a positive decimal),
6069 or 1 if no argument has been given.
6070 It is an error if the value exceeds the number of positional parameters.
6071 If the given number is 0, no action is performed, successfully.
6072 The stack as such can be managed via
6074 Note this command will fail in
6076 and hook macros unless the positional parameter stack has been
6077 explicitly created in the current context via
6084 but performs neither MIME decoding nor decryption, so that the raw
6085 message text is shown.
6089 (si) Shows the size in characters of each message of the given
6094 \*(NQ Sleep for the specified number of seconds (and optionally
6095 milliseconds), by default interruptably.
6096 If a third argument is given the sleep will be uninterruptible,
6097 otherwise the error number
6101 if the sleep has been interrupted.
6102 The command will fail and the error number will be
6103 .Va ^ERR Ns -OVERFLOW
6104 if the given duration(s) overflow the time datatype, and
6106 if the given durations are no valid integers.
6111 .It Ic sort , unsort
6112 The latter command disables sorted or threaded mode, returns to normal
6113 message order and, if the
6116 displays a header summary.
6117 The former command shows the current sorting criterion when used without
6118 an argument, but creates a sorted representation of the current folder
6119 otherwise, and changes the
6121 command and the addressing modes such that they refer to messages in
6123 Message numbers are the same as in regular mode.
6127 a header summary in the new order is also displayed.
6128 Automatic folder sorting can be enabled by setting the
6130 variable, as in, e.g.,
6131 .Ql set autosort=thread .
6132 Possible sorting criterions are:
6135 .Bl -tag -compact -width "subject"
6137 Sort the messages by their
6139 field, that is by the time they were sent.
6141 Sort messages by the value of their
6143 field, that is by the address of the sender.
6146 variable is set, the sender's real name (if any) is used.
6148 Sort the messages by their size.
6150 \*(OP Sort the message by their spam score, as has been classified by
6153 Sort the messages by their message status.
6155 Sort the messages by their subject.
6157 Create a threaded display.
6159 Sort messages by the value of their
6161 field, that is by the address of the recipient.
6164 variable is set, the recipient's real name (if any) is used.
6170 \*(NQ (so) The source command reads commands from the given file.
6171 .Sx "Filename transformations"
6173 If the given expanded argument ends with a vertical bar
6175 then the argument will instead be interpreted as a shell command and
6176 \*(UA will read the output generated by it.
6177 Interpretation of commands read is stopped when an error is encountered.
6180 cannot be used from within macros that execute as
6181 .Va folder-hook Ns s
6184 i.e., it can only be called from macros that were
6189 \*(NQ The difference to
6191 (beside not supporting pipe syntax aka shell command input) is that
6192 this command will not generate an error nor warn if the given file
6193 argument cannot be opened successfully.
6197 \*(OP Takes a list of messages and clears their
6203 \*(OP Takes a list of messages and causes the
6205 to forget it has ever used them to train its Bayesian filter.
6206 Unless otherwise noted the
6208 flag of the message is inspected to chose whether a message shall be
6216 \*(OP Takes a list of messages and informs the Bayesian filter of the
6220 This also clears the
6222 flag of the messages in question.
6226 \*(OP Takes a list of messages and rates them using the configured
6227 .Va spam-interface ,
6228 without modifying the messages, but setting their
6230 flag as appropriate; because the spam rating headers are lost the rate
6231 will be forgotten once the mailbox is left.
6232 Refer to the manual section
6234 for the complete picture of spam handling in \*(UA.
6238 \*(OP Takes a list of messages and sets their
6244 \*(OP Takes a list of messages and informs the Bayesian filter of the
6250 flag of the messages in question.
6266 slot for white- and blacklisting header fields.
6270 (to) Takes a message list and types out the first
6272 lines of each message on the users' terminal.
6273 Unless a special selection has been established for the
6277 command, the only header fields that are displayed are
6288 It is possible to apply compression to what is displayed by setting
6290 Messages are decrypted and converted to the terminal character set
6295 (tou) Takes a message list and marks the messages for saving in the
6297 .Sx "secondary mailbox"
6299 \*(UA deviates from the POSIX standard with this command,
6302 command will display the following message instead of the current one.
6308 but also displays header fields which would not pass the
6310 selection, and all visualizable parts of MIME
6311 .Ql multipart/alternative
6316 (t) Takes a message list and types out each message on the users terminal.
6317 The display of message headers is selectable via
6319 For MIME multipart messages, all parts with a content type of
6321 all parts which have a registered MIME type handler (see
6322 .Sx "HTML mail and MIME attachments" )
6323 which produces plain text output, and all
6325 parts are shown, others are hidden except for their headers.
6326 Messages are decrypted and converted to the terminal character set
6330 can be used to display parts which are not displayable as plain text.
6373 \*(OB Superseded by the multiplexer
6377 \*(OB Superseded by the multiplexer
6382 Superseded by the multiplexer
6393 .It Ic unmlsubscribe
6404 Takes a message list and marks each message as not having been read.
6408 Superseded by the multiplexer
6412 \*(OB Superseded by the multiplexer
6416 \*(OB Superseded by the multiplexer
6438 Perform URL percent codec operations on the raw-data argument, rather
6439 according to RFC 3986.
6443 .Sx "Command modifiers" ) ,
6444 and manages the error number
6446 This is a character set agnostic and thus locale dependent operation,
6447 and it may decode bytes which are invalid in the current
6449 \*(ID This command does not know about URLs beside that.
6451 The first argument specifies the operation:
6455 perform plain URL percent en- and decoding, respectively.
6459 perform a slightly modified operation which should be better for
6460 pathnames: it does not allow a tilde
6462 and will neither accept hyphen-minus
6466 as an initial character.
6467 The remains of the line form the URL data which is to be converted.
6468 If the coding operation fails the error number
6471 .Va ^ERR Ns -CANCELED ,
6472 and the unmodified input is used as the result; the error number may
6473 change again due to output or result storage errors.
6477 \*(NQ Edit the values of or create the given variable(s) in the
6479 Boolean variables cannot be edited, and variables can also not be
6485 \*(NQ This command produces the same output as the listing mode of
6489 ity adjustments, but only for the given variables.
6493 \*(OP Takes a message list and verifies each message.
6494 If a message is not a S/MIME signed message,
6495 verification will fail for it.
6496 The verification process checks if the message was signed using a valid
6498 if the message sender's email address matches one of those contained
6499 within the certificate,
6500 and if the message content has been altered.
6513 \*(NQ Evaluate arguments according to a given operator.
6514 This is a multiplexer command which can be used to perform signed 64-bit
6515 numeric calculations as well as byte string and string operations.
6516 It uses polish notation, i.e., the operator is the first argument and
6517 defines the number and type, and the meaning of the remaining arguments.
6518 An empty argument is replaced with a 0 if a number is expected.
6522 .Sx "Command modifiers" ) .
6525 The result that is shown in case of errors is always
6527 for usage errors and numeric operations, and the empty string for byte
6528 string and string operations;
6529 if the latter two fail to provide result data for
6531 errors, e.g., when a search operation failed, they also set the
6534 .Va ^ERR Ns -NODATA .
6535 Except when otherwise noted numeric arguments are parsed as signed 64-bit
6536 numbers, and errors will be reported in the error number
6538 as the numeric error
6539 .Va ^ERR Ns -RANGE .
6542 Numeric operations work on one or two signed 64-bit integers.
6543 One integer is expected by assignment (equals sign
6545 which does nothing but parsing the argument, thus detecting validity and
6546 possible overflow conditions, and unary not (tilde
6548 which creates the bitwise complement.
6549 Two integers are used by addition (plus sign
6551 subtraction (hyphen-minus
6553 multiplication (asterisk
6557 and modulo (percent sign
6559 as well as for the bitwise operators logical or (vertical bar
6562 bitwise and (ampersand
6565 bitwise xor (circumflex
6567 the bitwise signed left- and right shifts
6570 as well as for the unsigned right shift
6574 All numeric operators can be suffixed with a commercial at
6578 this will turn the operation into a saturated one, which means that
6579 overflow errors and division and modulo by zero are no longer reported
6580 via the exit status, but the result will linger at the minimum or
6581 maximum possible value, instead of overflowing (or trapping).
6582 This is true also for the argument parse step.
6583 For the bitwise shifts, the saturated maximum is 63.
6584 Any catched overflow will be reported via the error number
6587 .Va ^ERR Ns -OVERFLOW .
6590 Character set agnostic string functions have no notion of locale
6591 settings and character sets.
6594 which performs the usual
6595 .Sx "Filename transformations"
6596 on its argument, and
6598 which generates a random string of the given length, or of
6600 bytes (a constant from
6602 if the value 0 is given; the random string will be base64url encoded
6603 according to RFC 4648, and thus be usable as a (portable) filename.
6606 Byte string operations work on 8-bit bytes and have no notion of locale
6607 settings and character sets, effectively assuming ASCII data.
6608 Operations that take one argument are
6610 which queries the length of the given argument, and
6612 which calculates the Chris Torek hash of the given argument.
6615 Byte string operations with two or more arguments are
6617 which byte-searches in the first for the second argument, and shows the
6618 resulting 0-based offset shall it have been found,
6620 which is identical to
6622 but works case-insensitively according to the rules of the ASCII
6625 will show a substring of its first argument:
6626 the second argument is the 0-based starting offset, the optional third
6627 argument can be used to specify the length of the desired substring,
6628 by default the entire string is used;
6629 this operation tries to work around faulty arguments (set
6631 for error logs), but reports them via the error number
6634 .Va ^ERR Ns -OVERFLOW .
6637 String operations work, sufficient support provided, according to the
6638 active user's locale encoding and character set (see
6639 .Sx "Character sets" ) .
6640 There is the one argument operation
6642 which (one-way) converts the argument to something safely printable on
6648 is a string operation that will try to match the first argument with the
6649 regular expression given as the second argument, as does
6651 but which is case-insensitive.
6652 If the optional third argument has been given then instead of showing
6653 the match offset a replacement operation is performed:
6654 the third argument is treated as if specified via dollar-single-quote
6656 .Sx "Shell-style argument quoting" ) ,
6657 and any occurrence of a positional parameter, e.g.,
6659 is replaced by the corresponding match group of the regular expression.
6661 .Bd -literal -offset indent
6662 ? vexpr -@ +1 -9223372036854775808
6663 ? vput vexpr res ir bananarama (.*)NanA(.*) '\e${1}au\e$2'
6670 \*(NQ Manage the positional parameter stack (see
6674 If the first argument is
6676 then the positional parameter stack of the current context, or the
6677 global one, if there is none, is cleared.
6680 then the remaining arguments will be used to (re)create the stack,
6681 if the parameter stack size limit is excessed an
6682 .Va ^ERR Ns -OVERFLOW
6686 If the first argument is
6688 a round-trip capable representation of the stack contents is created,
6689 with each quoted parameter separated from each other with the first
6692 and followed by the first character of
6694 if that is not empty and not identical to the first.
6695 If that results in no separation at all a
6701 .Sx "Command modifiers" ) .
6702 I.e., the subcommands
6706 can be used (in conjunction with
6708 to (re)create an argument stack from and to a single variable losslessly.
6710 .Bd -literal -offset indent
6711 ? vpospar set hey, "'you ", world!
6712 ? echo $#: <${1}><${2}><${3}>
6713 ? vput vpospar x quote
6715 ? echo $#: <${1}><${2}><${3}>
6716 ? eval vpospar set ${x}
6717 ? echo $#: <${1}><${2}><${3}>
6723 (v) Takes a message list and invokes the display editor on each message.
6724 Modified contents are discarded unless the
6726 variable is set, and are not used unless the mailbox can be written to
6727 and the editor returns a successful exit status.
6731 (w) For conventional messages the body without all headers is written.
6732 The original message is never marked for deletion in the originating
6734 The output is decrypted and converted to its native format as necessary.
6735 If the output file exists, the text is appended.
6736 If a message is in MIME multipart format its first part is written to
6737 the specified file as for conventional messages, handling of the remains
6738 depends on the execution mode.
6739 No special handling of compressed files is performed.
6741 In interactive mode the user is consecutively asked for the filenames of
6742 the processed parts.
6743 For convience saving of each part may be skipped by giving an empty
6744 value, the same result as writing it to
6746 Shell piping the part content by specifying a leading vertical bar
6748 character for the filename is supported.
6749 Other user input undergoes the usual
6750 .Sx "Filename transformations" ,
6751 and contents of the destination file are overwritten if the file
6754 \*(ID In non-interactive mode any part which does not specify a filename
6755 is ignored, and suspicious parts of filenames of the remaining parts are
6756 URL percent encoded (as via
6758 to prevent injection of malicious character sequences, resulting in
6759 a filename that will be written into the current directory.
6760 Existing files will not be overwritten, instead the part number or
6761 a dot are appended after a number sign
6763 to the name until file creation succeeds (or fails due to other
6768 \*(NQ The sole difference to
6770 is that the new macro is executed in place of the current one, which
6771 will not regain control: all resources of the current macro will be
6775 may become cleaned up if the teared down macro context is the outermost
6776 level of the cleanup stack.
6777 If this command is not used from within a
6779 ed macro it will silently be (a more expensive variant of)
6789 \*(NQ \*(UA presents message headers in
6791 fuls as described under the
6794 Without arguments this command scrolls to the next window of messages,
6795 likewise if the argument is
6799 scrolls to the last,
6801 scrolls to the first, and
6806 A number argument prefixed by
6810 indicates that the window is calculated in relation to the current
6811 position, and a number without a prefix specifies an absolute position.
6817 but scrolls to the next or previous window that contains at least one
6828 .\" .Sh COMMAND ESCAPES {{{
6829 .Sh "COMMAND ESCAPES"
6831 Here is a summary of the command escapes available in compose mode,
6832 which are used to perform special functions when composing messages.
6833 Command escapes are only recognized at the beginning of lines, and
6834 consist of a trigger (escape) and a command character.
6835 The actual escape character can be set via the internal variable
6837 it defaults to the tilde
6839 Otherwise ignored whitespace characters following the escape character
6840 will prevent a possible addition of the command line to the \*(OPal
6844 Unless otherwise noted all compose mode command escapes ensure proper
6845 updates of the variables which represent the error number
6851 is set they will, unless stated otherwise, error out message compose
6852 mode if an operation fails.
6853 It is however possible to place the character hyphen-minus
6855 after (possible whitespace following) the escape character, which has an
6856 effect equivalent to the command modifier
6858 If the \*(OPal key bindings are available it is possible to create
6860 ings specifically for the compose mode.
6863 .Bl -tag -width ".It Ic BaNg"
6866 Insert the string of text in the message prefaced by a single
6868 (If the escape character has been changed,
6869 that character must be doubled instead.)
6872 .It Ic ~! Ar command
6873 Execute the indicated shell
6875 which follows, replacing unescaped exclamation marks with the previously
6876 executed command if the internal variable
6878 is set, then return to the message.
6882 Same effect as typing the end-of-file character.
6885 .It Ic ~: Ar \*(UA-command Ns \0or Ic ~_ Ar \*(UA-command
6886 Execute the given \*(UA command.
6887 Not all commands, however, are allowed.
6891 Write a summary of command escapes.
6894 .It Ic ~< Ar filename
6899 .It Ic ~<! Ar command
6901 is executed using the shell.
6902 Its standard output is inserted into the message.
6905 .It Ic ~@ Op Ar filename...
6906 Append or edit the list of attachments.
6907 Does not manage the error number
6913 instead if this is a concern).
6916 arguments is expected as shell tokens (see
6917 .Sx "Shell-style argument quoting" ;
6918 token-separating commas are ignored, too), to be
6919 interpreted as documented for the command line option
6921 with the message number exception as below.
6925 arguments the attachment list is edited, entry by entry;
6926 if a filename is left empty, that attachment is deleted from the list;
6927 once the end of the list is reached either new attachments may be
6928 entered or the session can be quit by committing an empty
6932 For all mode, if a given filename solely consists of the number sign
6934 followed by a valid message number of the currently active mailbox, then
6935 the given message is attached as a
6938 As the shell comment character the number sign must be quoted.
6942 Inserts the string contained in the
6945 .Ql Ic ~i Ns \0Sign ) .
6946 \*(OB The escape sequences tabulator
6950 are understood (use the
6954 ting the variable(s) instead).
6958 Inserts the string contained in the
6961 .Ql Ic ~i Ns \0sign ) .
6962 \*(OB The escape sequences tabulator
6966 are understood (use the
6970 ting the variable(s) instead).
6973 .It Ic ~b Ar name ...
6974 Add the given names to the list of blind carbon copy recipients.
6977 .It Ic ~c Ar name ...
6978 Add the given names to the list of carbon copy recipients.
6982 Read the file specified by the
6984 variable into the message.
6988 Invoke the text editor on the message collected so far.
6989 After the editing session is finished,
6990 the user may continue appending text to the message.
6993 .It Ic ~F Ar messages
6994 Read the named messages into the message being sent, including all
6995 message headers and MIME parts.
6996 If no messages are specified, read in the current message, the
7000 .It Ic ~f Ar messages
7001 Read the named messages into the message being sent.
7002 If no messages are specified, read in the current message, the
7004 Strips down the list of header fields according to the
7006 white- and blacklist selection of
7008 For MIME multipart messages,
7009 only the first displayable part is included.
7013 Edit the message header fields
7018 by typing each one in turn and allowing the user to edit the field.
7019 The default values for these fields originate from the
7027 Edit the message header fields
7033 by typing each one in turn and allowing the user to edit the field.
7036 .It Ic ~I Ar variable
7037 Insert the value of the specified variable into the message.
7038 The message remains unaltered if the variable is unset or empty.
7039 \*(OB The escape sequences tabulator
7043 are understood (use the
7047 ting the variable(s) instead).
7050 .It Ic ~i Ar variable
7053 but adds a newline character at the end of a successful insertion.
7056 .It Ic ~M Ar messages
7057 Read the named messages into the message being sent,
7060 If no messages are specified, read the current message, the
7064 .It Ic ~m Ar messages
7065 Read the named messages into the message being sent,
7068 If no messages are specified, read the current message, the
7070 Strips down the list of header fields according to the
7072 white- and blacklist selection of
7074 For MIME multipart messages,
7075 only the first displayable part is included.
7079 Display the message collected so far,
7080 prefaced by the message header fields
7081 and followed by the attachment list, if any.
7085 Abort the message being sent,
7086 copying it to the file specified by the
7093 .It Ic ~R Ar filename
7096 but indent each line that has been read by
7100 .It Ic ~r Ar filename Op Ar HERE-delimiter
7101 Read the named file, object to the usual
7102 .Sx "Filename transformations" ,
7103 into the message; if (the expanded)
7107 then standard input is used, e.g., for pasting purposes.
7108 Only in this latter mode
7110 may be given: if it is data will be read in until the given
7112 is seen on a line by itself, and encountering EOF is an error; the
7114 is a required argument in non-interactive mode; if it is single-quote
7115 quoted then the pasted content will not be expanded, \*(ID otherwise
7116 a future version of \*(UA may perform shell-style expansion on the content.
7120 Cause the named string to become the current subject field.
7121 Newline (NL) and carriage-return (CR) bytes are invalid and will be
7122 normalized to space (SP) characters.
7125 .It Ic ~t Ar name ...
7126 Add the given name(s) to the direct recipient list.
7129 .It Ic ~U Ar messages
7130 Read in the given / current message(s) excluding all headers, indented by
7134 .It Ic ~u Ar messages
7135 Read in the given / current message(s), excluding all headers.
7139 Invoke an alternate editor (defined by the
7141 environment variable) on the message collected so far.
7142 Usually, the alternate editor will be a screen editor.
7143 After the editor is quit,
7144 the user may resume appending text to the end of the message.
7147 .It Ic ~w Ar filename
7148 Write the message onto the named file, which is object to the usual
7149 .Sx "Filename transformations" .
7151 the message is appended to it.
7157 except that the message is not saved at all.
7160 .It Ic ~| Ar command
7161 Pipe the message through the specified filter command.
7162 If the command gives no output or terminates abnormally,
7163 retain the original text of the message.
7166 is often used as a rejustifying filter.
7170 .It Ic ~^ Ar cmd Op Ar subcmd Op Ar arg3 Op Ar arg4
7171 Low-level command meant for scripted message access, i.e., for
7172 .Va on-compose-splice
7174 .Va on-compose-splice-shell .
7175 The used protocol is likely subject to changes, and therefore the
7176 mentioned hooks receive the used protocol version as an initial line.
7177 In general the first field of a response line represents a status code
7178 which specifies whether a command was successful or not, whether result
7179 data is to be expected, and if, the format of the result data.
7180 Does not manage the error number
7184 because errors are reported via the protocol
7185 (hard errors like I/O failures cannot be handled).
7186 This command has read-only access to several virtual pseudo headers in
7187 the \*(UA private namespace, which may not exist (except for the first):
7191 .Bl -tag -compact -width ".It Va BaNg"
7192 .It Ql Mailx-Command:
7193 The name of the command that generates the message, one of
7199 .It Ql Mailx-Raw-To:
7200 .It Ql Mailx-Raw-Cc:
7201 .It Ql Mailx-Raw-Bcc:
7202 Represent the frozen initial state of these headers before any
7203 transformation (e.g.,
7206 .Va recipients-in-cc
7209 .It Ql Mailx-Orig-From:
7210 .It Ql Mailx-Orig-To:
7211 .It Ql Mailx-Orig-Cc:
7212 .It Ql Mailx-Orig-Bcc:
7213 The values of said headers of the original message which has been
7215 .Ic reply , forward , resend .
7219 The status codes are:
7223 .Bl -tag -compact -width ".It Ql 210"
7225 Status ok; the remains of the line are the result.
7228 Status ok; the rest of the line is optionally used for more status.
7229 What follows are lines of result addresses, terminated by an empty line.
7230 The address lines consist of two fields, the first of which is the
7231 plain address, e.g.,
7233 separated by a single ASCII SP space from the second which contains the
7234 unstripped address, even if that is identical to the first field, e.g.,
7235 .Ql (Lovely) Bob <bob@exam.ple> .
7236 All the input, including the empty line, must be consumed before further
7237 commands can be issued.
7240 Status ok; the rest of the line is optionally used for more status.
7241 What follows are lines of furtherly unspecified string content,
7242 terminated by an empty line.
7243 All the input, including the empty line, must be consumed before further
7244 commands can be issued.
7247 Syntax error; invalid command.
7250 Syntax error in parameters or arguments.
7253 Error: an argument fails verification.
7254 For example an invalid address has been specified, or an attempt was
7255 made to modify anything in \*(UA's own namespace.
7258 Error: an otherwise valid argument is rendered invalid due to context.
7259 For example, a second address is added to a header which may consist of
7260 a single address only.
7265 If a command indicates failure then the message will have remained
7267 Most commands can fail with
7269 if required arguments are missing (false command usage).
7270 The following (case-insensitive) commands are supported:
7273 .Bl -hang -width ".It Cm header"
7275 This command allows listing, inspection, and editing of message headers.
7276 Header name case is not normalized, and case-insensitive comparison
7277 should be used when matching names.
7278 The second argument specifies the subcommand to apply, one of:
7280 .Bl -hang -width ".It Cm remove"
7282 Without a third argument a list of all yet existing headers is given via
7284 this command is the default command of
7286 if no second argument has been given.
7287 A third argument restricts output to the given header only, which may
7290 if no such field is defined.
7293 Shows the content of the header given as the third argument.
7294 Dependent on the header type this may respond with
7298 any failure results in
7302 This will remove all instances of the header given as the third
7307 if no such header can be found, and
7309 on \*(UA namespace violations.
7312 This will remove from the header given as the third argument the
7313 instance at the list position (counting from one!) given with the fourth
7318 if the list position argument is not a number or on \*(UA namespace
7321 if no such header instance exists.
7324 Create a new or an additional instance of the header given in the third
7325 argument, with the header body content as given in the fourth argument
7326 (the remains of the line).
7329 if the third argument specifies a free-form header field name that is
7330 invalid, or if body content extraction fails to succeed,
7332 if any extracted address does not pass syntax and/or security checks or
7333 on \*(UA namespace violations, and
7335 to indicate prevention of excessing a single-instance header \(em note that
7337 can be appended to (a space separator will be added automatically first).
7340 is returned upon success, followed by the name of the header and the list
7341 position of the newly inserted instance.
7342 The list position is always 1 for single-instance header fields.
7343 All free-form header fields are managed in a single list.
7348 This command allows listing, removal and addition of message attachments.
7349 The second argument specifies the subcommand to apply, one of:
7351 .Bl -hang -width ".It Cm remove"
7353 List all attachments via
7357 if no attachments exist.
7358 This command is the default command of
7360 if no second argument has been given.
7363 This will remove the attachment given as the third argument, and report
7367 if no such attachment can be found.
7368 If there exists any path component in the given argument, then an exact
7369 match of the path which has been used to create the attachment is used
7370 directly, but if only the basename of that path matches then all
7371 attachments are traversed to find an exact match first, and the removal
7372 occurs afterwards; if multiple basenames match, a
7375 Message attachments are treated as absolute pathnames.
7377 If no path component exists in the given argument, then all attachments
7378 will be searched for
7380 parameter matches as well as for matches of the basename of the path
7381 which has been used when the attachment has been created; multiple
7386 This will interpret the third argument as a number and remove the
7387 attachment at that list position (counting from one!), reporting
7391 if the argument is not a number or
7393 if no such attachment exists.
7396 Adds the attachment given as the third argument, specified exactly as
7397 documented for the command line option
7399 and supporting the message number extension as documented for
7403 upon success, with the index of the new attachment following,
7405 if the given file cannot be opened,
7407 if an on-the-fly performed character set conversion fails, otherwise
7409 is reported; this is also reported if character set conversion is
7410 requested but not available.
7413 This uses the same search mechanism as described for
7415 and prints any known attributes of the first found attachment via
7419 if no such attachment can be found.
7420 The attributes are written as lines of keyword and value tuples, the
7421 keyword being separated from the rest of the line with an ASCII SP space
7425 This uses the same search mechanism as described for
7427 and is otherwise identical to
7430 .It Cm attribute-set
7431 This uses the same search mechanism as described for
7433 and will assign the attribute given as the fourth argument, which is
7434 expected to be a value tuple of keyword and other data, separated by
7435 a ASCII SP space or TAB tabulator character.
7436 If the value part is empty, then the given attribute is removed, or
7437 reset to a default value if existence of the attribute is crucial.
7441 upon success, with the index of the found attachment following,
7443 for message attachments or if the given keyword is invalid, and
7445 if no such attachment can be found.
7446 The following keywords may be used (case-insensitively):
7448 .Bl -hang -compact -width ".It Ql filename"
7450 Sets the filename of the MIME part, i.e., the name that is used for
7451 display and when (suggesting a name for) saving (purposes).
7452 .It Ql content-description
7453 Associate some descriptive information to the attachment's content, used
7454 in favour of the plain filename by some MUAs.
7456 May be used for uniquely identifying MIME entities in several contexts;
7457 this expects a special reference address format as defined in RFC 2045
7460 upon address content verification failure.
7462 Defines the media type/subtype of the part, which is managed
7463 automatically, but can be overwritten.
7464 .It Ql content-disposition
7465 Automatically set to the string
7469 .It Cm attribute-set-at
7470 This uses the same search mechanism as described for
7472 and is otherwise identical to
7483 .\" .Sh INTERNAL VARIABLES {{{
7484 .Sh "INTERNAL VARIABLES"
7486 Internal \*(UA variables are controlled via the
7490 commands; prefixing a variable name with the string
7494 has the same effect as using
7500 Creation or editing of variables can be performed in the
7505 will give more insight on the given variable(s), and
7507 when called without arguments, will show a listing of all variables.
7508 Both commands support a more
7511 Some well-known variables will also become inherited from the
7514 implicitly, others can be imported explicitly with the command
7516 and henceforth share said properties.
7519 Two different kinds of internal variables exist.
7520 There are boolean variables, which can only be in one of the two states
7524 and value variables with a(n optional) string value.
7525 For the latter proper quoting is necessary upon assignment time, the
7526 introduction of the section
7528 documents the supported quoting rules.
7530 .Bd -literal -offset indent
7531 ? wysh set one=val\e 1 two="val 2" \e
7532 three='val "3"' four=$'val \e'4\e''; \e
7533 varshow one two three four; \e
7534 unset one two three four
7538 Dependent upon the actual option the string values will be interpreted
7539 as numbers, colour names, normal text etc., but there also exists
7540 a special kind of string value, the
7541 .Dq boolean string ,
7542 which must either be a decimal integer (in which case
7546 and any other value is true) or any of the (case-insensitive) strings
7552 for a false boolean and
7558 for a true boolean; a special kind of boolean string is the
7560 which is a boolean string that can optionally be prefixed with the
7561 (case-insensitive) term
7565 which causes prompting of the user in interactive mode, with the given
7566 boolean as the default value.
7568 .\" .Ss "Initial settings" {{{
7569 .\" (Keep in SYNC: ./nail.h:okeys, ./nail.rc, ./nail.1:"Initial settings")
7570 .Ss "Initial settings"
7572 The standard POSIX 2008/Cor 2-2016 mandates the following initial
7578 .Pf no Va autoprint ,
7592 .Pf no Va ignoreeof ,
7594 .Pf no Va keepsave ,
7596 .Pf no Va outfolder ,
7604 .Pf no Va sendwait ,
7613 Notes: \*(UA does not support the
7615 variable \(en use command line options or
7617 to pass options through to a
7619 And the default global
7621 file, which is loaded unless the
7623 (with according argument) or
7625 command line options have been used, or the
7626 .Ev MAILX_NO_SYSTEM_RC
7627 environment variable is set (see
7628 .Sx "Resource files" )
7629 bends those initial settings a bit, e.g., it sets the variables
7634 to name a few, establishes a default
7636 selection etc., and should thus be taken into account.
7639 .\" .Ss "Variables" {{{
7642 .Bl -tag -width ".It Va BaNg"
7646 \*(RO The exit status of the last command, or the
7651 This status has a meaning in the state machine: in conjunction with
7653 any non-0 exit status will cause a program exit, and in
7655 mode any error while loading (any of the) resource files will have the
7659 .Sx "Command modifiers" ,
7660 can be used to instruct the state machine to ignore errors.
7664 \*(RO The current error number
7665 .Pf ( Xr errno 3 ) ,
7666 which is set after an error occurred; it is also available via
7668 and the error name and documentation string can be queried via
7672 \*(ID This machinery is new and the error number is only really usable
7673 if a command explicitly states that it manages the variable
7675 for others errno will be used in case of errors, or
7677 if that is 0: it thus may or may not reflect the real error.
7678 The error number may be set with the command
7684 \*(RO This is a multiplexer variable which performs dynamic expansion of
7685 the requested state or condition, of which there are:
7688 .Bl -tag -compact -width ".It Va BaNg"
7692 .It Va ^ERR , ^ERRDOC , ^ERRNAME
7693 The number, documentation, and name of the current
7695 respectively, which is usually set after an error occurred.
7696 \*(ID This machinery is new and is usually reliable only if a command
7697 explicitly states that it manages the variable
7699 which is effectively identical to
7701 Each of those variables can be suffixed with a hyphen minus followed by
7702 a name or number, in which case the expansion refers to the given error.
7703 Note this is a direct mapping of (a subset of) the system error values:
7704 .Bd -literal -offset indent
7706 eval echo \e$1: \e$^ERR-$1: \e$^ERRNAME-$1: \e$^ERRDOC-$1
7707 vput vexpr i + "$1" 1
7719 \*(RO Expands all positional parameters (see
7721 separated by a space character.
7722 \*(ID The special semantics of the equally named special parameter of the
7724 are not yet supported.
7728 \*(RO Expands all positional parameters (see
7730 separated by a space character.
7731 If placed in double quotation marks, each positional parameter is
7732 properly quoted to expand to a single parameter again.
7736 \*(RO Expands to the number of positional parameters, i.e., the size of
7737 the positional parameter stack in decimal.
7741 \*(RO Inside the scope of a
7745 ed macro this expands to the name of the calling macro, or to the empty
7746 string if the macro is running from top-level.
7747 For the \*(OPal regular expression search and replace operator of
7749 this expands to the entire matching expression.
7750 It represents the program name in global context.
7754 \*(RO Access of the positional parameter stack.
7755 All further parameters can be accessed with this syntax, too, e.g.,
7758 etc.; positional parameters can be shifted off the stack by calling
7760 The parameter stack contains, e.g., the arguments of a
7764 d macro, the matching groups of the \*(OPal regular expression search
7765 and replace expression of
7767 and can be explicitly created or overwritten with the command
7772 \*(RO Is set to the active
7776 .It Va add-file-recipients
7777 \*(BO When file or pipe recipients have been specified,
7778 mention them in the corresponding address fields of the message instead
7779 of silently stripping them from their recipient list.
7780 By default such addressees are not mentioned.
7784 \*(BO Causes only the local part to be evaluated
7785 when comparing addresses.
7789 \*(BO Causes messages saved in the
7791 .Sx "secondary mailbox"
7793 to be appended to the end rather than prepended.
7794 This should always be set.
7798 \*(BO Causes \*(UA to prompt for the subject of each message sent.
7799 If the user responds with simply a newline,
7800 no subject field will be sent.
7804 \*(BO Causes the prompts for
7808 lists to appear after the message has been edited.
7812 \*(BO If set, \*(UA asks for files to attach at the end of each message,
7813 shall the list be found empty at that time.
7814 An empty line finalizes the list.
7818 \*(BO Causes the user to be prompted for carbon copy recipients
7819 (at the end of each message if
7823 are set) shall the list be found empty (at that time).
7824 An empty line finalizes the list.
7828 \*(BO Causes the user to be prompted for blind carbon copy
7829 recipients (at the end of each message if
7833 are set) shall the list be found empty (at that time).
7834 An empty line finalizes the list.
7838 \*(BO\*(OP Causes the user to be prompted if the message is to be
7839 signed at the end of each message.
7842 variable is ignored when this variable is set.
7846 \*(BO Alternative name for
7851 A sequence of characters to display in the
7855 as shown in the display of
7857 each for one type of messages (see
7858 .Sx "Message states" ) ,
7859 with the default being
7862 .Ql NU\ \ *HMFAT+\-$~
7865 variable is set, in the following order:
7867 .Bl -tag -compact -width ".It Ql _"
7889 start of a collapsed thread.
7891 an uncollapsed thread (TODO ignored for now).
7895 classified as possible spam.
7901 Specifies a list of recipients to which a blind carbon copy of each
7902 outgoing message will be sent automatically.
7906 Specifies a list of recipients to which a carbon copy of each outgoing
7907 message will be sent automatically.
7911 \*(BO Causes threads to be collapsed automatically when threaded mode
7918 \*(BO Enable automatic
7920 ing of a(n existing)
7926 commands, e.g., the message that becomes the new
7928 is shown automatically, as via
7935 Causes sorted mode (see the
7937 command) to be entered automatically with the value of this variable as
7938 sorting method when a folder is opened, e.g.,
7939 .Ql set autosort=thread .
7943 \*(BO Enables the substitution of all not (reverse-solidus) escaped
7946 characters by the contents of the last executed command for the
7948 shell escape command and
7950 one of the compose mode
7951 .Sx "COMMAND ESCAPES" .
7952 If this variable is not set no reverse solidus stripping is performed.
7956 \*(OP Terminals generate multi-byte sequences for certain forms of
7957 input, for example for function and other special keys.
7958 Some terminals however do not write these multi-byte sequences as
7959 a whole, but byte-by-byte, and the latter is what \*(UA actually reads.
7960 This variable specifies the timeout in milliseconds that the MLE (see
7961 .Sx "On terminal control and line editor" )
7962 waits for more bytes to arrive unless it considers a sequence
7968 \*(BO Sets some cosmetical features to traditional BSD style;
7969 has the same affect as setting
7971 and all other variables prefixed with
7973 it also changes the behaviour of
7975 (which does not exist in BSD).
7979 \*(BO Changes the letters shown in the first column of a header
7980 summary to traditional BSD style.
7984 \*(BO Changes the display of columns in a header summary to traditional
7989 \*(BO Changes some informational messages to traditional BSD style.
7995 field to appear immediately after the
7997 field in message headers and with the
7999 .Sx "COMMAND ESCAPES" .
8003 .It Va build-os , build-osenv
8004 \*(RO The operating system \*(UA has been build for, usually taken from
8010 respectively, the former being lowercased.
8014 The value that should appear in the
8018 MIME header fields when no character set conversion of the message data
8020 This defaults to US-ASCII, and the chosen character set should be
8021 US-ASCII compatible.
8025 \*(OP The default 8-bit character set that is used as an implicit last
8026 member of the variable
8028 This defaults to UTF-8 if character set conversion capabilities are
8029 available, and to ISO-8859-1 otherwise, in which case the only supported
8032 and this variable is effectively ignored.
8033 Refer to the section
8034 .Sx "Character sets"
8035 for the complete picture of character set conversion in \*(UA.
8038 .It Va charset-unknown-8bit
8039 \*(OP RFC 1428 specifies conditions when internet mail gateways shall
8041 the content of a mail message by using a character set with the name
8043 Because of the unclassified nature of this character set \*(UA will not
8044 be capable to convert this character set to any other character set.
8045 If this variable is set any message part which uses the character set
8047 is assumed to really be in the character set given in the value,
8048 otherwise the (final) value of
8050 is used for this purpose.
8052 This variable will also be taken into account if a MIME type (see
8053 .Sx "The mime.types files" )
8054 of a MIME message part that uses the
8056 character set is forcefully treated as text.
8060 The default value for the
8065 .It Va colour-disable
8066 \*(BO\*(OP Forcefully disable usage of colours.
8067 Also see the section
8068 .Sx "Coloured display" .
8072 \*(BO\*(OP Whether colour shall be used for output that is paged through
8074 Note that pagers may need special command line options, e.g.,
8082 in order to support colours.
8083 Often doing manual adjustments is unnecessary since \*(UA may perform
8084 adjustments dependent on the value of the environment variable
8086 (see there for more).
8090 .It Va contact-mail , contact-web
8091 \*(RO Addresses for contact per email and web, respectively, e.g., for
8092 bug reports, suggestions, or help regarding \*(UA.
8093 The former can be used directly:
8094 .Ql ? eval mail $contact-mail .
8098 In a(n interactive) terminal session, then if this valued variable is
8099 set it will be used as a threshold to determine how many lines the given
8100 output has to span before it will be displayed via the configured
8104 can be forced by setting this to the value
8106 setting it without a value will deduce the current height of the
8107 terminal screen to compute the treshold (see
8112 \*(ID At the moment this uses the count of lines of the message in wire
8113 format, which, dependent on the
8115 of the message, is unrelated to the number of display lines.
8116 (The software is old and historically the relation was a given thing.)
8120 Define a set of custom headers to be injected into newly composed or
8121 forwarded messages; it is also possible to create custom headers in
8124 which can be automated by setting one of the hooks
8125 .Va on-compose-splice
8127 .Va on-compose-splice-shell .
8128 The value is interpreted as a comma-separated list of custom headers to
8129 be injected, to include commas in the header bodies escape them with
8131 \*(ID Overwriting of automatically managed headers is neither supported
8134 .Dl ? set customhdr='Hdr1: Body1-1\e, Body1-2, Hdr2: Body2'
8138 Controls the appearance of the
8140 date and time format specification of the
8142 variable, that is used, for example, when viewing the summary of
8144 If unset, then the local receiving date is used and displayed
8145 unformatted, otherwise the message sending
8147 It is possible to assign a
8149 format string and control formatting, but embedding newlines via the
8151 format is not supported, and will result in display errors.
8153 .Ql %Y-%m-%d %H:%M ,
8155 .Va datefield-markout-older .
8158 .It Va datefield-markout-older
8159 Only used in conjunction with
8161 Can be used to create a visible distinction of messages dated more than
8162 a day in the future, or older than six months, a concept comparable to the
8164 option of the POSIX utility
8166 If set to the empty string, then the plain month, day and year of the
8168 will be displayed, but a
8170 format string to control formatting can be assigned.
8176 \*(BO Enables debug messages and obsoletion warnings, disables the
8177 actual delivery of messages and also implies
8183 .It Va disposition-notification-send
8185 .Ql Disposition-Notification-To:
8186 header (RFC 3798) with the message.
8190 .\" TODO .It Va disposition-notification-send-HOST
8192 .\".Va disposition-notification-send
8193 .\" for SMTP accounts on a specific host.
8194 .\" TODO .It Va disposition-notification-send-USER@HOST
8196 .\".Va disposition-notification-send
8197 .\"for a specific account.
8201 \*(BO When dot is set, a period
8203 on a line by itself during message input in (interactive or batch
8205 compose mode will be treated as end-of-message (in addition to the
8206 normal end-of-file condition).
8207 This behaviour is implied in
8213 .It Va dotlock-ignore-error
8214 \*(BO\*(OP Synchronization of mailboxes which \*(UA treats as
8216 .Sx "primary system mailbox" Ns
8217 es (see, e.g., the notes on
8218 .Sx "Filename transformations" ,
8219 as well as the documentation of
8221 will be protected with so-called dotlock files\(emthe traditional mail
8222 spool file locking method\(emin addition to system file locking.
8223 Because \*(UA ships with a privilege-separated dotlock creation program
8224 that should always be able to create such a dotlock file there is no
8225 good reason to ignore dotlock file creation errors, and thus these are
8226 fatal unless this variable is set.
8230 \*(BO If this variable is set then the editor is started automatically
8231 when a message is composed in interactive mode, as if the
8233 .Sx "COMMAND ESCAPES"
8237 variable is implied for this automatically spawned editor session.
8241 \*(BO When a message is edited while being composed,
8242 its header is included in the editable text.
8246 \*(BO When entering interactive mode \*(UA normally writes
8247 .Dq \&No mail for user
8248 and exits immediately if a mailbox is empty or does not exist.
8249 If this variable is set \*(UA starts even with an empty or non-existent
8250 mailbox (the latter behaviour furtherly depends upon
8256 \*(BO Let each command with a non-0 exit status, including every
8260 s a non-0 status, cause a program exit unless prefixed by
8263 .Sx "Command modifiers" ) .
8265 .Sx "COMMAND ESCAPES" ,
8266 but which use a different modifier for ignoring the error.
8267 Please refer to the variable
8269 for more on this topic.
8273 The first character of this value defines the escape character for
8274 .Sx "COMMAND ESCAPES"
8276 The default value is the character tilde
8278 If set to the empty string, command escapes are disabled.
8282 If not set then file and command pipeline targets are not allowed,
8283 and any such address will be filtered out, giving a warning message.
8284 If set without a value then all possible recipient address
8285 specifications will be accepted \(en see the section
8286 .Sx "On sending mail, and non-interactive mode"
8288 To accept them, but only in interactive mode, or when tilde commands
8289 were enabled explicitly by using one of the command line options
8293 set this to the (case-insensitive) value
8295 (it actually acts like
8296 .Ql restrict,-all,+name,+addr ,
8297 so that care for ordering issues must be taken) .
8299 In fact the value is interpreted as a comma-separated list of values.
8302 then the existence of disallowed specifications is treated as a hard
8303 send error instead of only filtering them out.
8304 The remaining values specify whether a specific type of recipient
8305 address specification is allowed (optionally indicated by a plus sign
8307 prefix) or disallowed (prefixed with a hyphen-minus
8311 addresses all possible address specifications,
8315 command pipeline targets,
8317 plain user names and (MTA) aliases and
8320 These kind of values are interpreted in the given order, so that
8321 .Ql restrict,\:fail,\:+file,\:-all,\:+addr
8322 will cause hard errors for any non-network address recipient address
8323 unless \*(UA is in interactive mode or has been started with the
8327 command line option; in the latter case(s) any address may be used, then.
8329 Historically invalid network addressees are silently stripped off.
8330 To change this so that any encountered invalid email address causes
8331 a hard error it must be ensured that
8333 is an entry in the above list.
8334 Setting this automatically enables network addressees
8335 (it actually acts like
8336 .Ql failinvaddr,+addr ,
8337 so that care for ordering issues must be taken) .
8341 Unless this variable is set additional
8343 (Mail-Transfer-Agent)
8344 arguments from the command line, as can be given after a
8346 separator, are ignored due to safety reasons.
8347 However, if set to the special (case-insensitive) value
8349 then the presence of additional MTA arguments is treated as a hard
8350 error that causes \*(UA to exit with failure status.
8351 A lesser strict variant is the otherwise identical
8353 which does accept such arguments in interactive mode, or if tilde
8354 commands were enabled explicitly by using one of the command line options
8361 \*(RO String giving a list of features \*(UA, preceded with a plus sign
8363 if the feature is available, and a hyphen-minus
8366 The output of the command
8368 will include this information in a more pleasant output.
8372 \*(BO This setting reverses the meanings of a set of reply commands,
8373 turning the lowercase variants, which by default address all recipients
8374 included in the header of a message
8375 .Pf ( Ic reply , respond , followup )
8376 into the uppercase variants, which by default address the sender only
8377 .Pf ( Ic Reply , Respond , Followup )
8380 .Ic replysender , respondsender , followupsender
8382 .Ic replyall , respondall , followupall
8383 are not affected by the current setting of
8388 The default path under which mailboxes are to be saved:
8389 filenames that begin with the plus sign
8391 will have the plus sign replaced with the value of this variable if set,
8392 otherwise the plus sign will remain unchanged when doing
8393 .Sx "Filename transformations" ;
8396 for more on this topic.
8397 The value supports a subset of transformations itself, and if the
8398 non-empty value does not start with a solidus
8402 will be prefixed automatically.
8403 Once the actual value is evaluated first, the internal variable
8405 will be updated for caching purposes.
8409 This variable can be set to the name of a
8411 macro which will be called whenever a
8414 The macro will also be invoked when new mail arrives,
8415 but message lists for commands executed from the macro
8416 only include newly arrived messages then.
8418 are activated by default in a folder hook, causing the covered settings
8419 to be reverted once the folder is left again.
8422 .It Va folder-hook-FOLDER
8427 Unlike other folder specifications, the fully expanded name of a folder,
8428 without metacharacters, is used to avoid ambiguities.
8429 However, if the mailbox resides under
8433 specification is tried in addition, e.g., if
8437 (and thus relative to the user's home directory) then
8438 .Pa /home/usr1/mail/sent
8440 .Ql folder-hook-/home/usr1/mail/sent
8441 first, but then followed by
8442 .Ql folder-hook-+sent .
8445 .It Va folder-resolved
8446 \*(RO Set to the fully resolved path of
8448 once that evaluation has occurred; rather internal.
8452 \*(BO Controls whether a
8453 .Ql Mail-Followup-To:
8454 header is generated when sending messages to known mailing lists.
8456 .Va followup-to-honour
8458 .Ic mlist , mlsubscribe , reply
8463 .It Va followup-to-honour
8465 .Ql Mail-Followup-To:
8466 header is honoured when group-replying to a message via
8470 This is a quadoption; if set without a value it defaults to
8480 .It Va forward-as-attachment
8481 \*(BO Original messages are normally sent as inline text with the
8484 and only the first part of a multipart message is included.
8485 With this setting enabled messages are sent as unmodified MIME
8487 attachments with all of their parts included.
8490 .It Va forward-inject-head
8491 The string to put before the text of a message with the
8493 command instead of the default
8494 .Dq -------- Original Message -------- .
8495 No heading is put if it is set to the empty string.
8496 This variable is ignored if the
8497 .Va forward-as-attachment
8502 The address (or a list of addresses) to put into the
8504 field of the message header, quoting RFC 5322:
8505 the author(s) of the message, that is, the mailbox(es) of the person(s)
8506 or system(s) responsible for the writing of the message.
8509 ing to messages these addresses are handled as if they were in the
8513 If the machine's hostname is not valid at the Internet (for example at
8514 a dialup machine) then either this variable or
8516 (\*(IN and with a defined SMTP protocol in
8519 adds even more fine-tuning capabilities),
8523 contains more than one address,
8526 variable is required (according to the standard RFC 5322).
8528 If a file-based MTA is used, then
8530 (or, if that contains multiple addresses,
8532 can nonetheless be enforced to appear as the envelope sender address at
8533 the MTA protocol level (the RFC 5321 reverse-path), either by using the
8535 command line option (with an empty argument; see there for the complete
8536 picture on this topic), or by setting the internal variable
8537 .Va r-option-implicit .
8541 \*(BO When replying to or forwarding a message \*(UA normally removes
8542 the comment and name parts of email addresses.
8543 If this variable is set such stripping is not performed,
8544 and comments, names etc. are retained.
8547 \*(OB Predecessor of
8548 .Va forward-inject-head .
8552 \*(BO Causes the header summary to be written at startup and after
8553 commands that affect the number of messages or the order of messages in
8558 mode a header summary will also be displayed on folder changes.
8559 The command line option
8567 A format string to use for the summary of
8569 similar to the ones used for
8572 Format specifiers in the given string start with a percent sign
8574 and may be followed by an optional decimal number indicating the field
8575 width \(em if that is negative, the field is to be left-aligned.
8576 Valid format specifiers are:
8579 .Bl -tag -compact -width ".It Ql _%%_"
8581 A plain percent sign.
8584 a space character but for the current message
8586 for which it expands to
8590 a space character but for the current message
8592 for which it expands to
8595 \*(OP The spam score of the message, as has been classified via the
8598 Shows only a replacement character if there is no spam support.
8600 Message attribute character (status flag); the actual content can be
8604 The date found in the
8606 header of the message when
8608 is set (the default), otherwise the date when the message was received.
8609 Formatting can be controlled by assigning a
8614 The indenting level in threaded mode.
8616 The address of the message sender.
8618 The message thread tree structure.
8619 (Note that this format does not support a field width.)
8621 The number of lines of the message, if available.
8625 The number of octets (bytes) in the message, if available.
8627 Message subject (if any).
8629 Message subject (if any) in double quotes.
8631 Message recipient flags: is the addressee of the message a known or
8632 subscribed mailing list \(en see
8637 The position in threaded/sorted order.
8641 .Ql %>\&%a\&%m\ %-18f\ %16d\ %4l/%\-5o\ %i%-s ,
8643 .Ql %>\&%a\&%m\ %20-f\ \ %16d\ %3l/%\-5o\ %i%-S
8654 .It Va headline-bidi
8655 Bidirectional text requires special treatment when displaying headers,
8656 because numbers (in dates or for file sizes etc.) will not affect the
8657 current text direction, in effect resulting in ugly line layouts when
8658 arabic or other right-to-left text is to be displayed.
8659 On the other hand only a minority of terminals is capable to correctly
8660 handle direction changes, so that user interaction is necessary for
8662 Note that extended host system support is required nonetheless, e.g.,
8663 detection of the terminal character set is one precondition;
8664 and this feature only works in an Unicode (i.e., UTF-8) locale.
8666 In general setting this variable will cause \*(UA to encapsulate text
8667 fields that may occur when displaying
8669 (and some other fields, like dynamic expansions in
8671 with special Unicode control sequences;
8672 it is possible to fine-tune the terminal support level by assigning
8674 no value (or any value other than
8679 will make \*(UA assume that the terminal is capable to properly deal
8680 with Unicode version 6.3, in which case text is embedded in a pair of
8681 U+2068 (FIRST STRONG ISOLATE) and U+2069 (POP DIRECTIONAL ISOLATE)
8683 In addition no space on the line is reserved for these characters.
8685 Weaker support is chosen by using the value
8687 (Unicode 6.3, but reserve the room of two spaces for writing the control
8688 sequences onto the line).
8693 select Unicode 1.1 support (U+200E, LEFT-TO-RIGHT MARK); the latter
8694 again reserves room for two spaces in addition.
8698 \*(OP If a line editor is available then this can be set to
8699 name the (expandable) path of the location of a permanent history file.
8704 .It Va history-gabby
8705 \*(BO\*(OP Add more entries to the history as is normally done.
8708 .It Va history-gabby-persist
8709 \*(BO\*(OP \*(UA's own MLE will not save the additional
8711 entries in persistent storage unless this variable is set.
8712 On the other hand it will not loose the knowledge of whether
8713 a persistent entry was gabby or not.
8719 \*(OP Setting this variable imposes a limit on the number of concurrent
8721 If set to the value 0 then no further history entries will be added, and
8722 loading and incorporation of the
8724 upon program startup can also be suppressed by doing this.
8725 Runtime changes will not be reflected, but will affect the number of
8726 entries saved to permanent storage.
8730 \*(BO This setting controls whether messages are held in the system
8732 and it is set by default.
8736 Use this string as hostname when expanding local addresses instead of
8737 the value obtained from
8741 It is used, e.g., in
8745 fields, as well as when generating
8747 MIME part related unique ID fields.
8748 Setting it to the empty string will cause the normal hostname to be
8749 used, but nonetheless enables creation of said ID fields.
8750 \*(IN in conjunction with the built-in SMTP
8753 also influences the results:
8754 one should produce some test messages with the desired combination of
8763 \*(BO\*(OP Can be used to turn off the automatic conversion of domain
8764 names according to the rules of IDNA (internationalized domain names
8766 Since the IDNA code assumes that domain names are specified with the
8768 character set, an UTF-8 locale charset is required to represent all
8769 possible international domain names (before conversion, that is).
8773 The input field separator that is used (\*(ID by some functions) to
8774 determine where to split input data.
8776 .Bl -tag -compact -width ".It MMM"
8778 Unsetting is treated as assigning the default value,
8781 If set to the empty value, no field splitting will be performed.
8783 If set to a non-empty value, all whitespace characters are extracted
8784 and assigned to the variable
8788 .Bl -tag -compact -width ".It MMM"
8791 will be ignored at the beginning and end of input.
8792 Diverging from POSIX shells default whitespace is removed in addition,
8793 which is owed to the entirely different line content extraction rules.
8795 Each occurrence of a character of
8797 will cause field-splitting, any adjacent
8799 characters will be skipped.
8804 \*(RO Automatically deduced from the whitespace characters in
8809 \*(BO Ignore interrupt signals from the terminal while entering
8810 messages; instead echo them as
8812 characters and discard the current line.
8816 \*(BO Ignore end-of-file conditions
8817 .Pf ( Ql control-D )
8818 in compose mode on message input and in interactive command input.
8819 If set an interactive command input session can only be left by
8820 explicitly using one of the commands
8824 and message input in compose mode can only be terminated by entering
8827 on a line by itself or by using the
8829 .Sx "COMMAND ESCAPES" ;
8830 Setting this implies the behaviour that
8838 If this is set to a non-empty string it will specify the users
8840 .Sx "primary system mailbox" ,
8843 and the system-dependent default, and (thus) be used to replace
8846 .Sx "Filename transformations" ;
8849 for more on this topic.
8850 The value supports a subset of transformations itself.
8858 .Sx "COMMAND ESCAPES"
8861 option for indenting messages,
8862 in place of the normal tabulator character
8864 which is the default.
8865 Be sure to quote the value if it contains spaces or tabs.
8869 \*(BO If set, an empty
8871 .Sx "primary system mailbox"
8872 file is not removed.
8873 Note that, in conjunction with
8875 any empty file will be removed unless this variable is set.
8876 This may improve the interoperability with other mail user agents
8877 when using a common folder directory, and prevents malicious users
8878 from creating fake mailboxes in a world-writable spool directory.
8879 \*(ID Only local regular (MBOX) files are covered, Maildir or other
8880 mailbox types will never be removed, even if empty.
8883 .It Va keep-content-length
8884 \*(BO When (editing messages and) writing MBOX mailbox files \*(UA can
8889 header fields that some MUAs generate by setting this variable.
8890 Since \*(UA does neither use nor update these non-standardized header
8891 fields (which in itself shows one of their conceptual problems),
8892 stripping them should increase interoperability in between MUAs that
8893 work with with same mailbox files.
8894 Note that, if this is not set but
8895 .Va writebackedited ,
8896 as below, is, a possibly performed automatic stripping of these header
8897 fields already marks the message as being modified.
8898 \*(ID At some future time \*(UA will be capable to rewrite and apply an
8900 to modified messages, and then those fields will be stripped silently.
8904 \*(BO When a message is saved it is usually discarded from the
8905 originating folder when \*(UA is quit.
8906 This setting causes all saved message to be retained.
8909 .It Va line-editor-disable
8910 \*(BO Turn off any enhanced line editing capabilities (see
8911 .Sx "On terminal control and line editor"
8915 .It Va line-editor-no-defaults
8916 \*(BO\*(OP Do not establish any default key binding.
8920 Error log message prefix string
8921 .Pf ( Ql "\*(uA: " ) .
8924 .It Va mailbox-display
8925 \*(RO The name of the current mailbox
8927 possibly abbreviated for display purposes.
8930 .It Va mailbox-resolved
8931 \*(RO The fully resolved path of the current mailbox.
8934 .It Va mailx-extra-rc
8935 An additional startup file that is loaded as the last of the
8936 .Sx "Resource files" .
8937 Use this file for commands that are not understood by other POSIX
8939 implementations, i.e., mostly anything which is not covered by
8940 .Sx "Initial settings" .
8944 \*(BO When a message is replied to and this variable is set,
8945 it is marked as having been
8948 .Sx "Message states" .
8952 \*(BO When opening MBOX mailbox databases \*(UA by default uses tolerant
8953 POSIX rules for detecting message boundaries (so-called
8955 lines) due to compatibility reasons, instead of the stricter rules that
8956 have been standardized in RFC 4155.
8957 This behaviour can be switched to the stricter RFC 4155 rules by
8958 setting this variable.
8959 (This is never necessary for any message newly generated by \*(UA,
8960 it only applies to messages generated by buggy or malicious MUAs, or may
8961 occur in old MBOX databases: \*(UA itself will choose a proper
8963 to avoid false interpretation of
8965 content lines in the MBOX database.)
8967 This may temporarily be handy when \*(UA complains about invalid
8969 lines when opening a MBOX: in this case setting this variable and
8970 re-opening the mailbox in question may correct the result.
8971 If so, copying the entire mailbox to some other file, as in
8972 .Ql copy * SOME-FILE ,
8973 will perform proper, all-compatible
8975 quoting for all detected messages, resulting in a valid MBOX mailbox.
8976 Finally the variable can be unset again:
8977 .Bd -literal -offset indent
8979 localopts yes; wysh set mbox-rfc4155;\e
8980 wysh File "${1}"; eval copy * "${2}"
8982 call mboxfix /tmp/bad.mbox /tmp/good.mbox
8987 \*(BO Internal development variable.
8990 .It Va message-id-disable
8991 \*(BO By setting this variable the generation of
8993 can be completely suppressed, effectively leaving this task up to the
8995 (Mail-Transfer-Agent) or the SMTP server.
8996 (According to RFC 5321 a SMTP server is not required to add this
8997 field by itself, so it should be ensured that it accepts messages without
8999 This variable also affects automatic generation of
9004 .It Va message-inject-head
9005 A string to put at the beginning of each new message.
9006 The escape sequences tabulator
9013 .It Va message-inject-tail
9014 A string to put at the end of each new message.
9015 The escape sequences tabulator
9023 \*(BO Usually, when an
9025 expansion contains the sender, the sender is removed from the expansion.
9026 Setting this option suppresses these removals.
9031 option to be passed through to the
9033 (Mail-Transfer-Agent); though most of the modern MTAs no longer document
9034 this flag, no MTA is known which does not support it (for historical
9038 .It Va mime-allow-text-controls
9039 \*(BO When sending messages, each part of the message is MIME-inspected
9040 in order to classify the
9043 .Ql Content-Transfer-Encoding:
9046 that is required to send this part over mail transport, i.e.,
9047 a computation rather similar to what the
9049 command produces when used with the
9053 This classification however treats text files which are encoded in
9054 UTF-16 (seen for HTML files) and similar character sets as binary
9055 octet-streams, forcefully changing any
9060 .Ql application/octet-stream :
9061 If that actually happens a yet unset charset MIME parameter is set to
9063 effectively making it impossible for the receiving MUA to automatically
9064 interpret the contents of the part.
9066 If this variable is set, and the data was unambiguously identified as
9067 text data at first glance (by a
9071 file extension), then the original
9073 will not be overwritten.
9076 .It Va mime-alternative-favour-rich
9077 \*(BO If this variable is set then rich MIME alternative parts (e.g.,
9078 HTML) will be preferred in favour of included plain text versions when
9079 displaying messages, provided that a handler exists which produces
9080 output that can be (re)integrated into \*(UA's normal visual display.
9081 (E.g., at the time of this writing some newsletters ship their full
9082 content only in the rich HTML part, whereas the plain text part only
9083 contains topic subjects.)
9086 .It Va mime-counter-evidence
9089 field is used to decide how to handle MIME parts.
9090 Some MUAs, however, do not use
9091 .Sx "The mime.types files"
9093 .Sx "HTML mail and MIME attachments" )
9094 or a similar mechanism to correctly classify content, but specify an
9095 unspecific MIME type
9096 .Pf ( Ql application/octet-stream )
9097 even for plain text attachments.
9098 If this variable is set then \*(UA will try to re-classify such MIME
9099 message parts, if possible, for example via a possibly existing
9100 attachment filename.
9101 A non-empty value may also be given, in which case a number is expected,
9102 actually a carrier of bits.
9103 Creating the bit-carrying number is a simple addition:
9104 .Bd -literal -offset indent
9105 ? !echo Value should be set to $((2 + 4 + 8))
9106 Value should be set to 14
9109 .Bl -bullet -compact
9111 If bit two is set (2) then the detected
9113 will be carried along with the message and be used for deciding which
9114 MIME handler is to be used, for example;
9115 when displaying such a MIME part the part-info will indicate the
9116 overridden content-type by showing a plus sign
9119 If bit three is set (4) then the counter-evidence is always produced
9120 and a positive result will be used as the MIME type, even forcefully
9121 overriding the parts given MIME type.
9123 If bit four is set (8) then as a last resort the actual content of
9124 .Ql application/octet-stream
9125 parts will be inspected, so that data which looks like plain text can be
9130 .It Va mime-encoding
9132 .Ql Content-Transfer-Encoding
9133 to use in outgoing text messages and message parts, where applicable.
9134 (7-bit clean text messages are sent as-is, without a transfer encoding.)
9137 .Bl -tag -compact -width ".It Ql _%%_"
9140 8-bit transport effectively causes the raw data be passed through
9141 unchanged, but may cause problems when transferring mail messages over
9142 channels that are not ESMTP (RFC 1869) compliant.
9143 Also, several input data constructs are not allowed by the
9144 specifications and may cause a different transfer-encoding to be used.
9145 .It Ql quoted-printable
9147 Quoted-printable encoding is 7-bit clean and has the property that ASCII
9148 characters are passed through unchanged, so that an english message can
9149 be read as-is; it is also acceptible for other single-byte locales that
9150 share many characters with ASCII, like, e.g., ISO-8859-1.
9151 The encoding will cause a large overhead for messages in other character
9152 sets: e.g., it will require up to twelve (12) bytes to encode a single
9153 UTF-8 character of four (4) bytes.
9155 .Pf (Or\0 Ql b64 . )
9156 The default encoding, it is 7-bit clean and will always be used for
9158 This encoding has a constant input:output ratio of 3:4, regardless of
9159 the character set of the input data it will encode three bytes of input
9160 to four bytes of output.
9161 This transfer-encoding is not human readable without performing
9166 .It Va mimetypes-load-control
9167 Can be used to control which of
9168 .Sx "The mime.types files"
9169 are loaded: if the letter
9171 is part of the option value, then the user's personal
9173 file will be loaded (if it exists); likewise the letter
9175 controls loading of the system wide
9176 .Pa /etc/mime.types ;
9177 directives found in the user file take precedence, letter matching is
9179 If this variable is not set \*(UA will try to load both files.
9180 Incorporation of the \*(UA-built-in MIME types cannot be suppressed,
9181 but they will be matched last (the order can be listed via
9184 More sources can be specified by using a different syntax: if the
9185 value string contains an equals sign
9187 then it is instead parsed as a comma-separated list of the described
9190 pairs; the given filenames will be expanded and loaded, and their
9191 content may use the extended syntax that is described in the section
9192 .Sx "The mime.types files" .
9193 Directives found in such files always take precedence (are prepended to
9194 the MIME type cache).
9199 To choose an alternate Mail-Transfer-Agent, set this option to either
9200 the full pathname of an executable (optionally prefixed with a
9202 protocol indicator), or \*(OPally a SMTP protocol URL, e.g., \*(IN
9204 .Dl smtps?://[user[:password]@]server[:port]
9207 .Ql [smtp://]server[:port] . )
9208 The default has been chosen at compile time.
9209 All supported data transfers are executed in child processes, which
9210 run asynchronously and without supervision unless either the
9215 If such a child receives a TERM signal, it will abort and
9222 For a file-based MTA it may be necessary to set
9224 in in order to choose the right target of a modern
9227 It will be passed command line arguments from several possible sources:
9230 if set, from the command line if given and the variable
9233 Argument processing of the MTA will be terminated with a
9238 The otherwise occurring implicit usage of the following MTA command
9239 line arguments can be disabled by setting the boolean variable
9240 .Va mta-no-default-arguments
9241 (which will also disable passing
9245 (for not treating a line with only a dot
9247 character as the end of input),
9255 variable is set); in conjunction with the
9257 command line option \*(UA will also (not) pass
9263 \*(OPally \*(UA can send mail over SMTP network connections to a single
9264 defined SMTP smart host by specifying a SMTP URL as the value (see
9265 .Sx "On URL syntax and credential lookup" ) .
9266 Note that with some mail providers it may be necessary to set the
9268 variable in order to use a specific combination of
9273 \*(UA also supports forwarding of all network traffic over a specified
9275 The following SMTP variants may be used:
9279 The plain SMTP protocol (RFC 5321) that normally lives on the
9280 server port 25 and requires setting the
9281 .Va smtp-use-starttls
9282 variable to enter a SSL/TLS encrypted session state.
9283 Assign a value like \*(IN
9284 .Ql smtp://[user[:password]@]server[:port]
9286 .Ql smtp://server[:port] )
9287 to choose this protocol.
9289 The so-called SMTPS which is supposed to live on server port 465
9290 and is automatically SSL/TLS secured.
9291 Unfortunately it never became a standardized protocol and may thus not
9292 be supported by your hosts network service database
9293 \(en in fact the port number has already been reassigned to other
9296 SMTPS is nonetheless a commonly offered protocol and thus can be
9297 chosen by assigning a value like \*(IN
9298 .Ql smtps://[user[:password]@]server[:port]
9300 .Ql smtps://server[:port] ) ;
9301 due to the mentioned problems it is usually necessary to explicitly
9306 Finally there is the SUBMISSION protocol (RFC 6409), which usually
9307 lives on server port 587 and is practically identically to the SMTP
9308 protocol from \*(UA's point of view beside that; it requires setting the
9309 .Va smtp-use-starttls
9310 variable to enter a SSL/TLS secured session state.
9311 Assign a value like \*(IN
9312 .Ql submission://[user[:password]@]server[:port]
9314 .Ql submission://server[:port] ) .
9319 .It Va mta-arguments
9320 Arguments to pass through to a file-based
9322 can be given via this variable, which is parsed according to
9323 .Sx "Shell-style argument quoting"
9324 into an array of arguments, and which will be joined onto MTA options
9325 from other sources, and then passed individually to the MTA:
9326 .Ql ? wysh set mta-arguments='-t -X \&"/tmp/my log\&"' .
9329 .It Va mta-no-default-arguments
9330 \*(BO Unless this variable is set \*(UA will pass some well known
9331 standard command line options to a file-based
9333 (Mail-Transfer-Agent), see there for more.
9337 Many systems use a so-called
9339 environment to ensure compatibility with
9341 This works by inspecting the name that was used to invoke the mail
9343 If this variable is set then the mailwrapper (the program that is
9344 actually executed when calling the file-based
9346 will treat its contents as that name.
9349 .It Va netrc-lookup-USER@HOST , netrc-lookup-HOST , netrc-lookup
9350 \*(BO\*(IN\*(OP Used to control usage of the users
9352 file for lookup of account credentials, as documented in the section
9353 .Sx "On URL syntax and credential lookup"
9357 .Sx "The .netrc file"
9358 documents the file format.
9370 then \*(UA will read the output of a shell pipe instead of the users
9372 file if this variable is set (to the desired shell command).
9373 This can be used to, e.g., store
9376 .Ql ? set netrc-pipe='gpg -qd ~/.netrc.pgp' .
9380 If this variable has the value
9382 newly created local folders will be in Maildir instead of MBOX format.
9386 Checks for new mail in the current folder each time the prompt is shown.
9387 A Maildir folder must be re-scanned to determine if new mail has arrived.
9388 If this variable is set to the special value
9390 then a Maildir folder will not be rescanned completely, but only
9391 timestamp changes are detected.
9395 \*(BO Causes the filename given in the
9398 and the sender-based filenames for the
9402 commands to be interpreted relative to the directory given in the
9404 variable rather than to the current directory,
9405 unless it is set to an absolute pathname.
9408 .It Va on-compose-cleanup
9409 Macro hook which will be called after the message has been sent (or not,
9410 in case of failures), as the very last step before unrolling compose mode
9412 This hook is run even in case of fatal errors, and it is advisable to
9413 perform only absolutely necessary actions, like cleaning up
9416 For compose mode hooks that may affect the message content please see
9417 .Va on-compose-enter , on-compose-leave , on-compose-splice .
9418 \*(ID This hook exists only because
9419 .Ic alias , alternates , commandalias , shortcut ,
9420 to name a few, are currently not covered by
9422 or a similar mechanism: any changes applied in compose mode will
9423 continue to be in effect thereafter.
9427 .It Va on-compose-enter , on-compose-leave
9428 Macro hooks which will be called before compose mode is entered,
9429 and after composing has been finished (but before the
9431 is injected, etc.), respectively.
9433 are enabled for these hooks, causing any setting to be forgotten after
9434 the message has been sent;
9435 .Va on-compose-cleanup
9436 can be used to perform any other necessary cleanup.
9437 The following (read-only) variables will be set temporarily during
9438 execution of the macros to represent the according message headers, or
9439 the empty string for non-existent; they correspond to accoding virtual
9440 temporary message headers that can be accessed via
9443 .Sx "COMMAND ESCAPES" :
9445 .Bl -tag -compact -width ".It Va mailx_subject"
9446 .It Va mailx-command
9447 The command that generates the message.
9448 .It Va mailx-subject
9454 .It Va mailx-to , mailx-cc , mailx-bcc
9455 The list of receiver addresses as a space-separated list.
9456 .It Va mailx-raw-to , mailx-raw-cc , mailx-raw-bcc
9457 The list of receiver addresses before any mangling (due to, e.g.,
9460 .Va recipients-in-cc )
9461 as a space-separated list.
9462 .It Va mailx-orig-from
9463 When replying, forwarding or resending, this will be set to the
9465 of the given message.
9466 .It Va mailx-orig-to , mailx-orig-cc , mailx-orig-bcc
9467 When replying, forwarding or resending, this will be set to the
9468 receivers of the given message.
9474 .It Va on-compose-splice , on-compose-splice-shell
9475 These hooks run once the normal compose mode is finished, but before the
9476 .Va on-compose-leave
9477 macro hook is called, the
9480 Both hooks will be executed in a subprocess, with their input and output
9481 connected to \*(UA such that they can act as if they would be an
9483 The difference in between them is that the latter is a
9485 command, whereas the former is a normal \*(UA macro, but which is
9486 restricted to a small set of commands (the
9490 will indicate said capability).
9492 are enabled for these hooks (in the parent process), causing any setting
9493 to be forgotten after the message has been sent;
9494 .Va on-compose-cleanup
9495 can be used to perform other cleanup as necessary.
9498 During execution of these hooks \*(UA will temporarily forget whether it
9499 has been started in interactive mode, (a restricted set of)
9500 .Sx "COMMAND ESCAPES"
9501 will always be available, and for guaranteed reproducibilities sake
9505 will be set to their defaults.
9506 The compose mode command
9508 has been especially designed for scriptability (via these hooks).
9509 The first line the hook will read on its standard input is the protocol
9510 version of said command escape, currently
9512 backward incompatible protocol changes have to be expected.
9515 Care must be taken to avoid deadlocks and other false control flow:
9516 if both involved processes wait for more input to happen at the
9517 same time, or one does not expect more input but the other is stuck
9518 waiting for consumption of its output, etc.
9519 There is no automatic synchronization of the hook: it will not be
9520 stopped automatically just because it, e.g., emits
9522 The hooks will however receive a termination signal if the parent enters
9524 \*(ID Protection against and interaction with signals is not yet given;
9525 it is likely that in the future these scripts will be placed in an
9526 isolated session, which is signalled in its entirety as necessary.
9528 .Bd -literal -offset indent
9529 wysh set on-compose-splice-shell=$'\e
9531 printf "hello $version! Headers: ";\e
9532 echo \e'~^header list\e';\e
9533 read status result;\e
9534 echo "status=$status result=$result";\e
9537 set on-compose-splice=ocsm
9540 echo Splice protocol version is $ver
9541 echo '~^h l'; read hl; vput vexpr es substring "${hl}" 0 1
9543 echoerr 'Cannot read header list'; echo '~x'; xit
9545 if [ "$hl" @i!% ' cc' ]
9546 echo '~^h i cc Diet is your <mirr.or>'; read es;\e
9547 vput vexpr es substring "${es}" 0 1
9549 echoerr 'Cannot insert Cc: header'; echo '~x'
9557 .It Va on-resend-cleanup
9559 .Va on-compose-cleanup ,
9560 but is only triggered by
9564 .It Va on-resend-enter
9566 .Va on-compose-enter ,
9567 but is only triggered by
9572 \*(BO If set, each message feed through the command given for
9574 is followed by a formfeed character
9578 .It Va password-USER@HOST , password-HOST , password
9579 \*(IN Variable chain that sets a password, which is used in case none has
9580 been given in the protocol and account-specific URL;
9581 as a last resort \*(UA will ask for a password on the user's terminal if
9582 the authentication method requires a password.
9583 Specifying passwords in a startup file is generally a security risk;
9584 the file should be readable by the invoking user only.
9586 .It Va password-USER@HOST
9587 \*(OU (see the chain above for \*(IN)
9588 Set the password for
9592 If no such variable is defined for a host,
9593 the user will be asked for a password on standard input.
9594 Specifying passwords in a startup file is generally a security risk;
9595 the file should be readable by the invoking user only.
9599 \*(BO Send messages to the
9601 command without performing MIME and character set conversions.
9605 .It Va pipe-TYPE/SUBTYPE
9606 When a MIME message part of type
9608 (case-insensitive) is displayed or quoted,
9609 its text is filtered through the value of this variable interpreted as
9611 Note that only parts which can be displayed inline as plain text (see
9613 are displayed unless otherwise noted, other MIME parts will only be
9614 considered by and for the command
9618 The special value commercial at
9620 forces interpretation of the message part as plain text, e.g.,
9621 .Ql set pipe-application/xml=@
9622 will henceforth display XML
9624 (The same could also be achieved by adding a MIME type marker with the
9627 And \*(OPally MIME type handlers may be defined via
9628 .Sx "The Mailcap files"
9629 \(em these directives,
9631 has already been used, should be referred to for further documentation.
9636 can in fact be used as a trigger character to adjust usage and behaviour
9637 of a following shell command specification more thoroughly by appending
9638 more special characters which refer to further mailcap directives, e.g.,
9639 the following hypothetical command specification could be used:
9641 .Bd -literal -offset indent
9642 ? set pipe-X/Y='@!++=@vim ${MAILX_FILENAME_TEMPORARY}'
9646 .Bl -tag -compact -width ".It Ql __"
9648 The command produces plain text to be integrated in \*(UAs output:
9652 If set the handler will not be invoked when a message is to be quoted,
9653 but only when it will be displayed:
9654 .Cd x-mailx-noquote .
9657 Run the command asynchronously, i.e., without blocking \*(UA:
9661 The command must be run on an interactive terminal, \*(UA will
9662 temporarily release the terminal to it:
9666 Request creation of a zero-sized temporary file, the absolute pathname
9667 of which will be made accessible via the environment variable
9668 .Ev MAILX_FILENAME_TEMPORARY :
9669 .Cd x-mailx-tmpfile .
9670 If given twice then the file will be unlinked automatically by \*(UA
9671 when the command loop is entered again at latest:
9672 .Cd x-mailx-tmpfile-unlink .
9675 Normally the MIME part content is passed to the handler via standard
9676 input; if this flag is set then the data will instead be written into
9677 .Ev MAILX_FILENAME_TEMPORARY
9678 .Pf ( Cd x-mailx-tmpfile-fill ) ,
9679 the creation of which is implied; note however that in order to cause
9680 deletion of the temporary file you still have to use two plus signs
9685 To avoid ambiguities with normal shell command content you can use
9686 another commercial at to forcefully terminate interpretation of
9687 remaining characters.
9688 (Any character not in this list will have the same effect.)
9692 Some information about the MIME part to be displayed is embedded into
9693 the environment of the shell command:
9696 .Bl -tag -compact -width ".It Ev _AIL__ILENAME__ENERATED"
9698 .It Ev MAILX_CONTENT
9699 The MIME content-type of the part, if known, the empty string otherwise.
9702 .It Ev MAILX_CONTENT_EVIDENCE
9704 .Va mime-counter-evidence
9705 includes the carry-around-bit (2), then this will be set to the detected
9706 MIME content-type; not only then identical to
9707 .Ev \&\&MAILX_CONTENT
9711 .It Ev MAILX_FILENAME
9712 The filename, if any is set, the empty string otherwise.
9715 .It Ev MAILX_FILENAME_GENERATED
9719 .It Ev MAILX_FILENAME_TEMPORARY
9720 If temporary file creation has been requested through the command prefix
9721 this variable will be set and contain the absolute pathname of the
9727 .It Va pipe-EXTENSION
9728 This is identical to
9729 .Va pipe-TYPE/SUBTYPE
9732 (normalized to lowercase using character mappings of the ASCII charset)
9733 names a file extension, e.g.,
9735 Handlers registered using this method take precedence.
9738 .It Va pop3-auth-USER@HOST , pop3-auth-HOST , pop3-auth
9739 \*(OP\*(IN Variable chain that sets the POP3 authentication method.
9740 The only possible value as of now is
9742 which is thus the default.
9745 .Mx Va pop3-bulk-load
9746 .It Va pop3-bulk-load-USER@HOST , pop3-bulk-load-HOST , pop3-bulk-load
9747 \*(BO\*(OP When accessing a POP3 server \*(UA loads the headers of
9748 the messages, and only requests the message bodies on user request.
9749 For the POP3 protocol this means that the message headers will be
9751 If this variable is set then \*(UA will download only complete messages
9752 from the given POP3 server(s) instead.
9754 .Mx Va pop3-keepalive
9755 .It Va pop3-keepalive-USER@HOST , pop3-keepalive-HOST , pop3-keepalive
9756 \*(OP POP3 servers close the connection after a period of inactivity;
9757 the standard requires this to be at least 10 minutes,
9758 but practical experience may vary.
9759 Setting this variable to a numeric value greater than
9763 command to be sent each value seconds if no other operation is performed.
9766 .It Va pop3-no-apop-USER@HOST , pop3-no-apop-HOST , pop3-no-apop
9767 \*(BO\*(OP Unless this variable is set the
9769 authentication method will be used when connecting to a POP3 server that
9773 is that the password is not sent in clear text over the wire and that
9774 only a single packet is sent for the user/password tuple.
9776 .Va pop3-no-apop-HOST
9779 .Mx Va pop3-use-starttls
9780 .It Va pop3-use-starttls-USER@HOST , pop3-use-starttls-HOST , pop3-use-starttls
9781 \*(BO\*(OP Causes \*(UA to issue a
9783 command to make an unencrypted POP3 session SSL/TLS encrypted.
9784 This functionality is not supported by all servers,
9785 and is not used if the session is already encrypted by the POP3S method.
9787 .Va pop3-use-starttls-HOST
9793 \*(BO This flag enables POSIX mode, which changes behaviour of \*(UA
9794 where that deviates from standardized behaviour.
9795 It will be set implicitly before the
9796 .Sx "Resource files"
9797 are loaded if the environment variable
9799 is set, and adjusting any of those two will be reflected by the other
9801 The following behaviour is covered and enforced by this mechanism:
9804 .Bl -bullet -compact
9806 In non-interactive mode, any error encountered while loading resource
9807 files during program startup will cause a program exit, whereas in
9808 interactive mode such errors will stop loading of the currently loaded
9809 (stack of) file(s, i.e., recursively).
9810 These exits can be circumvented on a per-command base by using
9813 .Sx "Command modifiers" ,
9814 for each command which shall be allowed to fail.
9818 will replace the list of alternate addresses instead of appending to it.
9821 Upon changing the active
9825 will be displayed even if
9832 implies the behaviour described by
9838 is extended to cover any empty mailbox, not only empty
9840 .Sx "primary system mailbox" Ns
9841 es: they will be removed when they are left in empty state otherwise.
9846 .It Va print-alternatives
9847 \*(BO When a MIME message part of type
9848 .Ql multipart/alternative
9849 is displayed and it contains a subpart of type
9851 other parts are normally discarded.
9852 Setting this variable causes all subparts to be displayed,
9853 just as if the surrounding part was of type
9854 .Ql multipart/mixed .
9858 The string used as a prompt in interactive mode.
9859 Whenever the variable is evaluated the value is expanded as via
9860 dollar-single-quote expansion (see
9861 .Sx "Shell-style argument quoting" ) .
9862 This (post-assignment, i.e., second) expansion can be used to embed
9863 status information, for example
9868 .Va mailbox-display .
9870 In order to embed characters which should not be counted when
9871 calculating the visual width of the resulting string, enclose the
9872 characters of interest in a pair of reverse solidus escaped brackets:
9874 a slot for coloured prompts is also available with the \*(OPal command
9876 Prompting may be prevented by setting this to the null string
9878 .Ql set noprompt ) .
9882 This string is used for secondary prompts, but is otherwise identical to
9889 \*(BO Suppresses the printing of the version when first invoked.
9893 If set, \*(UA starts a replying message with the original message
9894 prefixed by the value of the variable
9896 Normally, a heading consisting of
9897 .Dq Fromheaderfield wrote:
9898 is put before the quotation.
9903 variable, this heading is omitted.
9906 is assigned, only the headers selected by the
9909 selection are put above the message body,
9912 acts like an automatic
9914 .Sx "COMMAND ESCAPES"
9918 is assigned, all headers are put above the message body and all MIME
9919 parts are included, making
9921 act like an automatic
9924 .Va quote-as-attachment .
9927 .It Va quote-as-attachment
9928 \*(BO Add the original message in its entirety as a
9930 MIME attachment when replying to a message.
9931 Note this works regardless of the setting of
9936 \*(OP Can be set in addition to
9938 Setting this turns on a more fancy quotation algorithm in that leading
9939 quotation characters are compressed and overlong lines are folded.
9941 can be set to either one or two (space separated) numeric values,
9942 which are interpreted as the maximum (goal) and the minimum line length,
9943 respectively, in a spirit rather equal to the
9945 program, but line-, not paragraph-based.
9946 If not set explicitly the minimum will reflect the goal algorithmically.
9947 The goal cannot be smaller than the length of
9949 plus some additional pad.
9950 Necessary adjustments take place silently.
9953 .It Va r-option-implicit
9954 \*(BO Setting this option evaluates the contents of
9956 (or, if that contains multiple addresses,
9958 and passes the results onto the used (file-based) MTA as described for the
9960 option (empty argument case).
9963 .It Va recipients-in-cc
9970 are by default merged into the new
9972 If this variable is set, only the original
9976 the rest is merged into
9981 Unless this variable is defined, no copies of outgoing mail will be saved.
9982 If defined it gives the pathname, subject to the usual
9983 .Sx "Filename transformations" ,
9984 of a folder where all new, replied-to or forwarded messages are saved:
9985 when saving to this folder fails the message is not sent, but instead
9989 The standard defines that relative (fully expanded) paths are to be
9990 interpreted relative to the current directory
9992 to force interpretation relative to
9995 needs to be set in addition.
9999 \*(BO If this variable is set the meaning of
10001 will be extended to cover messages which target only file and pipe
10004 These address types will not appear in recipient lists unless
10005 .Va add-file-recipients
10009 .It Va record-resent
10010 \*(BO If this variable is set the meaning of
10012 will be extended to also cover the
10019 .It Va reply-in-same-charset
10020 \*(BO If this variable is set \*(UA first tries to use the same
10021 character set of the original message for replies.
10022 If this fails, the mechanism described in
10023 .Sx "Character sets"
10024 is evaluated as usual.
10027 .It Va reply-strings
10028 Can be set to a comma-separated list of (case-insensitive according to
10029 ASCII rules) strings which shall be recognized in addition to the
10030 built-in strings as
10032 reply message indicators \(en built-in are
10034 which is mandated by RFC 5322, as well as the german
10039 which often has been seen in the wild;
10040 I.e., the separating colon has to be specified explicitly.
10044 A list of addresses to put into the
10046 field of the message header.
10047 Members of this list are handled as if they were in the
10052 .It Va reply-to-honour
10055 header is honoured when replying to a message via
10059 This is a quadoption; if set without a value it defaults to
10063 .It Va rfc822-body-from_
10064 \*(BO This variable can be used to force displaying a so-called
10066 line for messages that are embedded into an envelope mail via the
10068 MIME mechanism, for more visual convenience.
10072 \*(BO Enable saving of (partial) messages in
10074 upon interrupt or delivery error.
10078 The number of lines that represents a
10087 line display and scrolling via
10089 If this variable is not set \*(UA falls back to a calculation based upon
10090 the detected terminal window size and the baud rate: the faster the
10091 terminal, the more will be shown.
10092 Overall screen dimensions and pager usage is influenced by the
10093 environment variables
10101 .It Va searchheaders
10102 \*(BO Expand message-list specifiers in the form
10104 to all messages containing the substring
10106 in the header field
10108 The string search is case insensitive.
10111 .It Va sendcharsets
10112 \*(OP A comma-separated list of character set names that can be used in
10113 outgoing internet mail.
10114 The value of the variable
10116 is automatically appended to this list of character sets.
10117 If no character set conversion capabilities are compiled into \*(UA then
10118 the only supported charset is
10121 .Va sendcharsets-else-ttycharset
10122 and refer to the section
10123 .Sx "Character sets"
10124 for the complete picture of character set conversion in \*(UA.
10127 .It Va sendcharsets-else-ttycharset
10128 \*(BO\*(OP If this variable is set, but
10130 is not, then \*(UA acts as if
10132 had been set to the value of the variable
10134 In effect this combination passes through the message data in the
10135 character set of the current locale encoding:
10136 therefore mail message text will be (assumed to be) in ISO-8859-1
10137 encoding when send from within a ISO-8859-1 locale, and in UTF-8
10138 encoding when send from within an UTF-8 locale.
10142 never comes into play as
10144 is implicitly assumed to be 8-bit and capable to represent all files the
10145 user may specify (as is the case when no character set conversion
10146 support is available in \*(UA and the only supported character set is
10148 .Sx "Character sets" ) .
10149 This might be a problem for scripts which use the suggested
10151 setting, since in this case the character set is US-ASCII by definition,
10152 so that it is better to also override
10158 An address that is put into the
10160 field of outgoing messages, quoting RFC 5322: the mailbox of the agent
10161 responsible for the actual transmission of the message.
10162 This field should normally not be used unless the
10164 field contains more than one address, on which case it is required.
10167 address is handled as if it were in the
10171 .Va r-option-implicit .
10174 \*(OB Predecessor of
10177 .It Va sendmail-arguments
10178 \*(OB Predecessor of
10179 .Va mta-arguments .
10181 .It Va sendmail-no-default-arguments
10182 \*(OB\*(BO Predecessor of
10183 .Va mta-no-default-arguments .
10185 .It Va sendmail-progname
10186 \*(OB Predecessor of
10191 \*(BO When sending a message wait until the
10193 (including the built-in SMTP one) exits before accepting further commands.
10195 with this variable set errors reported by the MTA will be recognizable!
10196 If the MTA returns a non-zero exit status,
10197 the exit status of \*(UA will also be non-zero.
10201 \*(BO This setting causes \*(UA to start at the last message
10202 instead of the first one when opening a mail folder.
10206 \*(BO Causes \*(UA to use the sender's real name instead of the plain
10207 address in the header field summary and in message specifications.
10211 \*(BO Causes the recipient of the message to be shown in the header
10212 summary if the message was sent by the user.
10216 The string to expand
10219 .Sx "COMMAND ESCAPES" ) .
10223 The string to expand
10226 .Sx "COMMAND ESCAPES" ) .
10230 Must correspond to the name of a readable file if set.
10231 The file's content is then appended to each singlepart message
10232 and to the first part of each multipart message.
10233 Be warned that there is no possibility to edit the signature for an
10234 individual message.
10237 .It Va skipemptybody
10238 \*(BO If an outgoing message does not contain any text in its first or
10239 only message part, do not send it but discard it silently (see also the
10240 command line option
10245 .It Va smime-ca-dir , smime-ca-file
10246 \*(OP Specify the location of trusted CA certificates in PEM (Privacy
10247 Enhanced Mail) format as a directory and a file, respectively, for the
10248 purpose of verification of S/MIME signed messages.
10249 It is possible to set both, the file will be loaded immediately, the
10250 directory will be searched whenever no match has yet been found.
10251 The set of CA certificates which are built into the SSL/TLS library can
10252 be explicitly turned off by setting
10253 .Va smime-ca-no-defaults ,
10254 and further fine-tuning is possible via
10255 .Va smime-ca-flags .
10258 .It Va smime-ca-flags
10259 \*(OP Can be used to fine-tune behaviour of the X509 CA certificate
10260 storage, and the certificate verification that is used.
10261 The actual values and their meanings are documented for
10265 .It Va smime-ca-no-defaults
10266 \*(BO\*(OP Do not load the default CA locations that are built into the
10267 used to SSL/TLS library to verify S/MIME signed messages.
10269 .Mx Va smime-cipher
10270 .It Va smime-cipher-USER@HOST , smime-cipher
10271 \*(OP Specifies the cipher to use when generating S/MIME encrypted
10272 messages (for the specified account).
10273 RFC 5751 mandates a default of
10276 Possible values are (case-insensitive and) in decreasing cipher strength:
10284 (DES EDE3 CBC, 168 bits; default if
10286 is not available) and
10288 (DES CBC, 56 bits).
10290 The actually available cipher algorithms depend on the cryptographic
10291 library that \*(UA uses.
10292 \*(OP Support for more cipher algorithms may be available through
10293 dynamic loading via, e.g.,
10294 .Xr EVP_get_cipherbyname 3
10295 (OpenSSL) if \*(UA has been compiled to support this.
10298 .It Va smime-crl-dir
10299 \*(OP Specifies a directory that contains files with CRLs in PEM format
10300 to use when verifying S/MIME messages.
10303 .It Va smime-crl-file
10304 \*(OP Specifies a file that contains a CRL in PEM format to use when
10305 verifying S/MIME messages.
10308 .It Va smime-encrypt-USER@HOST
10309 \*(OP If this variable is set, messages send to the given receiver are
10310 encrypted before sending.
10311 The value of the variable must be set to the name of a file that
10312 contains a certificate in PEM format.
10314 If a message is sent to multiple recipients,
10315 each of them for whom a corresponding variable is set will receive an
10316 individually encrypted message;
10317 other recipients will continue to receive the message in plain text
10319 .Va smime-force-encryption
10321 It is recommended to sign encrypted messages, i.e., to also set the
10326 .It Va smime-force-encryption
10327 \*(BO\*(OP Causes \*(UA to refuse sending unencrypted messages.
10331 \*(BO\*(OP S/MIME sign outgoing messages with the user's private key
10332 and include the user's certificate as a MIME attachment.
10333 Signing a message enables a recipient to verify that the sender used
10334 a valid certificate,
10335 that the email addresses in the certificate match those in the message
10336 header and that the message content has not been altered.
10337 It does not change the message text,
10338 and people will be able to read the message as usual.
10340 .Va smime-sign-cert , smime-sign-include-certs
10342 .Va smime-sign-message-digest .
10344 .Mx Va smime-sign-cert
10345 .It Va smime-sign-cert-USER@HOST , smime-sign-cert
10346 \*(OP Points to a file in PEM format.
10347 For the purpose of signing and decryption this file needs to contain the
10348 user's private key, followed by his certificate.
10350 For message signing
10352 is always derived from the value of
10354 (or, if that contains multiple addresses,
10356 For the purpose of encryption the recipient's public encryption key
10357 (certificate) is expected; the command
10359 can be used to save certificates of signed messages (the section
10360 .Sx "Signed and encrypted messages with S/MIME"
10361 gives some details).
10362 This mode of operation is usually driven by the specialized form.
10364 When decrypting messages the account is derived from the recipient
10369 of the message, which are searched for addresses for which such
10371 \*(UA always uses the first address that matches,
10372 so if the same message is sent to more than one of the user's addresses
10373 using different encryption keys, decryption might fail.
10375 For signing and decryption purposes it is possible to use encrypted
10376 keys, and the pseudo-host(s)
10377 .Ql USER@HOST.smime-cert-key
10378 for the private key
10380 .Ql USER@HOST.smime-cert-cert
10381 for the certificate stored in the same file)
10382 will be used for performing any necessary password lookup,
10383 therefore the lookup can be automatized via the mechanisms described in
10384 .Sx "On URL syntax and credential lookup" .
10385 For example, the hypothetical address
10387 could be driven with a private key / certificate pair path defined in
10388 .Va \&\&smime-sign-cert-bob@exam.ple ,
10389 and needed passwords would then be looked up via the pseudo hosts
10390 .Ql bob@exam.ple.smime-cert-key
10392 .Ql bob@exam.ple.smime-cert-cert ) .
10393 To include intermediate certificates, use
10394 .Va smime-sign-include-certs .
10396 .Mx Va smime-sign-include-certs
10397 .It Va smime-sign-include-certs-USER@HOST , smime-sign-include-certs
10398 \*(OP If used, this is supposed to a consist of a comma-separated list
10399 of files, each of which containing a single certificate in PEM format to
10400 be included in the S/MIME message in addition to the
10401 .Va smime-sign-cert
10403 This can be used to include intermediate certificates of the certificate
10404 authority, in order to allow the receiver's S/MIME implementation to
10405 perform a verification of the entire certificate chain, starting from
10406 a local root certificate, over the intermediate certificates, down to the
10407 .Va smime-sign-cert .
10408 Even though top level certificates may also be included in the chain,
10409 they won't be used for the verification on the receiver's side.
10411 For the purpose of the mechanisms involved here,
10413 refers to the content of the internal variable
10415 (or, if that contains multiple addresses,
10418 .Ql USER@HOST.smime-include-certs
10419 will be used for performing password lookups for these certificates,
10420 shall they have been given one, therefore the lookup can be automatized
10421 via the mechanisms described in
10422 .Sx "On URL syntax and credential lookup" .
10424 .Mx Va smime-sign-message-digest
10425 .It Va smime-sign-message-digest-USER@HOST , smime-sign-message-digest
10426 \*(OP Specifies the message digest to use when signing S/MIME messages.
10427 RFC 5751 mandates a default of
10429 Possible values are (case-insensitive and) in decreasing cipher strength:
10437 The actually available message digest algorithms depend on the
10438 cryptographic library that \*(UA uses.
10439 \*(OP Support for more message digest algorithms may be available
10440 through dynamic loading via, e.g.,
10441 .Xr EVP_get_digestbyname 3
10442 (OpenSSL) if \*(UA has been compiled to support this.
10443 Remember that for this
10445 refers to the variable
10447 (or, if that contains multiple addresses,
10451 \*(OB\*(OP To use the built-in SMTP transport, specify a SMTP URL in
10453 \*(ID For compatibility reasons a set
10455 is used in preference of
10459 .It Va smtp-auth-USER@HOST , smtp-auth-HOST , smtp-auth
10460 \*(OP Variable chain that controls the SMTP
10462 authentication method, possible values are
10468 as well as the \*(OPal methods
10474 method does not need any user credentials,
10476 requires a user name and all other methods require a user name and
10484 .Va smtp-auth-password
10486 .Va smtp-auth-user ) .
10491 .Va smtp-auth-USER@HOST :
10492 may override dependent on sender address in the variable
10495 .It Va smtp-auth-password
10496 \*(OP\*(OU Sets the global fallback password for SMTP authentication.
10497 If the authentication method requires a password, but neither
10498 .Va smtp-auth-password
10500 .Va smtp-auth-password-USER@HOST
10502 \*(UA will ask for a password on the user's terminal.
10504 .It Va smtp-auth-password-USER@HOST
10506 .Va smtp-auth-password
10507 for specific values of sender addresses, dependent upon the variable
10510 .It Va smtp-auth-user
10511 \*(OP\*(OU Sets the global fallback user name for SMTP authentication.
10512 If the authentication method requires a user name, but neither
10515 .Va smtp-auth-user-USER@HOST
10517 \*(UA will ask for a user name on the user's terminal.
10519 .It Va smtp-auth-user-USER@HOST
10522 for specific values of sender addresses, dependent upon the variable
10526 .It Va smtp-hostname
10527 \*(OP\*(IN Normally \*(UA uses the variable
10529 to derive the necessary
10531 information in order to issue a
10538 can be used to use the
10540 from the SMTP account
10547 from the content of this variable (or, if that is the empty string,
10549 or the local hostname as a last resort).
10550 This often allows using an address that is itself valid but hosted by
10551 a provider other than which (in
10553 is about to send the message.
10554 Setting this variable also influences generated
10560 .Mx Va smtp-use-starttls
10561 .It Va smtp-use-starttls-USER@HOST , smtp-use-starttls-HOST , smtp-use-starttls
10562 \*(BO\*(OP Causes \*(UA to issue a
10564 command to make an SMTP
10566 session SSL/TLS encrypted, i.e., to enable transport layer security.
10569 .It Va socks-proxy-USER@HOST , socks-proxy-HOST , socks-proxy
10570 \*(OP If this is set to the hostname (SOCKS URL) of a SOCKS5 server then
10571 \*(UA will proxy all of its network activities through it.
10572 This can be used to proxy SMTP, POP3 etc. network traffic through the
10573 Tor anonymizer, for example.
10574 The following would create a local SOCKS proxy on port 10000 that
10575 forwards to the machine
10577 and from which the network traffic is actually instantiated:
10578 .Bd -literal -offset indent
10579 # Create local proxy server in terminal 1 forwarding to HOST
10580 $ ssh -D 10000 USER@HOST
10581 # Then, start a client that uses it in terminal 2
10582 $ \*(uA -Ssocks-proxy-USER@HOST=localhost:10000
10586 .It Va spam-interface
10587 \*(OP In order to use any of the spam-related commands (like, e.g.,
10589 the desired spam interface must be defined by setting this variable.
10590 Please refer to the manual section
10591 .Sx "Handling spam"
10592 for the complete picture of spam handling in \*(UA.
10593 All or none of the following interfaces may be available:
10595 .Bl -tag -width ".It Ql _ilte_"
10601 .Pf ( Lk http://spamassassin.apache.org SpamAssassin )
10603 Different to the generic filter interface \*(UA will automatically add
10604 the correct arguments for a given command and has the necessary
10605 knowledge to parse the program's output.
10606 A default value for
10608 will have been compiled into the \*(UA binary if
10612 during compilation.
10613 Shall it be necessary to define a specific connection type (rather than
10614 using a configuration file for that), the variable
10615 .Va spamc-arguments
10616 can be used as in, e.g.,
10617 .Ql -d server.example.com -p 783 .
10618 It is also possible to specify a per-user configuration via
10620 Note that this interface does not inspect the
10622 flag of a message for the command
10626 generic spam filter support via freely configurable hooks.
10627 This interface is meant for programs like
10629 and requires according behaviour in respect to the hooks' exit
10630 status for at least the command
10633 meaning a message is spam,
10637 for unsure and any other return value indicating a hard error);
10638 since the hooks can include shell code snippets diverting behaviour
10639 can be intercepted as necessary.
10641 .Va spamfilter-ham , spamfilter-noham , spamfilter-nospam , \
10644 .Va spamfilter-spam ;
10646 .Sx "Handling spam"
10647 contains examples for some programs.
10648 The process environment of the hooks will have the variable
10649 .Ev MAILX_FILENAME_GENERATED
10651 Note that spam score support for
10653 is not supported unless the \*(OPtional regular expression support is
10655 .Va spamfilter-rate-scanscore
10661 .It Va spam-maxsize
10662 \*(OP Messages that exceed this size will not be passed through to the
10664 .Va spam-interface .
10665 If unset or 0, the default of 420000 bytes is used.
10668 .It Va spamc-command
10669 \*(OP The path to the
10673 .Va spam-interface .
10674 Note that the path is not expanded, but used
10676 A fallback path will have been compiled into the \*(UA binary if the
10677 executable had been found during compilation.
10680 .It Va spamc-arguments
10681 \*(OP Even though \*(UA deals with most arguments for the
10684 automatically, it may at least sometimes be desirable to specify
10685 connection-related ones via this variable, e.g.,
10686 .Ql -d server.example.com -p 783 .
10690 \*(OP Specify a username for per-user configuration files for the
10692 .Va spam-interface .
10693 If this is set to the empty string then \*(UA will use the name of the
10702 .It Va spamfilter-ham , spamfilter-noham , \
10703 spamfilter-nospam , spamfilter-rate , spamfilter-spam
10704 \*(OP Command and argument hooks for the
10706 .Va spam-interface .
10708 .Sx "Handling spam"
10709 contains examples for some programs.
10712 .It Va spamfilter-rate-scanscore
10713 \*(OP Because of the generic nature of the
10716 spam scores are not supported for it by default, but if the \*(OPnal
10717 regular expression support is available then setting this variable can
10718 be used to overcome this restriction.
10719 It is interpreted as follows: first a number (digits) is parsed that
10720 must be followed by a semicolon
10722 and an extended regular expression.
10723 Then the latter is used to parse the first output line of the
10724 .Va spamfilter-rate
10725 hook, and, in case the evaluation is successful, the group that has been
10726 specified via the number is interpreted as a floating point scan score.
10730 .It Va ssl-ca-dir , ssl-ca-file
10731 \*(OP Specify the location of trusted CA certificates in PEM (Privacy
10732 Enhanced Mail) format as a directory and a file, respectively, for the
10733 purpose of verification of SSL/TLS server certificates.
10734 It is possible to set both, the file will be loaded immediately, the
10735 directory will be searched whenever no match has yet been found.
10736 The set of CA certificates which are built into the SSL/TLS library can
10737 be explicitly turned off by setting
10738 .Va ssl-ca-no-defaults ,
10739 and further fine-tuning is possible via
10742 .Xr SSL_CTX_load_verify_locations 3
10743 for more information.
10744 \*(UA will try to use the TLS/SNI (ServerNameIndication) extension when
10745 establishing TLS connections to servers identified with hostnames.
10749 .It Va ssl-ca-flags
10750 \*(OP Can be used to fine-tune behaviour of the X509 CA certificate
10751 storage, and the certificate verification that is used (also see
10753 The value is expected to consist of a comma-separated list of
10754 configuration directives, with any intervening whitespace being ignored.
10755 The directives directly map to flags that can be passed to
10756 .Xr X509_STORE_set_flags 3 ,
10757 which are usually defined in a file
10758 .Pa openssl/x509_vfy.h ,
10759 and the availability of which depends on the used SSL/TLS library
10760 version: a directive without mapping is ignored (error log subject to
10762 Directives currently understood (case-insensitively) include:
10765 .Bl -tag -compact -width ".It Cd BaNg"
10766 .It Cd no-alt-chains
10767 If the initial chain is not trusted, do not attempt to build an
10769 Setting this flag will make OpenSSL certificate verification match that
10770 of older OpenSSL versions, before automatic building and checking of
10771 alternative chains has been implemented; also see
10772 .Cd trusted-first .
10773 .It Cd no-check-time
10774 Do not check certificate/CRL validity against current time.
10775 .It Cd partial-chain
10776 By default partial, incomplete chains which cannot be verified up to the
10777 chain top, a self-signed root certificate, will not verify.
10778 With this flag set, a chain succeeds to verify if at least one signing
10779 certificate of the chain is in any of the configured trusted stores of
10781 The OpenSSL manual page
10782 .Xr SSL_CTX_load_verify_locations 3
10783 gives some advise how to manage your own trusted store of CA certificates.
10785 Disable workarounds for broken certificates.
10786 .It Cd trusted-first
10787 Try building a chain using issuers in the trusted store first to avoid
10788 problems with server-sent legacy intermediate certificates.
10789 Newer versions of OpenSSL support alternative chain checking and enable
10790 it by default, resulting in the same behaviour; also see
10791 .Cd no-alt-chains .
10796 .It Va ssl-ca-no-defaults
10797 \*(BO\*(OP Do not load the default CA locations that are built into the
10798 used to SSL/TLS library to verify SSL/TLS server certificates.
10801 .It Va ssl-cert-USER@HOST , ssl-cert-HOST , ssl-cert
10802 \*(OP Variable chain that sets the filename for a SSL/TLS client
10803 certificate required by some servers.
10804 This is a direct interface to the
10808 function of the OpenSSL library, if available.
10810 .Mx Va ssl-cipher-list
10811 .It Va ssl-cipher-list-USER@HOST , ssl-cipher-list-HOST , ssl-cipher-list
10812 \*(OP Specifies a list of ciphers for SSL/TLS connections.
10813 This is a direct interface to the
10817 function of the OpenSSL library, if available; see
10820 .Xr SSL_CTX_set_cipher_list 3
10821 for more information.
10822 By default \*(UA does not set a list of ciphers, in effect using a
10824 specific cipher (protocol standards ship with a list of acceptable
10825 ciphers), possibly cramped to what the actually used SSL/TLS library
10826 supports \(en the manual section
10827 .Sx "An example configuration"
10828 also contains a SSL/TLS use case.
10831 .It Va ssl-config-file
10832 \*(OP If this variable is set \*(UA will call
10833 .Xr CONF_modules_load_file 3
10834 to allow OpenSSL to be configured according to the host system wide
10836 If a non-empty value is given then this will be used to specify the
10837 configuration file to be used instead of the global OpenSSL default;
10838 note that in this case it is an error if the file cannot be loaded.
10839 The application name will always be passed as
10843 .It Va ssl-curves-USER@HOST , ssl-curves-HOST , ssl-curves
10844 \*(OP Specifies a list of supported curves for SSL/TLS connections.
10845 This is a direct interface to the
10849 function of the OpenSSL library, if available; see
10850 .Xr SSL_CTX_set1_curves_list 3
10851 for more information.
10852 By default \*(UA does not set a list of curves.
10856 .It Va ssl-crl-dir , ssl-crl-file
10857 \*(OP Specify a directory / a file, respectively that contains a CRL in
10858 PEM format to use when verifying SSL/TLS server certificates.
10861 .It Va ssl-key-USER@HOST , ssl-key-HOST , ssl-key
10862 \*(OP Variable chain that sets the filename for the private key of
10863 a SSL/TLS client certificate.
10864 If unset, the name of the certificate file is used.
10865 The file is expected to be in PEM format.
10866 This is a direct interface to the
10870 function of the OpenSSL library, if available.
10872 .It Va ssl-method-USER@HOST , ssl-method-HOST , ssl-method
10873 \*(OB\*(OP Please use the newer and more flexible
10875 instead: if both values are set,
10877 will take precedence!
10878 Can be set to the following values, the actually used
10880 specification to which it is mapped is shown in parenthesis:
10882 .Pf ( Ql -ALL, TLSv1.2 ) ,
10884 .Pf ( Ql -ALL, TLSv1.1 ) ,
10886 .Pf ( Ql -ALL, TLSv1 )
10889 .Pf ( Ql -ALL, SSLv3 ) ;
10894 and thus includes the SSLv3 protocol.
10895 Note that SSLv2 is no longer supported at all.
10897 .Mx Va ssl-protocol
10898 .It Va ssl-protocol-USER@HOST , ssl-protocol-HOST , ssl-protocol
10899 \*(OP Specify the used SSL/TLS protocol.
10900 This is a direct interface to the
10904 function of the OpenSSL library, if available;
10905 otherwise an \*(UA internal parser is used which understands the
10906 following subset of (case-insensitive) command strings:
10912 as well as the special value
10914 Multiple specifications may be given via a comma-separated list which
10915 ignores any whitespace.
10918 plus sign prefix will enable a protocol, a
10920 hyphen-minus prefix will disable it, so that
10922 will enable only the TLSv1.2 protocol.
10924 It depends upon the used TLS/SSL library which protocols are actually
10925 supported and which protocols are used if
10927 is not set, but note that SSLv2 is no longer supported at all and
10929 Especially for older protocols explicitly securing
10930 .Va ssl-cipher-list
10931 may be worthwile, see
10932 .Sx "An example configuration" .
10935 .It Va ssl-rand-egd
10936 \*(OP Gives the pathname to an entropy daemon socket, see
10938 Not all SSL/TLS libraries support this.
10941 .It Va ssl-rand-file
10942 \*(OP Gives the filename to a file with random entropy data, see
10943 .Xr RAND_load_file 3 .
10944 If this variable is not set, or set to the empty string, or if the
10945 .Sx "Filename transformations"
10947 .Xr RAND_file_name 3
10948 will be used to create the filename if, and only if,
10950 documents that the SSL PRNG is not yet sufficiently seeded.
10951 If \*(UA successfully seeded the SSL PRNG then it will update the file
10952 .Pf ( Xr RAND_write_file 3 ) .
10953 This variable is only used if
10955 is not set (or not supported by the SSL/TLS library).
10958 .It Va ssl-verify-USER@HOST , ssl-verify-HOST , ssl-verify
10959 \*(OP Variable chain that sets the action to be performed if an error
10960 occurs during SSL/TLS server certificate validation against the
10961 specified or default trust stores
10964 or the SSL/TLS library built-in defaults (unless usage disallowed via
10965 .Va ssl-ca-no-defaults ) ,
10966 and as fine-tuned via
10968 Valid (case-insensitive) values are
10970 (fail and close connection immediately),
10972 (ask whether to continue on standard input),
10974 (show a warning and continue),
10976 (do not perform validation).
10982 If only set without an assigned value, then this setting inhibits the
10988 header fields that include obvious references to \*(UA.
10989 There are two pitfalls associated with this:
10990 First, the message id of outgoing messages is not known anymore.
10991 Second, an expert may still use the remaining information in the header
10992 to track down the originating mail user agent.
10993 If set to the value
10999 suppression does not occur.
11004 (\*(OP) This specifies a comma-separated list of
11009 .Sx "On terminal control and line editor" ,
11010 escape commas with reverse solidus) to be used to overwrite or define
11013 this variable will only be queried once at program startup and can
11014 thus only be specified in resource files or on the command line.
11017 String capabilities form
11019 pairs and are expected unless noted otherwise.
11020 Numerics have to be notated as
11022 where the number is expected in normal decimal notation.
11023 Finally, booleans do not have any value but indicate a true or false
11024 state simply by being defined or not; this indeed means that \*(UA
11025 does not support undefining an existing boolean.
11026 String capability values will undergo some expansions before use:
11027 for one notations like
11030 .Ql control-LETTER ,
11031 and for clarification purposes
11033 can be used to specify
11035 (the control notation
11037 could lead to misreadings when a left bracket follows, which it does for
11038 the standard CSI sequence);
11039 finally three letter octal sequences, as in
11042 To specify that a terminal supports 256-colours, and to define sequences
11043 that home the cursor and produce an audible bell, one might write:
11045 .Bd -literal -offset indent
11046 ? set termcap='Co#256,home=\eE[H,bel=^G'
11050 The following terminal capabilities are or may be meaningful for the
11051 operation of the built-in line editor or \*(UA in general:
11054 .Bl -tag -compact -width ".It Cd yay"
11056 .It Cd colors Ns \0or Cd Co
11058 numeric capability specifying the maximum number of colours.
11059 Note that \*(UA does not actually care about the terminal beside that,
11060 but always emits ANSI / ISO 6429 escape sequences.
11063 .It Cd rmcup Ns \0or Cd te Ns \0/ Cd smcup Ns \0or Cd ti
11066 .Cd enter_ca_mode ,
11067 respectively: exit and enter the alternative screen ca-mode,
11068 effectively turning \*(UA into a fullscreen application.
11069 This must be enabled explicitly by setting
11070 .Va termcap-ca-mode .
11072 .It Cd smkx Ns \0or Cd ks Ns \0/ Cd rmkx Ns \0or Cd ke
11076 respectively: enable and disable the keypad.
11077 This is always enabled if available, because it seems even keyboards
11078 without keypads generate other key codes for, e.g., cursor keys in that
11079 case, and only if enabled we see the codes that we are interested in.
11081 .It Cd ed Ns \0or Cd cd
11085 .It Cd clear Ns \0or Cd cl
11087 clear the screen and home cursor.
11088 (Will be simulated via
11093 .It Cd home Ns \0or Cd ho
11098 .It Cd el Ns \0or Cd ce
11100 clear to the end of line.
11101 (Will be simulated via
11103 plus repetitions of space characters.)
11105 .It Cd hpa Ns \0or Cd ch
11106 .Cd column_address :
11107 move the cursor (to the given column parameter) in the current row.
11108 (Will be simulated via
11114 .Cd carriage_return :
11115 move to the first column in the current row.
11116 The default built-in fallback is
11119 .It Cd cub1 Ns \0or Cd le
11121 move the cursor left one space (non-destructively).
11122 The default built-in fallback is
11125 .It Cd cuf1 Ns \0or Cd nd
11127 move the cursor right one space (non-destructively).
11128 The default built-in fallback is
11130 which is used by most terminals.
11138 Many more capabilities which describe key-sequences are documented for
11143 .It Va termcap-ca-mode
11144 \*(OP Allow usage of the
11148 terminal capabilities, effectively turning \*(UA into a fullscreen
11149 application, as documented for
11152 this variable will only be queried once at program startup and can
11153 thus only be specified in resource files or on the command line.
11156 .It Va termcap-disable
11157 \*(OP Disable any interaction with a terminal control library.
11158 If set only some generic fallback built-ins and possibly the content of
11160 describe the terminal to \*(UA.
11162 this variable will only be queried once at program startup and can
11163 thus only be specified in resource files or on the command line.
11167 If defined, gives the number of lines of a message to be displayed
11170 if unset, the first five lines are printed, if set to 0 the variable
11173 If the value is negative then its absolute value will be used for
11174 unsigned right shifting (see
11182 \*(BO If set then the
11184 command series will strip adjacent empty lines and quotations.
11188 The character set of the terminal \*(UA operates on,
11189 and the one and only supported character set that \*(UA can use if no
11190 character set conversion capabilities have been compiled into it,
11191 in which case it defaults to ISO-8859-1 unless it can deduce a value
11192 from the locale specified in the
11194 environment variable (if supported, see there for more).
11195 It defaults to UTF-8 if conversion is available.
11196 Refer to the section
11197 .Sx "Character sets"
11198 for the complete picture about character sets.
11201 .It Va typescript-mode
11202 \*(BO A special multiplex variable that disables all variables and
11203 settings which result in behaviour that interferes with running \*(UA in
11206 .Va colour-disable ,
11207 .Va line-editor-disable
11208 and (before startup completed only)
11209 .Va termcap-disable .
11210 Unsetting it does not restore the former state of the covered settings.
11214 For a safety-by-default policy \*(UA sets its process
11218 but this variable can be used to override that:
11219 set it to an empty value to do not change the (current) setting (on
11220 startup), otherwise the process file mode creation mask is updated to
11222 Child processes inherit the process file mode creation mask.
11225 .It Va user-HOST , user
11226 \*(IN Variable chain that sets a global fallback user name, which is
11227 used in case none has been given in the protocol and account-specific
11229 This variable defaults to the name of the user who runs \*(UA.
11233 \*(BO Setting this enables upward compatibility with \*(UA
11234 version 15.0 in respect to which configuration options are available and
11235 how they are handled.
11236 This manual uses \*(IN and \*(OU to refer to the new and the old way of
11237 doing things, respectively.
11241 \*(BO This setting, also controllable via the command line option
11243 causes \*(UA to be more verbose, e.g., it will display obsoletion
11244 warnings and SSL/TLS certificate chains.
11245 Even though marked \*(BO this option may be set twice in order to
11246 increase the level of verbosity even more, in which case even details of
11247 the actual message delivery and protocol conversations are shown.
11250 is sufficient to disable verbosity as such.
11257 .It Va version , version-date , version-major , version-minor , version-update
11258 \*(RO \*(UA version information: the first variable contains a string
11259 containing the complete version identification, the latter three contain
11260 only digits: the major, minor and update version numbers.
11261 The date is in ISO 8601 notation.
11262 The output of the command
11264 will include this information.
11267 .It Va writebackedited
11268 If this variable is set messages modified using the
11272 commands are written back to the current folder when it is quit;
11273 it is only honoured for writable folders in MBOX format, though.
11274 Note that the editor will be pointed to the raw message content in that
11275 case, i.e., neither MIME decoding nor decryption will have been
11276 performed, and proper RFC 4155
11278 quoting of newly added or edited content is also left as an excercise to
11281 .\" }}} (Variables)
11283 .\" }}} (INTERNAL VARIABLES)
11286 .\" .Sh ENVIRONMENT {{{
11290 .Dq environment variable
11291 should be considered an indication that these variables are either
11292 standardized as vivid parts of process environments, or that they are
11293 commonly found in there.
11294 The process environment is inherited from the
11296 once \*(UA is started, and unless otherwise explicitly noted handling of
11297 the following variables transparently integrates into that of the
11298 .Sx "INTERNAL VARIABLES"
11299 from \*(UA's point of view.
11300 This means that, e.g., they can be managed via
11304 causing automatic program environment updates (to be inherited by
11305 newly created child processes).
11308 In order to transparently integrate other environment variables equally
11309 they need to be imported (linked) with the command
11311 This command can also be used to set and unset non-integrated
11312 environment variables from scratch, sufficient system support provided.
11313 The following example, applicable to a POSIX shell, sets the
11315 environment variable for \*(UA only, and beforehand exports the
11317 in order to affect any further processing in the running shell:
11319 .Bd -literal -offset indent
11320 $ EDITOR="vim -u ${HOME}/.vimrc"
11322 $ COLUMNS=80 \*(uA -R
11325 .Bl -tag -width ".It Ev BaNg"
11328 The user's preferred width in column positions for the terminal screen
11330 Queried and used once on program startup, actively managed for child
11331 processes and the MLE (see
11332 .Sx "On terminal control and line editor" )
11333 in interactive mode thereafter.
11334 Ignored in non-interactive mode, which always uses 80 columns, unless in
11340 The name of the (mailbox)
11342 to use for saving aborted messages if
11344 is set; this defaults to
11351 is set no output will be generated, otherwise the contents of the file
11356 Pathname of the text editor to use in the
11360 .Sx "COMMAND ESCAPES" .
11361 A default editor is used if this value is not defined.
11365 The user's home directory.
11366 This variable is only used when it resides in the process environment.
11367 The calling user's home directory will be used instead if this directory
11368 does not exist, is not accessible or cannot be read.
11369 (No test for being writable is performed to allow usage by
11370 non-privileged users within read-only jails, but dependent on the
11371 variable settings this directory is a default write target, e.g. for
11379 .It Ev LC_ALL , LC_CTYPE , LANG
11380 \*(OP The (names in lookup order of the)
11384 which indicates the used
11385 .Sx "Character sets" .
11386 Runtime changes trigger automatic updates of the entire locale system,
11387 updating and overwriting also a
11393 The user's preferred number of lines on a page or the vertical screen
11394 or window size in lines.
11395 Queried and used once on program startup, actively managed for child
11396 processes in interactive mode thereafter.
11397 Ignored in non-interactive mode, which always uses 24 lines, unless in
11403 Pathname of the directory lister to use in the
11405 command when operating on local mailboxes.
11408 (path search through
11413 Upon startup \*(UA will actively ensure that this variable refers to the
11414 name of the user who runs \*(UA, in order to be able to pass a verified
11415 name to any newly created child process.
11419 Is used as the users
11421 .Sx "primary system mailbox"
11425 This is assumed to be an absolute pathname.
11429 \*(OP Overrides the default path search for
11430 .Sx "The Mailcap files" ,
11431 which is defined in the standard RFC 1524 as
11432 .Ql ~/.mailcap:\:/etc/mailcap:\:/usr/etc/mailcap:\:/usr/local/etc/mailcap .
11433 .\" TODO we should have a mailcaps-default virtual RDONLY option!
11434 (\*(UA makes it a configuration option, however.)
11435 Note this is not a search path, but a path search.
11439 Is used as a startup file instead of
11442 When \*(UA scripts are invoked on behalf of other users,
11443 either this variable should be set to
11447 command line option should be used in order to avoid side-effects from
11448 reading their configuration files.
11449 This variable is only used when it resides in the process environment.
11452 .It Ev MAILX_NO_SYSTEM_RC
11453 If this variable is set then reading of
11455 at startup is inhibited, i.e., the same effect is achieved as if \*(UA
11456 had been started up with the option
11458 (and according argument) or
11460 This variable is only used when it resides in the process environment.
11464 The name of the users
11466 .Sx "secondary mailbox"
11468 A logical subset of the special
11469 .Sx "Filename transformations"
11475 Traditionally this MBOX is used as the file to save messages from the
11477 .Sx "primary system mailbox"
11478 that have been read.
11480 .Sx "Message states" .
11484 \*(IN\*(OP This variable overrides the default location of the user's
11490 Pathname of the program to use for backing the command
11494 variable enforces usage of a pager for output.
11495 The default paginator is
11497 (path search through
11500 \*(UA inspects the contents of this variable: if its contains the string
11502 then a non-existing environment variable
11509 dependent on whether terminal control support is available and whether
11510 that supports full (alternative) screen mode or not (also see
11511 .Sx "On terminal control and line editor" ) .
11515 will optionally be set to
11522 A colon-separated list of directories that is searched by the shell when
11523 looking for commands, e.g.,
11524 .Ql /bin:/usr/bin:/usr/local/bin .
11527 .It Ev POSIXLY_CORRECT
11528 This variable is automatically looked for upon startup, see
11534 The shell to use for the commands
11539 .Sx "COMMAND ESCAPES"
11540 and when starting subprocesses.
11541 A default shell is used if this environment variable is not defined.
11544 .It Ev SOURCE_DATE_EPOCH
11545 This specifies a time in seconds since the Unix epoch (1970-01-01) to be
11546 used in place of the current time.
11547 This variable is looked up upon program startup, and its existence will
11548 switch \*(UA to a completely reproducible mode which causes
11549 deterministic random numbers, a special fixed (non-existent?)
11551 and more to be used and set.
11552 It is to be used during development or by software packagers.
11553 \*(ID Currently an invalid setting is only ignored, rather than causing
11554 a program abortion.
11556 .Dl $ SOURCE_DATE_EPOCH=`date +%s` \*(uA
11560 \*(OP The terminal type for which output is to be prepared.
11561 For extended colour and font control please refer to
11562 .Sx "Coloured display" ,
11563 and for terminal management in general to
11564 .Sx "On terminal control and line editor" .
11568 Used as directory for temporary files instead of
11570 if set, existent, accessible as well as read- and writable.
11571 This variable is only used when it resides in the process environment,
11572 but \*(UA will ensure at startup that this environment variable is
11573 updated to contain a usable temporary directory.
11579 (see there), but this variable is not standardized, should therefore not
11580 be used, and is only corrected if already set.
11584 Pathname of the text editor to use in the
11588 .Sx "COMMAND ESCAPES" .
11598 .Bl -tag -width ".It Pa BaNg"
11600 File giving initial commands, one of the
11601 .Sx "Resource files" .
11604 System wide initialization file, one of the
11605 .Sx "Resource files" .
11609 \*(OP Personal MIME type handler definition file, see
11610 .Sx "The Mailcap files" .
11611 This location is part of the RFC 1524 standard search path, which is
11612 a configuration option and can be overridden via
11616 .It Pa /etc/mailcap
11617 \*(OP System wide MIME type handler definition file, see
11618 .Sx "The Mailcap files" .
11619 This location is part of the RFC 1524 standard search path, which is
11620 a configuration option and can be overridden via
11624 The default value for
11626 The actually used path is a configuration option.
11629 .It Pa ~/.mime.types
11630 Personal MIME types, see
11631 .Sx "The mime.types files" .
11632 The actually used path is a configuration option.
11635 .It Pa /etc/mime.types
11636 System wide MIME types, see
11637 .Sx "The mime.types files" .
11638 The actually used path is a configuration option.
11642 \*(IN\*(OP The default location of the users
11644 file \(en the section
11645 .Sx "The .netrc file"
11646 documents the file format.
11647 The actually used path is a configuration option and can be overridden via
11654 The actually used path is a compile-time constant.
11658 .\" .Ss "Resource files" {{{
11659 .Ss "Resource files"
11661 Upon startup \*(UA reads in several resource files:
11663 .Bl -tag -width ".It Pa BaNg"
11666 System wide initialization file.
11667 Reading of this file can be suppressed, either by using the
11669 (and according argument) or
11671 command line options, or by setting the
11674 .Ev MAILX_NO_SYSTEM_RC .
11678 File giving initial commands.
11679 A different file can be chosen by setting the
11683 Reading of this file can be suppressed with the
11685 command line option.
11687 .It Va mailx-extra-rc
11688 Defines a startup file to be read after all other resource files.
11689 It can be used to specify settings that are not understood by other
11691 implementations, for example.
11692 This variable is only honoured when defined in a resource file, e.g.,
11694 .Sx "INTERNAL VARIABLES" .
11698 The content of these files is interpreted as follows:
11701 .Bl -bullet -compact
11703 The whitespace characters space, tabulator and newline,
11704 as well as those defined by the variable
11706 are removed from the beginning and end of input lines.
11708 Empty lines are ignored.
11710 Any other line is interpreted as a command.
11711 It may be spread over multiple input lines if the newline character is
11713 by placing a reverse solidus character
11715 as the last character of the line; whereas any leading whitespace of
11716 follow lines is ignored, trailing whitespace before a escaped newline
11717 remains in the input.
11719 If the line (content) starts with the number sign
11721 then it is a comment-command and also ignored.
11722 (The comment-command is a real command, which does nothing, and
11723 therefore the usual follow lines mechanism applies!)
11727 Unless \*(UA is about to enter interactive mode syntax errors that occur
11728 while loading these files are treated as errors and cause program exit.
11729 More files with syntactically equal content can be
11731 The following, saved in a file, would be an examplary content:
11733 .Bd -literal -offset indent
11734 # This line is a comment command. And y\e
11735 es, it is really continued here.
11742 .\" .Ss "The mime.types files" {{{
11743 .Ss "The mime.types files"
11746 .Sx "HTML mail and MIME attachments"
11747 \*(UA needs to learn about MIME (Multipurpose Internet Mail Extensions)
11748 media types in order to classify message and attachment content.
11749 One source for them are
11751 files, the loading of which can be controlled by setting the variable
11752 .Va mimetypes-load-control .
11753 Another is the command
11755 which also offers access to \*(UAs MIME type cache.
11757 files have the following syntax:
11759 .Bd -literal -offset indent
11760 type/subtype extension [extension ...]
11761 # E.g., text/html html htm
11767 define the MIME media type, as standardized in RFC 2046:
11769 is used to declare the general type of data, while the
11771 specifies a specific format for that type of data.
11772 One or multiple filename
11774 s, separated by whitespace, can be bound to the media type format.
11775 Comments may be introduced anywhere on a line with a number sign
11777 causing the remaining line to be discarded.
11779 \*(UA also supports an extended, non-portable syntax in especially
11780 crafted files, which can be loaded via the alternative value syntax of
11781 .Va mimetypes-load-control ,
11782 and prepends an optional
11786 .Dl [type-marker ]type/subtype extension [extension ...]
11789 The following type markers are supported:
11792 .Bl -tag -compact -width ".It Ar _n_u"
11794 Treat message parts with this content as plain text.
11799 Treat message parts with this content as HTML tagsoup.
11800 If the \*(OPal HTML-tagsoup-to-text converter is not available treat
11801 the content as plain text instead.
11805 but instead of falling back to plain text require an explicit content
11806 handler to be defined.
11811 for sending messages:
11813 .Va mime-allow-text-controls ,
11814 .Va mimetypes-load-control .
11815 For reading etc. messages:
11816 .Sx "HTML mail and MIME attachments" ,
11817 .Sx "The Mailcap files" ,
11819 .Va mime-counter-evidence ,
11820 .Va mimetypes-load-control ,
11821 .Va pipe-TYPE/SUBTYPE ,
11822 .Va pipe-EXTENSION .
11825 .\" .Ss "The Mailcap files" {{{
11826 .Ss "The Mailcap files"
11828 .\" TODO MAILCAP DISABLED
11829 .Sy This feature is not available in v14.9.0, sorry!
11831 .Dq User Agent Configuration Mechanism
11832 which \*(UA \*(OPally supports (see
11833 .Sx "HTML mail and MIME attachments" ) .
11834 It defines a file format to be used to inform mail user agent programs
11835 about the locally-installed facilities for handling various data
11836 formats, i.e., about commands and how they can be used to display, edit
11837 et cetera MIME part contents, as well as a default path search that
11838 includes multiple possible locations of
11842 environment variable that can be used to overwrite that (repeating here
11843 that it is not a search path, but instead a path search specification).
11844 Any existing files will be loaded in sequence, appending any content to
11845 the list of MIME type handler directives.
11849 files consist of a set of newline separated entries.
11850 Comment lines start with a number sign
11852 (in the first column!) and are ignored.
11853 Empty lines are also ignored.
11854 All other lines form individual entries that must adhere to the syntax
11856 To extend a single entry (not comment) its line can be continued on
11857 follow lines if newline characters are
11859 by preceding them with the reverse solidus character
11861 The standard does not specify how leading whitespace of follow lines
11862 is to be treated, therefore \*(UA retains it.
11866 entries consist of a number of semicolon
11868 separated fields, and the reverse solidus
11870 character can be used to escape any following character including
11871 semicolon and itself.
11872 The first two fields are mandatory and must occur in the specified
11873 order, the remaining fields are optional and may appear in any order.
11874 Leading and trailing whitespace of content is ignored (removed).
11877 The first field defines the MIME
11879 the entry is about to handle (case-insensitively, and no reverse solidus
11880 escaping is possible in this field).
11881 If the subtype is specified as an asterisk
11883 the entry is meant to match all subtypes of the named type, e.g.,
11885 would match any audio type.
11886 The second field defines the shell command which shall be used to
11888 MIME parts of the given type; it is implicitly called the
11895 shell commands message (MIME part) data is passed via standard input
11896 unless the given shell command includes one or more instances of the
11899 in which case these instances will be replaced with a temporary filename
11900 and the data will have been stored in the file that is being pointed to.
11903 shell commands data is assumed to be generated on standard output unless
11904 the given command includes (one ore multiple)
11906 In any case any given
11908 format is replaced with a(n already) properly quoted filename.
11909 Note that when a command makes use of a temporary file via
11911 then \*(UA will remove it again, as if the
11912 .Cd x-mailx-tmpfile ,
11913 .Cd x-mailx-tmpfile-fill
11915 .Cd x-mailx-tmpfile-unlink
11916 flags had been set; see below for more.
11919 The optional fields either define a shell command or an attribute (flag)
11920 value, the latter being a single word and the former being a keyword
11921 naming the field followed by an equals sign
11923 succeeded by a shell command, and as usual for any
11925 content any whitespace surrounding the equals sign will be removed, too.
11926 Optional fields include the following:
11929 .Bl -tag -width ".It Cd BaNg"
11931 A program that can be used to compose a new body or body part in the
11933 (Currently unused.)
11935 .It Cd composetyped
11938 field, but is to be used when the composing program needs to specify the
11940 header field to be applied to the composed data.
11941 (Currently unused.)
11944 A program that can be used to edit a body or body part in the given
11946 (Currently unused.)
11949 A program that can be used to print a message or body part in the given
11951 (Currently unused.)
11954 Specifies a program to be run to test some condition, e.g., the machine
11955 architecture, or the window system in use, to determine whether or not
11956 this mailcap entry applies.
11957 If the test fails, a subsequent mailcap entry should be sought; also see
11958 .Cd x-mailx-test-once .
11961 .It Cd needsterminal
11962 This flag field indicates that the given shell command must be run on
11963 an interactive terminal.
11964 \*(UA will temporarily release the terminal to the given command in
11965 interactive mode, in non-interactive mode this entry will be entirely
11966 ignored; this flag implies
11967 .Cd x-mailx-noquote .
11970 .It Cd copiousoutput
11971 A flag field which indicates that the output of the
11973 command will be an extended stream of textual output that can be
11974 (re)integrated into \*(UA's normal visual display.
11975 It is mutually exclusive with
11976 .Cd needsterminal .
11978 .It Cd textualnewlines
11979 A flag field which indicates that this type of data is line-oriented and
11980 that, if encoded in
11982 all newlines should be converted to canonical form (CRLF) before
11983 encoding, and will be in that form after decoding.
11984 (Currently unused.)
11986 .It Cd nametemplate
11987 This field gives a filename format, in which
11989 will be replaced by a random string, the joined combination of which
11990 will be used as the filename denoted by
11991 .Ev MAILX_FILENAME_TEMPORARY .
11992 One could specify that a GIF file being passed to an image viewer should
11993 have a name ending in
11996 .Ql nametemplate=%s.gif .
11997 Note that \*(UA ignores the name template unless that solely specifies
11998 a filename suffix that consists of (ASCII) alphabetic and numeric
11999 characters, the underscore and dot only.
12002 Names a file, in X11 bitmap (xbm) format, which points to an appropriate
12003 icon to be used to visually denote the presence of this kind of data.
12004 This field is not used by \*(UA.
12007 A textual description that describes this type of data.
12010 .It Cd x-mailx-even-if-not-interactive
12011 An extension flag test field \(em by default handlers without
12013 are entirely ignored in non-interactive mode, but if this flag is set
12014 then their use will be considered.
12015 It is an error if this flag is set for commands that use the flag
12016 .Cd needsterminal .
12019 .It Cd x-mailx-noquote
12020 An extension flag field that indicates that even a
12023 command shall not be used to generate message quotes
12024 (as it would be by default).
12027 .It Cd x-mailx-async
12028 Extension flag field that denotes that the given
12030 command shall be executed asynchronously, without blocking \*(UA.
12031 Cannot be used in conjunction with
12032 .Cd needsterminal .
12035 .It Cd x-mailx-test-once
12036 Extension flag which denotes whether the given
12038 command shall be evaluated once only and the (boolean) result be cached.
12039 This is handy if some global unchanging condition is to be queried, like
12040 .Dq running under the X Window System .
12043 .It Cd x-mailx-tmpfile
12044 Extension flag field that requests creation of a zero-sized temporary
12045 file, the name of which is to be placed in the environment variable
12046 .Ev MAILX_FILENAME_TEMPORARY .
12047 It is an error to use this flag with commands that include a
12052 .It Cd x-mailx-tmpfile-fill
12053 Normally the MIME part content is passed to the handler via standard
12054 input; if this flag is set then the data will instead be written into
12056 .Cd x-mailx-tmpfile .
12057 In order to cause deletion of the temporary file you will have to set
12058 .Cd x-mailx-tmpfile-unlink
12060 It is an error to use this flag with commands that include a
12065 .It Cd x-mailx-tmpfile-unlink
12066 Extension flag field that requests that the temporary file shall be
12067 deleted automatically when the command loop is entered again at latest.
12068 (Do not use this for asynchronous handlers.)
12069 It is an error to use this flag with commands that include a
12071 format, or in conjunction with
12072 .Cd x-mailx-async ,
12073 or without also setting
12074 .Cd x-mailx-tmpfile
12076 .Cd x-mailx-tmpfile-fill .
12079 .It Cd x-mailx-tmpfile-keep
12082 implies the three tmpfile related flags above, but if you want, e.g.,
12084 and deal with the temporary file yourself, you can add in this flag to
12086 .Cd x-mailx-tmpfile-unlink .
12091 The standard includes the possibility to define any number of additional
12092 entry fields, prefixed by
12094 Flag fields apply to the entire
12096 entry \(em in some unusual cases, this may not be desirable, but
12097 differentiation can be accomplished via separate entries, taking
12098 advantage of the fact that subsequent entries are searched if an earlier
12099 one does not provide enough information.
12102 command needs to specify the
12106 command shall not, the following will help out the latter (with enabled
12110 level \*(UA will show information about handler evaluation):
12112 .Bd -literal -offset indent
12113 application/postscript; ps-to-terminal %s; needsterminal
12114 application/postscript; ps-to-terminal %s; compose=idraw %s
12118 In fields any occurrence of the format string
12120 will be replaced by the
12123 Named parameters from the
12125 field may be placed in the command execution line using
12127 followed by the parameter name and a closing
12130 The entire parameter should appear as a single command line argument,
12131 regardless of embedded spaces; thus:
12133 .Bd -literal -offset indent
12135 Content-type: multipart/mixed; boundary=42
12138 multipart/*; /usr/local/bin/showmulti \e
12139 %t %{boundary} ; composetyped = /usr/local/bin/makemulti
12141 # Executed shell command
12142 /usr/local/bin/showmulti multipart/mixed 42
12146 .\" TODO v15: Mailcap: %n,%F
12147 Note that \*(UA does not support handlers for multipart MIME parts as
12148 shown in this example (as of today).
12149 \*(UA does not support the additional formats
12153 An example file, also showing how to properly deal with the expansion of
12155 which includes any quotes that are necessary to make it a valid shell
12156 argument by itself and thus will cause undesired behaviour when placed
12157 in additional user-provided quotes:
12159 .Bd -literal -offset indent
12161 text/richtext; richtext %s; copiousoutput
12163 text/x-perl; perl -cWT %s
12165 application/pdf; \e
12167 trap "rm -f ${infile}" EXIT\e; \e
12168 trap "exit 75" INT QUIT TERM\e; \e
12170 x-mailx-async; x-mailx-tmpfile-keep
12172 application/*; echo "This is \e"%t\e" but \e
12173 is 50 \e% Greek to me" \e; < %s head -c 1024 | cat -vET; \e
12174 copiousoutput; x-mailx-noquote
12179 .Sx "HTML mail and MIME attachments" ,
12180 .Sx "The mime.types files" ,
12183 .Va mime-counter-evidence ,
12184 .Va pipe-TYPE/SUBTYPE ,
12185 .Va pipe-EXTENSION .
12188 .\" .Ss "The .netrc file" {{{
12189 .Ss "The .netrc file"
12193 file contains user credentials for machine accounts.
12194 The default location in the user's
12196 directory may be overridden by the
12198 environment variable.
12199 The file consists of space, tabulator or newline separated tokens.
12200 \*(UA implements a parser that supports a superset of the original BSD
12201 syntax, but users should nonetheless be aware of portability glitches
12202 of that file format, shall their
12204 be usable across multiple programs and platforms:
12207 .Bl -bullet -compact
12209 BSD does not support single, but only double quotation marks, e.g.,
12210 .Ql password="pass with spaces" .
12212 BSD (only?) supports escaping of single characters via a reverse solidus
12213 (e.g., a space can be escaped via
12215 in- as well as outside of a quoted string.
12217 BSD does not require a final quotation mark of the last user input token.
12219 The original BSD (Berknet) parser also supported a format which allowed
12220 tokens to be separated with commas \(en whereas at least Hewlett-Packard
12221 still seems to support this syntax, \*(UA does not!
12223 As a non-portable extension some widely-used programs support
12224 shell-style comments: if an input line starts, after any amount of
12225 whitespace, with a number sign
12227 then the rest of the line is ignored.
12229 Whereas other programs may require that the
12231 file is accessible by only the user if it contains a
12233 token for any other
12237 \*(UA will always require these strict permissions.
12241 Of the following list of supported tokens \*(UA only uses (and caches)
12246 At runtime the command
12248 can be used to control \*(UA's
12252 .Bl -tag -width ".It Cd BaNg"
12253 .It Cd machine Ar name
12254 The hostname of the entries' machine, lowercase-normalized by \*(UA
12256 Any further file content, until either end-of-file or the occurrence
12261 first-class token is bound (only related) to the machine
12264 As an extension that should not be the cause of any worries
12265 \*(UA supports a single wildcard prefix for
12267 .Bd -literal -offset indent
12268 machine *.example.com login USER password PASS
12269 machine pop3.example.com login USER password PASS
12270 machine smtp.example.com login USER password PASS
12276 .Ql pop3.example.com ,
12280 .Ql local.smtp.example.com .
12281 Note that in the example neither
12282 .Ql pop3.example.com
12284 .Ql smtp.example.com
12285 will be matched by the wildcard, since the exact matches take
12286 precedence (it is however faster to specify it the other way around).
12289 This is the same as
12291 except that it is a fallback entry that is used shall none of the
12292 specified machines match; only one default token may be specified,
12293 and it must be the last first-class token.
12295 .It Cd login Ar name
12296 The user name on the remote machine.
12298 .It Cd password Ar string
12299 The user's password on the remote machine.
12301 .It Cd account Ar string
12302 Supply an additional account password.
12303 This is merely for FTP purposes.
12305 .It Cd macdef Ar name
12307 A macro is defined with the specified
12309 it is formed from all lines beginning with the next line and continuing
12310 until a blank line is (consecutive newline characters are) encountered.
12313 entries cannot be utilized by multiple machines, too, but must be
12314 defined following the
12316 they are intended to be used with.)
12319 exists, it is automatically run as the last step of the login process.
12320 This is merely for FTP purposes.
12327 .\" .Sh EXAMPLES {{{
12330 .\" .Ss "An example configuration" {{{
12331 .Ss "An example configuration"
12333 .Bd -literal -offset indent
12334 # This example assumes v15.0 compatibility mode
12337 # Request strict transport security checks!
12338 set ssl-verify=strict
12340 # Where are the up-to-date SSL certificates?
12341 # (Since we manage up-to-date ones explicitly, do not use any,
12342 # possibly outdated, default certificates shipped with OpenSSL)
12343 #set ssl-ca-dir=/etc/ssl/certs
12344 set ssl-ca-file=/etc/ssl/certs/ca-certificates.crt
12345 set ssl-ca-no-defaults
12346 #set ssl-ca-flags=partial-chain
12347 wysh set smime-ca-file="${ssl-ca-file}" \e
12348 smime-ca-no-defaults #smime-ca-flags="${ssl-ca-flags}"
12350 # Do not use protocols older than TLS v1.2.
12351 # Change this only when the remote server does not support it:
12352 # maybe use ssl-protocol-HOST (or -USER@HOST) syntax to define
12353 # such explicit exceptions, then, e.g.
12354 # set ssl-protocol-exam.ple='-ALL,+TLSv1.1'
12355 set ssl-protocol='-ALL,+TLSv1.2'
12357 # Explicitly define the list of ciphers, which may improve security,
12358 # especially with protocols older than TLS v1.2. See ciphers(1).
12359 # Including "@STRENGTH" will sort the final list by algorithm strength.
12360 # In reality it is possibly best to only use ssl-cipher-list-HOST
12361 # (or -USER@HOST), as necessary, again..
12362 set ssl-cipher-list=TLSv1.2:!aNULL:!eNULL:@STRENGTH
12364 # - TLSv1.2:!aNULL:!eNULL:\e
12365 # ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:\e
12366 # DHE-RSA-AES256-SHA:@STRENGTH
12367 # -ALL:!aNULL:!eNULL:!MEDIUM:!LOW:!MD5:!RC4:!EXPORT:@STRENGTH
12368 # Especially with TLSv1.3 curves selection may be desired:
12369 #set ssl-curves=P-521:P-384:P-256
12371 # Essential setting: select allowed character sets
12372 set sendcharsets=utf-8,iso-8859-1
12374 # A very kind option: when replying to a message, first try to
12375 # use the same encoding that the original poster used herself!
12376 set reply-in-same-charset
12378 # When replying, do not merge From: and To: of the original message
12379 # into To:. Instead old From: -> new To:, old To: -> merge Cc:.
12380 set recipients-in-cc
12382 # When sending messages, wait until the Mail-Transfer-Agent finishs.
12383 # Only like this you will be able to see errors reported through the
12384 # exit status of the MTA (including the built-in SMTP one)!
12387 # Only use built-in MIME types, no mime.types(5) files
12388 set mimetypes-load-control
12390 # Default directory where we act in (relative to $HOME)
12392 # A leading "+" (often) means: under *folder*
12393 # *record* is used to save copies of sent messages
12394 set MBOX=+mbox.mbox DEAD=+dead.txt \e
12395 record=+sent.mbox record-files record-resent
12397 # Make "file mymbox" and "file myrec" go to..
12398 shortcut mymbox %:+mbox.mbox myrec +sent.mbox
12400 # Not really optional, e.g., for S/MIME
12401 set from='Your Name <address@exam.ple>'
12403 # It may be necessary to set hostname and/or smtp-hostname
12404 # if the "SERVER" of mta and "domain" of from do not match.
12405 # The `urlencode' command can be used to encode USER and PASS
12406 set mta=(smtps?|submission)://[USER[:PASS]@]SERVER[:PORT] \e
12407 smtp-auth=login/plain... \e
12410 # Never refuse to start into interactive mode, and more
12412 colour-pager crt= \e
12413 followup-to followup-to-honour=ask-yes \e
12414 history-file=+.\*(uAhist history-size=-1 history-gabby \e
12415 mime-counter-evidence=0xE \e
12416 prompt='?\e?!\e![\e${account}#\e${mailbox-display}]? ' \e
12417 reply-to-honour=ask-yes \e
12420 # Only include the selected header fields when typing messages
12421 headerpick type retain from_ date from to cc subject \e
12422 message-id mail-followup-to reply-to
12423 # ...when forwarding messages
12424 headerpick forward retain subject date from to cc
12425 # ...when saving message, etc.
12426 #headerpick save ignore ^Original-.*$ ^X-.*$
12428 # Some mailing lists
12429 mlist '@xyz-editor\e.xyz$' '@xyzf\e.xyz$'
12430 mlsubscribe '^xfans@xfans\e.xyz$'
12432 # Handle a few file extensions (to store MBOX databases)
12433 filetype bz2 'bzip2 -dc' 'bzip2 -zc' \e
12434 gz 'gzip -dc' 'gzip -c' xz 'xz -dc' 'xz -zc' \e
12435 zst 'zstd -dc' 'zstd -19 -zc' \e
12436 zst.pgp 'gpg -d | zstd -dc' 'zstd -19 -zc | gpg -e'
12438 # A real life example of a very huge free mail provider
12439 # Instead of directly placing content inside `account',
12440 # we `define' a macro: like that we can switch "accounts"
12441 # from within *on-compose-splice*, for example!
12443 set folder=~/spool/XooglX inbox=+syste.mbox sent=+sent
12444 set from='Your Name <address@examp.ple>'
12445 set mta=smtp://USER:PASS@smtp.gmXil.com smtp-use-starttls
12451 # Here is a pretty large one which does not allow sending mails
12452 # if there is a domain name mismatch on the SMTP protocol level,
12453 # which would bite us if the value of from does not match, e.g.,
12454 # for people who have a sXXXXeforge project and want to speak
12455 # with the mailing list under their project account (in from),
12456 # still sending the message through their normal mail provider
12458 set folder=~/spool/XandeX inbox=+syste.mbox sent=+sent
12459 set from='Your Name <address@exam.ple>'
12460 set mta=smtps://USER:PASS@smtp.yaXXex.ru:465 \e
12461 hostname=yaXXex.com smtp-hostname=
12467 # Create some new commands so that, e.g., `ls /tmp' will..
12468 commandalias lls '!ls ${LS_COLOR_FLAG} -aFlrS'
12469 commandalias llS '!ls ${LS_COLOR_FLAG} -aFlS'
12471 # We do not support gpg(1) directly yet. But simple --clearsign'd
12472 # message parts can be dealt with as follows:
12475 wysh set pipe-text/plain=$'@*#++=@\e
12476 < "${MAILX_FILENAME_TEMPORARY}" awk \e
12477 -v TMPFILE="${MAILX_FILENAME_TEMPORARY}" \e'\e
12479 /^-----BEGIN PGP SIGNED MESSAGE-----/,/^$/ {\e
12482 print "--- GPG --verify ---";\e
12483 system("gpg --verify " TMPFILE " 2>&1");\e
12484 print "--- GPG --verify ---";\e
12488 /^-----BEGIN PGP SIGNATURE-----/,\e
12489 /^-----END PGP SIGNATURE-----/{\e
12496 commandalias V '\e'call V
12500 When storing passwords in
12502 appropriate permissions should be set on this file with
12503 .Ql $ chmod 0600 \*(ur .
12506 is available user credentials can be stored in the central
12508 file instead; e.g., here is a different version of the example account
12509 that sets up SMTP and POP3:
12511 .Bd -literal -offset indent
12513 set folder=~/spool/XandeX inbox=+syste.mbox sent=+sent
12514 set from='Your Name <address@exam.ple>'
12516 # Load an encrypted ~/.netrc by uncommenting the next line
12517 #set netrc-pipe='gpg -qd ~/.netrc.pgp'
12519 set mta=smtps://smtp.yXXXXx.ru:465 \e
12520 smtp-hostname= hostname=yXXXXx.com
12521 set pop3-keepalive=240 pop3-no-apop-pop.yXXXXx.ru
12522 commandalias xp fi pop3s://pop.yXXXXx.ru
12534 .Bd -literal -offset indent
12535 machine *.yXXXXx.ru login USER password PASS
12539 This configuration should now work just fine:
12542 .Dl $ echo text | \*(uA -dvv -AXandeX -s Subject user@exam.ple
12545 .\" .Ss "S/MIME step by step" {{{
12546 .Ss "S/MIME step by step"
12548 \*(OP The first thing you need for participating in S/MIME message
12549 exchange is your personal certificate, including a private key.
12550 The certificate contains public information, in particular your name and
12551 your email address(es), and the public key that is used by others to
12552 encrypt messages for you,
12553 and to verify signed messages they supposedly received from you.
12554 The certificate is included in each signed message you send.
12555 The private key must be kept secret.
12556 It is used to decrypt messages that were previously encrypted with your
12557 public key, and to sign messages.
12560 For personal use it is recommended that you get a S/MIME certificate
12561 from one of the major CAs on the Internet using your WWW browser.
12562 Many CAs offer such certificates for free.
12564 .Lk https://www.CAcert.org
12565 which issues client and server certificates to members of their
12566 community for free; their root certificate
12567 .Pf ( Lk https://\:www.cacert.org/\:certs/\:root.crt )
12568 is often not in the default set of trusted CA root certificates, though,
12569 which means you will have to download their root certificate separately
12570 and ensure it is part of our S/MIME certificate validation chain by
12573 or as a vivid member of the
12574 .Va smime-ca-file .
12575 But let us take a step-by-step tour on how to setup S/MIME with
12576 a certificate from CAcert.org despite this situation!
12579 First of all you will have to become a member of the CAcert.org
12580 community, simply by registrating yourself via the web interface.
12581 Once you are, create and verify all email addresses you want to be able
12582 to create signed and encrypted messages for/with using the corresponding
12583 entries of the web interface.
12584 Now ready to create S/MIME certificates, so let us create a new
12585 .Dq client certificate ,
12586 ensure to include all email addresses that should be covered by the
12587 certificate in the following web form, and also to use your name as the
12591 Create a private key and a certificate request on your local computer
12592 (please see the manual pages of the used commands for more in-depth
12593 knowledge on what the used arguments etc. do):
12596 .Dl $ openssl req -nodes -newkey rsa:4096 -keyout key.pem -out creq.pem
12599 Afterwards copy-and-paste the content of
12601 into the certificate-request (CSR) field of the web form on the
12602 CAcert.org website (you may need to unfold some
12603 .Dq advanced options
12604 to see the corresponding text field).
12605 This last step will ensure that your private key (which never left your
12606 box) and the certificate belong together (through the public key that
12607 will find its way into the certificate via the certificate-request).
12608 You are now ready and can create your CAcert certified certificate.
12609 Download and store or copy-and-paste it as
12614 In order to use your new S/MIME setup a combined private key/public key
12615 (certificate) file has to be created:
12618 .Dl $ cat key.pem pub.crt > ME@HERE.com.paired
12621 This is the file \*(UA will work with.
12622 If you have created your private key with a passphrase then \*(UA will
12623 ask you for it whenever a message is signed or decrypted.
12624 Set the following variables to henceforth use S/MIME (setting
12626 is of interest for verification only):
12628 .Bd -literal -offset indent
12629 ? set smime-ca-file=ALL-TRUSTED-ROOT-CERTS-HERE \e
12630 smime-sign-cert=ME@HERE.com.paired \e
12631 smime-sign-message-digest=SHA256 \e
12637 .\" .Ss "Using CRLs with S/MIME or SSL/TLS" {{{
12638 .Ss "Using CRLs with S/MIME or SSL/TLS"
12640 \*(OP Certification authorities (CAs) issue certificate revocation
12641 lists (CRLs) on a regular basis.
12642 These lists contain the serial numbers of certificates that have been
12643 declared invalid after they have been issued.
12644 Such usually happens because the private key for the certificate has
12646 because the owner of the certificate has left the organization that is
12647 mentioned in the certificate, etc.
12648 To seriously use S/MIME or SSL/TLS verification,
12649 an up-to-date CRL is required for each trusted CA.
12650 There is otherwise no method to distinguish between valid and
12651 invalidated certificates.
12652 \*(UA currently offers no mechanism to fetch CRLs, nor to access them on
12653 the Internet, so they have to be retrieved by some external mechanism.
12656 \*(UA accepts CRLs in PEM format only;
12657 CRLs in DER format must be converted, like, e.\|g.:
12660 .Dl $ openssl crl \-inform DER \-in crl.der \-out crl.pem
12663 To tell \*(UA about the CRLs, a directory that contains all CRL files
12664 (and no other files) must be created.
12669 variables, respectively, must then be set to point to that directory.
12670 After that, \*(UA requires a CRL to be present for each CA that is used
12671 to verify a certificate.
12680 In general it is a good idea to turn on
12686 twice) if something does not work well.
12687 Very often a diagnostic message can be produced that leads to the
12688 problems' solution.
12690 .\" .Ss "\*(UA shortly hangs on startup" {{{
12691 .Ss "\*(UA shortly hangs on startup"
12693 This can have two reasons, one is the necessity to wait for a file lock
12694 and cannot be helped, the other being that \*(UA calls the function
12696 in order to query the nodename of the box (sometimes the real one is
12697 needed instead of the one represented by the internal variable
12699 One may have varying success by ensuring that the real hostname and
12703 or, more generally, that the name service is properly setup \(en
12706 return the expected value?
12707 Does this local hostname have a domain suffix?
12708 RFC 6762 standardized the link-local top-level domain
12710 try again after adding an (additional) entry with this extension.
12713 .\" .Ss "I cannot login to Google mail aka GMail" {{{
12714 .Ss "I cannot login to Google mail aka GMail"
12716 Since 2014 some free service providers classify programs as
12718 unless they use a special authentification method (OAuth 2.0) which
12719 was not standardized for non-HTTP protocol authentication token query
12720 until August 2015 (RFC 7628).
12723 Different to Kerberos / GSSAPI, which is developed since the mid of the
12724 1980s, where a user can easily create a local authentication ticket for
12725 her- and himself with the locally installed
12727 program, that protocol has no such local part but instead requires
12728 a world-wide-web query to create or fetch a token; since there is no
12729 local cache this query would have to be performed whenever \*(UA is
12730 invoked (in interactive sessions situation may differ).
12733 \*(UA does not support OAuth.
12734 Because of this it is necessary to declare \*(UA a
12735 .Dq less secure app
12736 (on the providers account web page) in order to read and send mail.
12737 However, it also seems possible to take the following steps instead:
12742 give the provider the number of a mobile phone,
12745 .Dq 2-Step Verification ,
12747 create an application specific password (16 characters), and
12749 use that special password instead of the real Google account password in
12750 \*(UA (for more on that see the section
12751 .Sx "On URL syntax and credential lookup" ) .
12755 .\" .Ss "Not \(dqdefunctional\(dq, but the editor key does not work" {{{
12756 .Ss "Not \(dqdefunctional\(dq, but the editor key does not work"
12758 It can happen that the terminal library (see
12759 .Sx "On terminal control and line editor",
12762 reports different codes than the terminal really sends, in which case
12763 \*(UA will tell that a key binding is functional, but will not be able to
12764 recognize it because the received data does not match anything expected.
12765 Especially without the \*(OPal terminal capability library support one
12766 reason for this may be that the (possibly even non-existing) keypad
12767 is not turned on and the resulting layout reports the keypad control
12768 codes for the normal keyboard keys.
12773 ings will show the byte sequences that are expected.
12776 To overcome the situation, use, e.g., the program
12778 in conjunction with the command line option
12780 if available, to see the byte sequences which are actually produced
12781 by keypresses, and use the variable
12783 to make \*(UA aware of them.
12784 E.g., the terminal this is typed on produces some false sequences, here
12785 an example showing the shifted home key:
12787 .Bd -literal -offset indent
12790 # 1B 5B=[ 31=1 3B=; 32=2 48=H
12795 ? \*(uA -v -Stermcap='kHOM=\eE[H'
12805 .\" .Sh "IMAP CLIENT" {{{
12808 \*(OPally there is IMAP client support available.
12809 This part of the program is obsolete and will vanish in v15 with the
12810 large MIME and I/O layer rewrite, because it uses old-style blocking I/O
12811 and makes excessive use of signal based long code jumps.
12812 Support can hopefully be readded later based on a new-style I/O, with
12813 SysV signal handling.
12814 In fact the IMAP support had already been removed from the codebase, but
12815 was reinstantiated on user demand: in effect the IMAP code is at the
12816 level of \*(UA v14.8.16 (with
12818 being the sole exception), and should be treated with some care.
12825 protocol prefixes, and an IMAP-based
12828 IMAP URLs (paths) undergo inspections and possible transformations
12829 before use (and the command
12831 can be used to manually apply them to any given argument).
12832 Hierarchy delimiters are normalized, a step which is configurable via the
12834 variable chain, but defaults to the first seen delimiter otherwise.
12835 \*(UA supports internationalised IMAP names, and en- and decodes the
12836 names from and to the
12838 as necessary and possible.
12839 If a mailbox name is expanded (see
12840 .Sx "Filename transformations" )
12841 to an IMAP mailbox, all names that begin with `+' then refer to IMAP
12842 mailboxes below the
12844 target box, while folder names prefixed by `@' refer to folders below
12845 the hierarchy base.
12848 Note: some IMAP servers do not accept the creation of mailboxes in
12849 the hierarchy base, but require that they are created as subfolders of
12850 `INBOX' \(en with such servers a folder name of the form
12852 .Dl imaps://mylogin@imap.myisp.example/INBOX.
12854 should be used (the last character is the server's hierarchy
12856 The following IMAP-specific commands exist:
12859 .Bl -tag -width ".It Ic BaNg"
12862 Only applicable to cached IMAP mailboxes;
12863 takes a message list and reads the specified messages into the IMAP
12868 If operating in disconnected mode on an IMAP mailbox,
12869 switch to online mode and connect to the mail server while retaining
12870 the mailbox status.
12871 See the description of the
12873 variable for more information.
12877 If operating in online mode on an IMAP mailbox,
12878 switch to disconnected mode while retaining the mailbox status.
12879 See the description of the
12882 A list of messages may optionally be given as argument;
12883 the respective messages are then read into the cache before the
12884 connection is closed, thus
12886 makes the entire mailbox available for disconnected use.
12890 Sends command strings directly to the current IMAP server.
12891 \*(UA operates always in IMAP `selected state' on the current mailbox;
12892 commands that change this will produce undesirable results and should be
12894 Useful IMAP commands are:
12895 .Bl -tag -offset indent -width ".Ic getquotearoot"
12897 Takes the name of an IMAP mailbox as an argument and creates it.
12899 (RFC 2087) Takes the name of an IMAP mailbox as an argument
12900 and prints the quotas that apply to the mailbox.
12901 Not all IMAP servers support this command.
12903 (RFC 2342) Takes no arguments and prints the Personal Namespaces,
12904 the Other User's Namespaces and the Shared Namespaces.
12905 Each namespace type is printed in parentheses;
12906 if there are multiple namespaces of the same type,
12907 inner parentheses separate them.
12908 For each namespace a prefix and a hierarchy separator is listed.
12909 Not all IMAP servers support this command.
12914 Perform IMAP path transformations.
12918 .Sx "Command modifiers" ) ,
12919 and manages the error number
12921 The first argument specifies the operation:
12923 normalizes hierarchy delimiters (see
12925 and converts the strings from the locale
12927 to the internationalized variant used by IMAP,
12929 performs the reverse operation.
12934 The following IMAP-specific internal variables exist:
12937 .Bl -tag -width ".It Va BaNg"
12939 .It Va disconnected
12940 \*(BO When an IMAP mailbox is selected and this variable is set,
12941 no connection to the server is initiated.
12942 Instead, data is obtained from the local cache (see
12945 Mailboxes that are not present in the cache
12946 and messages that have not yet entirely been fetched from the server
12948 to fetch all messages in a mailbox at once,
12950 .No ` Ns Li copy * /dev/null Ns '
12951 can be used while still in connected mode.
12952 Changes that are made to IMAP mailboxes in disconnected mode are queued
12953 and committed later when a connection to that server is made.
12954 This procedure is not completely reliable since it cannot be guaranteed
12955 that the IMAP unique identifiers (UIDs) on the server still match the
12956 ones in the cache at that time.
12959 when this problem occurs.
12961 .It Va disconnected-USER@HOST
12962 The specified account is handled as described for the
12965 but other accounts are not affected.
12968 .It Va imap-auth-USER@HOST , imap-auth
12969 Sets the IMAP authentication method.
12970 Valid values are `login' for the usual password-based authentication
12972 `cram-md5', which is a password-based authentication that does not send
12973 the password over the network in clear text,
12974 and `gssapi' for GSS-API based authentication.
12978 Enables caching of IMAP mailboxes.
12979 The value of this variable must point to a directory that is either
12980 existent or can be created by \*(UA.
12981 All contents of the cache can be deleted by \*(UA at any time;
12982 it is not safe to make assumptions about them.
12985 .It Va imap-delim-USER@HOST , imap-delim-HOST , imap-delim
12986 The hierarchy separator used by the IMAP server.
12987 Whenever an IMAP path is specified it will undergo normalization.
12988 One of the normalization steps is the squeezing and adjustment of
12989 hierarchy separators.
12990 If this variable is set, any occurrence of any character of the given
12991 value that exists in the path will be replaced by the first member of
12992 the value; an empty value will cause the default to be used, it is
12994 If not set, we will reuse the first hierarchy separator character that
12995 is discovered in a user-given mailbox name.
12997 .Mx Va imap-keepalive
12998 .It Va imap-keepalive-USER@HOST , imap-keepalive-HOST , imap-keepalive
12999 IMAP servers may close the connection after a period of
13000 inactivity; the standard requires this to be at least 30 minutes,
13001 but practical experience may vary.
13002 Setting this variable to a numeric `value' greater than 0 causes
13003 a `NOOP' command to be sent each `value' seconds if no other operation
13007 .It Va imap-list-depth
13008 When retrieving the list of folders on an IMAP server, the
13010 command stops after it has reached a certain depth to avoid possible
13012 The value of this variable sets the maximum depth allowed.
13014 If the folder separator on the current IMAP server is a slash `/',
13015 this variable has no effect and the
13017 command does not descend to subfolders.
13019 .Mx Va imap-use-starttls
13020 .It Va imap-use-starttls-USER@HOST , imap-use-starttls-HOST , imap-use-starttls
13021 Causes \*(UA to issue a `STARTTLS' command to make an unencrypted
13022 IMAP session SSL/TLS encrypted.
13023 This functionality is not supported by all servers,
13024 and is not used if the session is already encrypted by the IMAPS method.
13030 .\" .Sh "SEE ALSO" {{{
13040 .Xr spamassassin 1 ,
13049 .Xr mailwrapper 8 ,
13055 .\" .Sh HISTORY {{{
13058 M. Douglas McIlroy writes in his article
13059 .Dq A Research UNIX Reader: Annotated Excerpts \
13060 from the Programmer's Manual, 1971-1986
13063 command already appeared in First Edition
13067 .Bd -ragged -offset indent
13068 Electronic mail was there from the start.
13069 Never satisfied with its exact behavior, everybody touched it at one
13070 time or another: to assure the safety of simultaneous access, to improve
13071 privacy, to survive crashes, to exploit uucp, to screen out foreign
13072 freeloaders, or whatever.
13073 Not until v7 did the interface change (Thompson).
13074 Later, as mail became global in its reach, Dave Presotto took charge and
13075 brought order to communications with a grab-bag of external networks
13081 Mail was written in 1978 by Kurt Shoens and developed as part of the
13084 distribution until 1995.
13085 Mail has then seen further development in open source
13087 variants, noticeably by Christos Zoulas in
13089 Based upon this Nail, later Heirloom Mailx, was developed by Gunnar
13090 Ritter in the years 2000 until 2008.
13091 Since 2012 S-nail is maintained by Steffen (Daode) Nurpmeso.
13092 This man page is derived from
13093 .Dq The Mail Reference Manual
13094 that was originally written by Kurt Shoens.
13101 .An "Kurt Shoens" ,
13102 .An "Edward Wang" ,
13103 .An "Keith Bostic" ,
13104 .An "Christos Zoulas" ,
13105 .An "Gunnar Ritter" ,
13106 .An "Steffen Nurpmeso" .
13113 provide contact addresses:
13115 .\" v15-compat: drop eval as `mail' will expand variable?
13116 .Dl ? echo $contact-web; eval mail $contact-mail
13119 .\" .Sh CAVEATS {{{
13122 \*(ID Interrupting an operation via
13126 from anywhere else but a command prompt is very problematic and likely
13127 to leave the program in an undefined state: many library functions
13128 cannot deal with the
13130 that this software (still) performs; even though efforts have been taken
13131 to address this, no sooner but in v15 it will have been worked out:
13132 interruptions have not been disabled in order to allow forceful breakage
13133 of hanging network connections, for example (all this is unrelated to
13137 The SMTP and POP3 protocol support of \*(UA is very basic.
13138 Also, if it fails to contact its upstream SMTP server, it will not make
13139 further attempts to transfer the message at a later time (setting
13144 If this is a concern, it might be better to set up a local SMTP server
13145 that is capable of message queuing.
13152 After deleting some message of a POP3 mailbox the header summary falsely
13153 claims that there are no messages to display, one needs to perform
13154 a scroll or dot movement to restore proper state.
13156 In threaded display a power user may encounter crashes very
13157 occasionally (this is may and very).
13161 in the source repository lists future directions.