(BWDIC!) FIX false decision: for `if' etc., add -le,-gt.. operators..
[s-mailx.git] / nail.1
bloba5c2ba5c1df0d51d6c59e47979725614f6fd985a
1 .\"@ nail.1 - S-nail(1) reference manual.
2 .\"
3 .\" Copyright (c) 2000-2008 Gunnar Ritter, Freiburg i. Br., Germany.
4 .\" Copyright (c) 2012 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
5 .\"
6 .\" Copyright (c) 1980, 1990, 1993
7 .\"      The Regents of the University of California.  All rights reserved.
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
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.
20 .\"
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
31 .\" SUCH DAMAGE.
32 .\"
33 .\"--MKREL-START--
34 .\"@ S-nail(1): v14.9.0-pre3 / 2016-12-31
35 .Dd Dec 31, 2016
36 .ds VV \\%v14.9.0-pre3
37 .\"--MKREL-END--
38 .\"--MKMAN-START--
39 .ds UU \\%S-NAIL
40 .ds UA \\%S-nail
41 .ds uA \\%s-nail
42 .ds UR \\%s-nail.rc
43 .\"--MKMAN-END--
44 .\" --BEGINSTRIP--
45 .\"
46 .\" If not ~/.mailrc, it breaks POSIX compatibility.  And adjust main.c.
47 .ds ur \\%~/.mailrc
48 .ds OB [Obsolete]
49 .ds OP [Option]
50 .ds IN [v15-compat]
51 .ds OU [no v15-compat]
52 .ds ID [v15 behaviour may differ]
53 .ds NQ [Only new quoting rules]
54 .ds BO (Boolean)
55 .ds RO (Read-only)
57 .Dt "\*(UU" 1
58 .Os
59 .Mx -enable
62 .Sh NAME
63 .Nm \*(UA \%[\*(VV]
64 .Nd send and receive Internet mail
67 .\" .Sh SYNOPSIS {{{
68 .Sh SYNOPSIS
70 .\" Keep in SYNC: ./nail.1:"SYNOPSIS, main()
71 .Nm \*(uA
72 .Fl h | Fl Fl help
73 .Nm \*(uA
74 .Bk -words
75 .Op Fl BdEFintv~
76 .Op Fl \&: Ar spec
77 .Op Fl A Ar account
78 .Op Fl a Ar attachment
79 .Op Fl b Ar bcc-addr
80 .Op Fl c Ar cc-addr
81 .Op Fl M Ar type | Fl m Ar file | Fl q Ar file | Fl t
82 .Op Fl r Ar from-addr
83 .Op Fl S Ar var Ns Op Ns = Ns Ar value
84 .Op Fl s Ar subject
85 .Op Fl X Ar cmd
86 .Op Fl \&.
87 .Ar to-addr ...
88 .Op Fl Fl \~ Ns Ar mta-option ...
89 .Ek
90 .Nm \*(uA
91 .Bk -words
92 .Op Fl BdEeHiNnRv~
93 .Op Fl \&: Ar spec
94 .Op Fl A Ar account
95 .Op Fl L Ar spec-list
96 .Op Fl r Ar from-addr
97 .Op Fl S Ar var Ns Op Ns = Ns Ar value
98 .Op Fl u Ar user
99 .Op Fl X Ar cmd
100 .Op Fl Fl \~ Ns Ar mta-option ...
102 .Nm \*(uA
103 .Bk -words
104 .Op Fl BdEeHiNnRv~#
105 .Op Fl \&: Ar spec
106 .Op Fl A Ar account
107 .Fl f
108 .Op Fl L Ar spec-list
109 .Op Fl r Ar from-addr
110 .Op Fl S Ar var Ns Op Ns = Ns Ar value
111 .Op Fl X Ar cmd
112 .Op Ar file
113 .Op Fl Fl \~ Ns Ar mta-option ...
115 .\" }}}
118 .Mx -toc -tree html pdf ps xhtml
121 .\" .Sh DESCRIPTION {{{
122 .Sh DESCRIPTION
124 .Bd -filled -compact -offset indent
125 .Sy Compatibility note:
126 S-nail (\*(UA) will wrap up into \%S-mailx in v15.0 (circa 2018).
127 Backward incompatibility has to be expected \(en
128 .Sx COMMANDS
129 will use
130 .Sx "Shell-style argument quoting"
131 rules, for example, and shell metacharacters will become meaningful.
132 New and old behaviour is flagged \*(IN and \*(OU, and setting
133 .Va v15-compat ,
134 one of the many
135 .Sx "INTERNAL VARIABLES" ,
136 will choose new behaviour when applicable.
137 \*(OB flags what will vanish, and enabling
138 .Fl d
140 .Fl v
141 enables obsoletion warnings.
145 \*(UA provides a simple and friendly environment for sending and
146 receiving mail.
147 It is intended to provide the functionality of the POSIX
148 .Xr mailx 1
149 command, but is MIME capable and optionally offers extensions for
150 line editing, S/MIME, SMTP and POP3, among others.
151 \*(UA divides incoming mail into its constituent messages and allows
152 the user to deal with them in any order.
153 It offers many
154 .Sx COMMANDS
156 .Sx "INTERNAL VARIABLES"
157 for manipulating messages and sending mail.
158 It provides the user simple editing capabilities to ease the composition
159 of outgoing messages, and increasingly powerful and reliable
160 non-interactive scripting capabilities.
162 .\" .Ss "Options" {{{
163 .Ss "Options"
165 .Bl -tag -width ".It Fl BaNg"
167 .It Fl \&: Ar spec
168 Explicitly control which of the
169 .Sx "Resource files"
170 shall be loaded: if the letter
171 .Ql s
172 is (case-insensitively) part of the
173 .Ar spec
174 then the system wide
175 .Pa \*(UR
176 is loaded, likewise the letter
177 .Ql u
178 controls loading of the user's personal
179 .Pa \*(ur
180 file, whereas the letters
181 .Ql -
183 .Ql /
184 explicitly forbid loading of any resource files.
185 This option should be used by scripts: to avoid environmental noise they
186 should
187 .Dq detach
188 from any configuration files and create a script-local environment,
189 explicitly setting any of the desired
190 .Sx "INTERNAL VARIABLES"
192 .Fl S .
193 This option overrides
194 .Fl n .
197 .It Fl A Ar account
198 Executes an
199 .Ic account
200 command for the given user email
201 .Ar account
202 after program startup is complete (all resource files are loaded, any
203 .Fl S
204 setting is being established; only
205 .Fl X
206 commands have not been evaluated yet).
207 Being a special incarnation of
208 .Ic define Ns d
209 macros for the purpose of bundling longer-lived settings, activating
210 such an email account also switches to the accounts
211 .Mx -sx
212 .Sx "primary system mailbox"
213 (most likely the
214 .Va inbox ) .
217 .It Fl a Ar file Ns Op Ar =input-charset Ns Op Ar #output-charset
218 Attach
219 .Ar file
220 to the message (for compose mode opportunities refer to
221 .Ic ~@
223 .Ic ~^ ) .
224 .Sx "Filename transformations"
225 (also see
226 .Ic file )
227 will be performed, but shell word expansion is restricted to the tilde
228 .Ql ~ .
229 Shall
230 .Ar file
231 not be accessible but contain a
232 .Ql =
233 character, then anything before the
234 .Ql =
235 will be used as the filename, anything thereafter as a character set
236 specification.
238 If an input character set is specified,
239 .Mx -ix "character set specification"
240 but no output character set, then the given input character set is fixed
241 as-is, and no conversion will be applied;
242 giving the special string hyphen-minus
243 .Ql -
244 will be treated as if
245 .Va ttycharset
246 has been specified (the default).
247 If an output character set has also been given then the conversion will
248 be performed exactly as specified and on-the-fly, not considering the
249 file's type and content.
250 As an exception, if the output character set is specified as hyphen-minus
251 .Ql - ,
252 then the default conversion algorithm (see
253 .Sx "Character sets" )
254 is applied (therefore no conversion is performed on-the-fly,
255 .Ar file
256 will be MIME-classified and its contents will be inspected first).
257 It is an error to specify anything but
258 .Ql -
259 if no character set conversion is available
260 .Pf ( Va features
261 does not include the term
262 .Ql +iconv ) .
265 .It Fl B
266 (\*(OB: \*(UA will always use line-buffered output, to gain
267 line-buffered input even in batch mode enable batch mode via
268 .Fl # . )
271 .It Fl b Ar addr
272 Send a blind carbon copy to
273 .Ar addr Ns
274 ess, if the setting of
275 .Va expandaddr ,
276 one of the
277 .Sx "INTERNAL VARIABLES" ,
278 allows.
279 The option may be used multiple times.
280 Also see the section
281 .Sx "On sending mail, and non-interactive mode" .
284 .It Fl c Ar addr
285 Send carbon copies to the given receiver, if so allowed by
286 .Va expandaddr .
287 May be used multiple times.
290 .It Fl d
291 .Ic set
292 the internal variable
293 .Va debug
294 which enables debug messages and disables message delivery,
295 among others; effectively turns almost any operation into a dry-run.
298 .It Fl E
299 .Ic set
300 .Va skipemptybody
301 and thus discard messages with an empty message part body.
302 This command line option is \*(OB.
305 .It Fl e
306 Just check if mail is present (in the specified or system
307 .Va inbox ) :
308 if yes, return an exit status of zero, a non-zero value otherwise.
309 To restrict the set of mails to consider in this evaluation a message
310 specification can be added with the option
311 .Fl L .
314 .It Fl F
315 Save the message to send in a file named after the local part of the
316 first recipient's address (instead of in
317 .Va record Ns ).
320 .It Fl f
321 Read in the contents of the user's
322 .Ev MBOX
323 (or the specified file) for processing;
324 when \*(UA is quit, it writes undeleted messages back to this file
325 (but be aware of the
326 .Va hold
327 option).
328 The optional
329 .Ar file
330 argument will undergo some special
331 .Sx "Filename transformations"
332 (also see
333 .Ic file ) .
334 Note that
335 .Ar file
336 is not a argument to the flag
337 .Fl \&\&f ,
338 but is instead taken from the command line after option processing has
339 been completed.
340 In order to use a
341 .Ar file
342 that starts with a hyphen-minus, prefix with a relative path, as in
343 .Ql ./-hyphenbox.mbox .
346 .It Fl H
347 Display a summary of the
348 .Ic headers
349 of all messages in the specified mailbox or system
350 .Va inbox
351 and exit.
352 A configurable summary view is available via the
353 .Fl L
354 option.
357 .It Fl h
358 Show a short usage summary.
359 Because of widespread use a
360 .Fl Fl help
361 argument will have the same effect.
364 .It Fl i
365 .Ic set
366 .Va ignore
367 to ignore tty interrupt signals.
370 .It Fl L Ar spec-list
371 Display a summary of all
372 .Ic headers
373 of only those messages in the specified mailbox or the system
374 .Va inbox
375 that match the given
376 .Ar spec-list ,
377 then exit.
378 See the section
379 .Sx "Specifying messages"
380 for the format of
381 .Ar spec-list .
382 If the
383 .Fl e
384 (\*(OB or
385 .Fl H )
386 option has been given in addition no header summary is produced,
387 but \*(UA will instead indicate via its exit status whether
388 .Ar spec-list
389 matched any messages
390 .Pf ( Ql 0 )
391 or not
392 .Pf ( Ql 1 ) ;
393 note that any verbose output is suppressed in this mode and must instead
394 be enabled explicitly (e.g., by using the option
395 .Fl v ) .
398 .It Fl M Ar type
399 Special send mode that will flag standard input with the MIME
400 .Ql Content-Type:
401 set to the given
402 .Ar type
403 and use it as the main message body.
404 \*(ID Using this option will bypass processing of
405 .Va message-inject-head ,
406 .Va signature
408 .Va message-inject-tail .
409 Also see
410 .Fl q , m , t .
413 .It Fl m Ar file
414 Special send mode that will MIME classify the specified
415 .Ar file
416 and use it as the main message body.
417 \*(ID Using this option will bypass processing of
418 .Va message-inject-head ,
419 .Va signature
421 .Va message-inject-tail .
422 Also see
423 .Fl q , M , t .
426 .It Fl N
427 inhibit the initial display of message headers when reading mail or
428 editing a mail folder by calling
429 .Ic unset
430 for the internal variable
431 .Va header .
434 .It Fl n
435 Standard flag that inhibits reading the system wide
436 .Pa \*(UR
437 upon startup.
438 The option
439 .Fl \&:
440 allows more control over the startup sequence; also see
441 .Sx "Resource files" .
444 .It Fl q Ar file
445 Special send mode that will initialize the message body with the
446 contents of the specified
447 .Ar file ,
448 which may be standard input
449 .Ql -
450 only in non-interactive context.
451 Also see
452 .Fl M , m , t .
455 .It Fl R
456 Any folder opened will be in read-only mode.
460 .It Fl r Ar from-addr
461 The source address that appears in the
462 .Ql From:
463 .Pf ( Va from )
464 header of a message (or in the
465 .Ql Sender:
466 .Pf ( Va sender )
467 header if the former contains multiple addresses) is not used for
468 relaying and delegating a message over the wire via SMTP, but instead an
469 envelope will enwrap the message content and provide the necessary
470 information (i.e., the RFC 5321 reverse-path, also used to report, e.g.,
471 delivery errors) to transmit the message to its destination(s).
472 Whereas said headers and internal variables will be used by \*(UA to
473 create the envelope if the builtin SMTP
474 .Va mta
475 (Mail-Transfer-Agent) is used, a file-based MTA will instead use the
476 identity of the message-originating user.
478 This command line option can be used to specify the reverse-path, to be
479 passed to a file-based
480 .Va mta
481 when a message is sent, via
482 .Ql -f Ar from-addr .
483 Shall
484 .Ar from-addr
485 include a user name, then the address components will be separated and
486 the name part will be passed to a file-based
487 .Va mta
488 individually via
489 .Ql -F Ar name .
490 The given
491 .Ar from-addr
492 is also assigned to the internal variable
493 .Va from .
494 Many default installations and sites disallow explicit overriding of the
495 user identity which could be adjusted by this option, unless either
496 .Va mta
497 has been configured accordingly, or the user is member of a group with
498 special privileges, respectively.
500 If an empty string is passed as
501 .Ar from-addr
502 then the content of the variable
503 .Va from
504 (or, if that contains multiple addresses,
505 .Va sender )
506 will be evaluated and used for this purpose whenever the file-based
507 .Va mta
508 is contacted.
509 Note that \*(UA by default, without
510 .Fl \&\&r
511 that is, neither passes
512 .Fl \&\&f
514 .Fl \&\&F
515 command line options to a file-based MTA by itself, unless this
516 automatic deduction is enforced by
517 .Ic set Ns
518 ing the internal variable
519 .Va r-option-implicit .
523 .It Fl S Ar var Ns Op = Ns value
524 .Ic set
525 the internal
526 .Ar var Ns
527 iable and, in case of a non-boolean variable which has a value, assign
528 .Ar value
529 to it.
530 Even though
531 .Sx "INTERNAL VARIABLES"
532 .Ic \&\&set
534 .Fl S
535 may be overwritten from within resource files,
536 the command line setting will be reestablished after all resource files
537 have been loaded.
540 .It Fl s Ar subject
541 Specify the subject of the message to be sent.
542 Newline (NL) and carriage-return (CR) bytes are invalid and will be
543 normalized to space (SP) characters.
546 .It Fl t
547 The message given (on standard input) is expected to contain, separated
548 from the message body by an empty line, a message header with
549 .Ql To: ,
550 .Ql Cc: ,
552 .Ql Bcc:
553 fields giving its recipients, which will be added to any recipients
554 specified on the command line.
555 If a message subject is specified via
556 .Ql Subject:
557 then it will be used in favour of one given on the command line.
559 Also understood are
560 .Ql Reply-To:
561 (possibly overriding
562 .Va replyto ) ,
563 .Ql Sender:
564 .Pf ( Va sender ) ,
565 .Ql From:
566 .Pf ( Va from
567 and / or option
568 .Fl r ) .
569 .Ql Message-ID: ,
570 .Ql In-Reply-To: ,
571 .Ql References:
573 .Ql Mail-Followup-To: ,
574 by default created automatically dependent on message context, will
575 be used if specified (a special address massage will however still occur
576 for the latter).
577 Any other custom header field (also see
578 .Va customhdr ,
579 .Ic ~^ )
580 is passed through entirely
581 unchanged, and in conjunction with the option
582 .Fl ~
583 it is possible to embed
584 .Sx "COMMAND ESCAPES" .
585 Also see
586 .Fl M , m , q .
589 .It Fl u Ar user
590 Initially read the
591 .Mx -sx
592 .Sx "primary system mailbox"
594 .Ar user ,
595 appropriate privileges presumed; effectively identical to
596 .Ql -f %user .
599 .It Fl V
600 Show \*(UA's
601 .Va version
602 and exit.
603 The command
604 .Ic version
605 will also show the list of
606 .Va features :
607 .Ql $ \*(uA -Xversion -Xx .
610 .It Fl v
611 .Ic set Ns
612 ting the internal variable
613 .Va verbose
614 enables display of some informational context messages.
615 Using it twice increases the level of verbosity.
618 .It Fl X Ar cmd
619 Add the given (or multiple for a multiline argument)
620 .Ar cmd
621 to the list of commands to be executed,
622 as a last step of program startup, before normal operation starts.
623 This is the only possibility to execute commands in non-interactive mode
624 when reading startup files is actively prohibited.
625 The commands will be evaluated as a unit, just as via
626 .Ic source ,
627 but different to that errors won't stop evaluation.
628 Correlates with
629 .Fl #
631 .Va batch-exit-on-error .
634 .It Fl ~
635 Enable
636 .Sx "COMMAND ESCAPES"
637 even if not in interactive mode.
638 This can be used to, e.g., automatically format the composed message
639 text before sending the message:
640 .Bd -literal -offset indent
641 $ ( echo 'line    one. Word.     Word2.'; \e
642     echo '~| /usr/bin/fmt -tuw66' ) |\e
643   LC_ALL=C \*(uA -:/ -Sttycharset=utf-8 -d~ bob@exam.ple
647 .It Fl #
648 Enables batch mode.
649 In batch mode the full set of commands is available, just like in
650 interactive mode, standard input is made line buffered, and diverse
651 .Sx "INTERNAL VARIABLES"
652 are adjusted for batch necessities, e.g., it
653 .Ic set Ns
655 .Va emptystart ,
656 .Pf no Va header ,
657 .Va quiet ,
658 .Va sendwait ,
659 .Va typescript-mode
660 as well as
661 .Ev MAIL ,
662 .Ev MBOX
664 .Va inbox
665 (the latter three to
666 .Pa /dev/null ) ;
667 processing of
668 .Sx "COMMAND ESCAPES"
669 is enabled in compose mode.
670 The following prepares an email message in a batched dry run:
671 .Bd -literal -offset indent
672 $ LC_ALL=C printf 'm bob\en~s ubject\enText\en~.\enx\en' | \e
673   LC_ALL=C \*(uA -:/ -d# -X'alias bob bob@exam.ple'
677 .It Fl \&.
678 This flag forces termination of option processing in order to prevent
679 .Dq option injection
680 (attacks).
681 It also forcefully puts \*(UA into send mode, see
682 .Sx "On sending mail, and non-interactive mode" .
686 Any given
687 .Bk -words
688 .Ar to-addr ...
690 argument, as well as all receivers established by the command line options
691 .Fl b
693 .Fl c ,
694 are subject to checks established via
695 .Va expandaddr ,
696 one of the
697 .Sx "INTERNAL VARIABLES" .
698 .Bk -words
699 .Op Ar mta-option ...
701 arguments that are given at the end of the command line after a
702 .Ql --
703 separator will be passed through to a file-based
704 .Va mta
705 (Mail-Transfer-Agent) and persist for an entire (interactive) session
706 \(en if the setting of the internal variable
707 .Va expandargv
708 allows their recognition; no such constraints apply to the variable
709 .Va mta-arguments .
710 .\" }}}
712 .\" .Ss "A starter" {{{
713 .Ss "A starter"
715 \*(UA is a direct descendant of
717 Mail, a successor of the Research
719 mail which
720 .Dq was there from the start
721 according to
722 .Sx HISTORY .
723 It thus represents the user side of the
725 mail system, whereas the system side (Mail-Transfer-Agent, MTA) was
726 traditionally taken by
727 .Xr sendmail 8 ,
728 and most MTAs provide a binary of this name for compatibility purposes.
729 If the \*(OPal SMTP
730 .Va mta
731 is included in the
732 .Va features
733 of \*(UA then the system side is not a mandatory precondition for mail
734 delivery.
737 Because \*(UA strives for compliance with POSIX
738 .Xr mailx 1
739 it is likely that some configuration settings have to be adjusted before
740 using it is a smooth experience.
741 The default global
742 .Pa \*(UR
743 resource file bends those standard imposed settings of the
744 .Sx "INTERNAL VARIABLES"
745 a bit towards more user friendliness and safety, however, e.g., it
746 .Ic set Ns s
747 .Va hold
749 .Va keepsave
750 in order to suppress the automatic moving of messages to
751 .Ev MBOX
752 that would otherwise occur (see
753 .Sx "Message states" ) ,
755 .Va keep
756 to not remove empty system (MBOX) mailbox files in order not to mangle
757 file permissions when files eventually get recreated \(en
758 \*(UA will remove all empty (MBOX) mailbox files unless this variable is
759 set whenever
760 .Va posix
761 .Pf ( Ev POSIXLY_CORRECT )
762 mode has been enabled.
763 The file mode creation mask is explicitly managed via
764 .Va umask .
767 It also enables
768 .Va sendwait
769 in order to synchronize \*(UA with the exit status report of the used
770 .Va mta
771 when sending mails.
772 It sets
773 .Va emptystart
774 to enter interactive startup even if the initial mailbox is empty,
775 .Va editheaders
776 to allow editing of headers as well as
777 .Va fullnames
778 to not strip down addresses in compose mode, and
779 .Va quote
780 to include the message that is being responded to when
781 .Ic reply Ns
782 ing.
783 The section
784 .Sx EXAMPLES
785 contains some more complete configuration examples.
786 .\" }}}
788 .\" .Ss "On sending mail, and non-interactive mode" {{{
789 .Ss "On sending mail, and non-interactive mode"
791 To send a message to one or more people, using a local or a builtin
792 .Va mta
793 (Mail-Transfer-Agent) transport to actually deliver the generated mail
794 message, \*(UA can be invoked with arguments which are the names of
795 people to whom the mail will be sent, and the command line options
796 .Fl b
798 .Fl c
799 can be used to add (blind) carbon copy receivers:
801 .Bd -literal -offset indent
802 # Via sendmail(1)
803 $ \*(uA -s ubject -a ttach.txt bill@exam.ple
805 # But... try it in an isolated dry-run mode (-d) first
806 $ LC_ALL=C \*(uA -d -:/ -Ssendwait \e
807    -b bcc@exam.ple -c cc@exam.ple \e
808    -. '(Lovely) Bob <bob@exam.ple>' eric@exam.ple
810 # With SMTP
811 $ LC_ALL=C \*(uA -d -:/ -Sv15-compat -Ssendwait \e
812     -S 'mta=smtps://mylogin@exam.ple:465' -Ssmtp-auth=login \e
813     -S 'from=scriptreply@exam.ple' \e
814     -a /etc/mail.rc \e
815     -. eric@exam.ple
819 If standard input is a terminal rather than the message to be sent,
820 the user is expected to type in the message contents.
821 In this compose mode \*(UA treats lines beginning with the character
822 .Ql ~
823 special \(en these are so-called
824 .Sx "COMMAND ESCAPES" ,
825 which can be used to read in files, process shell commands, add and edit
826 attachments and more; e.g., the command escape
827 .Ic ~e
828 will start the text editor to revise the message in its current state,
829 .Ic ~h
830 allows editing of the most important message headers, with
831 .Ic ~^
832 custom headers can be created (more specifically than with
833 .Va customhdr ) .
834 .Ic ~?
835 gives an overview of most other available command escapes.
836 Typing
837 .Ql control-D
838 .Pf ( Ql ^D )
839 at the beginning of an empty line leaves compose mode and causes the
840 message to be sent, whereas typing
841 .Ql control-C
842 .Pf ( Ql ^C )
843 twice will abort the current letter (saving its contents in the file
844 denoted by
845 .Ev DEAD
846 unless
847 .Pf no Va save
848 is set).
849 Messages are sent asynchronously, without supervision, unless the variable
850 .Va sendwait
851 is set, therefore send errors are not recognizable until then.
854 A number of
855 .Sx ENVIRONMENT
857 .Sx "INTERNAL VARIABLES"
858 can be used to alter default behavior; e.g.,
859 .Ic set Ns
860 ting (also via
861 .Fl S )
862 .Va editalong
863 will automatically startup a text editor when compose mode is entered,
864 .Va editheaders
865 allows editing of headers additionally to plain body content,
866 .Va askcc
867 will cause the user to be prompted actively for carbon-copy recipients
868 and setting
869 .Va dot
870 will allow leaving compose mode by writing a line consisting solely of
871 a dot
872 .Pf ( Ql \&. ) .
873 .Va on-compose-enter
875 .Va on-compose-leave
876 hook variables may be set to
877 .Ic define Ns
878 d macros to automatically adjust some settings dependent
879 on receiver, sender or subject contexts, and via the
880 .Va on-compose-done-shell
881 as well as
882 .Va on-compose-done
883 variables, the latter also to be set to a
884 .Ic define Ns
885 d macro, increasingly powerful mechanisms to perform automated message
886 adjustments are available.
889 Especially for using public mail provider accounts with the SMTP
890 .Va mta
891 it is often necessary to set
892 .Va from
893 and/or
894 .Va hostname
895 (even finer control via
896 .Va smtp-hostname ) ,
897 which also causes creation of
898 .Ql Message-ID:
900 .Ql Content-ID:
901 header fields (even if empty) unless
902 .Va stealthmua
903 is set; saving a copy of sent messages in a
904 .Va record
905 mailbox may be desirable \(en as for most mailbox
906 .Ic file
907 targets the value will undergo
908 .Sx "Filename transformations" .
909 Defining user email
910 .Ic account Ns s
911 for the purpose of arranging a complete environment of settings that can
912 be switched to with a single command or command line option may be
913 useful (the section
914 .Sx EXAMPLES
915 contains example configurations for sending messages via some of the
916 well-known public mail providers and also gives a compact overview on
917 how to setup a secure SSL/TLS environment).
918 Performing some
919 .Fl d
921 .Va debug
922 sandbox dry-run tests first will prove correctness.
925 The section
926 .Sx "On URL syntax and credential lookup"
927 will spread light on the different ways of how to specify user email
928 account credentials, the
929 .Ql USER@HOST
930 variable chains, and accessing protocol-specific resources,
931 the section
932 .Sx "Character sets"
933 goes into the details of character encoding and how to use them for
934 representing messages and MIME part contents by specifying them in
935 .Va sendcharsets ,
936 and reading the section
937 .Sx "The mime.types files"
938 should help to understand how the MIME-type of outgoing attachments are
939 classified, and what can be done for fine-tuning.
940 Over the wire an intermediate, configurable
941 .Pf content-transfer-\: Va encoding
942 may be applied to the raw message part data.
945 Message recipients (as specified on the command line or defined in
946 .Ql To: ,
947 .Ql Cc:
949 .Ql Bcc: )
950 may not only be email addressees but can also be names of mailboxes and
951 even complete shell command pipe specifications.
952 If the variable
953 .Va expandaddr
954 is not set then only network addresses (see
955 .Xr mailaddr 7
956 for a description of mail addresses) and plain user names (including MTA
957 aliases) may be used, other types will be filtered out, giving a warning
958 message.
959 The command
960 .Ic addrcodec
961 can be used to generate standard compliant network addresses.
963 .\" When changing any of the following adjust any RECIPIENTADDRSPEC;
964 .\" grep the latter for the complete picture
966 If the variable
967 .Va expandaddr
968 is set then extended recipient addresses will optionally be accepted:
969 Any name which starts with a vertical bar
970 .Ql |
971 character specifies a command pipe \(en the command string following the
972 .Ql |
973 is executed and the message is sent to its standard input;
974 Likewise, any name that starts with the character solidus
975 .Ql /
976 or the character sequence dot solidus
977 .Ql ./
978 is treated as a file, regardless of the remaining content;
979 likewise a name that solely consists of a hyphen-minus
980 .Ql - .
981 Any other name which contains a commercial at
982 .Ql @
983 character is treated as a network address;
984 Any other name which starts with a plus sign
985 .Ql +
986 character specifies a mailbox name;
987 Any other name which contains a solidus
988 .Ql /
989 character but no exclamation mark
990 .Ql \&!
991 or percent sign
992 .Ql %
993 character before also specifies a mailbox name;
994 What remains is treated as a network address.
996 .Bd -literal -offset indent
997 $ echo bla | \*(uA -Sexpandaddr -s test ./mbox.mbox
998 $ echo bla | \*(uA -Sexpandaddr -s test '|cat >> ./mbox.mbox'
999 $ echo safe | LC_ALL=C \e
1000     \*(uA -:/ -Sv15-compat -Ssendwait -Snosave \e
1001       -Sexpandaddr=fail,-all,+addr,failinvaddr -s test \e
1002       -. bob@exam.ple
1006 It is possible to create personal distribution lists via the
1007 .Ic alias
1008 command, so that, for instance, the user can send mail to
1009 .Ql cohorts
1010 and have it go to a group of people.
1011 These aliases have nothing in common with the system wide aliases that
1012 may be used by the MTA, which are subject to the
1013 .Ql name
1014 constraint of
1015 .Va expandaddr
1016 and are often tracked in a file
1017 .Pa /etc/aliases
1018 (and documented in
1019 .Xr aliases 5
1021 .Xr sendmail 1 ) .
1022 Personal aliases will be expanded by \*(UA before the message is sent,
1023 and are thus a convenient alternative to specifying each addressee by
1024 itself; they correlate with the active set of
1025 .Ic alternates
1026 and are subject to
1027 .Va metoo
1028 filtering.
1031 .Dl alias cohorts bill jkf mark kridle@ucbcory ~/mail/cohorts.mbox
1034 To avoid environmental noise scripts should
1035 .Dq detach
1036 \*(UA from any configuration files and create a script-local
1037 environment, ideally with the command line options
1038 .Fl \&:
1039 to disable any configuration file in conjunction with repetitions of
1040 .Fl S
1041 to specify variables:
1043 .Bd -literal -offset indent
1044 $ env LC_ALL=C \*(uA -:/ \e
1045     -Sv15-compat -Ssendwait -Snosave -Sttycharset=utf-8 \e
1046     -Sexpandaddr=fail,-all,failinvaddr \e
1047     -S 'mta=smtps://mylogin@exam.ple:465' -Ssmtp-auth=login \e
1048     -S 'from=scriptreply@exam.ple' \e
1049     -s 'subject' -a attachment_file \e
1050     -. "Recipient 1 <rec1@exam.ple>" rec2@exam.ple \e
1051     < content_file
1055 As shown, scripts can
1056 .Dq fake
1057 a locale environment, the above specifies the all-compatible 7-bit clean
1058 .Ev LC_ALL
1059 .Dq C ,
1060 but will nonetheless take and send UTF-8 in the message text by using
1061 .Va ttycharset .
1062 In interactive mode, which is introduced in the next section, messages
1063 can be sent by calling the
1064 .Ic mail
1065 command with a list of recipient addresses \(em the semantics are
1066 completely identical to non-interactive message sending:
1068 .Bd -literal -offset indent
1069 $ \*(uA -d -Squiet -Semptystart
1070 "/var/spool/mail/user": 0 messages
1071 ? mail "Recipient 1 <rec1@exam.ple>", rec2@exam.ple
1072 ? # Will do the right thing (tm)
1073 ? m rec1@exam.ple rec2@exam.ple
1075 .\" }}}
1077 .\" .Ss "On reading mail, and interactive mode" {{{
1078 .Ss "On reading mail, and interactive mode"
1080 When invoked without addressees \*(UA enters interactive mode in which
1081 mails may be read.
1082 When used like that the user's system
1083 .Va inbox
1084 (see the command
1085 .Ic file
1086 for an in-depth description of the different mailbox types that exist)
1087 is read in and a one line header of each message therein is displayed.
1088 The visual style of this summary of
1089 .Ic headers
1090 can be adjusted through the variable
1091 .Va headline
1092 and the possible sorting criterion via
1093 .Va autosort .
1094 Scrolling through
1095 .Va screen Ns
1096 fuls of
1097 .Ic headers
1098 can be performed with the command
1099 .Ic z .
1100 If the initially opened mailbox is empty \*(UA will instead exit
1101 immediately (after displaying a message) unless the variable
1102 .Va emptystart
1103 is set.
1106 At the
1107 .Va prompt
1108 the command
1109 .Ic list
1110 will give a listing of all available commands and
1111 .Ic help
1112 will give a summary of some common ones.
1113 If the \*(OPal documentation strings are available one can type
1114 .Ql help X
1115 .Pf "(or " Ql ?X )
1116 and see the actual expansion of
1117 .Ql X
1118 and what its purpose is, i.e., commands can be abbreviated
1119 (note that POSIX defines some abbreviations, so that the alphabetical
1120 order of commands does not necessarily relate to the abbreviations; it is
1121 possible to define overwrites with the
1122 .Ic ghost
1123 command, however).
1124 These commands can also produce a more
1125 .Va verbose
1126 output.
1129 Messages are given numbers (starting at 1) which uniquely identify
1130 messages; the current message \(en the
1131 .Dq dot
1132 \(en will either be the first new message, or the first unread message,
1133 or the first message of the mailbox; the internal variable
1134 .Va showlast
1135 will instead cause usage of the last message for this purpose.
1136 The command
1137 .Ic headers
1138 will display a
1139 .Va screen Ns
1140 ful of header summaries containing the
1141 .Dq dot ,
1142 whereas
1143 .Ic from
1144 will display only the summaries of the given messages, defaulting to the
1145 .Dq dot .
1148 Message content can be displayed with the command
1149 .Ic type
1150 .Pf ( Ql t ,
1151 alias
1152 .Ic print ) .
1153 Here the variable
1154 .Va crt
1155 controls whether and when \*(UA will use the configured
1156 .Ev PAGER
1157 for display instead of directly writing to the user terminal
1158 .Va screen ,
1159 the sole difference to the command
1160 .Ic more ,
1161 which will always use the
1162 .Ev PAGER .
1163 The command
1164 .Ic top
1165 will instead only show the first
1166 .Va toplines
1167 of a message (maybe even compressed if
1168 .Va topsqueeze
1169 is set).
1172 By default the current message
1173 .Pf ( Dq dot )
1174 is displayed, but like with many other commands it is possible to give
1175 a fancy message specification (see
1176 .Sx "Specifying messages" ) ,
1177 e.g.,
1178 .Ql t:u
1179 will display all unread messages,
1180 .Ql t.
1181 will display the
1182 .Dq dot ,
1183 .Ql t 1 5
1184 will type the messages 1 and 5,
1185 .Ql t 1-5
1186 will type the messages 1 through 5, and
1187 .Ql t-
1189 .Ql t+
1190 will display the last and the next message, respectively.
1191 The command
1192 .Ic search
1193 (a more substantial alias for
1194 .Ic from )
1195 will display a header summary of the given message specification list
1196 instead of their content, e.g., the following will search for subjects:
1199 .Dl from "'@Some subject to search for'"
1202 In the default setup all header fields of a message will be
1203 .Ic type Ns
1204 d, but fields can be white- or blacklisted for a variety of
1205 applications by using the command
1206 .Ic headerpick ,
1207 e.g., to restrict display to a very restricted set:
1208 .Ql Ic \:headerpick Cd \:type retain add Ar \:from to cc subject .
1209 In order to display all header fields of a message regardless of
1210 currently active ignore or retain lists, use the commands
1211 .Ic Type
1213 .Ic Top .
1214 Note that historically the global
1215 .Pa \*(UR
1216 not only adjusts the list of displayed headers, but also sets
1217 .Va crt .
1220 Dependent upon the configuration a line editor (see the section
1221 .Sx "On terminal control and line editor" )
1222 aims at making user experience with the many
1223 .Sx COMMANDS
1224 a bit nicer.
1225 When reading the system
1226 .Va inbox
1227 or when
1228 .Fl f
1230 .Ic file )
1231 specified a mailbox explicitly prefixed with the special
1232 .Ql %:
1233 modifier (propagating the mailbox to a
1234 .Mx -sx
1235 .Sx "primary system mailbox" ) ,
1236 then messages which have been read will be moved to a
1237 .Mx -sx
1238 .Sx "secondary mailbox" ,
1239 the users
1240 .Ev MBOX
1241 file, automatically when the mailbox is left, either by changing the
1242 active mailbox or by quitting \*(UA (also see
1243 .Sx "Message states" )
1244 \(en this automatic moving from a system or primary to the secondary
1245 mailbox is not performed when the variable
1246 .Va hold
1247 is set.
1250 After examining a message the user can also
1251 .Ic delete Ql d
1252 the message,
1253 .Ic reply Ql r
1254 to the sender and all recipients or
1255 .Ic Reply Ql R
1256 exclusively to the sender(s).
1257 Messages can also be
1258 .Ic forward Ns
1259 ed (shorter alias is
1260 .Ic fwd Ns ).
1261 Note that when replying to or forwarding a message recipient addresses
1262 will be stripped from comments and names unless the internal variable
1263 .Va fullnames
1264 is set.
1265 Deletion causes \*(UA to forget about the message;
1266 This is not irreversible, though, one can
1267 .Ic undelete Ql u
1268 the message by giving its number,
1269 or the \*(UA session can be ended by giving the
1270 .Ic exit Ql x
1271 command.
1274 To end a mail processing session one may either issue
1275 .Ic quit Ql q
1276 to cause a full program exit, which possibly includes
1277 automatic moving of read messages to
1278 .Ev MBOX
1279 as well as updating the \*(OPal line editor
1280 .Va history-file ,
1281 or use the command
1282 .Ic exit Ql x
1283 instead in order to prevent any of these actions.
1284 .\" }}}
1286 .\" .Ss "HTML mail and MIME attachments" {{{
1287 .Ss "HTML mail and MIME attachments"
1289 Messages which are HTML-only get more and more common and of course many
1290 messages come bundled with a bouquet of MIME attachments.
1291 Whereas \*(UA \*(OPally supports a simple HTML-to-text converter to deal
1292 with HTML messages (see
1293 .Sx "The mime.types files" ) ,
1294 it normally cannot deal with any of these itself, but instead programs
1295 need to become registered to deal with specific MIME types or file
1296 extensions.
1297 These programs may either prepare plain text versions of their input
1298 in order to enable \*(UA to display the content on the terminal,
1299 or display the content themselves, for example in a graphical window.
1302 To install an external handler program for a specific MIME type set an
1303 according
1304 .Va pipe-TYPE/SUBTYPE
1305 variable; to instead define a handler for a specific file extension set
1306 the respective
1307 .Va pipe-EXTENSION
1308 variable \(en these handlers take precedence.
1309 \*(OPally \*(UA supports mail user agent configuration as defined in
1310 RFC 1524; this mechanism, documented in the section
1311 .Sx "The Mailcap files" ,
1312 will be queried for display or quote handlers if none of the former two
1313 .\" TODO v15-compat "will be" -> "is"
1314 did; it will be the sole source for handlers of other purpose.
1315 A last source for handlers may be the MIME type definition itself, if
1316 the \*(UA specific type-marker extension was used when defining the type
1317 with the command
1318 .Ic mimetype .
1319 (Many of the builtin MIME types do so by default.)
1322 The variable
1323 .Va mime-counter-evidence
1324 can be set to improve dealing with faulty MIME part declarations as are
1325 often seen in real-life messages.
1326 E.g., to display a HTML message inline (that is, converted to a more
1327 fancy plain text representation than the builtin converter is capable to
1328 produce) with either of the text-mode browsers
1329 .Xr lynx 1
1331 .Xr elinks 1 ,
1332 teach \*(UA about MathML documents and make it display them as plain
1333 text, and to open PDF attachments in an external PDF viewer,
1334 asynchronously and with some other magic attached:
1336 .Bd -literal -offset indent
1337 if [ "$features" !@ +filter-html-tagsoup ]
1338   #set pipe-text/html='elinks -force-html -dump 1'
1339   set pipe-text/html='lynx -stdin -dump -force_html'
1340   # Display HTML as plain text instead
1341   #set pipe-text/html=@
1342 endif
1343 mimetype '@ application/mathml+xml mathml'
1344 wysh set pipe-application/pdf='@&=@ \e
1345   trap "rm -f \e"${MAILX_FILENAME_TEMPORARY}\e"" EXIT;\e
1346   trap "trap \e"\e" INT QUIT TERM; exit 1" INT QUIT TERM;\e
1347   mupdf "${MAILX_FILENAME_TEMPORARY}"'
1351 Note: special care must be taken when using such commands as mail
1352 viruses may be distributed by this method: if messages of type
1353 .Ql application/x-sh
1354 or files with the extension
1355 .Ql .sh
1356 were blindly filtered through the shell, for example, a message sender
1357 could easily execute arbitrary code on the system \*(UA is running on.
1358 For more on MIME, also in respect to sending of messages, see the
1359 sections
1360 .Sx "The mime.types files" ,
1361 .Sx "The Mailcap files"
1362 and the command
1363 .Ic mimetype .
1364 .\" }}}
1366 .\" .Ss "Mailing lists" {{{
1367 .Ss "Mailing lists"
1369 \*(UA offers some support to ease handling of mailing lists.
1370 The command
1371 .Ic mlist
1372 promotes all given arguments to known mailing lists, and
1373 .Ic mlsubscribe
1374 sets their subscription attribute, creating them first as necessary.
1375 (On the other hand
1376 .Ic unmlsubscribe
1377 does not
1378 .Ic unmlist
1379 automatically, but only resets the subscription attribute.)
1380 Using the commands without arguments will show (a subset of) all
1381 currently defined mailing lists.
1383 .Va headline
1384 format
1385 .Ql \&%T
1386 can be used to mark out messages with configured list addresses
1387 in the header display.
1390 \*(OPally mailing lists may also be specified as (extended) regular
1391 expressions, which allows matching of many addresses with a single
1392 expression.
1393 However, all fully qualified list addresses are matched via a fast
1394 dictionary, whereas expressions are placed in (a) list(s) which is
1395 (are) matched sequentially.
1397 .Bd -literal -offset indent
1398 set followup-to followup-to-honour=ask-yes reply-to-honour=ask-yes
1399 wysh mlist a1@b1.c1 a2@b2.c2 '.*@lists\e.c3$'
1400 mlsubscribe a4@b4.c4 exact@lists.c3
1404 The variable
1405 .Va followup-to-honour
1406 will ensure that a
1407 .Ql Mail-\:Followup-\:To:
1408 header is honoured when the message is being replied to (via
1409 .Ic reply
1411 .Ic Lreply )
1413 .Va followup-to
1414 controls whether this header is created when sending mails; it will be
1415 created automatically for a couple of reasons, too, like when the
1416 special
1417 .Dq mailing list specific
1418 respond command
1419 .Ic Lreply
1420 is used, when
1421 .Ic reply
1422 is used to respond to a message with its
1423 .Ql Mail-Followup-To:
1424 being honoured etc.
1427 A difference in between the handling of known and subscribed lists is
1428 that the address of the sender is usually not part of a generated
1429 .Ql Mail-Followup-To:
1430 when addressing the latter, whereas it is for the former kind of lists.
1431 Usually because there are exceptions: say, if multiple lists are
1432 addressed and not all of them are subscribed lists.
1434 For convenience \*(UA will, temporarily, automatically add a list
1435 address that is presented in the
1436 .Ql List-To:
1437 header of a message that is being responded to to the list of known
1438 mailing lists.
1439 Shall that header have existed \*(UA will instead, dependent on the
1440 variable
1441 .Va reply-to-honour ,
1442 use an also set
1443 .Ql Reply-To:
1444 for this purpose in order to accept a list administrators' wish that
1445 is supposed to have been manifested like that (but only if it provides
1446 a single address which resides on the same domain as what is stated in
1447 .Ql List-To: ) .
1448 .\" }}}
1450 .\" .Ss "Resource files" {{{
1451 .Ss "Resource files"
1453 Upon startup \*(UA reads in several resource files:
1455 .Bl -tag -width ".It Pa BaNg"
1457 .It Pa \*(UR
1458 System wide initialization file.
1459 Reading of this file can be suppressed, either by using the
1460 .Fl \&:
1461 (and according argument) or
1462 .Fl n
1463 command line options, or by setting the
1464 .Sx ENVIRONMENT
1465 variable
1466 .Ev MAILX_NO_SYSTEM_RC .
1469 .It Pa \*(ur
1470 File giving initial commands.
1471 A different file can be chosen by setting the
1472 .Sx ENVIRONMENT
1473 variable
1474 .Ev MAILRC .
1475 Reading of this file can be suppressed with the
1476 .Fl \&:
1477 command line option.
1479 .It Va mailx-extra-rc
1480 Can be used to define an optional startup file to be read after all
1481 other resource files.
1482 It can be used to specify settings that are not understood by other
1483 .Xr mailx 1
1484 implementations, for example.
1485 This variable is only honoured when defined in a resource file, e.g.,
1486 it is one of the
1487 .Sx "INTERNAL VARIABLES" .
1491 The content of these files is interpreted as follows:
1494 .Bl -bullet -compact
1496 A lines' leading whitespace is removed.
1498 Empty lines are ignored.
1500 Any other line is interpreted as a command.
1501 It may be spread over multiple input lines if the newline character is
1502 .Dq escaped
1503 by placing a reverse solidus character
1504 .Ql \e
1505 as the last character of the line; whereas any leading whitespace of
1506 follow lines is ignored, trailing whitespace before a escaped newline
1507 remains in the input.
1509 If the line (content) starts with the number sign
1510 .Ql #
1511 then it is a comment-command \(en a real command! \(en and also ignored.
1512 This command is the only form of comment that is understood.
1516 Unless \*(UA is about to enter interactive mode syntax errors that occur
1517 while loading these files are treated as errors and cause program exit.
1518 More files with syntactically equal content can be
1519 .Ic source Ns ed .
1520 The following, saved in a file, would be an examplary content:
1522 .Bd -literal -offset indent
1523  # This line is a comment command.  And y\e
1524     es, it is really continued here.
1525 set debug \e
1526     verbose
1527     set editheaders
1529 .\" }}}
1531 .\" .Ss "Character sets" {{{
1532 .Ss "Character sets"
1534 \*(OP \*(UA detects the character set of the terminal by using
1535 mechanisms that are controlled by the
1536 .Ev LC_CTYPE
1537 locale setting
1538 (the manual for
1539 .Xr setlocale 3
1540 should give an overview); the \*(UA internal variable
1541 .Va ttycharset
1542 will be set to the detected terminal character set accordingly
1543 and will thus show up in the output of the commands
1544 .Ic set
1546 .Ic varshow .
1549 However, a user supplied
1550 .Va ttycharset
1551 value is not overwritten by this detection mechanism: this
1552 .Dq feature
1553 must be used if the detection does not work properly,
1554 and it may be used to adjust the name of the locale character set.
1555 E.g., on BSD systems one may use a locale with the character set
1556 ISO8859-1, which is not a valid name for this character set; to be on
1557 the safe side, one may set
1558 .Va ttycharset
1559 to the correct name, which is ISO-8859-1.
1562 Note that changing the value does not mean much beside that,
1563 since several aspects of the real character set are implied by the
1564 locale environment of the system,
1565 and that stays unaffected by the content of an overwritten
1566 .Va ttycharset
1567 variable.
1568 (This is mostly an issue when interactively using \*(UA, though.
1569 It is actually possible to send mail in a completely
1570 .Dq faked
1571 locale environment, an option that \*(UA's test-suite uses excessively.)
1574 If no character set conversion capabilities have been compiled into
1575 \*(UA
1576 .Pf ( Va features
1577 does not include the term
1578 .Ql +iconv ) ,
1579 then
1580 .Va ttycharset
1581 will be the only supported character set,
1582 it is simply assumed that it can be used to exchange 8-bit messages
1583 (over the wire an intermediate
1584 .Pf content-transfer-\: Va encoding
1585 may be applied),
1586 and the rest of this section does not apply;
1587 it may however still be necessary to explicitly set it if automatic
1588 detection fails, since in that case it defaults to the mentioned
1589 .\" (Keep in SYNC: ./nail.1:"Character sets", ./nail.h:CHARSET_*!)
1590 ISO-8859-1.
1593 When reading messages, their text is converted into
1594 .Va ttycharset
1595 as necessary in order to display them on the users terminal.
1596 Unprintable characters and invalid byte sequences are detected
1597 and replaced by proper substitution characters.
1598 Character set mappings for source character sets can be established with
1599 the command
1600 .Ic charsetalias ,
1601 which may be handy to work around faulty character set catalogues (e.g.,
1602 to add a missing LATIN1 to ISO-8859-1 mapping), or to enforce treatment
1603 of one character set as another one (e.g., to interpret LATIN1 as CP1252).
1604 Also see
1605 .Va charset-unknown-8bit
1606 to deal with another hairy aspect of message interpretation.
1609 When sending messages all their parts and attachments are classified.
1610 Whereas no character set conversion is performed on those parts which
1611 appear to be binary data,
1612 the character set being used must be declared within the MIME header of
1613 an outgoing text part if it contains characters that do not conform to
1614 the set of characters that are allowed by the email standards.
1615 Permissible values for character sets can be declared using the
1616 .Va sendcharsets
1617 variable, and
1618 .Va charset-8bit ,
1619 which defines a catch-all last-resort fallback character set that is
1620 implicitly appended to the list of character sets in
1621 .Va sendcharsets .
1624 When replying to a message and the variable
1625 .Va reply-in-same-charset
1626 is set then the character set of the message being replied to is tried
1627 first (after mapping via
1628 .Ic charsetalias ) .
1629 And it is also possible to make \*(UA work even more closely related to
1630 the current locale setting automatically by using the variable
1631 .Va sendcharsets-else-ttycharset ,
1632 please see there for more information.
1635 All the specified character sets are tried in order unless the
1636 conversion of the part or attachment succeeds.
1637 If none of the tried (8-bit) character sets is capable to represent the
1638 content of the part or attachment,
1639 then the message will not be sent and its text will optionally be
1640 .Va save Ns d
1642 .Ev DEAD .
1643 In general, if the message
1644 .Dq Cannot convert from a to b
1645 appears, either some characters are not appropriate for the currently
1646 selected (terminal) character set,
1647 or the needed conversion is not supported by the system.
1648 In the first case, it is necessary to set an appropriate
1649 .Ev LC_CTYPE
1650 locale and/or the variable
1651 .Va ttycharset .
1654 The best results are usually achieved when \*(UA is run in a UTF-8
1655 locale on a UTF-8 capable terminal, in which case the full Unicode
1656 spectrum of characters is available.
1657 In this setup characters from various countries can be displayed,
1658 while it is still possible to use more simple character sets for sending
1659 to retain maximum compatibility with older mail clients.
1662 On the other hand the POSIX standard defines a locale-independent 7-bit
1663 .Dq portable character set
1664 that should be used when overall portability is an issue, the even more
1665 restricted subset named
1666 .Dq portable filename character set
1667 consisting of A-Z, a-z, 0-9, period
1668 .Ql \&. ,
1669 underscore
1670 .Ql _
1671 and hyphen-minus
1672 .Ql - .
1673 .\" }}}
1675 .\" .Ss "Message states" {{{
1676 .Ss "Message states"
1678 \*(UA differentiates in between several different message states;
1679 the current state will be reflected in header summary displays if
1680 .Va headline
1681 is configured to do so (via the internal variable
1682 .Va attrlist ) ,
1683 and messages can also be selected and be acted upon depending on their
1684 state (see
1685 .Sx "Specifying messages" ) .
1686 When operating on the system
1687 .Va inbox ,
1688 or in any other
1689 .Mx -sx
1690 .Sx "primary system mailbox" ,
1691 special actions, like the automatic moving of messages to the
1692 .Mx -sx
1693 .Sx "secondary mailbox"
1694 .Ev MBOX ,
1695 may be applied when the mailbox is left (also implicitly via
1696 a successful exit of \*(UA, but not if the special command
1697 .Ic exit
1698 is used) \(en however, because this may be irritating to users which
1699 are used to
1700 .Dq more modern
1701 mail-user-agents, the default global
1702 .Pa \*(UR
1703 sets the internal
1704 .Va hold
1706 .Va keepsave
1707 variables in order to suppress this behaviour.
1709 .Bl -hang -width ".It Ql new"
1710 .It Ql new
1711 Message has neither been viewed nor moved to any other state.
1712 Such messages are retained even in the
1713 .Mx -sx
1714 .Sx "primary system mailbox" .
1716 .It Ql unread
1717 Message has neither been viewed nor moved to any other state, but the
1718 message was present already when the mailbox has been opened last:
1719 Such messages are retained even in the
1720 .Mx -sx
1721 .Sx "primary system mailbox" .
1723 .It Ql read
1724 The message has been processed by one of the following commands:
1725 .Ic ~f ,
1726 .Ic ~m ,
1727 .Ic ~F ,
1728 .Ic ~M ,
1729 .Ic copy ,
1730 .Ic mbox ,
1731 .Ic next ,
1732 .Ic pipe  ,
1733 .Ic Print ,
1734 .Ic print ,
1735 .Ic top ,
1736 .Ic Type ,
1737 .Ic type ,
1738 .Ic undelete .
1739 The commands
1740 .Ic dp
1742 .Ic dt
1743 will always try to automatically
1744 .Dq step
1746 .Ic type
1748 .Dq next
1749 logical message, and may thus mark multiple messages as read, the
1750 .Ic delete
1751 command will do so if  the internal variable
1752 .Va autoprint
1753 is set.
1754 Except when the
1755 .Ic exit
1756 command is used, messages that are in a
1757 .Mx -sx
1758 .Sx "primary system mailbox"
1759 and are in
1760 .Ql read
1761 state when the mailbox is left will be saved in
1762 .Ev MBOX
1763 unless the internal variable
1764 .Va hold
1765 it set.
1767 .It Ql deleted
1768 The message has been processed by one of the following commands:
1769 .Ic delete ,
1770 .Ic dp ,
1771 .Ic dt .
1772 Only
1773 .Ic undelete
1774 can be used to access such messages.
1776 .It Ql preserved
1777 The message has been processed by a
1778 .Ic preserve
1779 command and it will be retained in its current location.
1781 .It Ql saved
1782 The message has been processed by one of the following commands:
1783 .Ic save
1785 .Ic write .
1786 Unless when the
1787 .Ic exit
1788 command is used, messages that are in a
1789 .Mx -sx
1790 .Sx "primary system mailbox"
1791 and are in
1792 .Ql saved
1793 state when the mailbox is left will be deleted; they will be saved in
1794 .Ev MBOX
1795 when the internal variable
1796 .Va keepsave
1797 is set.
1801 In addition to these message states, flags which otherwise have no
1802 technical meaning in the mail system except allowing special ways of
1803 addressing them when
1804 .Sx "Specifying messages"
1805 can be set on messages.
1806 These flags are saved with messages and are thus persistent, and are
1807 portable between a set of widely used MUAs.
1809 .Bl -hang -width ".It Ic answered"
1810 .It Ic answered
1811 Mark messages as having been answered.
1812 .It Ic draft
1813 Mark messages as being a draft.
1814 .It Ic flag
1815 Mark messages which need special attention.
1817 .\" }}}
1819 .\" .Ss "Specifying messages" {{{
1820 .Ss "Specifying messages"
1822 Commands such as
1823 .Ic from ,
1824 .Ic type
1826 .Ic delete
1827 can be given a list of message numbers as arguments to apply to a number
1828 of messages at once.
1829 Thus
1830 .Ql delete 1 2
1831 deletes messages 1 and 2,
1832 whereas
1833 .Ql delete 1-5
1834 will delete the messages 1 through 5.
1835 In sorted or threaded mode (see the
1836 .Ic sort
1837 command),
1838 .Ql delete 1-5
1839 will delete the messages that are located between (and including)
1840 messages 1 through 5 in the sorted/threaded order, as shown in the
1841 .Ic headers
1842 summary.
1843 The following special message names exist:
1846 .Bl -tag -width ".It Ar BaNg"
1847 .It Ar \&.
1848 The current message, the so-called
1849 .Dq dot .
1851 .It Ar \&;
1852 The message that was previously the current message.
1854 .It Ar \&,
1855 The parent message of the current message,
1856 that is the message with the Message-ID given in the
1857 .Ql In-Reply-To:
1858 field or the last entry of the
1859 .Ql References:
1860 field of the current message.
1862 .It Ar -
1863 The next previous undeleted message,
1864 or the next previous deleted message for the
1865 .Ic undelete
1866 command.
1867 In sorted/threaded mode,
1868 the next previous such message in the sorted/threaded order.
1870 .It Ar +
1871 The next undeleted message,
1872 or the next deleted message for the
1873 .Ic undelete
1874 command.
1875 In sorted/threaded mode,
1876 the next such message in the sorted/threaded order.
1878 .It Ar ^
1879 The first undeleted message,
1880 or the first deleted message for the
1881 .Ic undelete
1882 command.
1883 In sorted/threaded mode,
1884 the first such message in the sorted/threaded order.
1886 .It Ar $
1887 The last message.
1888 In sorted/threaded mode,
1889 the last message in the sorted/threaded order.
1891 .It Ar & Ns Ar x
1892 In threaded mode,
1893 selects the message addressed with
1894 .Ar x ,
1895 where
1896 .Ar x
1897 is any other message specification,
1898 and all messages from the thread that begins at it.
1899 Otherwise it is identical to
1900 .Ar x .
1902 .Ar x
1903 is omitted,
1904 the thread beginning with the current message is selected.
1906 .It Ar *
1907 All messages.
1908 .It Ar `
1909 All messages that were included in the
1910 .Sx "Message list arguments"
1911 of the previous command.
1913 .It Ar x-y
1914 An inclusive range of message numbers.
1915 Selectors that may also be used as endpoints include any of
1916 .Ar .;-+^$ .
1918 .It Ar address
1919 A case-insensitive
1920 .Dq any substring matches
1921 search against the
1922 .Ql From:
1923 header, which will match addresses (too) even if
1924 .Va showname
1925 is set (and POSIX says
1926 .Dq any address as shown in a header summary shall be matchable in this form ) ;
1927 However, if the
1928 .Va allnet
1929 variable is set, only the local part of the address is evaluated
1930 for the comparison, not ignoring case, and the setting of
1931 .Va showname
1932 is completely ignored.
1933 For finer control and match boundaries use the
1934 .Ql @
1935 search expression.
1937 .It Ar / Ns Ar string
1938 All messages that contain
1939 .Ar string
1940 in the subject field (case ignored).
1941 See also the
1942 .Va searchheaders
1943 variable.
1945 .Ar string
1946 is empty,
1947 the string from the previous specification of that type is used again.
1949 .It Xo Op Ar @ Ns Ar name-list Ns
1950 .Ar @ Ns Ar expr
1952 All messages that contain the given case-insensitive search
1953 .Ar expr Ns
1954 ession; if the \*(OPal regular expression (see
1955 .Xr re_format 7 )
1956 support is available
1957 .Ar expr
1958 will be interpreted as (an extended) one if any of the
1959 .Dq magical
1960 (extended) regular expression characters is seen: in this case this
1961 should match strings correctly which are in the locale
1962 .Ev LC_CTYPE
1963 encoding.
1964 If the optional
1965 .Ar @ Ns Ar name-list
1966 part is missing, the search is restricted to the subject field body,
1967 but otherwise
1968 .Ar name-list
1969 specifies a comma-separated list of header fields to search, as in
1971 .Dl '@to,from,cc@Someone i ought to know'
1973 In order to search for a string that includes a
1974 .Ql @
1975 (commercial at) character the
1976 .Ar name-list
1977 is effectively non-optional, but may be given as the empty string.
1978 Some special header fields may be abbreviated:
1979 .Ql f ,
1980 .Ql t ,
1981 .Ql c ,
1982 .Ql b
1984 .Ql s
1985 will match
1986 .Ql From ,
1987 .Ql To ,
1988 .Ql Cc ,
1989 .Ql Bcc
1991 .Ql Subject ,
1992 respectively and case-insensitively.
1993 The special names
1994 .Ql header
1996 .Ql <
1997 can be used to search in (all of) the header(s) of the message, and the
1998 special names
1999 .Ql body
2001 .Ql >
2003 .Ql text
2005 .Ql =
2006 can be used to perform full text searches \(en whereas the former
2007 searches only the body, the latter also searches the message header.
2009 This message specification performs full text comparison, but even with
2010 regular expression support it is almost impossible to write a search
2011 expression that savely matches only a specific address domain.
2012 To request that the content of the header is treated as a list of
2013 addresses, and to strip those down to the plain email address which the
2014 search expression is to be matched against, prefix the header name
2015 (abbreviation) with a tilde
2016 .Ql ~ :
2018 .Dl @~f@@a\e.safe\e.domain\e.match$
2020 .It Ar :c
2021 All messages of state
2022 .Ql c ,
2023 where
2024 .Ql c
2025 is one or multiple of the following colon modifiers:
2027 .Bl -tag -compact -width ".It Ar :M"
2028 .It Ar n
2029 .Ql new
2030 messages.
2031 .It Ar o
2032 Old messages (any not in state
2033 .Ql read
2035 .Ql new ) .
2036 .It Ar u
2037 .Ql unread
2038 messages.
2039 .It Ar d
2040 .Ql deleted
2041 messages (for the
2042 .Ic undelete
2044 .Ic from
2045 commands only).
2046 .It Ar r
2047 .Ql read
2048 messages.
2049 .It Ar f
2050 .Ic flag Ns
2051 ged messages.
2052 .It Ar a
2053 .Ic answered
2054 messages (cf. the variable
2055 .Va markanswered ) .
2056 .It Ar t
2057 Messages marked as
2058 .Ic draft .
2059 .It Ar s
2060 \*(OP Messages classified as spam (see
2061 .Sx "Handling spam" . )
2062 .It Ar S
2063 \*(OP Messages with unsure spam classification.
2069 \*(OP IMAP-style SEARCH expressions may also be used.
2070 This addressing mode is available with all types of folders;
2071 \*(UA will perform the search locally as necessary.
2072 Strings must be enclosed by double quotes
2073 .Ql \&"
2074 in their entirety if they contain white space or parentheses;
2075 within the quotes, only reverse solidus
2076 .Ql \e
2077 is recognized as an escape character.
2078 All string searches are case-insensitive.
2079 When the description indicates that the
2080 .Dq envelope
2081 representation of an address field is used,
2082 this means that the search string is checked against both a list
2083 constructed as
2085 .Bd -literal -offset indent
2086 (\*qname\*q \*qsource\*q \*qlocal-part\*q \*qdomain-part\*q)
2090 for each address,
2091 and the addresses without real names from the respective header field.
2092 These search expressions can be nested using parentheses, see below for
2093 examples.
2096 .Bl -tag -compact -width ".It Ar _n_u"
2097 .It Ar ( criterion )
2098 All messages that satisfy the given
2099 .Ar criterion .
2100 .It Ar ( criterion1 criterion2 ... criterionN )
2101 All messages that satisfy all of the given criteria.
2103 .It Ar ( or criterion1 criterion2 )
2104 All messages that satisfy either
2105 .Ar criterion1
2107 .Ar criterion2 ,
2108 or both.
2109 To connect more than two criteria using
2110 .Ql or
2111 specifications have to be nested using additional parentheses,
2112 as with
2113 .Ql (or a (or b c)) ,
2114 since
2115 .Ql (or a b c)
2116 really means
2117 .Ql ((a or b) and c) .
2118 For a simple
2119 .Ql or
2120 operation of independent criteria on the lowest nesting level,
2121 it is possible to achieve similar effects by using three separate
2122 criteria, as with
2123 .Ql (a) (b) (c) .
2125 .It Ar ( not criterion )
2126 All messages that do not satisfy
2127 .Ar criterion .
2128 .It Ar ( bcc \*q Ns Ar string Ns Ar \*q )
2129 All messages that contain
2130 .Ar string
2131 in the envelope representation of the
2132 .Ql Bcc:
2133 field.
2134 .It Ar ( cc \*q Ns Ar string Ns Ar \*q )
2135 All messages that contain
2136 .Ar string
2137 in the envelope representation of the
2138 .Ql Cc:
2139 field.
2140 .It Ar ( from \*q Ns Ar string Ns Ar \*q )
2141 All messages that contain
2142 .Ar string
2143 in the envelope representation of the
2144 .Ql From:
2145 field.
2146 .It Ar ( subject \*q Ns Ar string Ns Ar \*q )
2147 All messages that contain
2148 .Ar string
2149 in the
2150 .Ql Subject:
2151 field.
2152 .It Ar ( to \*q Ns Ar string Ns Ar \*q )
2153 All messages that contain
2154 .Ar string
2155 in the envelope representation of the
2156 .Ql To:
2157 field.
2158 .It Ar ( header name \*q Ns Ar string Ns Ar \*q )
2159 All messages that contain
2160 .Ar string
2161 in the specified
2162 .Ql Name:
2163 field.
2164 .It Ar ( body \*q Ns Ar string Ns Ar \*q )
2165 All messages that contain
2166 .Ar string
2167 in their body.
2168 .It Ar ( text \*q Ns Ar string Ns Ar \*q )
2169 All messages that contain
2170 .Ar string
2171 in their header or body.
2172 .It Ar ( larger size )
2173 All messages that are larger than
2174 .Ar size
2175 (in bytes).
2176 .It Ar ( smaller size )
2177 All messages that are smaller than
2178 .Ar size
2179 (in bytes).
2181 .It Ar ( before date )
2182 All messages that were received before
2183 .Ar date ,
2184 which must be in the form
2185 .Ql d[d]-mon-yyyy ,
2186 where
2187 .Ql d
2188 denotes the day of the month as one or two digits,
2189 .Ql mon
2190 is the name of the month \(en one of
2191 .Ql Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec ,
2193 .Ql yyyy
2194 is the year as four digits, e.g.,
2195 .Ql 28-Dec-2012 .
2197 .It Ar ( on date )
2198 All messages that were received on the specified date.
2199 .It Ar ( since date )
2200 All messages that were received since the specified date.
2201 .It Ar ( sentbefore date )
2202 All messages that were sent on the specified date.
2203 .It Ar ( senton date )
2204 All messages that were sent on the specified date.
2205 .It Ar ( sentsince date )
2206 All messages that were sent since the specified date.
2207 .It Ar ()
2208 The same criterion as for the previous search.
2209 This specification cannot be used as part of another criterion.
2210 If the previous command line contained more than one independent
2211 criterion then the last of those criteria is used.
2213 .\" }}}
2215 .\" .Ss "On URL syntax and credential lookup" {{{
2216 .Ss "On URL syntax and credential lookup"
2218 \*(IN For accessing protocol-specific resources usage of Uniform
2219 Resource Locators (URL, RFC 1738) has become omnipresent.
2220 \*(UA expects and understands URLs in the following form;
2221 parts in brackets
2222 .Ql []
2223 denote optional parts, optional either because there also exist other
2224 ways to define the information in question or because support of the
2225 part is protocol-specific (e.g.,
2226 .Ql /path
2227 is used by the IMAP protocol but not by POP3);
2228 If any of
2229 .Ql USER
2231 .Ql PASSWORD
2232 are specified they must be given in URL percent encoded form (RFC 3986;
2233 the command
2234 .Ic urlcodec
2235 may be helpful):
2238 .Dl PROTOCOL://[USER[:PASSWORD]@]server[:port][/path]
2241 Note that these \*(UA URLs most often do not conform to any real
2242 standard, but instead represent a normalized variant of RFC 1738 \(en
2243 they are not used in data exchange but only meant as a compact,
2244 easy-to-use way of defining and representing information in
2245 a well-known notation.
2248 Many internal variables of \*(UA exist in multiple versions, called
2249 variable chains for the rest of this document: the plain
2250 .Ql variable
2251 as well as
2252 .Ql variable-HOST
2254 .Ql variable-USER@HOST .
2255 Here
2256 .Ql HOST
2257 indeed means
2258 .Ql server:port
2259 if a
2260 .Ql port
2261 had been specified in the respective URL, otherwise it refers to the plain
2262 .Ql server .
2263 Also,
2264 .Ql USER
2265 is not truly the
2266 .Ql USER
2267 that had been found when doing the user chain lookup as is described
2268 below, i.e., this
2269 .Ql USER
2270 will never be in URL percent encoded form, whether it came from an URL
2271 or not; i.e., variable chain name extensions of
2272 .Sx "INTERNAL VARIABLES"
2273 must not be URL percent encoded.
2276 For example, whether an hypothetical URL
2277 .Ql smtp://hey%3Ayou@our.house
2278 had been given that includes a user, or whether the URL was
2279 .Ql smtp://our.house
2280 and the user had been found differently, to lookup the variable chain
2281 .Va smtp-use-starttls
2282 \*(UA first looks for whether
2283 .Ql smtp-\:use-\:starttls-\:hey:you@our.house
2284 is defined, then whether
2285 .Ql smtp-\:use-\:starttls-\:our.house
2286 exists before finally ending up looking at the plain variable itself.
2289 \*(UA obeys the following logic scheme when dealing with the
2290 necessary credential information of an account:
2292 .Bl -bullet
2294 If no
2295 .Ql USER
2296 has been given in the URL the variables
2297 .Va user-HOST
2299 .Va user
2300 are looked up; if no such variable(s) can be found then \*(UA will,
2301 when enforced by the \*(OPal variables
2302 .Va netrc-lookup-HOST
2304 .Va netrc-lookup ,
2305 search the users
2306 .Pa .netrc
2307 file for a
2308 .Ql HOST
2309 specific entry which provides a
2310 .Ql login
2311 name: this lookup will only succeed if unambiguous (one possible matching
2312 entry for
2313 .Ql HOST ) .
2314 It is possible to load encrypted
2315 .Pa .netrc
2316 files via
2317 .Va netrc-pipe .
2319 If there is still no
2320 .Ql USER
2321 then \*(UA will fall back to the user who is supposed to run \*(UA,
2322 the identity of which has been fixated during \*(UA startup and is
2323 known to be a valid user on the current host.
2326 Authentication: unless otherwise noted this will lookup the
2327 .Va PROTOCOL-auth-USER@HOST , PROTOCOL-auth-HOST , PROTOCOL-auth
2328 variable chain, falling back to a protocol-specific default should this
2329 have no success.
2332 If no
2333 .Ql PASSWORD
2334 has been given in the URL, then if the
2335 .Ql USER
2336 has been found through the \*(OPal
2337 .Va netrc-lookup
2338 that may have already provided the password, too.
2339 Otherwise the variable chain
2340 .Va password-USER@HOST , password-HOST , password
2341 is looked up and used if existent.
2343 Afterwards the complete \*(OPal variable chain
2344 .Va netrc-lookup-USER@HOST , netrc-lookup-HOST , netrc-lookup
2345 is looked up.
2346 If set, the
2347 .Pa .netrc
2348 cache is searched for a password only (multiple user accounts for
2349 a single machine may exist as well as a fallback entry without user
2350 but with a password).
2352 If at that point there is still no password available, but the
2353 (protocols') chosen authentication type requires a password, then in
2354 interactive mode the user will be prompted on the terminal.
2358 .Sy Note:
2359 S/MIME verification works relative to the values found in the
2360 .Ql From:
2362 .Ql Sender: )
2363 header field(s), which means that the values of
2364 .Va smime-sign , smime-sign-cert , smime-sign-include-certs
2366 .Va smime-sign-message-digest
2367 will not be looked up using the
2368 .Ql USER
2370 .Ql HOST
2371 chains from above but instead use the corresponding values from the
2372 message that is being worked on.
2373 In unusual cases multiple and different
2374 .Ql USER
2376 .Ql HOST
2377 combinations may therefore be involved \(en on the other hand those
2378 unusual cases become possible.
2379 The usual case is as short as:
2382 .Dl set mta=smtp://USER:PASS@HOST smtp-use-starttls \e
2383 .Dl \ \ \ \ smime-sign smime-sign-cert=+smime.pair
2386 The section
2387 .Sx EXAMPLES
2388 contains complete example configurations.
2389 .\" }}}
2391 .\" .Ss "On terminal control and line editor" {{{
2392 .Ss "On terminal control and line editor"
2394 \*(OP Terminal control will be realized through one of the standard
2396 libraries, either the
2397 .Lb libtermcap ,
2398 or, alternatively, the
2399 .Lb libterminfo ,
2400 both of which will be initialized to work with the environment variable
2401 .Ev TERM .
2402 Terminal control will enhance or enable interactive usage aspects, e.g.,
2403 .Sx "Coloured display" ,
2404 and extend behaviour of the Mailx-Line-Editor (MLE), which may learn the
2405 byte-sequences of keys like the cursor and function keys, and which will
2406 automatically enter the so-called
2407 .Dq ca-mode
2408 alternative screen shall the terminal support it.
2409 The internal variable
2410 .Va termcap
2411 can be used to overwrite settings or to learn (correct(ed)) keycodes.
2412 Actual interaction with the chosen library can be disabled completely by
2413 setting the internal variable
2414 .Va termcap-disable ;
2415 .Va termcap
2416 will be queried regardless, even if the \*(OPal support for the
2417 libraries has not been enabled at configuration time.
2420 \*(OP The builtin \*(UA Mailx-Line-Editor (MLE) should work in all
2421 environments which comply to the ISO C standard
2422 .St -isoC-amd1 ,
2423 and will support wide glyphs if possible (the necessary functionality
2424 had been removed from ISO C, but was included in
2425 .St -xpg4 ) .
2426 Prevent usage of a line editor in interactive mode by setting the
2427 internal variable
2428 .Va line-editor-disable .
2429 Especially if the \*(OPal terminal control support is missing setting
2430 entries in the internal variable
2431 .Va termcap
2432 will help shall the MLE misbehave, see there for more.
2433 The MLE can support a little bit of
2434 .Ic colour .
2437 \*(OP If the
2438 .Ic history
2439 feature is available then input from line editor prompts will be saved
2440 in a history list that can be searched in and be expanded from.
2441 Such saving can be prevented by prefixing input with any amount of
2442 whitespace.
2443 Aspects of history, like allowed content and maximum size, as well as
2444 whether history shall be saved persistently, can be configured with the
2445 internal variables
2446 .Va history-file ,
2447 .Va history-gabby ,
2448 .Va history-gabby-persist
2450 .Va history-size .
2453 The MLE supports a set of editing and control commands.
2454 By default (as) many (as possible) of these will be assigned to a set of
2455 single-letter control codes, which should work on any terminal (and can
2456 be generated by holding the
2457 .Dq control
2458 key while pressing the key of desire, e.g.,
2459 .Ql control-D ) .
2460 If the \*(OPal
2461 .Ic bind
2462 command is available then the MLE commands can also be accessed freely
2463 by assigning the command name, which is shown in parenthesis in the list
2464 below, to any desired key-sequence, and the MLE will instead and also use
2465 .Ic bind
2466 to establish its builtin key bindings
2467 (more of them if the \*(OPal terminal control is available),
2468 an action which can then be suppressed completely by setting
2469 .Va line-editor-no-defaults .
2470 .Sx "Shell-style argument quoting"
2471 notation is used in the following;
2472 combinations not mentioned either cause job control signals or do not
2473 generate a (unique) keycode:
2477 .Bl -tag -compact -width ".It Ql Ba"
2478 .It Ql \ecA
2479 Go to the start of the line
2481 .Pf ( Cd mle-go-home ) .
2483 .It Ql \ecB
2484 Move the cursor backward one character
2486 .Pf ( Cd mle-go-bwd ) .
2488 .It Ql \ecD
2489 Forward delete the character under the cursor;
2490 quits \*(UA if used on the empty line unless the internal variable
2491 .Va ignoreeof
2492 is set
2494 .Pf ( Cd mle-del-fwd ) .
2496 .It Ql \ecE
2497 Go to the end of the line
2499 .Pf ( Cd mle-go-end ) .
2501 .It Ql \ecF
2502 Move the cursor forward one character
2504 .Pf ( Cd mle-go-fwd ) .
2506 .It Ql \ecG
2507 Cancel current operation, full reset.
2508 If there is an active history search or tabulator expansion then this
2509 command will first reset that, reverting to the former line content;
2510 thus a second reset is needed for a full reset in this case
2512 .Pf ( Cd mle-reset ) .
2514 .It Ql \ecH
2515 Backspace: backward delete one character
2517 .Pf ( Cd mle-del-bwd ) .
2519 .It Ql \ecI
2520 \*(NQ
2521 Horizontal tabulator:
2522 try to expand the word before the cursor, supporting the usual
2523 .Sx "Filename transformations"
2525 .Pf ( Cd mle-complete ) .
2526 This is affected by
2527 .Cd mle-quote-rndtrip .
2529 .It Ql \ecJ
2530 Newline:
2531 commit the current line
2533 .Pf ( Cd mle-commit ) .
2535 .It Ql \ecK
2536 Cut all characters from the cursor to the end of the line
2538 .Pf ( Cd mle-snarf-end ) .
2540 .It Ql \ecL
2541 Repaint the line
2543 .Pf ( Cd mle-repaint ) .
2545 .It Ql \ecN
2546 \*(OP Go to the next history entry
2548 .Pf ( Cd mle-hist-fwd ) .
2550 .It Ql \ecO
2551 (\*(OPally context-dependent) Invokes the command
2552 .Ql Ic dt .
2554 .It Ql \ecP
2555 \*(OP Go to the previous history entry
2557 .Pf ( Cd mle-hist-bwd ) .
2559 .It Ql \ecQ
2560 Toggle roundtrip mode shell quotes, where produced,
2561 on and off
2563 .Pf ( Cd mle-quote-rndtrip ) .
2564 This setting is temporary, and will be forgotten once the command line
2565 is committed.
2567 .It Ql \ecR
2568 \*(OP Complete the current line from (the remaining) older history entries
2570 .Pf ( Cd mle-hist-srch-bwd ) .
2572 .It Ql \ecS
2573 \*(OP Complete the current line from (the remaining) newer history entries
2575 .Pf ( Cd mle-hist-srch-fwd ) .
2577 .It Ql \ecT
2578 Paste the snarf buffer
2580 .Pf ( Cd mle-paste ) .
2582 .It Ql \ecU
2583 The same as
2584 .Ql \ecA
2585 followed by
2586 .Ql \ecK
2588 .Pf ( Cd mle-snarf-line ) .
2590 .It Ql \ecV
2591 Prompts for a Unicode character (its hexadecimal number) to be inserted
2593 .Pf ( Cd mle-prompt-char ) .
2594 Note this command needs to be assigned to a single-letter control code
2595 in order to become recognized and executed during input of
2596 a key-sequence (only three single-letter control codes can be used for
2597 that shortcut purpose); this control code is special-treated and cannot
2598 be part of any other sequence, because any occurrence will perform the
2599 .Cd mle-prompt-char
2600 function immediately.
2602 .It Ql \ecW
2603 Cut the characters from the one preceding the cursor to the preceding
2604 word boundary
2606 .Pf ( Cd mle-snarf-word-bwd ) .
2608 .It Ql \ecX
2609 Move the cursor forward one word boundary
2611 .Pf ( Cd mle-go-word-fwd ) .
2613 .It Ql \ecY
2614 Move the cursor backward one word boundary
2616 .Pf ( Cd mle-go-word-bwd ) .
2618 .It Ql \ec[
2619 Escape: reset a possibly used multibyte character input state machine
2620 and \*(OPally a lingering, incomplete key binding
2622 .Pf ( Cd mle-cancel ) .
2623 This command needs to be assigned to a single-letter control code in
2624 order to become recognized and executed during input of a key-sequence
2625 (only three single-letter control codes can be used for that shortcut
2626 purpose).
2627 This control code may also be part of a multi-byte sequence, but if
2628 a sequence is active and the very control code is currently also an
2629 expected input, then it will first be consumed by the active sequence.
2631 .It Ql \ec\e
2632 (\*(OPally context-dependent) Invokes the command
2633 .Ql Ic z Ns + .
2635 .It Ql \ec]
2636 (\*(OPally context-dependent) Invokes the command
2637 .Ql Ic z Ns $ .
2639 .It Ql \ec^
2640 (\*(OPally context-dependent) Invokes the command
2641 .Ql Ic z Ns 0 .
2643 .It Ql \ec_
2644 Cut the characters from the one after the cursor to the succeeding word
2645 boundary
2647 .Pf ( Cd mle-snarf-word-fwd ) .
2649 .It Ql \ec?
2650 Backspace:
2651 .Cd mle-del-bwd .
2653 .It \(en
2655 .Cd mle-fullreset :
2656 in difference to
2657 .Cd mle-reset
2658 this will immediately reset a possibly active search etc.
2660 .It \(en
2662 .Cd mle-bell :
2663 ring the audible bell.
2665 .\" }}}
2667 .\" .Ss "Coloured display" {{{
2668 .Ss "Coloured display"
2670 \*(OP \*(UA can be configured to support a coloured display and font
2671 attributes by emitting ANSI / ISO 6429 SGR (select graphic rendition)
2672 escape sequences.
2673 Usage of colours and font attributes solely depends upon the
2674 capability of the detected terminal type that is defined by the
2675 environment variable
2676 .Ev TERM
2677 and which can be fine-tuned by the user via the internal variable
2678 .Va termcap .
2681 On top of what \*(UA knows about the terminal the boolean variable
2682 .Va colour-pager
2683 defines whether the actually applicable colour and font attribute
2684 sequences should also be generated when output is going to be paged
2685 through the external program defined by the environment variable
2686 .Ev PAGER
2687 (also see
2688 .Va crt Ns
2690 This is not enabled by default because different pager programs need
2691 different command line switches or other configuration in order to
2692 support those sequences.
2693 \*(UA however knows about some widely used pagers and in a clean
2694 environment it is often enough to simply set
2695 .Va colour-pager ;
2696 please refer to that variable for more on this topic.
2699 If the variable
2700 .Va colour-disable
2701 is set then any active usage of colour and font attribute sequences
2702 is suppressed, but without affecting possibly established
2703 .Ic colour
2704 mappings.
2707 To define and control colours and font attributes a single multiplexer
2708 command family exists:
2709 .Ic colour
2710 shows or defines colour mappings for the given colour type (e.g.,
2711 monochrome) and
2712 .Ic uncolour
2713 can be used to remove mappings of a given colour type.
2714 Since colours are only available in interactive mode, it may make
2715 sense to conditionalize the colour setup by encapsulating it with
2716 .Ic if :
2718 .Bd -literal -offset indent
2719 if terminal && $features =@ +colour
2720   colour iso  view-msginfo  ft=bold,fg=green
2721   colour iso  view-header   ft=bold,fg=red   "from,subject"
2722   colour iso  view-header   fg=red
2724   uncolour iso view-header  from,subject
2725   colour iso  view-header   ft=bold,fg=magenta,bg=cyan
2726   colour 256  view-header   ft=bold,fg=208,bg=230 subject,from
2727   colour mono view-header   ft=bold
2728   colour mono view-header   ft=bold,ft=reverse subject,from
2729 endif
2731 .\" }}}
2732 .\" }}} (DESCRIPTION)
2735 .\" .Sh COMMANDS {{{
2736 .Sh COMMANDS
2738 Each command is typed on a line by itself,
2739 and may take arguments following the command word.
2740 An unquoted reverse solidus
2741 .Ql \e
2742 at the end of a command line
2743 .Dq escapes
2744 the newline character: it is discarded and the next line of input is
2745 used as a follow-up line, with all leading whitespace removed;
2746 once the entire command line is completed, the processing that is
2747 documented in the following begins.
2750 Command names may be abbreviated, in which case the first command that
2751 matches the given prefix will be used.
2752 The command
2753 .Ic list
2754 can be used to show the list of all commands, either alphabetically
2755 sorted or in prefix search order (these do not match, also because the
2756 POSIX standard prescribes a set of abbreviations).
2757 \*(OPally the command
2758 .Ic help
2760 .Ic \&? ) ,
2761 when given an argument, will show a documentation string for the
2762 command matching the expanded argument, as in
2763 .Ql ?t ,
2764 which should be a shorthand of
2765 .Ql ?type .
2766 Both commands support a more
2767 .Va verbose
2768 listing mode which includes the argument type of the command,
2769 and other information which applies; a handy suggestion might be:
2771 .Bd -literal -offset indent
2772 ? define __xv {
2773   # Be careful to choose sh(1)ell-style on _entire_ line!
2774   # Result status ends up in $!
2775   localopts 1;wysh set verbose;ignerr eval "${@}";return ${?}
2777 ? ghost xv '\ecall __xv'
2778 ? xv help set
2781 .\" .Ss "Command modifiers" {{{
2782 .Ss "Command modifiers"
2784 Commands may be prefixed by one or multiple command modifiers.
2787 .Bl -bullet
2789 The modifier reverse solidus
2791 .Cm \e ,
2792 to be placed first, prevents
2793 .Ic ghost
2794 expansions on the remains of the line, e.g.,
2795 .Ql \eecho
2796 will always evaluate the command
2797 .Ic echo ,
2798 even if a ghost of the same name exists.
2799 .Ic ghost
2800 content may itself contain further command modifiers, including
2801 an initial reverse solidus to prevent further expansions.
2804 The modifier
2806 .Cm ignerr
2807 indicates that any error generated by the following command should be
2808 ignored by the state machine, via, e.g.,
2809 .Va batch-exit-on-error .
2810 .Va \&? ,
2811 one of the many
2812 .Sx "INTERNAL VARIABLES" ,
2813 will be set to the real exit status of the command regardless.
2816 Some commands support the
2818 .Cm vput
2819 modifier: if used, they expect the name of a variable, which can itself
2820 be a variable, i.e., shell expansion is applied, as their first
2821 argument, and will place their computation result in it instead of the
2822 default location (it is usually written to standard output).
2823 The given name will be tested for being a valid
2824 .Xr sh 1
2825 variable name, and may therefore only consist of upper- and lowercase
2826 characters, digits, and the underscore; the hyphen-minus may be used as
2827 a non-portable extension.
2828 In addition the name may either not be one of the known
2829 .Sx "INTERNAL VARIABLES" ,
2830 or must otherwise refer to a writable (non-boolean) value variable.
2831 It is a hard error that is tracked in
2832 .Va \&?
2833 if any of these tests fail.
2834 The actual put operation may fail nonetheless, e.g., if the variable
2835 expects a number argument only a number will be accepted.
2836 Some commands may report this as a hard failure in
2837 .Va \&? ,
2838 but most will use the soft exit status
2839 .Va \&!
2840 to indicate these failures.
2843 Last, but not least, the modifier
2845 .Cm wysh
2846 can be used for some old and established commands to choose the new
2847 .Sx "Shell-style argument quoting"
2848 rules over the traditional
2849 .Sx "Old-style argument quoting" .
2851 .\" }}}
2853 .\" .Ss "Message list arguments" {{{
2854 .Ss "Message list arguments"
2856 Some commands expect arguments that represent messages (actually
2857 their symbolic message numbers), as has been documented above under
2858 .Sx "Specifying messages"
2859 already.
2860 If no explicit message list has been specified, the next message
2861 forward that satisfies the command's requirements will be used,
2862 and if there are no messages forward of the current message,
2863 the search proceeds backwards;
2864 if there are no good messages at all to be found, an error message is
2865 shown and the command is aborted.
2866 .\" }}}
2868 .\" .Ss "Old-style argument quoting" {{{
2869 .Ss "Old-style argument quoting"
2871 \*(ID This section documents the old, traditional style of quoting
2872 non-message-list arguments to commands which expect this type of
2873 arguments: whereas still used by the majority of such commands, the new
2874 .Sx "Shell-style argument quoting"
2875 may be available even for those via
2876 .Cm wysh ,
2877 one of the
2878 .Sx "Command modifiers" .
2879 Nonetheless care must be taken, because only new commands have been
2880 designed with all the capabilities of the new quoting rules in mind,
2881 which can, e.g., generate control characters.
2884 .Bl -bullet -offset indent
2886 An argument can be enclosed between paired double-quotes
2887 .Ql """argument"""
2889 single-quotes
2890 .Ql 'argument' ;
2891 any white space, shell word expansion, or reverse solidus characters
2892 (except as described next) within the quotes are treated literally as
2893 part of the argument.
2894 A double-quote will be treated literally within single-quotes and vice
2895 versa.
2896 Inside such a quoted string the actually used quote character can be
2897 used nonetheless by escaping it with a reverse solidus
2898 .Ql \e ,
2899 as in
2900 .Ql """y\e""ou""" .
2903 An argument that is not enclosed in quotes, as above, can usually still
2904 contain space characters if those spaces are reverse solidus escaped, as in
2905 .Ql you\e are .
2908 A reverse solidus outside of the enclosing quotes is discarded
2909 and the following character is treated literally as part of the argument.
2911 .\" }}}
2913 .\" .Ss "Shell-style argument quoting" {{{
2914 .Ss "Shell-style argument quoting"
2916 Commands which don't expect message-list arguments use
2917 .Xr sh 1 Ns
2918 ell-style, and therefore POSIX standardized, argument parsing and
2919 quoting rules.
2920 \*(ID Most new commands only support these new rules and are flagged
2921 \*(NQ, some elder ones can use them with the command modifier
2922 .Cm wysh ;
2923 in the future only this type of argument quoting will remain.
2926 A command line is parsed from left to right and an input token is
2927 completed whenever an unquoted, otherwise ignored, metacharacter is seen.
2928 Metacharacters are vertical bar
2929 .Cm \&| ,
2930 ampersand
2931 .Cm & ,
2932 semicolon
2933 .Cm \&; ,
2934 as well as
2935 .Cm space , tabulator , newline .
2936 The additional metacharacters left and right parenthesis
2937 .Cm \&( , \&)
2938 and less-than and greater-than signs
2939 .Cm < , >
2940 that the
2941 .Xr sh 1
2942 supports are not used, and are treated as ordinary characters: for one
2943 these characters are a vivid part of email addresses, and it also seems
2944 highly unlikely that their function will become meaningful to \*(UA.
2947 Any unquoted number sign
2948 .Ql #
2949 at the beginning of new token starts a comment that extends to the end
2950 of the line, and therefore ends argument processing.
2951 An unquoted dollar sign
2952 .Ql $
2953 will cause variable expansion of the given name:
2954 .Sx "INTERNAL VARIABLES"
2955 as well as
2956 .Sx ENVIRONMENT
2957 (shell) variables can be accessed through this mechanism, brace
2958 enclosing the name is supported (i.e., to subdivide a token).
2961 Whereas the metacharacters
2962 .Cm space , tabulator , newline
2963 only complete an input token, vertical bar
2964 .Cm \&| ,
2965 ampersand
2966 .Cm &
2967 and semicolon
2968 .Cm \&;
2969 also act as control operators and perform control functions.
2970 For now supported is semicolon
2971 .Cm \&; ,
2972 which terminates a single command, therefore sequencing the command line
2973 and making the remainder of the line a subject to reevaluation.
2974 With sequencing, multiple command argument types and quoting rules may
2975 therefore apply to a single line, which can become problematic before
2976 v15: e.g., the first of the following will cause surprising results.
2979 .Dl ? echo one; set verbose; echo verbose=$verbose.
2980 .Dl ? echo one; wysh set verbose; echo verbose=$verbose.
2983 Quoting is a mechanism that will remove the special meaning of
2984 metacharacters and reserved words, and will prevent expansion.
2985 There are four quoting mechanisms: the escape character, single-quotes,
2986 double-quotes and dollar-single-quotes:
2989 .Bl -bullet -offset indent
2991 The literal value of any character can be preserved by preceding it
2992 with the escape character reverse solidus
2993 .Ql \e .
2996 Arguments which are enclosed in
2997 .Ql 'single-\:quotes'
2998 retain their literal value.
2999 A single-quote cannot occur within single-quotes.
3002 The literal value of all characters enclosed in
3003 .Ql \(dqdouble-\:quotes\(dq
3004 is retained, with the exception of dollar sign
3005 .Ql $ ,
3006 which will cause variable expansion, as above, backquote (grave accent)
3007 .Ql ` ,
3008 (which not yet means anything special), reverse solidus
3009 .Ql \e ,
3010 which will escape any of the characters dollar sign
3011 .Ql $
3012 (to prevent variable expansion), backquote (grave accent)
3013 .Ql ` ,
3014 double-quote
3015 .Ql \(dq
3016 (to prevent ending the quote) and reverse solidus
3017 .Ql \e
3018 (to prevent escaping, i.e., to embed a reverse solidus character as-is),
3019 but has no special meaning otherwise.
3022 Arguments enclosed in
3023 .Ql $'dollar-\:single-\:quotes'
3024 extend normal single quotes in that reverse solidus escape sequences are
3025 expanded as follows:
3027 .Bl -tag -compact -width "Ql \eNNN"
3028 .It Ql \ea
3029 alerts (bell).
3030 .It Ql \eb
3031 emits a backspace.
3032 .It Ql \eE
3033 an escape character.
3034 .It Ql \ee
3035 an escape character.
3036 .It Ql \ef
3037 form feed.
3038 .It Ql \en
3039 new line.
3040 .It Ql \er
3041 carriage return.
3042 .It Ql \et
3043 horizontal tab.
3044 .It Ql \ev
3045 vertical tab.
3046 .It Ql \e\e
3047 emits a reverse solidus character.
3048 .It Ql \e'
3049 single quote.
3050 .It Ql \e"
3051 double quote (escaping is optional).
3052 .It Ql \eNNN
3053 eight-bit byte with the octal value
3054 .Ql NNN
3055 (one to three octal digits), optionally prefixed by an additional
3056 .Ql 0 .
3057 A 0 byte will suppress further output for the quoted argument.
3058 .It Ql \exHH
3059 eight-bit byte with the hexadecimal value
3060 .Ql HH
3061 (one or two hexadecimal characters).
3062 A 0 byte will suppress further output for the quoted argument.
3063 .It Ql \eUHHHHHHHH
3064 the Unicode / ISO-10646 character with the hexadecimal codepoint value
3065 .Ql HHHHHHHH
3066 (one to eight hexadecimal digits) \(em note that Unicode defines the
3067 maximum codepoint ever to be supported as
3068 .Ql 0x10FFFF
3069 (in planes of
3070 .Ql 0xFFFF
3071 characters each).
3072 This escape is only supported in locales which support Unicode (see
3073 .Sx "Character sets" ) ,
3074 in other cases the sequence will remain unexpanded unless the given code
3075 point is ASCII compatible or can be represented in the current locale.
3076 The character NUL will suppress further output for the quoted argument.
3077 .It Ql \euHHHH
3078 Identical to
3079 .Ql \eUHHHHHHHH
3080 except it takes only one to four hexadecimal digits.
3081 .It Ql \ecX
3082 Emits the non-printable (ASCII and compatible) C0 control codes
3083 0 (NUL) to 31 (US), and 127 (DEL).
3084 Printable representations of ASCII control codes can be created by
3085 mapping them to a different part of the ASCII character set, which is
3086 possible by adding the number 64 for the codes 0 to 31, e.g., 7 (BEL) is
3087 .Ql 7 + 64 = 71 = G .
3088 The real operation is a bitwise logical XOR with 64 (bit 7 set, see
3089 .Ic vexpr ) ,
3090 thus also covering code 127 (DEL), which is mapped to 63 (question mark):
3091 .Ql ? vexpr ^ 127 64 .
3093 Whereas historically circumflex notation has often been used for
3094 visualization purposes of control codes, e.g.,
3095 .Ql ^G ,
3096 the reverse solidus notation has been standardized:
3097 .Ql \ecG .
3098 Some control codes also have standardized (ISO 10646, ISO C) aliases,
3099 as shown above (e.g.,
3100 .Ql \ea ,
3101 .Ql \en ,
3102 .Ql \et ) :
3103 whenever such an alias exists it will be used for display purposes.
3104 The control code NUL
3105 .Pf ( Ql \ec@ ,
3106 a non-standard extension) ends argument processing without producing
3107 further output.
3108 .It Ql \e$NAME
3109 Non-standard extension: expand the given variable name, as above.
3110 Brace enclosing the name is supported.
3111 .It Ql \e`{command}
3112 Not yet supported, just to raise awareness: Non-standard extension.
3117 Caveats:
3119 .Bd -literal -offset indent
3120 echo 'Quotes '${HOME}' and 'tokens" differ!"# no comment
3121 echo Quotes ${HOME} and tokens differ! # comment
3122 echo Don"'"t you worry$'\ex21' The sun shines on us. $'\eu263A'
3124 .\" }}}
3126 .\" .Ss "Filename transformations" {{{
3127 .Ss "Filename transformations"
3129 Filenames, where expected, and unless documented otherwise, are
3130 subsequently subject to the following filename transformations, in
3131 sequence:
3133 .Bl -bullet -offset indent
3135 If the given name is a registered
3136 .Ic shortcut ,
3137 it will be replaced with the expanded shortcut.
3140 The filename is matched against the following patterns or strings:
3142 .Bl -hang -compact -width ".Ar %user"
3143 .It Ar #
3144 (Number sign) is expanded to the previous file.
3145 .It Ar %
3146 (Percent sign) is replaced by the invoking
3147 .Mx -ix "primary system mailbox"
3148 user's primary system mailbox, which either is the (itself expandable)
3149 .Va inbox
3150 if that is set, the standardized absolute pathname indicated by
3151 .Ev MAIL
3152 if that is set, or a builtin compile-time default otherwise.
3153 .It Ar %user
3154 Expands to the primary system mailbox of
3155 .Ar user
3156 (and never the value of
3157 .Va inbox ,
3158 regardless of its actual setting).
3159 .It Ar &
3160 (Ampersand) is replaced with the invoking users
3161 .Mx -ix "secondary mailbox"
3162 secondary mailbox, the
3163 .Ev MBOX .
3164 .It Ar +file
3165 Refers to a
3166 .Ar file
3167 in the
3168 .Va folder
3169 directory (if that variable is set).
3170 .It Ar %:filespec
3171 Expands to the same value as
3172 .Ar filespec ,
3173 but has special meaning when used with, e.g., the command
3174 .Ic file :
3175 the file will be treated as a primary system mailbox by, e.g., the
3176 .Ic mbox
3178 .Ic save
3179 commands, meaning that messages that have been read in the current
3180 session will be moved to the
3181 .Ev MBOX
3182 mailbox instead of simply being flagged as read.
3186 Meta expansions are applied to the resulting filename, as applicable to
3187 the resulting file access protocol (also see
3188 .Sx "On URL syntax and credential lookup" ) .
3189 If the fully expanded filename results in multiple pathnames and the
3190 command is expecting only one file, an error results.
3192 For the file-protocol, a leading tilde
3193 .Ql ~
3194 character will be replaced by the expansion of
3195 .Ev HOME ,
3196 except when followed by a valid user name, in which case the home
3197 directory of the given user is used instead.
3199 Any occurrence of
3200 .Ql $VARIABLE
3202 .Ql ${VARIABLE} )
3203 will be replaced by the expansion of the variable, if possible;
3204 .Sx "INTERNAL VARIABLES"
3205 as well as
3206 .Sx ENVIRONMENT
3207 (shell) variables can be accessed through this mechanism, and the usual
3208 escape mechanism has to be applied to prevent interpretation.
3210 In interactive context, in order to allow simple value acceptance (via
3211 .Dq ENTER ) ,
3212 arguments will usually be displayed in a properly quoted form, e.g., a file
3213 .Ql diet\e is \ecurd.txt
3214 may be displayed as
3215 .Ql 'diet\e is \ecurd.txt' .
3217 .\" }}}
3219 .\" .Ss "Commands" {{{
3220 .Ss "Commands"
3222 The following commands are available:
3224 .Bl -tag -width ".It Ic BaNg"
3226 .It Ic \&!
3227 Executes the
3228 .Ev SHELL
3229 command which follows, replacing unescaped exclamation marks with the
3230 previously executed command if the internal variable
3231 .Va bang
3232 is set.
3235 .It Ic #
3236 The comment-command causes the entire line to be ignored.
3237 .Sy Note:
3238 this really is a normal command which' purpose is to discard its
3239 arguments, not a
3240 .Dq comment-start
3241 indicating special character, which means that, e.g., trailing comments
3242 on a line are not possible.
3245 .It Ic +
3246 Goes to the next message in sequence and types it
3247 (like
3248 .Dq ENTER ) .
3251 .It Ic -
3252 Display the preceding message, or the n'th previous message if given
3253 a numeric argument n.
3256 .It Ic =
3257 Show the current message number (the
3258 .Dq dot ) .
3261 .It Ic \&?
3262 Show a brief summary of commands.
3263 \*(OP Given an argument a synopsis for the command in question is
3264 shown instead; commands can be abbreviated in general and this command
3265 can be used to see the full expansion of an abbreviation including the
3266 synopsis, try, e.g.,
3267 .Ql ?h ,
3268 .Ql ?hel
3270 .Ql ?help
3271 and see how the output changes.
3272 This mode also supports a more
3273 .Va verbose
3274 output, which will provide the informations documented for
3275 .Ic list .
3278 .It Ic \&|
3279 A synonym for the
3280 .Ic pipe
3281 command.
3284 .It Ic ~
3285 \*(NQ Interprets the remainder of the word as a macro name and passes
3286 it through to the
3287 .Ic call
3288 command; e.g.,
3289 .Ql ~ Ns Ar mymacro
3290 is a shorter synonym for
3291 .Ql call Ar mymacro .
3294 .It Ic account
3295 (ac) Creates, selects or lists (an) account(s).
3296 Accounts are special incarnations of
3297 .Ic define Ns d
3298 macros and group commands and variable settings which together usually
3299 arrange the environment for the purpose of creating an email account.
3300 Different to normal macros settings which are covered by
3301 .Ic localopts
3302 \(en here by default enabled! \(en will not be reverted before the
3303 .Ic account
3304 is changed again.
3305 The special account
3306 .Ql null
3307 (case-insensitive) always exists, and all but it can be deleted via
3308 .Ic unaccount .
3310 Without arguments a listing of all defined accounts is shown.
3311 With one argument the given account is activated: the system
3312 .Va inbox
3313 of that account will be activated (as via
3314 .Ic file ) ,
3315 a possibly installed
3316 .Va folder-hook
3317 will be run, and the internal variable
3318 .Va -account
3319 will be updated.
3320 The two argument form is identical to defining a macro as via
3321 .Ic define :
3322 .Bd -literal -offset indent
3323 account myisp {
3324   set folder=~/mail inbox=+syste.mbox record=+sent.mbox
3325   set from='myname@myisp.example (My Name)'
3326   set mta=smtp://mylogin@smtp.myisp.example
3331 .It Ic addrcodec
3332 \*(NQ Interprets the given arguments as an email address specification,
3333 formats it as induced by email standards, and then shows the result.
3334 Supports
3335 .Cm vput
3336 (see
3337 .Sx "Command modifiers" ) .
3338 The return status is tracked via
3339 .Va \&! .
3340 \*(ID This will improve further.
3343 .It Ic alias
3344 (a) Aliases are a method of creating personal distribution lists that
3345 map a single alias name to none to multiple real receivers;
3346 these aliases become expanded after message composing is completed; to
3347 delete aliases, use the command
3348 .Ic unalias .
3349 With no arguments the command shows all currently defined aliases.
3350 With one argument, shows the expansion of the given alias.
3351 With more than one argument, creates or appends to the alias name given
3352 as the first argument the remaining arguments.
3353 Alias names are restricted to alphabetic characters, digits, the
3354 underscore, hyphen-minus, the number sign, colon, commercial at and
3355 period, the last character can also be the dollar sign:
3356 .Ql [[:alnum:]_#:@.-]+$? .
3359 .It Ic alternates
3360 (alt) Manage a list of alternate addresses or names of the active user,
3361 members of which will be removed from recipient lists when replying to
3362 messages (and the
3363 .Va metoo
3364 variable is not set).
3365 Without arguments the current set of alternates is displayed, otherwise
3366 the set of alternate names is replaced by the given arguments, and the
3367 internal variable
3368 .Va -alternates
3369 is updated accordingly.
3372 .It Ic answered
3373 Takes a message list and marks each message as having been answered.
3374 Messages will be marked answered when being
3375 .Ic reply Ns d
3376 to automatically if the
3377 .Va markanswered
3378 variable is set.
3379 See the section
3380 .Sx "Message states" .
3384 .It Ic bind
3385 \*(OP\*(NQ The bind command extends the MLE (see
3386 .Sx "On terminal control and line editor" )
3387 with freely configurable key bindings.
3388 With one argument all bindings for the given context are shown,
3389 specifying an asterisk
3390 .Ql *
3391 will show the bindings of all contexts; a more verbose listing will be
3392 produced if either of
3393 .Va debug
3395 .Va verbose
3396 are set.
3397 With two or more arguments a binding is (re)established:
3398 the first argument is the context to which the binding shall apply,
3399 the second argument is a comma-separated list of the
3400 .Dq keys
3401 which form the binding, and any remaining arguments form the expansion.
3402 To indicate that a binding shall not be auto-committed, but that the
3403 expansion shall instead be furtherly editable by the user, a commercial at
3404 .Ql @
3405 (that will be removed) can be placed last in the expansion, from which
3406 leading and trailing whitespace will finally be removed.
3407 Reverse solidus cannot be used as the last character of expansion.
3410 Contexts define when a binding applies, i.e., a binding will not be seen
3411 unless the context for which it is defined for is currently active.
3412 This is not true for the shared binding
3413 .Ql base ,
3414 which is the foundation for all other bindings and as such always
3415 applies, its bindings, however, only apply secondarily.
3416 The available contexts are the shared
3417 .Ql base ,
3419 .Ql default
3420 context which is used in all not otherwise documented situations, and
3421 .Ql compose ,
3422 which applies to compose mode only.
3425 .Dq Keys
3426 which form the binding are specified as a comma-separated list of
3427 byte-sequences, where each list entry corresponds to one key(press).
3428 \*(OPally a list entry may, indicated by a leading colon character
3429 .Ql \&: ,
3430 also refer to the name of a terminal capability;
3431 several dozen names will be compiled into \*(UA and may be specified
3432 either by their
3433 .Xr terminfo 5 ,
3434 or, if existing, by their
3435 .Xr termcap 5
3436 name, regardless of the actually used terminal control library.
3437 It is however possible to use any capability, as long as the name is
3438 resolvable by the control library or defined in the internal variable
3439 .Va termcap .
3440 Input sequences are not case-normalized, so that an exact match is
3441 required to update or remove a binding.
3442 Examples:
3444 .Bd -literal -offset indent
3445 bind base $'\eE',d mle-snarf-word-fwd # Esc(ape)
3446 bind base $'\eE',$'\ec?' mle-snarf-word-bwd # Esc, Delete
3447 bind default $'\ecA',:khome,w 'echo An editable binding@'
3448 bind default a,b,c rm -rf / @  # Another editable binding
3449 bind default :kf1 File %
3450 bind compose :kf1 ~e
3454 Note that the entire comma-separated list is first parsed (over) as a
3455 shell-token with whitespace as the field separator, before being parsed
3456 and expanded for real with comma as the field separator, therefore
3457 whitespace needs to be properly quoted, see
3458 .Sx "Shell-style argument quoting" .
3459 Using Unicode reverse solidus escape sequences renders a binding
3460 defunctional if the locale does not support Unicode (see
3461 .Sx "Character sets" ) ,
3462 and using terminal capabilities does so if no terminal control support
3463 is (currently) available.
3466 The following terminal capability names are builtin and can be used in
3467 .Xr terminfo 5
3468 or (if available) the two-letter
3469 .Xr termcap 5
3470 notation regardless of the actually used library.
3471 See the respective manual for a list of capabilities.
3472 The program
3473 .Xr infocmp 1
3474 can be used to show all the capabilities of
3475 .Ev TERM
3476 or the given terminal type;
3477 using the
3478 .Fl \&\&x
3479 flag will also show supported (non-standard) extensions.
3482 .Bl -tag -compact -width kcuuf_or_kcuuf
3483 .It Cd kbs Ns \0or Cd kb
3484 Backspace.
3485 .It Cd kdch1 Ns \0or Cd kD
3486 Delete character.
3487 .It Cd kDC Ns \0or Cd *4
3488 \(em shifted variant.
3489 .It Cd kel Ns \0or Cd kE
3490 Clear to end of line.
3491 .It Cd kext Ns \0or Cd @9
3492 Exit.
3493 .It Cd kich1 Ns \0or Cd kI
3494 Insert character.
3495 .It Cd kIC Ns \0or Cd #3
3496 \(em shifted variant.
3497 .It Cd khome Ns \0or Cd kh
3498 Home.
3499 .It Cd kHOM Ns \0or Cd #2
3500 \(em shifted variant.
3501 .It Cd kend Ns \0or Cd @7
3502 End.
3503 .It Cd knp Ns \0or Cd kN
3504 Next page.
3505 .It Cd kpp Ns \0or Cd kP
3506 Previous page.
3507 .It Cd kcub1 Ns \0or Cd kl
3508 Left cursor (with more modifiers: see below).
3509 .It Cd kLFT Ns \0or Cd #4
3510 \(em shifted variant.
3511 .It Cd kcuf1 Ns \0or Cd kr
3512 Right cursor (ditto).
3513 .It Cd kRIT Ns \0or Cd %i
3514 \(em shifted variant.
3515 .It Cd kcud1 Ns \0or Cd kd
3516 Down cursor (ditto).
3517 .It Cd kDN
3518 \(em shifted variant (only terminfo).
3519 .It Cd kcuu1 Ns \0or Cd ku
3520 Up cursor (ditto).
3521 .It Cd kUP
3522 \(em shifted variant (only terminfo).
3523 .It Cd kf0 Ns \0or Cd k0
3524 Function key 0.
3525 Add one for each function key up to
3526 .Cd kf9
3528 .Cd k9 ,
3529 respectively.
3530 .It Cd kf10 Ns \0or Cd k;
3531 Function key 10.
3532 .It Cd kf11 Ns \0or Cd F1
3533 Function key 11.
3534 Add one for each function key up to
3535 .Cd kf19
3537 .Cd F9 ,
3538 respectively.
3542 Some terminals support key-modifier combination extensions, e.g.,
3543 .Ql Alt+Shift+xy .
3544 For example, the delete key,
3545 .Cd kdch1 :
3546 in its shifted variant, the name is mutated to
3547 .Cd  kDC ,
3548 then a number is appended for the states
3549 .Ql Alt
3550 .Pf ( Cd kDC3 ) ,
3551 .Ql Shift+Alt
3552 .Pf ( Cd kDC4 ) ,
3553 .Ql Control
3554 .Pf ( Cd kDC5 ) ,
3555 .Ql Shift+Control
3556 .Pf ( Cd kDC6 ) ,
3557 .Ql Alt+Control
3558 .Pf ( Cd kDC7 ) ,
3559 finally
3560 .Ql Shift+Alt+Control
3561 .Pf ( Cd kDC8 ) .
3562 The same for the left cursor key,
3563 .Cd kcub1 :
3564 .Cd KLFT , KLFT3 , KLFT4 , KLFT5 , KLFT6 , KLFT7 , KLFT8 .
3567 Key bindings can be removed with the command
3568 .Ic unbind .
3569 It is advisable to use an initial escape or other control character (e.g.,
3570 .Ql \ecA )
3571 for bindings which describe user key combinations (as opposed to purely
3572 terminal capability based ones), in order to avoid ambiguities whether
3573 input belongs to key sequences or not; it also reduces search time.
3574 Adjusting
3575 .Va bind-timeout
3576 may help shall keys and sequences be falsely recognized.
3580 .It Ic call
3581 \*(NQ Calls the given macro, which must have been created via
3582 .Ic define .
3583 Parameters given to macros are implicitly local to the macro's scope, and
3584 may be accessed via the special parameter syntax that is known from the
3585 .Xr sh 1 ,
3586 e.g.,
3587 .Va 1 ,
3588 .Va * ,
3589 .Va @ ,
3590 .Va # .
3591 Positional parameters may be removed by
3592 .Ic shift Ns
3593 ing them off the stack.
3594 Macro execution can be terminated at any time by calling
3595 .Ic return .
3596 Numeric and string operations can be performed via
3597 .Ic vexpr ,
3599 .Ic eval
3600 may be helpful to recreate argument lists.
3601 .Bd -literal -offset indent
3602 define exmac {
3603   echo Parameter 1 of ${#} is ${1}, all: ${*} / ${@}
3604   return 1000 0
3606 call exmac Hello macro exmac!
3610 .It Ic call_if
3611 Identical to
3612 .Ic call
3613 if the given macro has been created via
3614 .Ic define ,
3615 but doesn't fail nor warn if the macro doesn't exist.
3618 .It Ic cd
3619 (ch) Change the working directory to
3620 .Ev HOME
3621 or the given argument.
3622 Synonym for
3623 .Ic chdir .
3626 .It Ic certsave
3627 \*(OP Only applicable to S/MIME signed messages.
3628 Takes a message list and a file name and saves the certificates
3629 contained within the message signatures to the named file in both
3630 human-readable and PEM format.
3631 The certificates can later be used to send encrypted messages to the
3632 respective message senders by setting
3633 .Va smime-encrypt-USER@HOST
3634 variables.
3638 .It Ic charsetalias , uncharsetalias
3639 \*(NQ Manage (character set conversion) character set alias mappings,
3640 as documented in the section
3641 .Sx "Character sets" .
3642 Character set aliases are expanded recursively, but no expansion is
3643 performed on values of the user-settable variables, e.g.,
3644 .Va charset-8bit .
3645 These are effectively no-operations if character set conversion
3646 is not available (i.e., no
3647 .Ql +iconv
3649 .Va features ) .
3650 Without arguments the list of all currently defined aliases is shown.
3651 Otherwise all given arguments are treated as pairs of character sets and
3652 their desired target alias name, creating new or changing already
3653 existing aliases, as necessary.
3655 The latter deletes all aliases given as arguments, the special argument
3656 .Ql *
3657 will remove all aliases.
3660 .It Ic chdir
3661 (ch) Change the working directory to
3662 .Ev HOME
3663 or the given argument.
3664 Synonym for
3665 .Ic cd .
3668 .It Ic collapse
3669 Only applicable to threaded mode.
3670 Takes a message list and makes all replies to these messages invisible
3671 in header summaries, unless they are in state
3672 .Ql new .
3676 .It Ic colour
3677 \*(OP\*(NQ Manage colour mappings of and for a
3678 .Sx "Coloured display" .
3679 The type of colour is given as the (case-insensitive) first argument,
3680 which must be one of
3681 .Ql 256
3682 for 256-colour terminals,
3683 .Ql 8 ,
3684 .Ql ansi
3686 .Ql iso
3687 for the standard 8-colour ANSI / ISO 6429 color palette and
3688 .Ql 1
3690 .Ql mono
3691 for monochrome terminals.
3692 Monochrome terminals cannot deal with colours, but only (some) font
3693 attributes.
3696 Without further arguments the list of all currently defined mappings
3697 for the given colour type is shown (as a special case giving
3698 .Ql all
3700 .Ql *
3701 will show the mappings of all types).
3702 Otherwise the second argument defines the mappable slot, and the third
3703 argument a (comma-separated list of) colour and font attribute
3704 specification(s), and the optional fourth argument can be used to
3705 specify a precondition: if conditioned mappings exist they are tested in
3706 (creation) order unless a (case-insensitive) match has been found, and
3707 the default mapping (if any has been established) will only be chosen as
3708 a last resort.
3709 The types of precondition available depend on the mappable slot (see
3710 .Sx "Coloured display"
3711 for some examples), the following of which exist:
3714 Mappings prefixed with
3715 .Ql mle-
3716 are used for the \*(OPal builtin Mailx-Line-Editor (MLE, see
3717 .Sx "On terminal control and line editor" )
3718 and do not support preconditions.
3720 .Bl -tag -compact -width view-partinfo
3721 .It Ar mle-position
3722 This mapping is used for the position indicator that is visible when
3723 a line cannot be fully displayed on the screen.
3724 .It Ar mle-prompt
3725 Used for the
3726 .Va prompt .
3730 Mappings prefixed with
3731 .Ql sum-
3732 are used in header summaries, and they all understand the preconditions
3733 .Ql dot
3734 (the current message) and
3735 .Ql older
3736 for elder messages (only honoured in conjunction with
3737 .Va datefield-markout-older ) .
3739 .Bl -tag -compact -width view-partinfo
3740 .It Ar sum-dotmark
3741 This mapping is used for the
3742 .Dq dotmark
3743 that can be created with the
3744 .Ql %>
3746 .Ql %<
3747 formats of the variable
3748 .Va headline .
3749 .It Ar sum-header
3750 For the complete header summary line except the
3751 .Dq dotmark
3752 and the thread structure.
3753 .It Ar sum-thread
3754 For the thread structure which can be created with the
3755 .Ql %i
3756 format of the variable
3757 .Va headline .
3761 Mappings prefixed with
3762 .Ql view-
3763 are used when displaying messages.
3765 .Bl -tag -compact -width view-partinfo
3766 .It Ar view-from_
3767 This mapping is used for so-called
3768 .Ql From_
3769 lines, which are MBOX file format specific header lines.
3770 .It Ar view-header
3771 For header lines.
3772 A comma-separated list of headers to which the mapping applies may be
3773 given as a precondition; if the \*(OPal regular expression support is
3774 available then if any of the
3775 .Dq magical
3776 (extended) regular expression characters is seen the precondition will
3777 be evaluated as (an extended) one.
3778 .It Ar view-msginfo
3779 For the introductional message info line.
3780 .It Ar view-partinfo
3781 For MIME part info lines.
3785 The following (case-insensitive) colour definitions and font attributes
3786 are understood, multiple of which can be specified in a comma-separated
3787 list:
3789 .Bl -tag -width ft=
3790 .It Ar ft=
3791 a font attribute:
3792 .Ql bold ,
3793 .Ql reverse
3795 .Ql underline .
3796 It is possible (and often applicable) to specify multiple font
3797 attributes for a single mapping.
3799 .It Ar fg=
3800 foreground colour attribute:
3801 .Ql black ,
3802 .Ql blue ,
3803 .Ql green ,
3804 .Ql red ,
3805 .Ql brown ,
3806 .Ql magenta ,
3807 .Ql cyan
3809 .Ql white .
3810 To specify a 256-color mode a decimal number colour specification in
3811 the range 0 to 255, inclusive, is supported, and interpreted as follows:
3813 .Bl -tag -compact -width "999 - 999"
3814 .It 0 - 7
3815 the standard ISO 6429 colors, as above.
3816 .It 8 - 15
3817 high intensity variants of the standard colors.
3818 .It 16 - 231
3819 216 colors in tuples of 6.
3820 .It 232 - 255
3821 grayscale from black to white in 24 steps.
3823 .Bd -literal -offset indent
3824 #!/bin/sh -
3825 fg() { printf "\e033[38;5;${1}m($1)"; }
3826 bg() { printf "\e033[48;5;${1}m($1)"; }
3828 while [ $i -lt 256 ]; do fg $i; i=$(($i + 1)); done
3829 printf "\e033[0m\en"
3831 while [ $i -lt 256 ]; do bg $i; i=$(($i + 1)); done
3832 printf "\e033[0m\en"
3835 .It Ar bg=
3836 background colour attribute (see
3837 .Cd fg=
3838 for possible values).
3842 Mappings may be removed with the command
3843 .Ic uncolour .
3844 For a generic overview see the section
3845 .Sx "Coloured display" .
3849 .It Ic Copy
3850 (C) Copy messages to files whose names are derived from the author of
3851 the respective message and do not mark them as being saved;
3852 otherwise identical to
3853 .Ic Save .
3856 .It Ic copy
3857 (c) Copy messages to the named file and do not mark them as being saved;
3858 otherwise identical to
3859 .Ic save .
3862 .It Ic cwd
3863 Show the name of the current working directory, as reported by
3864 .Xr getcwd 3 .
3865 Supports
3866 .Cm vput
3867 (see
3868 .Sx "Command modifiers" ) .
3869 The return status is tracked via
3870 .Va \&! .
3873 .It Ic Decrypt
3874 \*(OP For unencrypted messages this command is identical to
3875 .Ic Copy ;
3876 Encrypted messages are first decrypted, if possible, and then copied.
3879 .It Ic decrypt
3880 \*(OP For unencrypted messages this command is identical to
3881 .Ic copy ;
3882 Encrypted messages are first decrypted, if possible, and then copied.
3885 .It Ic define
3886 Without arguments the current list of macros, including their content,
3887 is shown, otherwise a macro is defined.
3888 A macro definition is a sequence of commands in the following form:
3889 .Bd -literal -offset indent
3890 define name {
3891   command1
3892   command2
3893   ...
3894   commandN
3898 A defined macro can be invoked explicitly by using the
3899 .Ic call
3901 .Ic ~
3902 commands, or implicitly if a macro hook is triggered, e.g., a
3903 .Va folder-hook .
3904 It is possible to localize adjustments, like creation, deletion and
3905 modification of
3906 .Sx "INTERNAL VARIABLES" ,
3907 by using the
3908 .Ic localopts
3909 command; the scope which is localized depends on how (i.e.,
3910 .Dq as what :
3911 normal macro, folder hook, hook,
3912 .Ic account
3913 switch) the macro is invoked.
3914 Execution of a macro body can be stopped from within by calling
3915 .Ic return .
3916 Inside a
3917 .Ic call Ns
3918 ed macro, given positional parameters can be
3919 .Ic shift Ns
3921 Macros can be deleted via
3922 .Ic undefine .
3925 .It Ic delete
3926 (d) Marks the given message list as
3927 .Ql deleted .
3928 Deleted messages will neither be saved in
3929 .Ev MBOX
3930 nor will they be available for most other commands.
3931 If the
3932 .Va autoprint
3933 variable is set, automatically
3934 .Ic type
3935 the new
3936 .Dq dot .
3937 Also see
3938 .Ic undelete ,
3939 .Ic dp ,
3940 .Ic dt .
3943 .It Ic discard
3944 (di) Identical to
3945 .Ic ignore .
3946 Superseded by the multiplexer
3947 .Ic headerpick .
3951 .It Ic dp , dt
3952 Delete the given messages and automatically
3953 .Ic type
3954 the new
3955 .Dq dot
3956 if one exists, regardless of the setting of
3957 .Va autoprint .
3960 .It Ic dotmove
3961 Move the
3962 .Dq dot
3963 up or down by one message when given
3964 .Ql +
3966 .Ql -
3967 argument, respectively.
3970 .It Ic draft
3971 Takes a message list and marks each given message as a draft.
3972 See the section
3973 .Sx "Message states" .
3976 .It Ic echo
3977 \*(NQ (ec) Echoes arguments to standard output and writes a trailing
3978 newline, whereas the otherwise identical
3979 .Ic echon
3980 does not.
3981 .Sx "Shell-style argument quoting"
3982 is used,
3983 .Sx "Filename transformations"
3984 are applied to the expanded arguments.
3987 .It Ic echoerr
3988 \*(NQ Identical to
3989 .Ic echo
3990 except that is echoes to standard error.
3991 Also see
3992 .Ic echoerrn .
3995 .It Ic echon
3996 \*(NQ Identical to
3997 .Ic echo ,
3998 but does not write a trailing newline.
4001 .It Ic echoerrn
4002 \*(NQ Identical to
4003 .Ic echoerr ,
4004 but does not write a trailing newline.
4007 .It Ic edit
4008 (e) Point the text editor (as defined in
4009 .Ev EDITOR )
4010 at each message from the given list in turn.
4011 Modified contents are discarded unless the
4012 .Va writebackedited
4013 variable is set.
4016 .It Ic elif
4017 Part of the
4018 .Ic if Ns / Ns Ic elif Ns / Ns Ic else Ns / Ns Ic endif
4019 conditional \(em if the condition of a preceding
4020 .Ic if
4021 was false, check the following condition and execute the following block
4022 if it evaluates true.
4025 .It Ic else
4026 (el) Part of the
4027 .Ic if Ns / Ns Ic elif Ns / Ns Ic else Ns / Ns Ic endif
4028 conditional \(em if none of the conditions of the preceding
4029 .Ic if
4031 .Ic elif
4032 commands was true, the
4033 .Ic else
4034 block is executed.
4037 .It Ic endif
4038 (en) Marks the end of an
4039 .Ic if Ns / Ns Ic elif Ns / Ns Ic else Ns / Ns Ic endif
4040 conditional execution block.
4044 .It Ic environ
4045 \*(NQ \*(UA has a strict notion about which variables are
4046 .Sx "INTERNAL VARIABLES"
4047 and which are managed in the program
4048 .Sx ENVIRONMENT .
4049 Since some of the latter are a vivid part of \*(UAs functioning,
4050 however, they are transparently integrated into the normal handling of
4051 internal variables via
4052 .Ic set
4054 .Ic unset .
4055 To integrate other environment variables of choice into this
4056 transparent handling, and also to export internal variables into the
4057 process environment where they normally are not, a
4058 .Ql link
4059 needs to become established with this command, as in, e.g.,
4062 .Dl environ link PERL5LIB from TZ
4065 Afterwards changing such variables with
4066 .Ic set
4067 will cause automatic updates of the program environment, and therefore
4068 be inherited by newly created child processes.
4069 Sufficient system support provided (it was in BSD as early as 1987, and
4070 is standardized since Y2K) removing such variables with
4071 .Ic unset
4072 will remove them also from the program environment, but in any way
4073 the knowledge they ever have been
4074 .Ql link Ns
4075 ed will be lost.
4076 Note this implies that
4077 .Ic localopts
4078 may cause loss of links.
4081 The command
4082 .Ql unlink
4083 will remove an existing link, but leaves the variables as such intact.
4084 Additionally the subcommands
4085 .Ql set
4087 .Ql unset
4088 are provided, which work exactly the same as the documented commands
4089 .Ic set
4091 .Ic unset ,
4092 but (additionally) link the variable(s) with the program environment and
4093 thus immediately export them to, or remove them from (if possible),
4094 respectively, the program environment.
4098 .It Ic errors
4099 \*(OP Since \*(UA uses the console as a user interface it can happen
4100 that messages scroll by too fast to become recognized.
4101 Optionally an error message ring queue is available which stores
4102 duplicates of any error message and notifies the user in interactive
4103 sessions whenever a new error has occurred.
4104 The queue is finite: if its maximum size is reached any new message
4105 replaces the eldest.
4106 The command
4107 .Ic errors
4108 can be used to manage this message queue: if given
4109 .Ar show
4110 or no argument the queue will be displayed and cleared,
4111 .Ar clear
4112 will only clear all messages from the queue.
4115 .It Ic eval
4116 \*(NQ Construct a command by concatenating the arguments, separated with
4117 a single space character, and then evaluate the result.
4118 This command passes through the status of the evaluated command.
4119 Also see
4120 .Ic call .
4121 .Bd -literal -offset indent
4122 define xverbose {
4123   # Like this, sh(1)ell-stylish from begin to end: works!
4124   # Result status ends up in $!, then
4125   localopts 1;wysh set verbose;ignerr eval "${@}";return ${?}
4127 ghost xv '\ecall xverbose'
4129 # E.g.:
4130 define xxx {
4131   echo "xxx arg <$1>"
4132   shift
4133   if [ $# > 0 ]
4134     call xxx "$@"
4135   endif
4137 define yyy {
4138   eval "$@ ' ball"
4140 call yyy '~xxx' "b\e$'\et'u ' "
4141 xxx arg <b      u>
4142 xxx arg <  >
4143 xxx arg <ball>
4147 .It Ic exit
4148 (ex or x) Exit from \*(UA without changing the active mailbox and skip
4149 any saving of messages in
4150 .Ev MBOX
4151 as well as a possibly tracked line editor history file.
4154 .It Ic File
4155 (Fi) Like
4156 .Ic file ,
4157 but open the mailbox read-only.
4161 .It Ic file
4162 (fi) The file command switches to a new mailbox.
4163 Without arguments it shows status information of the current mailbox.
4164 If an argument is given, it will write out changes (such as deletions)
4165 the user has made and open a new mailbox.
4166 .Sx "Filename transformations"
4167 will be applied to the
4168 .Ar name
4169 argument.
4172 If the name ends with
4173 .Ql .gz ,
4174 .Ql .bz2
4176 .Ql .xz
4177 it is treated as being compressed with
4178 .Xr gzip 1 ,
4179 .Xr bzip2 1
4181 .Xr xz 1 ,
4182 respectively, and transparently handled through an intermediate
4183 (un)compression step (using a temporary file) with the according
4184 facility, sufficient support provided.
4185 Likewise, if the named file does not exist, but a file with one of the
4186 mentioned compression extensions does, then the name is automatically
4187 expanded and the compressed file is used.
4190 Otherwise, if the name ends with an extension for which
4191 .Va file-hook-load-EXTENSION
4193 .Va file-hook-save-EXTENSION
4194 variables are set, then the given hooks will be used to load and save
4195 .Dq name ,
4196 and \*(UA will work with an intermediate temporary file.
4198 MBOX files (flat file-based mailboxes) are generally locked during file
4199 operations in order to avoid inconsistencies due to concurrent
4200 modifications.
4201 \*(OPal Mailbox files which \*(UA treats as the system
4202 .Va inbox
4203 .Pf ( Ev MAIL ) ,
4205 .Mx -sx
4206 .Sx "primary system mailbox" Ns
4207 es in general will also be protected by so-called dotlock files, the
4208 traditional way of mail spool file locking: for any file
4209 .Ql a
4210 a lock file
4211 .Ql a.lock
4212 will be created for the duration of the synchronization \(em
4213 as necessary a privilege-separated dotlock child process will be used
4214 to accommodate for necessary privilege adjustments in order to create
4215 the dotlock file in the same directory
4216 and with the same user and group identities as the file of interest.
4219 \*(UA by default uses tolerant POSIX rules when reading MBOX database
4220 files, but it will detect invalid message boundaries in this mode and
4221 complain (even more with
4222 .Va debug )
4223 if any is seen: in this case
4224 .Va mbox-rfc4155
4225 can be used to create a valid MBOX database from the invalid input.
4229 .Ar name
4230 refers to a directory with the subdirectories
4231 .Ql tmp ,
4232 .Ql new
4234 .Ql cur ,
4235 then it is treated as a folder in
4236 .Dq Maildir
4237 format; \*(ID the variable
4238 .Va newfolders
4239 can be used to control the format of yet non-existent folders.
4240 A name of the form
4243 .Dl \*(IN protocol://[user[:password]@]host[:port][/path]
4244 .Dl \*(OU protocol://[user@]host[:port][/path]
4247 is taken as an Internet mailbox specification.
4248 The \*(OPally supported protocols are
4249 .Ar pop3
4250 (POP3) and
4251 .Ar pop3s
4252 (POP3 with SSL/TLS encrypted transport).
4254 .Ar [/path]
4255 part is valid only for IMAP; there it defaults to
4256 .Ar INBOX .
4257 Also see the section
4258 .Sx "On URL syntax and credential lookup" .
4261 \*(OU If
4262 .Ar user
4263 contains special characters, in particular
4264 .Ql /
4266 .Ql % ,
4267 they must be escaped in URL notation \(en the command
4268 .Ic urlcodec
4269 can be used to show the necessary conversion.
4273 .It Ic flag
4274 Takes a message list and marks the messages as flagged for
4275 urgent/special attention.
4276 See the section
4277 .Sx "Message states" .
4280 .It Ic folder
4281 (fold) The same as
4282 .Ic file .
4285 .It Ic folders
4286 With no arguments, list the names of the folders in the folder directory.
4287 With an existing folder as an argument,
4288 lists the names of folders below the named folder.
4291 .It Ic Followup
4292 (F) Similar to
4293 .Ic Respond ,
4294 but saves the message in a file named after the local part of the first
4295 recipient's address (instead of in
4296 .Va record Ns ).
4299 .It Ic followup
4300 (fo) Similar to
4301 .Ic respond ,
4302 but saves the message in a file named after the local part of the first
4303 recipient's address (instead of in
4304 .Va record Ns ).
4307 .It Ic followupall
4308 Similar to
4309 .Ic followup ,
4310 but responds to all recipients regardless of the
4311 .Va flipr
4312 variable.
4315 .It Ic followupsender
4316 Similar to
4317 .Ic Followup ,
4318 but responds to the sender only regardless of the
4319 .Va flipr
4320 variable.
4323 .It Ic Forward
4324 Alias for
4325 .Ic Fwd .
4328 .It Ic forward
4329 Alias for
4330 .Ic fwd .
4333 .It Ic from
4334 (f) Takes a list of message specifications and displays a summary of
4335 their message headers, exactly as via
4336 .Ic headers .
4337 An alias of this command is
4338 .Ic search .
4339 Also see
4340 .Sx "Specifying messages" .
4343 .It Ic Fwd
4344 Similar to
4345 .Ic fwd ,
4346 but saves the message in a file named after the local part of the
4347 recipient's address (instead of in
4348 .Va record Ns ).
4351 .It Ic fwd
4352 Takes a message and the address of a recipient
4353 and forwards the message to him.
4354 The text of the original message is included in the new one,
4355 with the value of the
4356 .Va fwdheading
4357 variable preceding it.
4358 To filter the included header fields to the desired subset use the
4359 .Ql foward
4360 slot of the white- and blacklisting command
4361 .Ic headerpick .
4362 Only the first part of a multipart message is included unless
4363 .Va forward-as-attachment ,
4364 and recipient addresses will be stripped from comments, names etc.
4365 unless the internal variable
4366 .Va fullnames
4367 is set .
4370 .It Ic fwdignore
4371 \*(OB Superseded by the multiplexer
4372 .Ic headerpick .
4375 .It Ic fwdretain
4376 \*(OB Superseded by the multiplexer
4377 .Ic headerpick .
4380 .It Ic ghost
4381 Define or list command aliases, so-called ghosts.
4382 A ghost can be used everywhere a normal command can be used, but always
4383 takes precedence: any arguments that are given to the command alias are
4384 joined onto the alias content, and the resulting string forms the
4385 command line that is, in effect, executed.
4386 Command ghosts can be removed with
4387 .Ic unghost .
4388 Without arguments a list of all currently known aliases is shown.
4389 With one argument the expansion of the given alias is shown.
4391 With two or more arguments a command alias is defined or updated: the
4392 first argument is the name under which the remaining command line should
4393 be accessible, the content of which can be just about anything.
4394 A ghost may itself expand to another ghost, but to avoid expansion loops
4395 further expansion will be prevented if a ghost refers to itself or if an
4396 expansion depth limit is reached.
4397 Explicit expansion prevention is available via reverse solidus
4398 .Cm \e ,
4400 .Sx "Command modifiers" .
4401 .Bd -literal -offset indent
4402 ? gh xx
4403 \*(uA: `ghost': no such alias: xx
4404 ? gh xx echo hello,
4405 ? gh xx
4406 ghost xx "echo hello,"
4407 ? xx
4408 hello,
4409 ? xx world
4410 hello, world
4415 .It Ic headerpick
4416 \*(NQ Multiplexer command to establish white- and blacklisting
4417 selections of header fields for a variety of applications.
4418 Without arguments the set of contexts that have settings is displayed.
4419 When given arguments, the first argument is the context to which the
4420 command applies, one of (case-insensitively)
4421 .Ql type
4422 for display purposes (via, e.g.,
4423 .Ic type ) ,
4424 .Ql save
4425 for selecting which headers shall be stored persistently when
4426 .Ic save ,
4427 .Ic copy ,
4428 .Ic move
4429 or even
4430 .Ic decrypt Ns
4431 ing messages (note that MIME related etc. header fields should not be
4432 ignored in order to not destroy usability of the message in this case),
4433 .Ql forward
4434 for stripping down messages when
4435 .Ic forward Ns
4436 ing message (has no effect if
4437 .Va forward-as-attachment
4438 is set), and
4439 .Ql top
4440 for defining user-defined set of fields for the command
4441 .Ic top .
4444 The current settings of the given context are displayed if only the
4445 first argument is given.
4446 A second argument denotes the type of restriction that is to be chosen,
4447 it may be (a case-insensitive prefix of)
4448 .Ql retain
4450 .Ql ignore
4451 for white- and blacklisting purposes, respectively.
4452 Establishing a whitelist suppresses inspection of the corresponding
4453 blacklist.
4454 If no further argument is given the current settings of the given type
4455 will be displayed.
4458 With four or more arguments the third denotes the action to be applied,
4459 it may be
4460 .Ql add
4462 .Ql +
4463 for addition of fields, and
4464 .Ql remove
4466 .Ql -
4467 for removal of fields from the given type of the given context.
4468 The fourth, and any following arguments are expected to specify the
4469 fields of desire, or \*(OPally, regular expression matches ought to
4470 be applied.
4471 The special wildcard field (asterisk,
4472 .Ql * )
4473 will establish a (fast) shorthand setting which covers all fields, or
4474 remove all fields in one operation, respectively.
4478 .It Ic headers
4479 (h) Show the current group of headers, the size of which depends on
4480 the variable
4481 .Va screen
4482 and the style of which can be adjusted with the variable
4483 .Va headline .
4484 If a message-specification is given the group of headers containing the
4485 first message therein is shown and the message at the top of the screen
4486 becomes the new
4487 .Dq dot .
4490 .It Ic help
4491 (hel) A synonym for
4492 .Ic \&? .
4495 .It Ic history
4496 \*(OP Either
4497 .Ar show
4499 .Ar clear
4500 the list of history entries;
4501 a decimal
4502 .Ar NUMBER
4503 argument selects and evaluates the respective history entry,
4504 which will become the new history top; a negative number is used as an
4505 offset to the current command, e.g.,
4506 .Ql -1
4507 will select the last command, the history top.
4508 The default mode if no arguments are given is
4509 .Ar show .
4512 .It Ic hold
4513 (ho, also
4514 .Ic preserve )
4515 Takes a message list and marks each message therein to be saved in the
4516 user's system
4517 .Va inbox
4518 instead of in
4519 .Ev MBOX .
4520 Does not override the
4521 .Ic delete
4522 command.
4523 \*(UA deviates from the POSIX standard with this command, because a
4524 .Ic next
4525 command issued after
4526 .Ic hold
4527 will display the following message, not the current one.
4531 .It Ic if
4532 (i) Part of the nestable
4533 .Ic if Ns / Ns Ic elif Ns / Ns Ic else Ns / Ns Ic endif
4534 conditional execution construct \(em if the given condition is true then
4535 the encapsulated block is executed.
4536 POSIX only supports the (case-insensitive) conditions
4537 .Ql r Ns
4538 eceive
4540 .Ql s Ns
4541 end, all remaining conditions are non-portable extensions; note that
4542 falsely specified conditions cause the execution of the entire
4543 conditional construct until the (matching) closing
4544 .Ic endif
4545 command to be suppressed.
4546 The syntax of the nestable
4547 .Ic if
4548 conditional execution construct requires that each condition and syntax
4549 element is surrounded by whitespace.
4551 .Bd -literal -offset indent
4552 if receive
4553   commands ...
4554 else
4555   commands ...
4556 endif
4560 The (case-insensitive) condition
4561 .Ql t Ns
4562 erminal will evaluate to true if the standard input is a terminal, i.e.,
4563 in interactive sessions.
4564 Another condition can be any boolean value (see the section
4565 .Sx "INTERNAL VARIABLES"
4566 for textual boolean representations) to mark an enwrapped block as
4567 .Dq never execute
4569 .Dq always execute .
4570 It is possible to check
4571 .Sx "INTERNAL VARIABLES"
4572 as well as
4573 .Sx ENVIRONMENT
4574 variables for existence or compare their expansion against a user given
4575 value or another variable by using the
4576 .Ql $
4577 .Pf ( Dq variable next )
4578 conditional trigger character;
4579 a variable on the right hand side may be signalled using the same
4580 mechanism.
4581 The variable names may be enclosed in a pair of matching braces.
4584 Integer operators treat the left and right hand side as integral numbers
4585 and compare them arithmetically.
4586 It is an error if any of the operands is not a valid integer, an empty
4587 operand is treated as if it were 0.
4588 Available operators are
4589 .Ql -lt
4590 (less than),
4591 .Ql -le
4592 (less than or equal to),
4593 .Ql -eq
4594 (equal),
4595 .Ql -ne
4596 (not equal),
4597 .Ql -ge
4598 (greater than or equal to), and
4599 .Ql -gt
4600 (greater than).
4603 String operators compare the left and right hand side 8-bit byte-wise,
4604 ignoring case according to the rules of the US-ASCII encoding
4605 (therefore, dependent on the active locale, possibly producing false
4606 results for strings in the locale encoding).
4607 An unset variable is treated as the empty string.
4608 Available operators are
4609 .Ql <
4610 (less than),
4611 .Ql <=
4612 (less than or equal to),
4613 .Ql ==
4614 (equal),
4615 .Ql !=
4616 (not equal),
4617 .Ql >=
4618 (greater than or equal to),
4619 .Ql >
4620 (greater than),
4621 .Ql =@
4622 (is substring of) and
4623 .Ql !@
4624 (is not substring of).
4627 When the \*(OPal regular expression support is available, the additional
4628 string operators
4629 .Ql =~
4631 .Ql !~
4632 can be used.
4633 They treat the right hand side as an extended regular expression that is
4634 matched case-insensitively and according to the active
4635 .Ev LC_CTYPE
4636 locale, meaning that strings in the locale encoding should be matched
4637 correctly.
4640 Conditions can be joined via AND-OR lists (where the AND operator is
4641 .Ql &&
4642 and the OR operator is
4643 .Ql || ) ,
4644 which have equal precedence and will be evaluated with left
4645 associativity, thus using the same syntax that is known for the
4646 .Xr sh 1 .
4647 It is also possible to form groups of conditions and lists by enclosing
4648 them in pairs of brackets
4649 .Ql [\ \&.\&.\&.\ ] ,
4650 which may be interlocked within each other, and also be joined via
4651 AND-OR lists.
4654 The results of individual conditions and entire groups may be modified
4655 via unary operators: the unary operator
4656 .Ql \&!
4657 will reverse the result.
4659 .Bd -literal -offset indent
4660 if $debug
4661   echo *debug* is set
4662 endif
4663 if [ "$ttycharset" == UTF-8 ] || [ "$ttycharset" == UTF8 ]
4664   echo *ttycharset* is set to UTF-8, case-insensitively
4665 endif
4666 set t1=one t2=one
4667 if [ "${t1}" == "${t2}" ]
4668   echo These two variables are equal
4669 endif
4670 # This is a string test, -ge was added for v14.9.0
4671 if [ "$version-major" >= 15 ]
4672   echo Running a new version..
4673   if [ "$features" =@ +regex ]
4674     if [ "$TERM" =~ "^xterm\&.*" ]
4675       echo ..in an X terminal
4676     endif
4677   endif
4678   if [ [ true ] && [ [ "${debug}" != '' ] || \e
4679       [ "$verbose" != '' ] ] ]
4680     echo Noisy, noisy
4681   endif
4682   if true && [ "$debug" != '' ] || [ "${verbose}" != '' ]
4683     echo Left associativity, as is known from the shell
4684   endif
4685   if ! ! true && ! [ ! "$debug" && ! "$verbose" ]
4686     echo Unary operator support
4687   endif
4688 endif
4693 .It Ic ignore
4694 (ig) Identical to
4695 .Ic discard .
4696 Superseded by the multiplexer
4697 .Ic headerpick .
4700 .It Ic list
4701 Shows the names of all available commands, alphabetically sorted.
4702 If given any non-whitespace argument the list will be shown in the order
4703 in which command prefixes are searched.
4704 In conjunction with a set variable
4705 .Va verbose
4706 additional information will be provided for each command: the argument
4707 type will be indicated, the \*(OPal documentation string will be shown,
4708 and the set of command flags will show up:
4710 .Bl -tag -compact -width ".It Ql BaNg"
4711 .It Ql "vput modifier"
4712 command supports the command modifier
4713 .Cm vput .
4714 .It Ql "status in *!*"
4715 the soft exit status is tracked in
4716 .Va \&! .
4717 .It Ql "needs box"
4718 commands needs an active mailbox, a
4719 .Ic file .
4720 .It Ql "ok: batch or interactive"
4721 command may only be used in interactive or
4722 .Fl #
4723 batch mode.
4724 .It Ql "ok: send mode"
4725 command can be used in send mode.
4726 .It Ql "not ok: compose mode"
4727 command is not available when in compose-mode.
4728 .It Ql "not ok: during startup"
4729 command cannot be used during program startup, e.g., while loading
4730 .Sx "Resource files" .
4731 .It Ql "ok: in subprocess"
4732 command is allowed to be used when running in a subprocess instance,
4733 e.g., from within a macro that is called via
4734 .Va on-compose-done .
4738 .It Ic localopts
4739 This command can be used to localize changes to variables, meaning that
4740 their state will be reverted to the former one once the covered scope
4741 is left.
4742 It can only be used inside of macro definition blocks introduced by
4743 .Ic account
4745 .Ic define ,
4746 and is interpreted as a boolean (string, see
4747 .Sx "INTERNAL VARIABLES" ) ;
4749 .Dq covered scope
4750 of an account is left once it is switched off again.
4751 .Bd -literal -offset indent
4752 define temporary_settings {
4753   set possibly_global_option1
4754   localopts on
4755   set local_option1
4756   set local_option2
4757   localopts off
4758   set possibly_global_option2
4762 .Sy Note
4763 that this setting
4764 .Dq stacks up :
4765 i.e., if
4766 .Ql macro1
4767 enables change localization and calls
4768 .Ql macro2 ,
4769 which explicitly resets localization, then any value changes within
4770 .Ql macro2
4771 will still be reverted by
4772 .Ql macro1 !
4773 \*(ID Once the outermost level, the one which enabled localization
4774 first, is left, but no earlier, all adjustments will be unrolled.
4775 \*(ID Likewise worth knowing, if in this example
4776 .Ql macro2
4777 changes to a different
4778 .Ic account
4779 which sets some variables that are yet covered by localizations, their
4780 scope will be extended, and in fact leaving the
4781 .Ic account
4782 will (thus) restore settings in (likely) global scope which actually
4783 were defined in a local, private context.
4786 .It Ic Lreply
4787 Reply to messages that come in via known
4788 .Pf ( Ic mlist )
4789 or subscribed
4790 .Pf ( Ic mlsubscribe )
4791 mailing lists, or pretend to do so (see
4792 .Sx "Mailing lists" ) :
4793 on top of the usual
4794 .Ic reply
4795 functionality this will actively resort and even remove message
4796 recipients in order to generate a message that is supposed to be sent to
4797 a mailing list.
4798 For example it will also implicitly generate a
4799 .Ql Mail-Followup-To:
4800 header if that seems useful, regardless of the setting of the variable
4801 .Va followup-to .
4804 .It Ic Mail
4805 Similar to
4806 .Ic mail ,
4807 but saves the message in a file named after the local part of the first
4808 recipient's address (instead of in
4809 .Va record Ns ).
4812 .It Ic mail
4813 (m) Takes a (list of) recipient address(es) as (an) argument(s),
4814 or asks on standard input if none were given;
4815 then collects the remaining mail content and sends it out.
4818 .It Ic mbox
4819 (mb) The given message list is to be sent to
4820 .Ev MBOX
4821 when \*(UA is quit; this is the default action unless the variable
4822 .Va hold
4823 is set.
4824 \*(ID This command can only be used in a
4825 .Mx -sx
4826 .Sx "primary system mailbox" .
4829 .It Ic mimetype
4830 Without any arguments the content of the MIME type cache will displayed.
4831 Otherwise each argument defines a complete MIME type specification of
4832 a type that shall be added (prepended) to the cache.
4833 In any event MIME type sources are loaded first as necessary \(en
4834 .Va mimetypes-load-control
4835 can be used to fine-tune which sources are actually loaded.
4836 Refer to the section on
4837 .Sx "The mime.types files"
4838 for more on MIME type specifications and this topic in general.
4839 MIME type unregistration and cache resets can be triggered with
4840 .Ic unmimetype .
4843 .It Ic mlist
4844 Without arguments the list of all currently defined mailing lists
4845 (and their attributes, if any) is shown; a more verbose listing will be
4846 produced if either of
4847 .Va debug
4849 .Va verbose
4850 are set.
4851 Otherwise all given arguments (which need not be quoted except for
4852 whitespace) will be added and henceforth be recognized as mailing lists.
4853 Mailing lists may be removed via the command
4854 .Ic unmlist .
4856 If the \*(OPal regular expression support is available then mailing
4857 lists may also be specified as (extended) regular expressions (see
4858 .Xr re_format 7
4859 for more on those).
4862 .It Ic mlsubscribe
4863 Without arguments the list of all currently defined mailing lists which
4864 have a subscription attribute is shown; a more verbose listing will be
4865 produced if either of
4866 .Va debug
4868 .Va verbose
4869 are set.
4870 Otherwise this attribute will be set for all given mailing lists,
4871 newly creating them as necessary (as via
4872 .Ic mlist ) .
4873 Subscription attributes may be removed via the command
4874 .Ic unmlsubscribe .
4875 Also see
4876 .Va followup-to .
4879 .It Ic Move
4880 Similar to
4881 .Ic move ,
4882 but moves the messages to a file named after the local part of the
4883 sender address of the first message (instead of in
4884 .Va record Ns ).
4887 .It Ic move
4888 Acts like
4889 .Ic copy
4890 but marks the messages for deletion if they were transferred
4891 successfully.
4894 .It Ic More
4895 Like
4896 .Ic more ,
4897 but also displays header fields which would not pass the
4898 .Ic headerpick
4899 selection, and all MIME parts.
4900 Identical to
4901 .Ic Page .
4904 .It Ic more
4905 Invokes the
4906 .Ev PAGER
4907 on the given messages, even in non-interactive mode and as long as the
4908 standard output is a terminal.
4909 Identical to
4910 .Ic page .
4913 .It Ic netrc
4914 \*(OP When used without arguments or if
4915 .Ar show
4916 has been given the content of the
4917 .Pa .netrc
4918 cache is shown, loading it first as necessary.
4919 If the argument is
4920 .Ar load
4921 then the cache will only be initialized and
4922 .Ar clear
4923 will remove its contents.
4924 Note that \*(UA will try to load the file only once, use
4925 .Ql Ic \&\&netrc Ns \:\0\:clear
4926 to unlock further attempts.
4928 .Va netrc-lookup ,
4929 .Va netrc-pipe
4930 and the section
4931 .Sx "On URL syntax and credential lookup" ;
4932 the section
4933 .Sx "The .netrc file"
4934 documents the file format in detail.
4937 .It Ic newmail
4938 Checks for new mail in the current folder without committing any changes
4939 before.
4940 If new mail is present, a message is shown.
4941 If the
4942 .Va header
4943 variable is set,
4944 the headers of each new message are also shown.
4945 This command is not available for all mailbox types.
4948 .It Ic next
4949 (n) (like
4950 .Ql +
4952 .Dq ENTER )
4953 Goes to the next message in sequence and types it.
4954 With an argument list, types the next matching message.
4957 .It Ic New
4958 Same as
4959 .Ic Unread .
4962 .It Ic new
4963 Same as
4964 .Ic unread .
4967 .It Ic noop
4968 If the current folder is accessed via a network connection, a
4969 .Dq NOOP
4970 command is sent, otherwise no operation is performed.
4973 .It Ic Page
4974 Like
4975 .Ic page ,
4976 but also displays header fields which would not pass the
4977 .Ic headerpick
4978 selection, and all MIME parts.
4979 Identical to
4980 .Ic More .
4983 .It Ic page
4984 Invokes the
4985 .Ev PAGER
4986 on the given messages, even in non-interactive mode and as long as the
4987 standard output is a terminal.
4988 Identical to
4989 .Ic more .
4992 .It Ic Pipe
4993 Like
4994 .Ic pipe
4995 but also pipes header fields which would not pass the
4996 .Ic headerpick
4997 selection, and all parts of MIME
4998 .Ql multipart/alternative
4999 messages.
5002 .It Ic pipe
5003 (pi) Takes a message list and a shell command
5004 and pipes the messages through the command.
5005 Without an argument the current message is piped through the command
5006 given by the
5007 .Va cmd
5008 variable.
5009 If the
5010 .Va page
5011 variable is set,
5012 every message is followed by a formfeed character.
5015 .It Ic preserve
5016 (pre) A synonym for
5017 .Ic hold .
5020 .It Ic Print
5021 (P) Alias for
5022 .Ic Type .
5025 .It Ic print
5026 (p) Research
5028 equivalent of
5029 .Ic type .
5032 .It Ic quit
5033 (q) Terminates the session, saving all undeleted, unsaved messages in
5034 the current
5035 .Ev MBOX ,
5036 preserving all messages marked with
5037 .Ic hold
5039 .Ic preserve
5040 or never referenced in the system
5041 .Va inbox ,
5042 and removing all other messages from the
5043 .Mx -sx
5044 .Sx "primary system mailbox" .
5045 If new mail has arrived during the session,
5046 the message
5047 .Dq You have new mail
5048 will be shown.
5049 If given while editing a mailbox file with the command line option
5050 .Fl f ,
5051 then the edit file is rewritten.
5052 A return to the shell is effected,
5053 unless the rewrite of edit file fails,
5054 in which case the user can escape with the exit command.
5057 .It Ic read
5058 \*(NQ Read a line from standard input, and assign the splitted and
5059 trimmed line data to the given variables.
5060 The variable names are check by the same rules as documented for
5061 .Cm vput .
5062 If there are more fields than variables, assign successive fields to the
5063 last given variable.
5064 If there are less fields than variables, assign the empty string to the
5065 remains.
5066 The return status is tracked via
5067 .Va \&! :
5068 even though variable names are checked errors may still happen if it is
5069 tried to set, e.g., strings to variables which expect number settings;
5070 it thus only happens if names are used which have special meaning to \*(UA.
5071 \*(ID This command will likely be extended towards more
5072 .Xr read 1
5073 compatibility: for now splitting always occurs at whitespace, reverse
5074 solidus newline escaping is always supported, and the \*(OPal line
5075 editing features are always available when on an interactive terminal.
5076 .Bd -literal -offset indent
5077 ? read a b c
5078    H  e  l  l  o
5079 ? echo "<$a> <$b> <$c>"
5080 <H> <e> <l  l  o>
5084 .It Ic redirect
5085 Same as
5086 .Ic resend .
5089 .It Ic Redirect
5090 Same as
5091 .Ic Resend .
5094 .It Ic remove
5095 Removes the named files or directories.
5096 If a name refer to a mailbox, e.g., a Maildir mailbox, then a mailbox
5097 type specific removal will be performed, deleting the complete mailbox.
5098 The user is asked for confirmation in interactive mode.
5101 .It Ic rename
5102 Takes the name of an existing folder
5103 and the name for the new folder
5104 and renames the first to the second one.
5105 Both folders must be of the same type.
5108 .It Ic Reply
5109 (R) Reply to originator.
5110 Does not reply to other recipients of the original message.
5111 .Va flipr
5112 will exchange this command with
5113 .Ic reply .
5114 Unless the internal variable
5115 .Va fullnames
5116 is set the recipient address will be stripped from comments, names etc.
5119 .It Ic reply
5120 (r) Take a message and group-responds to it by addressing the sender
5121 and all recipients.
5122 .Va followup-to ,
5123 .Va followup-to-honour ,
5124 .Va reply-to-honour
5125 as well as
5126 .Va recipients-in-cc
5127 influence response behaviour.
5128 The command
5129 .Ic Lreply
5130 offers special support for replying to mailing lists.
5131 Unless the internal variable
5132 .Va fullnames
5133 is set recipient addresses will be stripped from comments, names etc.
5135 .Va flipr
5136 is set the commands
5137 .Ic Reply
5139 .Ic reply
5140 are exchanged.
5143 .It Ic replyall
5144 Similar to
5145 .Ic reply ,
5146 but initiates a group-reply regardless of the value of
5147 .Va flipr .
5150 .It Ic replysender
5151 Similar to
5152 .Ic Reply ,
5153 but responds to the sender only regardless of the value of
5154 .Va flipr .
5157 .It Ic Resend
5158 Like
5159 .Ic resend ,
5160 but does not add any header lines.
5161 This is not a way to hide the sender's identity,
5162 but useful for sending a message again to the same recipients.
5165 .It Ic resend
5166 Takes a list of messages and a user name
5167 and sends each message to the named user.
5168 .Ql Resent-From:
5169 and related header fields are prepended to the new copy of the message.
5172 .It Ic Respond
5173 Same as
5174 .Ic Reply .
5177 .It Ic respond
5178 Same as
5179 .Ic reply .
5182 .It Ic respondall
5183 Same as
5184 .Ic replyall .
5187 .It Ic respondsender
5188 Same as
5189 .Ic replysender .
5192 .It Ic retain
5193 (ret) Superseded by the multiplexer
5194 .Ic headerpick .
5197 .It Ic return
5198 Only available inside the scope of a
5199 .Ic define Ns
5200 d macro or an
5201 .Ic account ,
5202 this will stop evaluation of any further macro content, and return
5203 execution control to the caller.
5204 If no arguments are specified, the return value, which will be stored in
5205 .Va \&! ,
5206 as well as the macro command exit status, which is made available in
5207 .Va \&? ,
5208 are both set to 0.
5209 If only the return value is given the command exit status will be 0.
5210 Both optional parameters must be specified as unsigned (positive)
5211 decimal numbers.
5213 \*(ID Notes: any non-0 command exit status is treated as a hard error
5214 by the state machinery, and will be propagated up and cause, e.g.,
5215 a file inclusion via
5216 .Ic source
5217 to fail; this two argument form likely is a temporary hack that will
5218 vanish in v15.
5221 .It Ic Save
5222 (S) Similar to
5223 .Ic save,
5224 but saves the messages in a file named after the local part of the
5225 sender of the first message instead of (in
5226 .Va record
5227 and) taking a filename argument.
5230 .It Ic save
5231 (s) Takes a message list and a filename and appends each message in turn
5232 to the end of the file.
5233 If no filename is given, the
5234 .Ev MBOX
5235 file is used.
5236 The filename in quotes, followed by the generated character count
5237 is echoed on the user's terminal.
5238 If editing a
5239 .Mx -sx
5240 .Sx "primary system mailbox"
5241 the messages are marked for deletion.
5242 .Sx "Filename transformations"
5243 will be applied.
5246 .It Ic savediscard
5247 \*(OB Superseded by the multiplexer
5248 .Ic headerpick .
5251 .It Ic saveignore
5252 \*(OB Superseded by the multiplexer
5253 .Ic headerpick .
5256 .It Ic saveretain
5257 \*(OB Superseded by the multiplexer
5258 .Ic headerpick .
5261 .It Ic search
5262 Takes a message specification (list) and displays a header summary of
5263 all matching messages, as via
5264 .Ic headers .
5265 This command is an alias of
5266 .Ic from .
5267 Also see
5268 .Sx "Specifying messages" .
5271 .It Ic seen
5272 Takes a message list and marks all messages as having been read.
5275 .It Ic set
5276 (se) Without arguments this command shows all internal variables which
5277 are currently known to \*(UA (they have been set).
5278 A more verbose listing will be produced if either of
5279 .Va debug
5281 .Va verbose
5282 are set, in which case variables may be preceded with a comment line
5283 that gives some context of what \*(UA knows about the given variable.
5285 Otherwise the given variables (and arguments) are set or adjusted.
5286 Arguments are of the form
5287 .Ql name=value
5288 (no space before or after
5289 .Ql = ) ,
5290 or plain
5291 .Ql name
5292 if there is no value, i.e., a boolean variable.
5293 Quotation marks may be placed around any part of the assignment
5294 statement to quote blanks or tabs, e.g.,
5296 .Dl set indentprefix='->'
5298 If an argument begins with
5299 .Ql no ,
5300 as in
5301 .Ql set nosave ,
5302 the effect is the same as invoking the
5303 .Ic unset
5304 command with the remaining part of the variable
5305 .Pf ( Ql unset save ) .
5308 .Ql name
5309 that is known to map to an environment variable will automatically cause
5310 updates in the program environment (unsetting a variable in the
5311 environment requires corresponding system support).
5312 Please use the command
5313 .Ic environ
5314 for further environmental control.
5315 Also see
5316 .Ic varedit ,
5317 .Ic varshow
5318 and the sections
5319 .Sx "INTERNAL VARIABLES"
5321 .Sx ENVIRONMENT .
5324 .It Ic shell
5325 (sh) Invokes an interactive version of the shell.
5328 .It Ic shortcut
5329 Without arguments the list of all currently defined shortcuts is
5330 shown.
5331 Otherwise all given arguments are treated as pairs of shortcuts and
5332 their expansions, creating new or changing already existing shortcuts,
5333 as necessary.
5334 Shortcuts can be removed with the command
5335 .Ic unshortcut .
5338 .It Ic shift
5339 Only available inside the scope of a
5340 .Ic call Ns
5341 ed macro, this will shift the positional parameters (starting at
5342 .Va 1 )
5343 by the given number (which must be an unsigned, positive, decimal),
5344 or 1 if no argument has been given.
5345 It is an error if the value exceeds the number of positional parameters.
5346 If the given number is 0, no action is performed, successfully.
5349 .It Ic show
5350 Like
5351 .Ic type ,
5352 but performs neither MIME decoding nor decryption, so that the raw
5353 message text is shown.
5356 .It Ic size
5357 (si) Shows the size in characters of each message of the given
5358 message-list.
5361 .It Ic sort
5362 Shows the current sorting criterion when used without an argument.
5363 Otherwise creates a sorted representation of the current folder,
5364 and changes the
5365 .Ic next
5366 command and the addressing modes such that they refer to messages in
5367 the sorted order.
5368 Message numbers are the same as in regular mode.
5369 If the
5370 .Va header
5371 variable is set,
5372 a header summary in the new order is also displayed.
5373 Automatic folder sorting can be enabled by setting the
5374 .Va autosort
5375 variable, as in, e.g.,
5376 .Ql set autosort=thread .
5377 Possible sorting criterions are:
5379 .Bl -tag -compact -width "subject"
5380 .It Ar date
5381 Sort the messages by their
5382 .Ql Date:
5383 field, that is by the time they were sent.
5384 .It Ar from
5385 Sort messages by the value of their
5386 .Ql From:
5387 field, that is by the address of the sender.
5388 If the
5389 .Va showname
5390 variable is set, the sender's real name (if any) is used.
5391 .It Ar size
5392 Sort the messages by their size.
5393 .It spam
5394 \*(OP Sort the message by their spam score, as has been classified by
5395 .Ic spamrate .
5396 .It Ar status
5397 Sort the messages by their message status.
5398 .It Ar subject
5399 Sort the messages by their subject.
5400 .It Ar thread
5401 Create a threaded display.
5402 .It Ar to
5403 Sort messages by the value of their
5404 .Ql To:
5405 field, that is by the address of the recipient.
5406 If the
5407 .Va showname
5408 variable is set, the recipient's real name (if any) is used.
5412 .It Ic source
5413 \*(NQ (so) The source command reads commands from the given file.
5414 .Sx "Filename transformations"
5415 will be applied.
5416 If the given expanded argument ends with a vertical bar
5417 .Ql |
5418 then the argument will instead be interpreted as a shell command and
5419 \*(UA will read the output generated by it.
5420 Interpretation of commands read is stopped when an error is encountered.
5421 \*(ID Note that
5422 .Ic \&\&source
5423 cannot be used from within macros that execute as
5424 .Va folder-hook Ns s
5426 .Ic account Ns s ,
5427 i.e., it can only be called from macros that were
5428 .Ic call Ns ed .
5431 .It Ic source_if
5432 \*(NQ The difference to
5433 .Ic source
5434 (beside not supporting pipe syntax aka shell command input) is that
5435 this command will not generate an error nor warn if the given file
5436 argument cannot be opened successfully.
5439 .It Ic spamclear
5440 \*(OP Takes a list of messages and clears their
5441 .Ql is-spam
5442 flag.
5445 .It Ic spamforget
5446 \*(OP Takes a list of messages and causes the
5447 .Va spam-interface
5448 to forget it has ever used them to train its Bayesian filter.
5449 Unless otherwise noted the
5450 .Ql is-spam
5451 flag of the message is inspected to chose whether a message shall be
5452 forgotten to be
5453 .Dq ham
5455 .Dq spam .
5458 .It Ic spamham
5459 \*(OP Takes a list of messages and informs the Bayesian filter of the
5460 .Va spam-interface
5461 that they are
5462 .Dq ham .
5463 This also clears the
5464 .Ql is-spam
5465 flag of the messages in question.
5468 .It Ic spamrate
5469 \*(OP Takes a list of messages and rates them using the configured
5470 .Va spam-interface ,
5471 without modifying the messages, but setting their
5472 .Ql is-spam
5473 flag as appropriate; because the spam rating headers are lost the rate
5474 will be forgotten once the mailbox is left.
5475 Refer to the manual section
5476 .Sx "Handling spam"
5477 for the complete picture of spam handling in \*(UA.
5480 .It Ic spamset
5481 \*(OP Takes a list of messages and sets their
5482 .Ql is-spam
5483 flag.
5486 .It Ic spamspam
5487 \*(OP Takes a list of messages and informs the Bayesian filter of the
5488 .Va spam-interface
5489 that they are
5490 .Dq spam .
5491 This also sets the
5492 .Ql is-spam
5493 flag of the messages in question.
5496 .It Ic thread
5497 \*(OB The same as
5498 .Ql sort thread
5499 (consider using a
5500 .Ql ghost
5501 as necessary).
5502 Create a threaded representation of the current folder,
5503 i.\|e. indent messages that are replies to other messages in the header
5504 display and change the
5505 .Ic next
5506 command and the addressing modes such that they refer to messages in the
5507 threaded order.
5508 Message numbers are the same as in unthreaded mode.
5509 If the
5510 .Va header
5511 variable is set,
5512 a header summary in threaded order is also displayed.
5515 .It Ic Top
5516 Like
5517 .Ic top
5518 but always uses the
5519 .Ic headerpick
5520 .Ql type
5521 slot for white- and blacklisting header fields.
5524 .It Ic top
5525 (to) Takes a message list and types out the first
5526 .Va toplines
5527 lines of each message on the users' terminal.
5528 Unless a special selection has been established for the
5529 .Ql top
5530 slot of the
5531 .Ic headerpick
5532 command, the only header fields that are displayed are
5533 .Ql From: ,
5534 .Ql To: ,
5535 .Ql CC: ,
5537 .Ql Subject: .
5538 .Ic Top
5539 will always use the
5540 .Ql type
5541 .Ic headerpick
5542 selection instead.
5543 It is possible to apply compression to what is displayed by setting
5544 .Va topsqueeze .
5545 Messages are decrypted and converted to the terminal character set
5546 if necessary.
5549 .It Ic touch
5550 (tou) Takes a message list and marks the messages for saving in
5551 .Ev MBOX .
5552 \*(UA deviates from the POSIX standard with this command,
5553 as a following
5554 .Ic next
5555 command will display the following message instead of the current one.
5558 .It Ic Type
5559 (T) Like
5560 .Ic type
5561 but also displays header fields which would not pass the
5562 .Ic headerpick
5563 selection, and all parts of MIME
5564 .Ql multipart/alternative
5565 messages.
5568 .It Ic type
5569 (t) Takes a message list and types out each message on the users'
5570 terminal, honouring
5571 .Ic headerpick
5572 selections.
5573 For MIME multipart messages, all parts with a content type of
5574 .Ql text
5576 .Ql message
5577 are shown, the other are hidden except for their headers.
5578 Messages are decrypted and converted to the terminal character set
5579 if necessary.
5582 .It Ic unaccount
5583 Delete all given accounts.
5584 An error message is shown if a given account is not defined.
5585 The special name
5586 .Ql *
5587 will discard all existing accounts.
5590 .It Ic unalias
5591 (una) Takes a list of names defined by alias commands
5592 and discards the remembered groups of users.
5593 The special name
5594 .Ql *
5595 will discard all existing aliases.
5598 .It Ic unanswered
5599 Takes a message list and marks each message as not having been answered.
5602 .It Ic unbind
5603 Forget about a key
5604 .Ic bind Ns
5605 ing, specified by its context and input sequence, both of which may be
5606 specified as a wildcard (asterisk,
5607 .Ql * ) ,
5608 e.g.,
5609 .Ql unbind * *
5610 will remove all bindings of all contexts.
5613 .It Ic uncollapse
5614 Only applicable to threaded mode.
5615 Takes a message list and makes the message and all replies to it visible
5616 in header summaries again.
5617 When a message becomes the current message,
5618 it is automatically made visible.
5619 Also when a message with collapsed replies is displayed,
5620 all of these are automatically uncollapsed.
5623 .It Ic uncolour
5624 Forget about a
5625 .Ic colour
5626 mapping for the given colour type (see
5627 .Ic colour
5628 for a list of types) and mapping; if the optional precondition argument
5629 is used then only the exact tuple of mapping and precondition is removed.
5630 The special name
5631 .Ql *
5632 will remove all mappings (no precondition allowed).
5633 Also see
5634 .Sx "Coloured display"
5635 for the general picture.
5638 .It Ic undefine
5639 Undefine all given macros.
5640 An error message is shown if a given macro is not defined.
5641 The special name
5642 .Ql *
5643 will discard all existing macros.
5646 .It Ic undelete
5647 (u) Takes a message list and marks each message as not being deleted.
5648 If the
5649 .Va autoprint
5650 variable is set, the last message restored will be
5651 .Ic type Ns
5652 d automatically; if no message list had been specified then the usual
5653 search for a visible message is performed, as documented for
5654 .Sx COMMANDS ,
5655 showing only the next input prompt if the search fails.
5656 Also see
5657 .Ic delete ,
5658 .Ic dp ,
5659 .Ic dt .
5662 .It Ic undraft
5663 Takes a message list and
5664 .Pf un Ic draft Ns
5665 s each message.
5668 .It Ic unflag
5669 Takes a message list and marks each message as not being
5670 .Ic flag Ns ged .
5673 .It Ic unfwdignore
5674 \*(OB Superseded by the multiplexer
5675 .Ic headerpick .
5678 .It Ic unfwdretain
5679 \*(OB Superseded by the multiplexer
5680 .Ic headerpick .
5683 .It Ic unghost
5684 Remove all the given command
5685 .Ic ghost Ns s Ns .
5686 The special name
5687 .Ql *
5688 will remove all ghosts.
5691 .It Ic unignore
5692 Superseded by the multiplexer
5693 .Ic headerpick .
5696 .It Ic unmimetype
5697 Delete all given MIME types, e.g.,
5698 .Ql unmimetype text/plain
5699 will remove all registered specifications for the MIME type
5700 .Ql text/plain .
5701 The special name
5702 .Ql *
5703 will discard all existing MIME types, just as will
5704 .Ql reset ,
5705 but which also reenables cache initialization via
5706 .Va mimetypes-load-control .
5709 .It Ic unmlist
5710 Forget about all the given mailing lists.
5711 The special name
5712 .Ql *
5713 will remove all lists.
5714 Also see
5715 .Ic mlist .
5718 .It Ic unmlsubscribe
5719 Remove the subscription attribute from all given mailing lists.
5720 The special name
5721 .Ql *
5722 will clear the attribute from all lists which have it set.
5723 Also see
5724 .Ic mlsubscribe .
5727 .It Ic Unread
5728 Same as
5729 .Ic unread .
5732 .It Ic unread
5733 Takes a message list and marks each message as not having been read.
5736 .It Ic unretain
5737 Superseded by the multiplexer
5738 .Ic headerpick .
5741 .It Ic unsaveignore
5742 \*(OB Superseded by the multiplexer
5743 .Ic headerpick .
5746 .It Ic unsaveretain
5747 \*(OB Superseded by the multiplexer
5748 .Ic headerpick .
5751 .It Ic unset
5752 \*(NQ (uns) Takes a list of internal variable names and discards their
5753 remembered values; the reverse of
5754 .Ic set .
5755 Also see
5756 .Ic environ .
5759 .It Ic unshortcut
5760 Delete the
5761 .Ic shortcut Ns
5762 s given as arguments, the special argument
5763 .Ql *
5764 will remove all shortcuts.
5767 .It Ic unsort
5768 Disable sorted or threaded mode
5769 (see the
5770 .Ic sort
5772 .Ic thread
5773 commands),
5774 return to normal message order and,
5775 if the
5776 .Va header
5777 variable is set,
5778 displays a header summary.
5781 .It Ic unthread
5782 \*(OB
5783 Same as
5784 .Ic unsort .
5787 .It Ic urlcodec
5788 \*(NQ Perform URL percent codec operations, rather according to RFC 3986.
5789 Supports
5790 .Cm vput
5791 (see
5792 .Sx "Command modifiers" ) .
5793 The return status is tracked via
5794 .Va \&! .
5795 This is a character set agnostic and thus locale dependent operation,
5796 and it may decode bytes which are invalid in the current locale, unless
5797 the input solely consists of characters in the portable character set, see
5798 .Sx "Character sets" .
5799 \*(ID This command does not about URLs beside that.
5801 The first argument specifies the operation:
5802 .Ar enc[ode]
5804 .Ar dec[code]
5805 perform plain URL percent en- and decoding, respectively.
5806 .Ar p[ath]enc[ode]
5808 .Ar p[ath]dec[ode]
5809 perform a slightly modified operation which should be better for
5810 pathnames: it does not allow a tilde
5811 .Ql ~ ,
5812 and will neither accept hyphen-minus
5813 .Ql -
5814 nor dot
5815 .Ql .
5816 as an initial character.
5817 The remaining arguments form the URL data which is to be converted.
5820 .It Ic varedit
5821 \*(NQ Edit the values of or create the given variable(s) in the
5822 .Ev EDITOR .
5823 Boolean variables cannot be edited, and variables can also not be
5824 .Ic unset
5825 with this command.
5828 .It Ic varshow
5829 \*(NQ This command produces the same output as the listing mode of
5830 .Ic set ,
5831 including
5832 .Va verbose Ns
5833 ity adjustments, but only for the given variables.
5836 .It Ic verify
5837 \*(OP Takes a message list and verifies each message.
5838 If a message is not a S/MIME signed message,
5839 verification will fail for it.
5840 The verification process checks if the message was signed using a valid
5841 certificate,
5842 if the message sender's email address matches one of those contained
5843 within the certificate,
5844 and if the message content has been altered.
5847 .It Ic version
5848 Shows the
5849 .Va version
5851 .Va features
5852 of \*(UA.
5856 .It Ic vexpr
5857 \*(NQ Evaluate arguments according to a given operator.
5858 This is a multiplexer command which can be used to perform signed 64-bit
5859 numeric calculations as well as string operations.
5860 It uses polish notation, i.e., the operator is the first argument and
5861 defines the number and type, and the meaning of the remaining arguments.
5862 An empty argument is replaced with a 0 if a number is expected.
5863 Supports
5864 .Cm vput
5865 (see
5866 .Sx "Command modifiers" ) .
5867 The return status is tracked via
5868 .Va \&! ,
5869 the result that is shown in case of (soft) errors is
5870 .Ql -1 .
5871 In general only invalid use cases cause hard errors which are reflected in
5872 .Va \&?
5873 and affect the state machine.
5876 Numeric operations work on one or two signed 64-bit integers.
5877 One integer is expected by assignment (equals sign
5878 .Ql = ) ,
5879 which does nothing but parsing the argument, thus detecting validity and
5880 possible overflow conditions, and unary not (tilde
5881 .Ql ~ ) ,
5882 which creates the bitwise complement.
5883 Two integers are used by addition (plus sign
5884 .Ql + ) ,
5885 subtraction (hyphen-minus
5886 .Ql - ) ,
5887 multiplication (asterisk
5888 .Ql * ) ,
5889 division (solidus
5890 .Ql / )
5891 and modulo (percent sign
5892 .Ql % ) ,
5893 as well as for the bitwise operators logical or (vertical bar
5894 .Ql | ,
5895 to be quoted) ,
5896 bitwise and (ampersand
5897 .Ql \&& ,
5898 to be quoted) ,
5899 bitwise xor (circumflex
5900 .Ql ^ ) ,
5901 the bitwise signed left- and right shifts
5902 .Pf ( Ql << ,
5903 .Ql >> ) ,
5904 as well as for the unsigned right shift
5905 .Ql >>> .
5908 All numeric operators can be suffixed with a commercial at
5909 .Ql @ ,
5910 e.g.,
5911 .Ql *@ :
5912 this will turn the operation into a saturated one, which means that
5913 overflow errors and division and modulo by zero are still reflected in
5914 the return status, but the result will linger at the minimum or maximum
5915 possible value, instead of overflowing (or trapping).
5916 For the bitwise shifts, the saturated maximum is 63.
5917 If in saturated mode the overflow occurs during parsing the numbers,
5918 then the actual operation will not be performed but the given maximum
5919 value is used as the result immediately.
5922 String operations that take one argument are
5923 .Ql length ,
5924 which queries the length of the given argument,
5925 .Ql hash ,
5926 which calculates the Chris Torek hash of the given string, and
5927 .Ql file-expand ,
5928 which performs the usual
5929 .Sx "Filename transformations" ,
5930 on its argument, as well as
5931 .Ql random ,
5932 which generates a random string of the given length, or of
5933 .Dv \&\&PATH_MAX
5934 bytes (a constant from
5935 .Pa /usr/include )
5936 if the value 0 is given; the random string will be base64url encoded
5937 according to RFC 4648, and thus be usable as a file name.
5940 String operations with two or more arguments are
5941 .Ql find ,
5942 which searches in the first for the second argument, and shows the
5943 resulting 0-based offset shall it have been found,
5944 .Ql ifind ,
5945 which is identical to
5946 .Ql find ,
5947 but works case-insensitively according to the rules of the ASCII
5948 character set.
5949 .Ql substring
5950 will show a substring of its first argument:
5951 the second argument is the 0-based starting offset, the optional third
5952 argument can be used to specify the length of the desired substring,
5953 by default the entire string is used;
5954 this operation tries to work around faulty arguments, but the (soft)
5955 return status will still reflect them (set
5956 .Va verbose
5957 for error logs).
5960 \*(OP
5961 .Ql regex
5962 will try to match the first argument with the regular expression given
5963 in the second argument, as does
5964 .Ql iregex ,
5965 but which is case-insensitive.
5966 These operators match according to the active
5967 .Ev LC_CTYPE
5968 locale and thus should match correctly strings in the locale encoding.
5969 If the optional third argument has been given then instead of showing
5970 the match offset a replacement operation is performed:
5971 the third argument is treated as if specified via dollar-single-quote
5972 (see
5973 .Sx "Shell-style argument quoting" ) ,
5974 and any occurrence of a positional parameter, e.g.,
5975 .Va 1 ,
5976 is replaced by the corresponding match group of the regular expression.
5978 .Bd -literal -offset indent
5979 ? vexpr -@ +1 -9223372036854775808
5980 ? vput vexpr res ir bananarama (.*)nana(.*) '\e${1}au\e$2'
5981 ? echo $0 $res
5986 .It Ic visual
5987 (v) Takes a message list and invokes the display editor on each message.
5988 Modified contents are discarded unless the
5989 .Va writebackedited
5990 variable is set.
5993 .It Ic write
5994 (w) For conventional messages the body without all headers is written.
5995 The original message is never marked for deletion in the originating
5996 mail folder.
5997 The output is decrypted and converted to its native format as necessary.
5998 If the output file exists, the text is appended.
5999 If a message is in MIME multipart format its first part is written to
6000 the specified file as for conventional messages, handling of the remains
6001 depends on the execution mode.
6002 No special handling of compressed files is performed.
6004 In interactive mode the user is consecutively asked for the filenames of
6005 the processed parts.
6006 For convience saving of each part may be skipped by giving an empty
6007 value, the same result as writing it to
6008 .Pa /dev/null .
6009 Shell piping the part content by specifying a leading vertical bar
6010 .Ql |
6011 character for the filename is supported.
6012 Other user input undergoes the usual
6013 .Sx "Filename transformations" ,
6014 and contents of the destination file are overwritten if the file
6015 previously existed.
6017 \*(ID In non-interactive mode any part which does not specify a filename
6018 is ignored, and suspicious parts of filenames of the remaining parts are
6019 URL percent encoded (as via
6020 .Ic urlencode )
6021 to prevent injection of malicious character sequences, resulting in
6022 a filename that will be written into the current directory.
6023 Existing files will not be overwritten, instead the part number or
6024 a dot are appended after a number sign
6025 .Ql #
6026 to the name until file creation succeeds (or fails due to other
6027 reasons).
6030 .It Ic xit
6031 (x) A synonym for
6032 .Ic exit .
6035 .It Ic z
6036 \*(NQ \*(UA presents message headers in
6037 .Va screen Ns
6038 fuls as described under the
6039 .Ic headers
6040 command.
6041 Without arguments this command scrolls to the next window of messages,
6042 likewise if the argument is
6043 .Ql + .
6044 An argument of
6045 .Ql -
6046 scrolls to the last,
6047 .Ql ^
6048 scrolls to the first, and
6049 .Ql $
6050 to the last
6051 .Va \&\&screen
6052 of messages.
6053 A number argument prefixed by
6054 .Ql +
6056 .Ql \-
6057 indicates that the window is calculated in relation to the current
6058 position, and a number without a prefix specifies an absolute position.
6061 .It Ic Z
6062 \*(NQ Similar to
6063 .Ic z ,
6064 but scrolls to the next or previous window that contains at least one
6065 .Ql new
6067 .Ic flag Ns
6068 ged message.
6070 .\" }}}
6071 .\" }}}
6074 .\" .Sh COMMAND ESCAPES {{{
6075 .Sh "COMMAND ESCAPES"
6077 Here is a summary of the command escapes available in compose mode,
6078 which are used to perform special functions when composing messages.
6079 Command escapes are only recognized at the beginning of lines.
6080 The actual escape character can be set via the internal variable
6081 .Va escape ,
6082 it defaults to the tilde
6083 .Ql ~ .
6086 .Bl -tag -width ".It Ic BaNg"
6088 .It Ic ~~ Ar string
6089 Insert the string of text in the message prefaced by a single
6090 .Ql ~ .
6091 (If the escape character has been changed,
6092 that character must be doubled
6093 in order to send it at the beginning of a line.)
6096 .It Ic ~! Ar command
6097 Execute the indicated shell
6098 .Ar command
6099 which follows, replacing unescaped exclamation marks with the previously
6100 executed command if the internal variable
6101 .Va bang
6102 is set, then return to the message.
6105 .It Ic ~.
6106 Same effect as typing the end-of-file character.
6109 .It Ic ~: Ar \*(UA-command Ns \0or Ic ~_ Ar \*(UA-command
6110 Execute the given \*(UA command.
6111 Not all commands, however, are allowed.
6114 .It Ic ~?
6115 Write a summary of command escapes.
6118 .It Ic ~< Ar filename
6119 Identical to
6120 .Ic ~r .
6123 .It Ic ~<! Ar command
6124 .Ar command
6125 is executed using the shell.
6126 Its standard output is inserted into the message.
6129 .It Ic ~@ Op Ar filename...
6130 Append or edit the list of attachments.
6131 A list of
6132 .Ar filename
6133 arguments is expected (see
6134 .Sx "Shell-style argument quoting" ;
6135 any token-separating commas are ignored), to be
6136 interpreted as documented for the command line option
6137 .Fl a ,
6138 with the message number exception as below.
6139 Without
6140 .Ar filename
6141 arguments the attachment list is edited, entry by entry;
6142 if a filename is left empty, that attachment is deleted from the list;
6143 once the end of the list is reached either new attachments may be
6144 entered or the session can be quit by committing an empty
6145 .Dq new
6146 attachment.
6147 For each mode, if a given file name solely consists of the number sign
6148 .Ql #
6149 followed by a valid message number of the currently active mailbox, then
6150 the given message is attached as a MIME
6151 .Ql message/rfc822
6152 part (note the number sign is the comment character and must be quoted).
6155 .It Ic ~A
6156 Inserts the string contained in the
6157 .Va Sign
6158 variable (same as
6159 .Ql Ic ~i Ns \0Sign ) .
6160 \*(OB (Use the
6161 .Cm wysh
6162 prefix when
6163 .Ic set Ns
6164 ting the variable(s) instead!) The escape sequences tabulator
6165 .Ql \et
6166 and newline
6167 .Ql \en
6168 are understood.
6171 .It Ic ~a
6172 Inserts the string contained in the
6173 .Va sign
6174 variable (same as
6175 .Ql Ic ~i Ns \0sign ) .
6176 \*(OB (Use the
6177 .Cm wysh
6178 prefix when
6179 .Ic set Ns
6180 ting the variable(s) instead!) The escape sequences tabulator
6181 .Ql \et
6182 and newline
6183 .Ql \en
6184 are understood.
6187 .It Ic ~b Ar name ...
6188 Add the given names to the list of blind carbon copy recipients.
6191 .It Ic ~c Ar name ...
6192 Add the given names to the list of carbon copy recipients.
6195 .It Ic ~d
6196 Read the file specified by the
6197 .Ev DEAD
6198 variable into the message.
6201 .It Ic ~e
6202 Invoke the text editor on the message collected so far.
6203 After the editing session is finished,
6204 the user may continue appending text to the message.
6207 .It Ic ~F Ar messages
6208 Read the named messages into the message being sent, including all
6209 message headers and MIME parts.
6210 If no messages are specified, read in the current message.
6213 .It Ic ~f Ar messages
6214 Read the named messages into the message being sent.
6215 If no messages are specified, read in the current message.
6216 Strips down the list of header fields according to the
6217 .Ql type
6218 white- and blacklist selection of
6219 .Ic headerpick .
6220 For MIME multipart messages,
6221 only the first displayable part is included.
6224 .It Ic ~H
6225 Edit the message header fields
6226 .Ql From: ,
6227 .Ql Reply-To:
6229 .Ql Sender:
6230 by typing each one in turn and allowing the user to edit the field.
6231 The default values for these fields originate from the
6232 .Va from , replyto
6234 .Va sender
6235 variables.
6238 .It Ic ~h
6239 Edit the message header fields
6240 .Ql To: ,
6241 .Ql Cc: ,
6242 .Ql Bcc:
6244 .Ql Subject:
6245 by typing each one in turn and allowing the user to edit the field.
6248 .It Ic ~i Ar variable
6249 Insert the value of the specified variable into the message,
6250 adding a newline character at the end.
6251 The message remains unaltered if the variable is unset or empty.
6252 \*(OB (Use the
6253 .Cm wysh
6254 prefix when
6255 .Ic set Ns
6256 ting the variable(s) instead!) The escape sequences tabulator
6257 .Ql \et
6258 and newline
6259 .Ql \en
6260 are understood.
6263 .It Ic ~M Ar messages
6264 Read the named messages into the message being sent,
6265 indented by
6266 .Va indentprefix .
6267 If no messages are specified, read the current message.
6270 .It Ic ~m Ar messages
6271 Read the named messages into the message being sent,
6272 indented by
6273 .Va indentprefix .
6274 If no messages are specified, read the current message.
6275 Strips down the list of header fields according to the
6276 .Ql type
6277 white- and blacklist selection of
6278 .Ic headerpick .
6279 For MIME multipart messages,
6280 only the first displayable part is included.
6283 .It Ic ~p
6284 Display the message collected so far,
6285 prefaced by the message header fields
6286 and followed by the attachment list, if any.
6289 .It Ic ~q
6290 Abort the message being sent,
6291 copying it to the file specified by the
6292 .Ev DEAD
6293 variable if
6294 .Va save
6295 is set.
6298 .It Ic ~R Ar filename
6299 Identical to
6300 .Ic ~r ,
6301 but indent each line that has been read by
6302 .Va indentprefix .
6305 .It Ic ~r Ar filename Op Ar HERE-delimiter
6306 Read the named file into the message.
6307 .Ar filename
6308 can also be a hyphen-minus
6309 .Ql - ,
6310 in which case standard input is used, e.g., for pasting purposes.
6311 Only in this latter mode
6312 .Ar HERE-delimiter
6313 may be given: if it is data will be read in until the given
6314 .Ar HERE-delimiter
6315 is seen on a line by itself, and encountering EOF is an error; the
6316 .Ar HERE-delimiter
6317 is a required argument in non-interactive mode;
6318 note that variables expansion is performed on the delimiter.
6321 .It Ic ~s Ar string
6322 Cause the named string to become the current subject field.
6323 Newline (NL) and carriage-return (CR) bytes are invalid and will be
6324 normalized to space (SP) characters.
6327 .It Ic ~t Ar name ...
6328 Add the given name(s) to the direct recipient list.
6331 .It Ic ~U Ar messages
6332 Read in the given / current message(s) excluding all headers, indented by
6333 .Va indentprefix .
6336 .It Ic ~u Ar messages
6337 Read in the given / current message(s), excluding all headers.
6340 .It Ic ~v
6341 Invoke an alternate editor (defined by the
6342 .Ev VISUAL
6343 environment variable) on the message collected so far.
6344 Usually, the alternate editor will be a screen editor.
6345 After the editor is quit,
6346 the user may resume appending text to the end of the message.
6349 .It Ic ~w Ar filename
6350 Write the message onto the named file.
6351 If the file exists,
6352 the message is appended to it.
6355 .It Ic ~x
6356 Same as
6357 .Ic ~q ,
6358 except that the message is not saved at all.
6361 .It Ic ~| Ar command
6362 Pipe the message through the specified filter command.
6363 If the command gives no output or terminates abnormally,
6364 retain the original text of the message.
6365 E.g., the command
6366 .Xr fmt 1
6367 is often used as a rejustifying filter.
6371 .It Ic ~^ Ar cmd Op Ar subcmd Op Ar arg3 Op Ar arg4
6372 Low-level command ment for scripted message access, i.e., for
6373 .Va on-compose-done-shell
6375 .Va on-compose-done .
6376 The used protocol is likely subject to changes, and therefore the
6377 mentioned hooks receive the used protocol version as an initial line.
6378 In general the first field of a response line represents a status code
6379 which specifies whether a command was successful or not, whether result
6380 data is to be expected, and if, the format of the result data.
6381 The status codes are:
6384 .Bl -tag -compact -width _210_
6385 .It Ql 210
6386 Status ok; the remains of the line are the result.
6387 .It Ql 211
6388 Status ok; the rest of the line is optionally used for more status.
6389 What follows are lines of result addresses, terminated by an empty line.
6390 The address lines consist of two fields, the first of which is the
6391 plain address, e.g.,
6392 .Ql bob@exam.ple ,
6393 separated by a single ASCII SP space from the second which contains the
6394 unstripped address, even if that is identical to the first field, e.g.,
6395 .Ql (Lovely) Bob <bob@exam.ple> .
6396 .It Ql 212
6397 Status ok; the rest of the line is optionally used for more status.
6398 What follows are lines of furtherly unspecified string content,
6399 terminated by an empty line.
6400 (All the input, including the empty line, must be consumed before
6401 further commands can be issued.)
6402 .It Ql 500
6403 Syntax error; invalid command.
6404 .It Ql 501
6405 Syntax error in parameters or arguments.
6406 .It Ql 505
6407 Error: an argument fails verification.
6408 For example an invalid address has been specified.
6409 .It Ql 506
6410 Error: an otherwise valid argument is rendered invalid due to context.
6411 For example, a second address is added to a header which may consist of
6412 a single address only.
6416 If a command indicates failure then the message will have remained
6417 unmodified.
6418 Most commands can fail with
6419 .Ql 500
6420 if required arguments are missing (false command usage).
6421 The following commands are supported, and, as usual, case-insensitive:
6424 .Bl -hang -width header
6425 .It Ar header
6426 This command allows listing, inspection, and editing of message headers.
6427 The second argument specifies the subcommand to apply, one of:
6430 .Bl -hang -compact -width remove
6431 .It Ar list
6432 Without a third argument a list of all yet existing headers is given via
6433 .Ql 210 ;
6434 this command is the default command of
6435 .Ar header
6436 if no second argument has been given.
6437 A third argument restricts output to the given header only, which may
6438 fail with
6439 .Ql 501
6440 if no such field is defined.
6442 .It Ar show
6443 Shows the content of the header given as the third argument.
6444 Dependent on the header type this may respond with
6445 .Ql 211
6447 .Ql 212 ;
6448 any failure results in
6449 .Ql 501 .
6451 .It Ar remove
6452 This will remove all instances of the header given as the third
6453 argument, reporting
6454 .Ql 210
6455 upon success or
6456 .Ql 501
6457 if no such header can be found.
6459 .It Ar insert
6460 Create a new or an additional instance of the header given in the third
6461 argument, with the header body content as given in the fourth argument
6462 (the remains of the line).
6463 It may return
6464 .Ql 501
6465 if the third argument specifies a free-form header field name that is
6466 invalid, or if body content extraction fails to succeed,
6467 .Ql 505
6468 if any extracted address does not pass syntax and/or security checks, and
6469 .Ql 506
6470 to indicate prevention of excessing a single-instance header \(em note that
6471 .Ql Subject:
6472 can be appended to (a space separator will be added automatically first).
6473 .Ql 210
6474 is returned upon success.
6478 .It Ar attachment
6479 This command allows listing, removal and addition of message attachments.
6480 The second argument specifies the subcommand to apply, one of:
6483 .Bl -hang -compact -width remove
6484 .It Ar list
6485 List all attachments via
6486 .Ql 212 ,
6487 or report
6488 .Ql 501
6489 if no attachments exist.
6490 This command is the default command of
6491 .Ar attachment
6492 if no second argument has been given.
6494 .It Ar remove
6495 This will remove the attachment given as the third argument, and report
6496 .Ql 210
6497 upon success or
6498 .Ql 501
6499 if no such attachment can be found.
6500 If there exists any path component in the given argument, then an exact
6501 match of the path which has been used to create the attachment is used
6502 directly, but if only the basename of that path matches then all
6503 attachments are traversed to find an exact match first, and the removal
6504 occurs afterwards; if multiple basenames match, a
6505 .Ql 506
6506 error occurs.
6507 Message attachments are treated as absolute pathnames.
6509 If no path component exists in the given argument, then all attachments
6510 will be searched for
6511 .Ql filename=
6512 parameter matches as well as for matches of the basename of the path
6513 which has been used when the attachment has been created; multiple
6514 matches result in a
6515 .Ql 506 .
6517 .It Ar remove-at
6518 This will interpret the third argument as a number and remove the
6519 attachment at that list position (counting from one!), reporting
6520 .Ql 210
6521 upon success or
6522 .Ql 505
6523 if the argument is not a number or
6524 .Ql 501
6525 if no such attachment exists.
6527 .It Ar insert
6528 Adds the attachment given as the third argument, specified exactly as
6529 documented for the command line option
6530 .Fl a ,
6531 and supporting the message number extension as documented for
6532 .Ic ~@ .
6533 This reports
6534 .Ql 210
6535 upon success, with the index of the new attachment following,
6536 .Ql 505
6537 if the given file cannot be opened,
6538 .Ql 506
6539 if an on-the-fly performed character set conversion fails, otherwise
6540 .Ql 501
6541 is reported; this is also reported if character set conversion is
6542 requested but not available.
6544 .It Ar attribute
6545 This uses the same search mechanism as described for
6546 .Ar remove
6547 and prints any known attributes of the first found attachment via
6548 .Ql 212
6549 upon success or
6550 .Ql 501
6551 if no such attachment can be found.
6552 The attributes are written as lines of keyword and value tuples, the
6553 keyword being separated from the rest of the line with an ASCII SP space
6554 character.
6556 .It Ar attribute-at
6557 This uses the same search mechanism as described for
6558 .Ar remove-at
6559 and is otherwise identical to
6560 .Ar attribute .
6562 .It Ar attribute-set
6563 This uses the same search mechanism as described for
6564 .Ar remove ,
6565 and will assign the attribute given as the fourth argument, which is
6566 expected to be a value tuple of keyword and other data, separated by
6567 a ASCII SP space or TAB tabulator character.
6568 If the value part is empty, then the given attribute is removed, or
6569 reset to a default value if existence of the attribute is crucial.
6570 It returns via
6571 .Ql 210
6572 upon success, with the index of the found attachment following,
6573 .Ql 505
6574 for message attachments or if the given keyword is invalid, and
6575 .Ql 501
6576 if no such attachment can be found.
6577 The following keywords may be used (case-insensitively):
6579 .Bl -hang -compact -width ".Ql filename"
6580 .It Ql filename
6581 Sets the filename of the MIME part, i.e., the name that is used for
6582 display and when (suggesting a name for) saving (purposes).
6583 .It Ql content-description
6584 Associate some descriptive information to the attachment's content, used
6585 in favour of the plain filename by some MUAs.
6586 .It Ql content-id
6587 May be used for uniquely identifying MIME entities in several contexts;
6588 this expects a special reference address format as defined in RFC 2045
6589 and generates a
6590 .Ql 505
6591 upon address content verification failure.
6592 .It Ql content-type
6593 Specifies the media type and subtype of the part; managed automatically.
6594 .It Ql content-disposition
6595 Automatically set to the string
6596 .Ql attachment .
6599 .It Ar attribute-set-at
6600 This uses the same search mechanism as described for
6601 .Ar remove-at
6602 and is otherwise identical to
6603 .Ar attribute-set .
6609 .\" }}}
6612 .\" .Sh INTERNAL VARIABLES {{{
6613 .Sh "INTERNAL VARIABLES"
6615 Internal \*(UA variables are controlled via the
6616 .Ic set
6618 .Ic unset
6619 commands; prefixing a variable name with the string
6620 .Ql no
6621 and calling
6622 .Ic set
6623 has the same effect as using
6624 .Ic unset :
6625 .Ql unset crt
6627 .Ql set nocrt
6628 do the same thing.
6629 Creation or editing of variables can be performed in the
6630 .Ev EDITOR
6631 with the command
6632 .Ic varedit .
6633 .Ic varshow
6634 will give more insight on the given variable(s), and
6635 .Ic set ,
6636 when called without arguments, will show a listing of all variables.
6637 Both commands support a more
6638 .Va verbose
6639 listing mode.
6640 Some well-known variables will also become inherited from the
6641 program
6642 .Sx ENVIRONMENT
6643 implicitly, others can be explicitly imported with the command
6644 .Ic environ
6645 and henceforth share said properties.
6648 Two different kind of internal variables exist.
6649 There are boolean variables, which can only be in one of the two states
6650 .Dq set
6652 .Dq unset ,
6653 and value variables with a(n optional) string value.
6654 For the latter proper quoting is necessary upon assignment time, the
6655 introduction of the section
6656 .Sx COMMANDS
6657 documents the supported quoting rules.
6659 .Bd -literal -offset indent
6660 wysh set one=val\e 1 two="val 2" \e
6661     three='val "3"' four=$'val \e'4\e''; \e
6662 varshow one two three four; \e
6663 unset one two three four
6667 Dependent upon the actual option the string values will be interpreted
6668 as numbers, colour names, normal text etc., but there also exists
6669 a special kind of string value, the
6670 .Dq boolean string ,
6671 which must either be a decimal integer (in which case
6672 .Ql 0
6673 is false and
6674 .Ql 1
6675 and any other value is true) or any of the (case-insensitive) strings
6676 .Ql off ,
6677 .Ql no ,
6678 .Ql n
6680 .Ql false
6681 for a false boolean and
6682 .Ql on ,
6683 .Ql yes ,
6684 .Ql y
6686 .Ql true
6687 for a true boolean; a special kind of boolean string is the
6688 .Dq quadoption ,
6689 which is a boolean string that can optionally be prefixed with the
6690 (case-insensitive) term
6691 .Ql ask- ,
6692 as in
6693 .Ql ask-yes ,
6694 which causes prompting of the user in interactive mode, with the given
6695 boolean as the default value.
6697 .\" .Ss "Initial settings" {{{
6698 .\" (Keep in SYNC: ./nail.h:okeys, ./nail.rc, ./nail.1:"Initial settings")
6699 .Ss "Initial Settings"
6701 The standard POSIX 2008/Cor 2-2016 mandates the following initial
6702 variable settings:
6703 .Pf no Va allnet ,
6704 .Pf no Va append ,
6705 .Va asksub ,
6706 .Pf no Va askbcc ,
6707 .Pf no Va autoprint ,
6708 .Pf no Va bang ,
6709 .Pf no Va cmd ,
6710 .Pf no Va crt ,
6711 .Pf no Va debug ,
6712 .Pf no Va dot ,
6713 .Va escape
6714 set to
6715 .Ql ~ ,
6716 .Pf no Va flipr ,
6717 .Pf no Va folder ,
6718 .Va header ,
6719 .Pf no Va hold ,
6720 .Pf no Va ignore ,
6721 .Pf no Va ignoreeof ,
6722 .Pf no Va keep ,
6723 .Pf no Va keepsave ,
6724 .Pf no Va metoo ,
6725 .Pf no Va outfolder ,
6726 .Pf no Va page ,
6727 .Va prompt
6728 set to
6729 .Ql ?\0 ,
6730 .Pf no Va quiet ,
6731 .Pf no Va record ,
6732 .Va save ,
6733 .Pf no Va sendwait ,
6734 .Pf no Va showto ,
6735 .Pf no Va Sign ,
6736 .Pf no Va sign ,
6737 .Va toplines
6738 set to
6739 .Ql 5 .
6742 Notes: \*(UA does not support the
6743 .Pf no Va onehop
6744 variable \(en use command line options or
6745 .Va mta-arguments
6746 to pass options through to a
6747 .Va mta .
6748 And the default global
6749 .Pa \*(UR
6750 file, which is loaded unless the
6751 .Fl \&:
6752 (with according argument) or
6753 .Fl n
6754 command line options have been used, or the
6755 .Ev MAILX_NO_SYSTEM_RC
6756 environment variable is set, see
6757 .Sx "Resource files" )
6758 bends those initial settings a bit, e.g., it sets the variables
6759 .Va hold ,
6760 .Va keepsave
6762 .Va keep ,
6763 to name a few, establishes a default
6764 .Ic headerpick
6765 selection etc., and should thus be taken into account.
6766 .\" }}}
6768 .\" .Ss "Variables" {{{
6769 .Ss "Variables"
6771 .Bl -tag -width ".It Va BaNg"
6774 .It Va \&?
6775 \*(RO The (hard) exit status of the last command.
6776 This exit status has a meaning for the state machine, in parts
6777 prescribed by the POSIX standard, and, e.g., for
6778 .Cm ignerr
6780 .Va batch-exit-on-error .
6781 This is why \*(UA also knows about a
6782 .Dq soft
6783 exit status, which is tracked in
6784 .Va \&! .
6787 .It Va \&!
6788 \*(RO The so-called
6789 .Dq soft
6790 exit status of the last command, which, different to
6791 .Va \&? ,
6792 has no meaning for the state machine, and can therefore easily transport
6793 different error-indicating values.
6794 It is directly addressable with the command
6795 .Ic return
6796 from within a
6797 .Ic define Ns
6798 d and
6799 .Ic call Ns
6800 ed macro, or an
6801 .Ic account .
6804 .It Va *
6805 \*(RO Only available inside the scope of a
6806 .Ic call Ns
6807 ed macro, this will expand to all parameters of the macro, separated by
6808 a space character.
6809 \*(ID The special semantics of the equally named special parameter of the
6810 .Xr sh 1
6811 are not yet supported.
6814 .It Va @
6815 \*(RO Only available inside the scope of a
6816 .Ic call Ns
6817 ed macro, this will expand to all parameters of the macro, separated by
6818 a space character.
6819 \*(ID The special semantics of the equally named special parameter of the
6820 .Xr sh 1
6821 are not yet supported.
6824 .It Va #
6825 \*(RO Only available inside the scope of a
6826 .Ic call Ns
6827 ed macro, this will expand to the number of positional parameters in
6828 decimal.
6831 .It Va \&0
6832 \*(RO Available inside the scope of a
6833 .Ic define Ns
6834 d and
6835 .Ic call Ns
6836 ed macro, this expands to the name of the calling macro, or to the empty
6837 string if the macro is running from top-level.
6838 For the \*(OPal regular expression search and replace operator of
6839 .Ic vexpr
6840 this expands to the entire matching expression.
6843 .It Va 1
6844 \*(RO Available inside the scope of a
6845 .Ic define Ns
6846 d and
6847 .Ic call Ns
6848 ed macro, this will access the first positional parameter passed.
6849 All further parameters can be accessed with this syntax, too, e.g.,
6850 .Ql 2 ,
6851 .Ql 3
6852 etc.; positional parameters can be shifted off the stack by calling
6853 .Ic shift .
6854 Positional parameters are also accessible in the \*(OPal regular
6855 expression search and replace expression of
6856 .Ic vexpr .
6859 .It Va -account
6860 \*(RO Is set to the active
6861 .Ic account .
6864 .It Va -alternates
6865 \*(RO Is set to the list of
6866 .Ic alternates .
6869 .It Va -folder-resolved
6870 \*(RO Set to the fully resolved path of
6871 .Va folder
6872 once that evaluation has occurred; rather internal.
6875 .It Va -mailbox-display
6876 \*(RO The name of the current mailbox
6877 .Pf ( Ic file ) ,
6878 possibly abbreviated for display purposes.
6881 .It Va -mailbox-resolved
6882 \*(RO The fully resolved path of the current mailbox.
6885 .It Va add-file-recipients
6886 \*(BO When file or pipe recipients have been specified,
6887 mention them in the corresponding address fields of the message instead
6888 of silently stripping them from their recipient list.
6889 By default such addressees are not mentioned.
6892 .It Va allnet
6893 \*(BO Causes only the local part to be evaluated
6894 when comparing addresses.
6897 .It Va append
6898 \*(BO Causes messages saved in
6899 .Ev MBOX
6900 to be appended to the end rather than prepended.
6901 This should always be set.
6904 .It Va ask
6905 \*(BO Causes \*(UA to prompt for the subject of each message sent.
6906 If the user responds with simply a newline,
6907 no subject field will be sent.
6910 .It Va askatend
6911 \*(BO Causes the prompts for
6912 .Ql Cc:
6914 .Ql Bcc:
6915 lists to appear after the message has been edited.
6918 .It Va askattach
6919 \*(BO If set, \*(UA asks for files to attach at the end of each message,
6920 shall the list be found empty at that time.
6921 An empty line finalizes the list.
6924 .It Va askcc
6925 \*(BO Causes the user to be prompted for carbon copy recipients
6926 (at the end of each message if
6927 .Va askatend
6929 .Va bsdcompat
6930 are set) shall the list be found empty (at that time).
6931 An empty line finalizes the list.
6934 .It Va askbcc
6935 \*(BO Causes the user to be prompted for blind carbon copy
6936 recipients (at the end of each message if
6937 .Va askatend
6939 .Va bsdcompat
6940 are set) shall the list be found empty (at that time).
6941 An empty line finalizes the list.
6944 .It Va asksign
6945 \*(BO\*(OP Causes the user to be prompted if the message is to be
6946 signed at the end of each message.
6948 .Va smime-sign
6949 variable is ignored when this variable is set.
6952 .It Va asksub
6953 \*(BO Alternative name for
6954 .Va ask .
6957 .It Va attrlist
6958 A sequence of characters to display in the
6959 .Ql attribute
6960 column of the
6961 .Va headline
6962 as shown in the display of
6963 .Ic headers ;
6964 each for one type of messages (see
6965 .Sx "Message states" ) ,
6966 with the default being
6967 .Ql NUROSPMFAT+\-$~
6969 .Ql NU\ \ *HMFAT+\-$~
6970 if the
6971 .Va bsdflags
6972 variable is set, in the following order:
6974 .Bl -tag -compact -width ".It Ql _"
6975 .It Ql N
6976 new.
6977 .It Ql U
6978 unread but old.
6979 .It Ql R
6980 new but read.
6981 .It Ql O
6982 read and old.
6983 .It Ql S
6984 saved.
6985 .It Ql P
6986 preserved.
6987 .It Ql M
6988 mboxed.
6989 .It Ql F
6990 flagged.
6991 .It Ql A
6992 answered.
6993 .It Ql T
6994 draft.
6995 .It Ql +
6996 start of a collapsed thread.
6997 .It Ql -
6998 an uncollapsed thread (TODO ignored for now).
6999 .It Ql $
7000 classified as spam.
7001 .It Ql ~
7002 classified as possible spam.
7007 .It Va autobcc
7008 Specifies a list of recipients to which a blind carbon copy of each
7009 outgoing message will be sent automatically.
7012 .It Va autocc
7013 Specifies a list of recipients to which a carbon copy of each outgoing
7014 message will be sent automatically.
7017 .It Va autocollapse
7018 \*(BO Causes threads to be collapsed automatically when threaded mode
7019 is entered (see the
7020 .Ic collapse
7021 command).
7024 .It Va autoprint
7025 \*(BO Enable automatic
7026 .Ic type Ns
7027 ing of a(n existing)
7028 .Dq successive
7029 message after
7030 .Ic delete
7032 .Ic undelete
7033 commands, e.g., the message that becomes the new
7034 .Dq dot
7035 is shown automatically, as via
7036 .Ic dp
7038 .Ic dt .
7041 .It Va autothread
7042 \*(BO\*(OB Causes threaded mode (see the
7043 .Ic thread
7044 command) to be entered automatically when a folder is opened.
7045 The same as
7046 .Ql autosort=thread .
7049 .It Va autosort
7050 Causes sorted mode (see the
7051 .Ic sort
7052 command) to be entered automatically with the value of this variable as
7053 sorting method when a folder is opened, e.g.,
7054 .Ql set autosort=thread .
7057 .It Va bang
7058 \*(BO Enables the substitution of all not (reverse-solidus) escaped
7059 exclamation mark
7060 .Ql \&!
7061 characters by the contents of the last executed command for the
7062 .Ic \&!
7063 shell escape command and
7064 .Ic ~! ,
7065 one of the compose mode
7066 .Sx "COMMAND ESCAPES" .
7067 If this variable is not set no reverse solidus stripping is performed.
7070 .It Va batch-exit-on-error
7071 If the batch mode has been enabled via the
7072 .Fl #
7073 command line option, then this variable will be consulted whenever \*(UA
7074 completes one operation.
7075 It is ment as a convenient alternative to manually testing
7076 .Va \&? .
7077 If any value is set, a number is expected; if it is
7078 .Ql 1
7079 then each failed operation will cause \*(UA to exit.
7081 \*(ID If it is set without a value, then only top-level operations that
7082 happen directly
7083 .Dq on the command-prompt ,
7084 i.e., neither in running macros nor from within source files etc., are
7085 considered, unless a main operation that directly affects the return
7086 value, like, e.g., a failed
7087 .Ic mail
7088 command, is affected; this mode of operation is likely to change in v15,
7089 and tests should be performed to see whether the desired effect is seen.
7092 .It Va bind-timeout
7093 \*(OP Terminals generate multi-byte sequences for certain forms of
7094 input, for example for function and other special keys.
7095 Some terminals however do not write these multi-byte sequences as
7096 a whole, but byte-by-byte, and the latter is what \*(UA actually reads.
7097 This variable specifies the timeout in milliseconds that the MLE (see
7098 .Sx "On terminal control and line editor" )
7099 waits for more bytes to arrive unless it considers a sequence
7100 .Dq complete .
7101 The default is 200.
7104 .It Va bsdannounce
7105 \*(BO Causes automatic display of a header summary after executing a
7106 .Ic file
7107 command, and thus complements the standard variable
7108 .Va header ,
7109 which controls header summary display on program startup.
7110 It is only meaningful if
7111 .Va header
7112 is also set.
7115 .It Va bsdcompat
7116 \*(BO Sets some cosmetical features to traditional BSD style;
7117 has the same affect as setting
7118 .Va askatend
7119 and all other variables prefixed with
7120 .Ql bsd ;
7121 it also changes the behaviour of
7122 .Va emptystart
7123 (which does not exist in BSD).
7126 .It Va bsdflags
7127 \*(BO Changes the letters shown in the first column of a header
7128 summary to traditional BSD style.
7131 .It Va bsdheadline
7132 \*(BO Changes the display of columns in a header summary to traditional
7133 BSD style.
7136 .It Va bsdmsgs
7137 \*(BO Changes some informational messages to traditional BSD style.
7140 .It Va bsdorder
7141 \*(BO Causes the
7142 .Ql Subject:
7143 field to appear immediately after the
7144 .Ql To:
7145 field in message headers and with the
7146 .Ic ~h
7147 .Sx "COMMAND ESCAPES" .
7150 .It Va charset-7bit
7151 The value that should appear in the
7152 .Ql charset=
7153 parameter of
7154 .Ql Content-Type:
7155 MIME header fields when no character set conversion of the message data
7156 was performed.
7157 This defaults to US-ASCII, and the chosen character set should be
7158 US-ASCII compatible.
7161 .It Va charset-8bit
7162 \*(OP The default 8-bit character set that is used as an implicit last
7163 member of the variable
7164 .Va sendcharsets .
7165 This defaults to UTF-8 if character set conversion capabilities are
7166 available, and to ISO-8859-1 otherwise, in which case the only supported
7167 character set is
7168 .Va ttycharset
7169 and this variable is effectively ignored.
7170 Refer to the section
7171 .Sx "Character sets"
7172 for the complete picture of character set conversion in \*(UA.
7175 .It Va charset-unknown-8bit
7176 \*(OP RFC 1428 specifies conditions when internet mail gateways shall
7177 .Dq upgrade
7178 the content of a mail message by using a character set with the name
7179 .Ql unknown-8bit .
7180 Because of the unclassified nature of this character set \*(UA will not
7181 be capable to convert this character set to any other character set.
7182 If this variable is set any message part which uses the character set
7183 .Ql unknown-8bit
7184 is assumed to really be in the character set given in the value,
7185 otherwise the (final) value of
7186 .Va charset-8bit
7187 is used for this purpose.
7189 This variable will also be taken into account if a MIME type (see
7190 .Sx "The mime.types files" )
7191 of a MIME message part that uses the
7192 .Ql binary
7193 character set is forcefully treated as text.
7196 .It Va cmd
7197 The default value for the
7198 .Ic pipe
7199 command.
7202 .It Va colour-disable
7203 \*(BO\*(OP Forcefully disable usage of colours.
7204 Also see the section
7205 .Sx "Coloured display" .
7208 .It Va colour-pager
7209 \*(BO\*(OP Whether colour shall be used for output that is paged through
7210 .Ev PAGER .
7211 Note that pagers may need special command line options, e.g.,
7212 .Xr less 1
7213 requires the option
7214 .Fl \&\&R
7216 .Xr lv 1
7217 the option
7218 .Fl \&\&c
7219 in order to support colours.
7220 Often doing manual adjustments is unnecessary since \*(UA may perform
7221 adjustments dependent on the value of the environment variable
7222 .Ev PAGER
7223 (see there for more).
7226 .It Va crt
7227 In a(n interactive) terminal session, then if this valued variable is
7228 set it will be used as a threshold to determine how many lines the given
7229 output has to span before it will be displayed via the configured
7230 .Ev PAGER ;
7231 Usage of the
7232 .Ev PAGER
7233 can be forced by setting this to the value
7234 .Ql 0 ,
7235 setting it without a value will deduce the current height of the
7236 terminal screen to compute the treshold (see
7237 .Ev LINES ,
7238 .Va screen
7240 .Xr stty 1 ) .
7241 \*(ID At the moment this uses the count of lines of the message in wire
7242 format, which, dependent on the
7243 .Va encoding
7244 of the message, is unrelated to the number of display lines.
7245 (The software is old and historically the relation was a given thing.)
7248 .It Va customhdr
7249 Define a set of custom headers to be injected into newly composed or
7250 forwarded messages; it is also possible to create custom headers in
7251 compose mode with
7252 .Ic ~^ ,
7253 which can be automated by setting one of the hooks
7254 .Va on-compose-done-shell
7256 .Va on-compose-done .
7257 The value is interpreted as a comma-separated list of custom headers to
7258 be injected, to include commas in the header bodies escape them with
7259 reverse solidus.
7260 \*(ID Overwriting of automatically managed headers is neither supported
7261 nor prevented.
7263 .Dl set customhdr='Hdr1: Body1-1\e, Body1-2,  Hdr2: Body2'
7266 .It Va datefield
7267 Controls the appearance of the
7268 .Ql %d
7269 date and time format specification of the
7270 .Va headline
7271 variable, that is used, for example, when viewing the summary of
7272 .Ic headers .
7273 If unset, then the local receiving date is used and displayed
7274 unformatted, otherwise the message sending
7275 .Ql Date: .
7276 It is possible to assign a
7277 .Xr strftime 3
7278 format string and control formatting, but embedding newlines via the
7279 .Ql %n
7280 format is not supported, and will result in display errors.
7281 The default is
7282 .Ql %Y-%m-%d %H:%M ,
7283 and also see
7284 .Va datefield-markout-older .
7287 .It Va datefield-markout-older
7288 Only used in conjunction with
7289 .Va datefield .
7290 Can be used to create a visible distinction of messages dated more than
7291 a day in the future, or older than six months, a concept comparable to the
7292 .Fl \&\&l
7293 option of the POSIX utility
7294 .Xr ls 1 .
7295 If set to the empty string, then the plain month, day and year of the
7296 .Ql Date:
7297 will be displayed, but a
7298 .Xr strftime 3
7299 format string to control formatting can be assigned.
7300 The default is
7301 .Ql %Y-%m-%d .
7304 .It Va debug
7305 \*(BO Enables debug messages and obsoletion warnings, disables the
7306 actual delivery of messages and also implies
7307 .Pf no Va record
7308 as well as
7309 .Pf no Va save .
7312 .It Va disposition-notification-send
7313 \*(BO\*(OP Emit a
7314 .Ql Disposition-Notification-To:
7315 header (RFC 3798) with the message.
7316 This requires the
7317 .Va from
7318 variable to be set.
7319 .\" TODO .It Va disposition-notification-send-HOST
7320 .\"Overrides
7321 .\".Va disposition-notification-send
7322 .\" for SMTP accounts on a specific host.
7323 .\" TODO .It Va disposition-notification-send-USER@HOST
7324 .\"Overrides
7325 .\".Va disposition-notification-send
7326 .\"for a specific account.
7329 .It Va dot
7330 \*(BO When dot is set, a period
7331 .Ql \&.
7332 on a line by itself during message input in (interactive) compose mode
7333 will be treated as end-of-message (in addition to the normal end-of-file
7334 condition).
7336 .Va ignoreeof
7337 is set
7338 .Pf no Va dot
7339 is ignored.
7342 .It Va dotlock-ignore-error
7343 \*(BO\*(OP Synchronization of mailboxes which \*(UA treats as
7344 .Mx -sx
7345 .Sx "primary system mailbox" Ns
7346 es (see, e.g., the notes on
7347 .Sx "Filename transformations" ,
7348 as well as the documentation of
7349 .Ic file )
7350 will be protected with so-called dotlock files\(emthe traditional mail
7351 spool file locking method\(emin addition to system file locking.
7352 Because \*(UA ships with a privilege-separated dotlock creation program
7353 that should always be able to create such a dotlock file there is no
7354 good reason to ignore dotlock file creation errors, and thus these are
7355 fatal unless this variable is set.
7358 .It Va editalong
7359 \*(BO If this variable is set then the editor is started automatically
7360 when a message is composed in interactive mode, as if the
7361 .Ic ~e
7362 .Sx "COMMAND ESCAPES"
7363 had been specified.
7365 .Va editheaders
7366 variable is implied for this automatically spawned editor session.
7369 .It Va editheaders
7370 \*(BO When a message is edited while being composed,
7371 its header is included in the editable text.
7373 .Ql To: ,
7374 .Ql Cc: ,
7375 .Ql Bcc: ,
7376 .Ql Subject: ,
7377 .Ql From: ,
7378 .Ql Reply-To:
7380 .Ql Sender:
7381 fields are accepted within the header, other fields are ignored.
7384 .It Va emptystart
7385 \*(BO When entering interactive mode \*(UA normally writes
7386 .Dq \&No mail for user
7387 and exits immediately if a mailbox is empty or does not exist.
7388 If this variable is set \*(UA starts even with an empty or nonexistent
7389 mailbox (the latter behaviour furtherly depends upon
7390 .Va bsdcompat ,
7391 though).
7394 .It Va encoding
7395 The MIME
7396 .Ql Content-Transfer-Encoding
7397 to use in outgoing text messages and message parts, where applicable.
7398 (7-bit clean text messages are sent as-is, without a transfer encoding.)
7399 Valid values are:
7401 .Bl -tag -compact -width "_%%_"
7402 .It Ql 8bit
7403 .Pf (Or\0 Ql 8b . )
7404 8-bit transport effectively causes the raw data be passed through
7405 unchanged, but may cause problems when transferring mail messages over
7406 channels that are not ESMTP (RFC 1869) compliant.
7407 Also, several input data constructs are not allowed by the
7408 specifications and may cause a different transfer-encoding to be used.
7409 .It Ql quoted-printable
7410 .Pf (Or\0 Ql qp . )
7411 Quoted-printable encoding is 7-bit clean and has the property that ASCII
7412 characters are passed through unchanged, so that an english message can
7413 be read as-is; it is also acceptible for other single-byte locales that
7414 share many characters with ASCII, like, e.g., ISO-8859-1.
7415 The encoding will cause a large overhead for messages in other character
7416 sets: e.g., it will require up to twelve (12) bytes to encode a single
7417 UTF-8 character of four (4) bytes.
7418 .It Ql base64
7419 .Pf (Or\0 Ql b64 . )
7420 The default encoding, it is 7-bit clean and will always be used for
7421 binary data.
7422 This encoding has a constant input:output ratio of 3:4, regardless of
7423 the character set of the input data it will encode three bytes of input
7424 to four bytes of output.
7425 This transfer-encoding is not human readable without performing
7426 a decoding step.
7430 .It Va escape
7431 If defined, the first character of the value of this variable
7432 gives the character to use in place of tilde
7433 .Ql ~
7434 to denote
7435 .Sx "COMMAND ESCAPES" .
7436 If set to the empty string, command escapes are disabled.
7439 .It Va expandaddr
7440 If not set then file and command pipeline targets are not allowed,
7441 and any such address will be filtered out, giving a warning message.
7442 If set without a value then all possible recipient address
7443 specifications will be accepted \(en see the section
7444 .Sx "On sending mail, and non-interactive mode"
7445 for more on this.
7446 To accept them, but only in interactive mode, or when tilde commands
7447 were enabled explicitly by using one of the command line options
7448 .Fl ~
7450 .Fl # ,
7451 set this to the (case-insensitive) value
7452 .Ql restrict
7453 (it actually acts like
7454 .Ql restrict,-all,+name,+addr ,
7455 so that care for ordering issues must be taken) .
7457 In fact the value is interpreted as a comma-separated list of values.
7458 If it contains
7459 .Ql fail
7460 then the existence of disallowed specifications is treated as a hard
7461 send error instead of only filtering them out.
7462 The remaining values specify whether a specific type of recipient
7463 address specification is allowed (optionally indicated by a plus sign
7464 .Ql +
7465 prefix) or disallowed (prefixed with a hyphen-minus
7466 .Ql - ) .
7467 The value
7468 .Ql all
7469 addresses all possible address specifications,
7470 .Ql file
7471 file targets,
7472 .Ql pipe
7473 command pipeline targets,
7474 .Ql name
7475 plain user names and (MTA) aliases (\*(OB
7476 .Ql noalias
7477 may be used as an alternative syntax to
7478 .Ql -name )
7480 .Ql addr
7481 network addresses.
7482 These kind of values are interpreted in the given order, so that
7483 .Ql restrict,\:fail,\:+file,\:-all,\:+addr
7484 will cause hard errors for any non-network address recipient address
7485 unless \*(UA is in interactive mode or has been started with the
7486 .Fl ~
7488 .Fl #
7489 command line option; in the latter case(s) any address may be used, then.
7491 Historically invalid network addressees are silently stripped off.
7492 To change this and ensure that any encountered invalid email address
7493 instead causes a hard error, ensure the string
7494 .Ql failinvaddr
7495 is an entry in the above list.
7496 Setting this automatically enables network addressees
7497 (it actually acts like
7498 .Ql failinvaddr,+addr ,
7499 so that care for ordering issues must be taken) .
7502 .It Va expandargv
7503 Unless this variable is set additional
7504 .Va mta
7505 (Mail-Transfer-Agent)
7506 arguments from the command line, as can be given after a
7507 .Fl \&\&-
7508 separator, are ignored due to safety reasons.
7509 However, if set to the special (case-insensitive) value
7510 .Ql fail ,
7511 then the presence of additional MTA arguments is treated as a hard
7512 error that causes \*(UA to exit with failure status.
7513 A lesser strict variant is the otherwise identical
7514 .Ql restrict ,
7515 which does accept such arguments in interactive mode, or if tilde
7516 commands were enabled explicitly by using one of the command line options
7517 .Fl ~
7519 .Fl # .
7522 .It Va features
7523 \*(RO String giving a list of features \*(UA, preceded with a plus sign
7524 .Ql +
7525 if the feature is available, and a hyphen-minus
7526 .Ql -
7527 otherwise.
7528 The output of the command
7529 .Ic version
7530 will include this information.
7533 .It Va flipr
7534 \*(BO This setting reverses the meanings of a set of reply commands,
7535 turning the lowercase variants, which by default address all recipients
7536 included in the header of a message
7537 .Pf ( Ic reply , respond , followup )
7538 into the uppercase variants, which by default address the sender only
7539 .Pf ( Ic Reply , Respond , Followup )
7540 and vice versa.
7541 The commands
7542 .Ic replysender , respondsender , followupsender
7543 as well as
7544 .Ic replyall , respondall , followupall
7545 are not affected by the current setting of
7546 .Va flipr .
7550 .It Va file-hook-load-EXTENSION , file-hook-save-EXTENSION
7551 It is possible to install file hooks which will be used by the
7552 .Ic file
7553 command in order to be able to transparently handle (through an
7554 intermediate temporary file) files with specific
7555 .Ql EXTENSION Ns
7556 s: the variable values can include shell snippets and are expected to
7557 write data to standard output / read data from standard input,
7558 respectively.
7559 \*(ID The variables may not be changed while there is a mailbox
7560 attendant.
7561 .Bd -literal -offset indent
7562 set file-hook-load-xy='echo >&2 XY-LOAD; gzip -cd' \e
7563     file-hook-save-xy='echo >&2 XY-SAVE; gzip -c' \e
7564     record=+null-sent.xy
7568 .It Va folder
7569 The default path under which mailboxes are to be saved:
7570 file names that begin with the plus sign
7571 .Ql +
7572 will have the plus sign replaced with the value of this variable if set,
7573 otherwise the plus sign will remain unchanged when doing
7574 .Sx "Filename transformations" ;
7575 also see
7576 .Ic file
7577 for more on this topic.
7578 The value supports a subset of transformations itself, and if the
7579 non-empty value does not start with a solidus
7580 .Ql / ,
7581 then the value of
7582 .Ev HOME
7583 will be prefixed automatically.
7586 .It Va folder-hook
7587 This variable can be set to the name of a
7588 .Ic define Ns d
7589 macro which will be called whenever a
7590 .Ic file
7591 is opened.
7592 The macro will also be invoked when new mail arrives,
7593 but message lists for commands executed from the macro
7594 only include newly arrived messages then.
7595 .Ic localopts
7596 are activated by default in a folder hook, causing the covered settings
7597 to be reverted once the folder is left again.
7599 .Sy \*(ID:
7600 Macro behaviour, including option localization, will change in v15.
7601 One should be aware of that and possibly embed version checks in the
7602 used resource file(s).
7605 .It Va folder-hook-FOLDER
7606 Overrides
7607 .Va folder-hook
7608 for a folder named
7609 .Ql FOLDER .
7610 Unlike other folder specifications, the fully expanded name of a folder,
7611 without metacharacters, is used to avoid ambiguities.
7612 However, if the mailbox resides under
7613 .Va folder
7614 then the usual
7615 .Ql +
7616 specification is tried in addition, e.g., if
7617 .Va \&\&folder
7619 .Dq mail
7620 (and thus relative to the user's home directory) then
7621 .Pa /home/usr1/mail/sent
7622 will be tried as
7623 .Ql folder-hook-/home/usr1/mail/sent
7624 first, but then followed by
7625 .Ql folder-hook-+sent .
7628 .It Va followup-to
7629 \*(BO Controls whether a
7630 .Ql Mail-Followup-To:
7631 header is generated when sending messages to known mailing lists.
7632 Also see
7633 .Va followup-to-honour
7634 and the commands
7635 .Ic mlist , mlsubscribe , reply
7637 .Ic Lreply .
7640 .It Va followup-to-honour
7641 Controls whether a
7642 .Ql Mail-Followup-To:
7643 header is honoured when group-replying to a message via
7644 .Ic reply
7646 .Ic Lreply .
7647 This is a quadoption; if set without a value it defaults to
7648 .Dq yes .
7649 Also see
7650 .Va followup-to
7651 and the commands
7652 .Ic mlist
7654 .Ic mlsubscribe .
7657 .It Va forward-as-attachment
7658 \*(BO Original messages are normally sent as inline text with the
7659 .Ic forward
7660 command,
7661 and only the first part of a multipart message is included.
7662 With this setting enabled messages are sent as unmodified MIME
7663 .Ql message/rfc822
7664 attachments with all of their parts included.
7667 .It Va from
7668 The address (or a list of addresses) to put into the
7669 .Ql From:
7670 field of the message header, quoting RFC 5322:
7671 the author(s) of the message, that is, the mailbox(es) of the person(s)
7672 or system(s) responsible for the writing of the message.
7673 When
7674 .Ic reply Ns
7675 ing to messages these addresses are handled as if they were in the
7676 .Ic alternates
7677 list.
7679 If the machine's hostname is not valid at the Internet (for example at
7680 a dialup machine) then either this variable or
7681 .Va hostname
7682 (\*(IN and with a defined SMTP protocol in
7683 .Va mta
7684 .Va smtp-hostname
7685 adds even more fine-tuning capabilities),
7686 have to be set.
7688 .Va \&\&from
7689 contains more than one address,
7690 setting the
7691 .Va sender
7692 variable is required (according to the standard RFC 5322).
7694 If a file-based MTA is used, then
7695 .Va from
7696 (or, if that contains multiple addresses,
7697 .Va sender )
7698 can nonetheless be enforced to appear as the envelope sender address at
7699 the MTA protocol level (the RFC 5321 reverse-path), either by using the
7700 .Fl r
7701 command line option (with an empty argument; see there for the complete
7702 picture on this topic), or by setting the internal variable
7703 .Va r-option-implicit .
7706 .It Va fullnames
7707 \*(BO When replying to or forwarding a message \*(UA normally removes
7708 the comment and name parts of email addresses.
7709 If this variable is set such stripping is not performed,
7710 and comments, names etc. are retained.
7713 .It Va fwdheading
7714 The string to put before the text of a message with the
7715 .Ic forward
7716 command
7717 (unless the
7718 .Va forward-as-attachment
7719 variable is set).
7720 Defaults to
7721 .Dq -------- Original Message --------
7722 if unset; No heading is put if it is set to the empty string.
7725 .It Va header
7726 \*(BO Causes the header summary to be written at startup and after
7727 commands that affect the number of messages or the order of messages in
7728 the current folder; enabled by default.
7729 The command line option
7730 .Fl N
7731 can be used to set
7732 .Pf no Va header .
7733 The variable
7734 .Va bsdannounce
7735 complements this and controls header summary display on folder changes.
7739 .It Va headline
7740 A format string to use for the summary of
7741 .Ic headers ,
7742 similar to the ones used for
7743 .Xr printf 3
7744 formats.
7745 Format specifiers in the given string start with a percent sign
7746 .Ql %
7747 and may be followed by an optional decimal number indicating the field
7748 width \(em if that is negative, the field is to be left-aligned.
7749 Valid format specifiers are:
7752 .Bl -tag -compact -width "_%%_"
7753 .It Ql %%
7754 A plain percent sign.
7755 .It Ql %>
7756 .Dq Dotmark :
7757 a space character but for the current message
7758 .Pf ( Dq dot ) ,
7759 for which it expands to
7760 .Ql > .
7761 .It Ql %<
7762 .Dq Dotmark :
7763 a space character but for the current message
7764 .Pf ( Dq dot ) ,
7765 for which it expands to
7766 .Ql < .
7767 .It Ql %$
7768 \*(OP The spam score of the message, as has been classified via the
7769 command
7770 .Ic spamrate .
7771 Shows only a replacement character if there is no spam support.
7772 .It Ql %a
7773 Message attribute character (status flag); the actual content can be
7774 adjusted by setting
7775 .Va attrlist .
7776 .It Ql %d
7777 The date found in the
7778 .Ql From:
7779 header of the message when
7780 .Va datefield
7781 is set (the default), otherwise the date when the message was received.
7782 Formatting can be controlled by assigning a
7783 .Xr strftime 3
7784 format string to
7785 .Va datefield .
7786 .It Ql %e
7787 The indenting level in threaded mode.
7788 .It Ql %f
7789 The address of the message sender.
7790 .It Ql %i
7791 The message thread tree structure.
7792 (Note that this format does not support a field width.)
7793 .It Ql %l
7794 The number of lines of the message, if available.
7795 .It Ql %m
7796 Message number.
7797 .It Ql %o
7798 The number of octets (bytes) in the message, if available.
7799 .It Ql %s
7800 Message subject (if any).
7801 .It Ql %S
7802 Message subject (if any) in double quotes.
7803 .It Ql \&%T
7804 Message recipient flags: is the addressee of the message a known or
7805 subscribed mailing list \(en see
7806 .Ic mlist
7808 .Ic mlsubscribe .
7809 .It Ql %t
7810 The position in threaded/sorted order.
7813 The default is
7814 .Ql %>\&%a\&%m\ %-18f\ %16d\ %4l/%\-5o\ %i%-s ,
7816 .Ql %>\&%a\&%m\ %20-f\ \ %16d\ %3l/%\-5o\ %i%-S
7818 .Va bsdcompat
7819 is set.
7820 Also see
7821 .Va attrlist
7823 .Va headline-bidi .
7827 .It Va headline-bidi
7828 Bidirectional text requires special treatment when displaying headers,
7829 because numbers (in dates or for file sizes etc.) will not affect the
7830 current text direction, in effect resulting in ugly line layouts when
7831 arabic or other right-to-left text is to be displayed.
7832 On the other hand only a minority of terminals is capable to correctly
7833 handle direction changes, so that user interaction is necessary for
7834 acceptable results.
7835 Note that extended host system support is required nonetheless, e.g.,
7836 detection of the terminal character set is one precondition;
7837 and this feature only works in an Unicode (i.e., UTF-8) locale.
7839 In general setting this variable will cause \*(UA to encapsulate text
7840 fields that may occur when displaying
7841 .Va headline
7842 (and some other fields, like dynamic expansions in
7843 .Va prompt )
7844 with special Unicode control sequences;
7845 it is possible to fine-tune the terminal support level by assigning
7846 a value:
7847 no value (or any value other than
7848 .Ql 1 ,
7849 .Ql 2
7851 .Ql 3 )
7852 will make \*(UA assume that the terminal is capable to properly deal
7853 with Unicode version 6.3, in which case text is embedded in a pair of
7854 U+2068 (FIRST STRONG ISOLATE) and U+2069 (POP DIRECTIONAL ISOLATE)
7855 characters.
7856 In addition no space on the line is reserved for these characters.
7858 Weaker support is chosen by using the value
7859 .Ql 1
7860 (Unicode 6.3, but reserve the room of two spaces for writing the control
7861 sequences onto the line).
7862 The values
7863 .Ql 2
7865 .Ql 3
7866 select Unicode 1.1 support (U+200E, LEFT-TO-RIGHT MARK); the latter
7867 again reserves room for two spaces in addition.
7870 .It Va history-file
7871 \*(OP If a line editor is available then this can be set to
7872 name the (expandable) path of the location of a permanent history file.
7873 Also see
7874 .Va history-size .
7877 .It Va history-gabby
7878 \*(BO\*(OP Add more entries to the history as is normally done.
7881 .It Va history-gabby-persist
7882 \*(BO\*(OP \*(UA's own MLE will not save the additional
7883 .Va history-gabby
7884 entries in persistent storage unless this variable is set.
7885 On the other hand it will not loose the knowledge of whether
7886 a persistent entry was gabby or not.
7887 Also see
7888 .Va history-file .
7891 .It Va history-size
7892 \*(OP Setting this variable imposes a limit on the number of concurrent
7893 history entries.
7894 If set to the value 0 then no further history entries will be added, and
7895 loading and incorporation of the
7896 .Va history-file
7897 upon program startup can also be suppressed by doing this.
7898 Runtime changes will not be reflected, but will affect the number of
7899 entries saved to permanent storage.
7902 .It Va hold
7903 \*(BO This setting controls whether messages are held in the system
7904 .Va inbox ,
7905 and it is set by default.
7908 .It Va hostname
7909 Use this string as hostname when expanding local addresses instead of
7910 the value obtained from
7911 .Xr uname 3
7913 .Xr getaddrinfo 3 .
7914 It is used, e.g., in
7915 .Ql Message-ID:
7917 .Ql From:
7918 fields, as well as when generating
7919 .Ql Content-ID:
7920 MIME part related unique ID fields.
7921 Setting it to the empty string will cause the normal hostname to be
7922 used, but nonetheless enables creation of said ID fields.
7923 \*(IN in conjunction with the builtin SMTP
7924 .Va mta
7925 .Va smtp-hostname
7926 also influences the results:
7927 one should produce some test messages with the desired combination of
7928 .Va \&\&hostname ,
7929 and/or
7930 .Va from ,
7931 .Va sender
7932 etc. first.
7935 .It Va idna-disable
7936 \*(BO\*(OP Can be used to turn off the automatic conversion of domain
7937 names according to the rules of IDNA (internationalized domain names
7938 for applications).
7939 Since the IDNA code assumes that domain names are specified with the
7940 .Va ttycharset
7941 character set, an UTF-8 locale charset is required to represent all
7942 possible international domain names (before conversion, that is).
7945 .It Va ignore
7946 \*(BO Ignore interrupt signals from the terminal while entering
7947 messages; instead echo them as
7948 .Ql @
7949 characters and discard the current line.
7952 .It Va ignoreeof
7953 \*(BO Ignore end-of-file conditions
7954 .Pf ( Ql control-D )
7955 in compose mode on message input and in interactive command input.
7956 If set an interactive command input session can only be left by
7957 explicitly using one of the commands
7958 .Ic exit
7960 .Ic quit ,
7961 and message input in compose mode can only be terminated by entering
7962 a period
7963 .Ql \&.
7964 on a line by itself or by using the
7965 .Ic ~.
7966 .Sx "COMMAND ESCAPES" ;
7967 .Va ignoreeof
7968 overrides a setting of
7969 .Pf no Va dot .
7972 .It Va inbox
7973 If this is set to a non-empty string it will specify the users
7974 .Mx -sx
7975 .Sx "primary system mailbox" ,
7976 overriding
7977 .Ev MAIL
7978 and the system-dependent default, and (thus) be used to replace
7979 .Ql %
7980 when doing
7981 .Sx "Filename transformations" ;
7982 also see
7983 .Ic file
7984 for more on this topic.
7985 The value supports a subset of transformations itself.
7988 .It Va indentprefix
7989 String used by the
7990 .Ic ~m , ~M
7992 .Ic ~R
7993 .Sx "COMMAND ESCAPES"
7994 and by the
7995 .Va quote
7996 option for indenting messages,
7997 in place of the normal tabulator character
7998 .Ql ^I ,
7999 which is the default.
8000 Be sure to quote the value if it contains spaces or tabs.
8003 .It Va keep
8004 \*(BO If set, an empty system (MBOX) mailbox file is not removed.
8005 Note that, in conjunction with
8006 .Va posix
8007 (and, thus,
8008 .Ev POSIXLY_CORRECT )
8009 any empty file will be removed unless this variable is set.
8010 This may improve the interoperability with other mail user agents
8011 when using a common folder directory, and prevents malicious users
8012 from creating fake mailboxes in a world-writable spool directory.
8013 \*(ID Only local regular (MBOX) files are covered, Maildir or other
8014 mailbox types will never be removed, even if empty.
8017 .It Va keep-content-length
8018 \*(BO When (editing messages and) writing
8019 .Ev MBOX
8020 mailbox files \*(UA can be told to keep the
8021 .Ql Content-Length:
8023 .Ql Lines:
8024 header fields that some MUAs generate by setting this variable.
8025 Since \*(UA does neither use nor update these non-standardized header
8026 fields (which in itself shows one of their conceptual problems),
8027 stripping them should increase interoperability in between MUAs that
8028 work with with same mailbox files.
8029 Note that, if this is not set but
8030 .Va writebackedited ,
8031 as below, is, a possibly performed automatic stripping of these header
8032 fields already marks the message as being modified.
8035 .It Va keepsave
8036 \*(BO When a message is saved it is usually discarded from the
8037 originating folder when \*(UA is quit.
8038 This setting causes all saved message to be retained.
8041 .It Va line-editor-disable
8042 \*(BO Turn off any enhanced line editing capabilities (see
8043 .Sx "On terminal control and line editor"
8044 for more).
8047 .It Va line-editor-no-defaults
8048 \*(BO\*(OP Do not establish any default key binding.
8051 .It Va mailx-extra-rc
8052 An additional startup file that is loaded as the last of the
8053 .Sx "Resource files" .
8054 Use this file for commands that are not understood by other POSIX
8055 .Xr mailx 1
8056 implementations.
8059 .It Va markanswered
8060 \*(BO When a message is replied to and this variable is set,
8061 it is marked as having been
8062 .Ic answered .
8063 See the section
8064 .Sx "Message states" .
8067 .It Va mbox-rfc4155
8068 \*(BO If this is set then when opening MBOX mailbox files \*(UA will not
8069 use the tolerant POSIX rules for detecting message boundaries (so-called
8070 .Ql From_
8071 lines), as it does by default for compatibility reasons, but the more
8072 strict rules that have been defined in RFC 4155.
8073 When saving to MBOX mailboxes this indicates when so-called
8074 .Ql From_
8075 quoting is to be applied \(em note this is never necessary for any
8076 message newly generated by \*(UA, it only applies to messages generated
8077 by buggy or malicious MUAs.
8078 (\*(UA will use a proper
8079 .Va encoding
8080 to ensure that
8081 .Ql From_
8082 lines cannot be misinterpreted as message boundaries.)
8084 This should not be set normally, but may be handy when \*(UA complains
8085 about having seen invalid
8086 .Ql From_
8087 lines when opening a MBOX: in this case temporarily setting this
8088 variable, re-opening the mailbox in question, unsetting this variable
8089 again and then invoking
8090 .Ql copy * SOME-FILE
8091 will perform proper, POSIX-compliant
8092 .Ql From_
8093 quoting for all detected messages, resulting in a valid MBOX mailbox.
8096 .It Va memdebug
8097 \*(BO Internal development variable.
8100 .It Va message-id-disable
8101 \*(BO By setting this variable the generation of
8102 .Ql Message-ID:
8103 can be completely suppressed, effectively leaving this task up to the
8104 .Va mta
8105 (Mail-Transfer-Agent) or the SMTP server.
8106 (According to RFC 5321 a SMTP server is not required to add this
8107 field by itself, so it should be ensured that it accepts messages without
8108 .Ql Message-ID . )
8109 This variable also affects automatic generation of
8110 .Va Content-ID:
8111 MIME header fields.
8114 .It Va message-inject-head
8115 A string to put at the beginning of each new message.
8116 The escape sequences tabulator
8117 .Ql \et
8118 and newline
8119 .Ql \en
8120 are understood.
8123 .It Va message-inject-tail
8124 A string to put at the end of each new message.
8125 The escape sequences tabulator
8126 .Ql \et
8127 and newline
8128 .Ql \en
8129 are understood.
8132 .It Va metoo
8133 \*(BO Usually, when an
8134 .Ic alias
8135 expansion contains the sender, the sender is removed from the expansion.
8136 Setting this option suppresses these removals.
8137 Note that a set
8138 .Va metoo
8139 also causes a
8140 .Ql -m
8141 option to be passed through to the
8142 .Va mta
8143 (Mail-Transfer-Agent); though most of the modern MTAs no longer document
8144 this flag, no MTA is known which does not support it (for historical
8145 compatibility).
8148 .It Va mime-allow-text-controls
8149 \*(BO When sending messages, each part of the message is MIME-inspected
8150 in order to classify the
8151 .Ql Content-Type:
8153 .Ql Content-Transfer-Encoding:
8154 (see
8155 .Va encoding )
8156 that is required to send this part over mail transport, i.e.,
8157 a computation rather similar to what the
8158 .Xr file 1
8159 command produces when used with the
8160 .Ql --mime
8161 option.
8163 This classification however treats text files which are encoded in
8164 UTF-16 (seen for HTML files) and similar character sets as binary
8165 octet-streams, forcefully changing any
8166 .Ql text/plain
8168 .Ql text/html
8169 specification to
8170 .Ql application/octet-stream :
8171 If that actually happens a yet unset charset MIME parameter is set to
8172 .Ql binary ,
8173 effectively making it impossible for the receiving MUA to automatically
8174 interpret the contents of the part.
8176 If this variable is set, and the data was unambiguously identified as
8177 text data at first glance (by a
8178 .Ql .txt
8180 .Ql .html
8181 file extension), then the original
8182 .Ql Content-Type:
8183 will not be overwritten.
8186 .It Va mime-alternative-favour-rich
8187 \*(BO If this variable is set then rich MIME alternative parts (e.g.,
8188 HTML) will be preferred in favour of included plain text versions when
8189 displaying messages, provided that a handler exists which produces
8190 output that can be (re)integrated into \*(UA's normal visual display.
8191 (E.g., at the time of this writing some newsletters ship their full
8192 content only in the rich HTML part, whereas the plain text part only
8193 contains topic subjects.)
8196 .It Va mime-counter-evidence
8197 Normally the
8198 .Ql Content-Type:
8199 field is used to decide how to handle MIME parts.
8200 Some MUAs however do not use
8201 .Xr mime.types 5
8202 or a similar mechanism to correctly classify content, but simply specify
8203 .Ql application/octet-stream ,
8204 even for plain text attachments like
8205 .Ql text/diff .
8206 If this variable is set then \*(UA will try to classify such MIME
8207 message parts on its own, if possible, for example via a possibly
8208 existing attachment filename.
8209 A non-empty value may also be given, in which case a number is expected,
8210 actually a carrier of bits.
8211 Creating the bit-carrying number is a simple addition:
8212 .Bd -literal -offset indent
8213 ? !echo Value should be set to $((2 + 4 + 8))
8214 Value should be set to 14
8217 .Bl -bullet -compact
8219 If bit two is set (2) then the detected
8220 .Dq real
8221 content-type will be carried along with the message and be used for
8222 deciding which
8223 .Va pipe-TYPE/SUBTYPE
8224 is responsible for the MIME part, shall that question arise;
8225 when displaying such a MIME part the part-info will indicate the
8226 overridden content-type by showing a plus sign
8227 .Ql + .
8229 If bit three is set (4) then the counter-evidence is always produced
8230 and a positive result will be used as the MIME type, even forcefully
8231 overriding the parts given MIME type.
8233 If bit four is set (8) then as a last resort the actual content of
8234 .Ql application/octet-stream
8235 parts will be inspected, so that data which looks like plain text can be
8236 treated as such.
8240 .It Va mimetypes-load-control
8241 Can be used to control which of the
8242 .Xr mime.types 5
8243 databases are loaded by \*(UA, as furtherly described in the section
8244 .Sx "The mime.types files" .
8245 If the letter
8246 .Ql u
8247 is part of the option value, then the user's personal
8248 .Pa ~/.mime.types
8249 file will be loaded (if it exists); likewise the letter
8250 .Ql s
8251 controls loading of the system wide
8252 .Pa /etc/mime.types ;
8253 directives found in the user file take precedence, letter matching is
8254 case-insensitive.
8255 If this variable is not set \*(UA will try to load both files.
8256 Incorporation of the \*(UA-builtin MIME types cannot be suppressed,
8257 but they will be matched last (the order can be listed via
8258 .Ic mimetype ) .
8260 More sources can be specified by using a different syntax: if the
8261 value string contains an equals sign
8262 .Ql =
8263 then it is instead parsed as a comma-separated list of the described
8264 letters plus
8265 .Ql f=FILENAME
8266 pairs; the given filenames will be expanded and loaded, and their
8267 content may use the extended syntax that is described in the section
8268 .Sx "The mime.types files" .
8269 Directives found in such files always take precedence (are prepended to
8270 the MIME type cache).
8274 .It Va mta
8275 To choose an alternate Mail-Transfer-Agent, set this option to either
8276 the full pathname of an executable (optionally prefixed with a
8277 .Ql file://
8278 protocol indicator), or \*(OPally a SMTP protocol URL, e.g., \*(IN
8280 .Dl smtps?://[user[:password]@]server[:port]
8282 (\*(OU:
8283 .Ql [smtp://]server[:port] . )
8284 The default has been chosen at compie time.
8285 All supported data transfers are executed in child processes, which
8286 run asynchronously, and without supervision, unless either the
8287 .Va sendwait
8288 or the
8289 .Va verbose
8290 variable is set.
8291 If such a child receives a TERM signal, it will abort and
8292 .Va save
8293 the message to
8294 .Ev DEAD ,
8295 if so configured.
8298 For a file-based MTA it may be necessary to set
8299 .Va mta-argv0
8300 in in order to choose the right target of a modern
8301 .Xr mailwrapper 8
8302 environment.
8303 It will be passed command line arguments from several possible sources:
8304 from the variable
8305 .Va mta-arguments
8306 if set, from the command line if given and the variable
8307 .Va expandargv
8308 allows their use.
8309 Argument processing of the MTA will be terminated with a
8310 .Fl \&\&-
8311 separator.
8314 The otherwise occurring implicit usage of the following MTA command
8315 line arguments can be disabled by setting the boolean variable
8316 .Va mta-no-default-arguments
8317 (which will also disable passing
8318 .Fl \&\&-
8319 to the MTA):
8320 .Fl \&\&i
8321 (for not treating a line with only a dot
8322 .Ql \&.
8323 character as the end of input),
8324 .Fl \&\&m
8325 (shall the variable
8326 .Va metoo
8327 be set) and
8328 .Fl \&\&v
8329 (if the
8330 .Va verbose
8331 variable is set); in conjunction with the
8332 .Fl r
8333 command line option \*(UA will also (not) pass
8334 .Fl \&\&f
8335 as well as possibly
8336 .Fl \&\&F .
8339 \*(OP \*(UA can send mail over SMTP network connections to a single
8340 defined SMTP smarthost, the access URL of which has to be assigned to
8341 .Va mta .
8342 To use this mode it is helpful to read
8343 .Sx "On URL syntax and credential lookup" .
8344 It may be necessary to set the
8345 .Va smtp-hostname
8346 variable in order to use a specific combination of
8347 .Va from ,
8348 .Va hostname
8350 .Va mta
8351 with some mail providers.
8354 .Bl -bullet -compact
8356 The plain SMTP protocol (RFC 5321) that normally lives on the
8357 server port 25 and requires setting the
8358 .Va smtp-use-starttls
8359 variable to enter a SSL/TLS encrypted session state.
8360 Assign a value like \*(IN
8361 .Ql smtp://[user[:password]@]server[:port]
8362 (\*(OU
8363 .Ql smtp://server[:port] )
8364 to choose this protocol.
8366 The so-called SMTPS which is supposed to live on server port 465
8367 and is automatically SSL/TLS secured.
8368 Unfortunately it never became a standardized protocol and may thus not
8369 be supported by your hosts network service database
8370 \(en in fact the port number has already been reassigned to other
8371 protocols!
8373 SMTPS is nonetheless a commonly offered protocol and thus can be
8374 chosen by assigning a value like \*(IN
8375 .Ql smtps://[user[:password]@]server[:port]
8376 (\*(OU
8377 .Ql smtps://server[:port] ) ;
8378 due to the mentioned problems it is usually necessary to explicitly
8379 specify the port as
8380 .Ql :465 ,
8381 however.
8383 Finally there is the SUBMISSION protocol (RFC 6409), which usually
8384 lives on server port 587 and is practically identically to the SMTP
8385 protocol from \*(UA's point of view beside that; it requires setting the
8386 .Va smtp-use-starttls
8387 variable to enter a SSL/TLS secured session state.
8388 Assign a value like \*(IN
8389 .Ql submission://[user[:password]@]server[:port]
8390 (\*(OU
8391 .Ql submission://server[:port] ) .
8396 .It Va mta-arguments
8397 Arguments to pass through to a file-based
8398 .Va mta
8399 can be given via this variable, which is parsed according to
8400 .Sx "Shell-style argument quoting"
8401 into an array of arguments, and which will be joined onto MTA options
8402 from other sources, and then passed individually to the MTA:
8404 .Dl wysh set mta-arguments='-t -X \&"/tmp/my log\&"'
8407 .It Va mta-no-default-arguments
8408 \*(BO Unless this variable is set \*(UA will pass some well known
8409 standard command line options to a file-based
8410 .Va mta
8411 (Mail-Transfer-Agent), see there for more.
8414 .It Va mta-argv0
8415 Many systems use a so-called
8416 .Xr mailwrapper 8
8417 environment to ensure compatibility with
8418 .Xr sendmail 1 .
8419 This works by inspecting the name that was used to invoke the mail
8420 delivery system.
8421 If this variable is set then the mailwrapper (the program that is
8422 actually executed when calling the file-based
8423 .Va mta )
8424 will treat its contents as that name.
8425 The default is
8426 .Ql sendmail .
8428 .Mx Va netrc-lookup
8429 .It Va netrc-lookup-USER@HOST , netrc-lookup-HOST , netrc-lookup
8430 \*(BO\*(IN\*(OP Used to control usage of the users
8431 .Pa .netrc
8432 file for lookup of account credentials, as documented in the section
8433 .Sx "On URL syntax and credential lookup"
8434 and for the command
8435 .Ic netrc ;
8436 the section
8437 .Sx "The .netrc file"
8438 documents the file format.
8439 Also see
8440 .Va netrc-pipe .
8443 .It Va netrc-pipe
8444 \*(IN\*(OP When
8445 .Pa .netrc
8446 is loaded (see
8447 .Ic netrc
8449 .Va netrc-lookup )
8450 then \*(UA will read the output of a shell pipe instead of the users
8451 .Pa .netrc
8452 file if this variable is set (to the desired shell command).
8453 This can be used to, e.g., store
8454 .Pa .netrc
8455 in encrypted form:
8457 .Dl set netrc-pipe='gpg -qd ~/.netrc.pgp'
8460 .It Va newfolders
8461 If this variable has the value
8462 .Ql maildir ,
8463 newly created local folders will be in Maildir format.
8466 .It Va newmail
8467 Checks for new mail in the current folder each time the prompt is shown.
8468 A Maildir folder must be re-scanned to determine if new mail has arrived.
8469 If this variable is set to the special value
8470 .Ql nopoll
8471 then a Maildir folder will not be rescanned completely, but only
8472 timestamp changes are detected.
8476 .It Va on-compose-done-shell , on-compose-done
8477 These hooks run once the normal compose mode is finished, but before the
8478 .Va on-compose-leave
8479 macro hook is called, the
8480 .Va signature
8481 is injected etc.
8482 Both hooks will be executed in a subprocess, with their input and output
8483 connected to \*(UA such that they can act as if they would be an
8484 interactive user.
8485 The difference in between them is that the former is a
8486 .Ev SHELL
8487 command, whereas the latter is a normal \*(UA macro, but which is
8488 restricted to a small set of commands (the
8489 .Va verbose
8490 output of, e.g.,
8491 .Ic list
8492 will indicate said capability), just enough for the purpose of
8493 controlling the real \*(UA instance sufficiently.
8494 .Ic localopts
8495 are enabled for these hooks (in the parent process), causing any setting
8496 to be forgotten after the message has been sent.
8498 During execution of these hook \*(UA will temporarily forget whether it
8499 has been started in interactive mode, (a restricted set of)
8500 .Sx "COMMAND ESCAPES"
8501 will always be available, and for guaranteed reproduceabilities sake
8502 .Va escape
8503 will be set to its default.
8504 The compose mode command
8505 .Ic ~^
8506 has been especially designed for scriptability (via these hooks).
8507 The first line the hook will read on its standard input is the protocol
8508 version of said command escape, currently
8509 .Dq 0 0 1 :
8510 backward incompatible protocol changes are to be expected in the
8511 future, and it is advisable to make use of the protocol version.
8512 \*(ID because most \*(UA commands do not take this new functionality
8513 into account but are ment for human interaction special care must be
8514 taken to avoid deadlocks because of unexpected control flow; i.e., that
8515 both involved processes wait for more input to happen at the same time,
8516 or one doesn't expect more input but the other is stuck waiting for
8517 consumation of its output.
8518 .Bd -literal -offset indent
8519 wysh set on-compose-done-shell=$'\e
8520   read version;\e
8521   printf "hello $version!  Headers: ";\e
8522   echo \e'~^header list\e';\e
8523   read status result;\e
8524   echo "status=$status result=$result";\e
8525   '
8527 set on-compose-done=ocdm
8528 define ocdm {
8529   read ver
8530   echo version is $ver, escape=$escape
8531   if [ "$features" !@ +regex ]
8532     echoerr 'Need regular-expression support, aborting send'
8533     echo '~x'
8534   endif
8535   echo '~^header list'
8536   read hl
8537   if [ "$hl" !~ ^2 ]
8538     echoerr 'Failed to read header list, bailing out'
8539     echo '~x'
8540   endif
8541   if [ "$hl" !@ ' cc' ]
8542     echo '~^header insert cc Diet is your <mirr.or>'
8543     read es
8544     if [ "$es" !~ ^2 ]
8545       echoerr 'Failed to insert Cc: header, bailing out'
8546       echo '~x'
8547     endif
8548   endif
8549   echo '~:set from="Hoola Hoop <hh@exam.ple>"'
8555 .It Va on-compose-enter , on-compose-leave
8556 Macro hooks which will be executed before compose mode is entered, and
8557 after composing has been finished (but before the
8558 .Va signature
8559 is injected, etc.), respectively.
8560 .Ic localopts
8561 are enabled for these hooks, causing any setting to be forgotten after
8562 the message has been sent.
8563 The following (read-only) variables will be set temporarily during
8564 execution of the macros:
8566 .Bl -tag -compact -width ".It Va compose_subject"
8567 .It Va compose-from
8568 .Va from .
8569 .It Va compose-sender
8570 .Va sender .
8571 .It Va compose-to , compose-cc , compose-bcc
8572 The list of receiver addresses as a space-separated list.
8573 .It Va compose-subject
8574 The subject.
8578 .It Va outfolder
8579 \*(BO Causes the filename given in the
8580 .Va record
8581 variable
8582 and the sender-based filenames for the
8583 .Ic Copy
8585 .Ic Save
8586 commands to be interpreted relative to the directory given in the
8587 .Va folder
8588 variable rather than to the current directory,
8589 unless it is set to an absolute pathname.
8592 .It Va page
8593 \*(BO If set, each message feed through the command given for
8594 .Ic pipe
8595 is followed by a formfeed character
8596 .Ql \ef .
8598 .Mx Va password
8599 .It Va password-USER@HOST , password-HOST , password
8600 \*(IN Variable chain that sets a password, which is used in case none has
8601 been given in the protocol and account-specific URL;
8602 as a last resort \*(UA will ask for a password on the user's terminal if
8603 the authentication method requires a password.
8604 Specifying passwords in a startup file is generally a security risk;
8605 the file should be readable by the invoking user only.
8607 .It Va password-USER@HOST
8608 \*(OU (see the chain above for \*(IN)
8609 Set the password for
8610 .Ql USER
8611 when connecting to
8612 .Ql HOST .
8613 If no such variable is defined for a host,
8614 the user will be asked for a password on standard input.
8615 Specifying passwords in a startup file is generally a security risk;
8616 the file should be readable by the invoking user only.
8619 .It Va piperaw
8620 \*(BO Send messages to the
8621 .Ic pipe
8622 command without performing MIME and character set conversions.
8626 .It Va pipe-TYPE/SUBTYPE
8627 When a MIME message part of type
8628 .Ql TYPE/SUBTYPE
8629 (case-insensitive) is displayed or quoted,
8630 its text is filtered through the value of this variable interpreted as
8631 a shell command.
8632 The special value
8633 .Ql @
8634 forces interpretation of the message part as plain text, e.g.,
8635 .Ql set pipe-application/xml=@
8636 will henceforth display XML
8637 .Dq as is .
8638 (The same could also be achieved by adding a MIME type marker with the
8639 .Ic mimetype
8640 command.
8641 And \*(OPally MIME type handlers may be defined via
8642 .Sx "The Mailcap files"
8643 \(em corresponding flag strings are shown in parenthesis below.)
8646 The special value
8647 .Ql @
8648 can in fact be used to adjust usage and behaviour of a following shell
8649 command specification by appending trigger characters to it, e.g., the
8650 following hypothetical command specification could be used:
8651 .Bd -literal -offset indent
8652 set pipe-X/Y='@*!++=@vim ${MAILX_FILENAME_TEMPORARY}'
8656 .Bl -tag -compact -width ".It Ql __"
8657 .It Ql *
8658 Simply by using the special
8659 .Ql @
8660 prefix the MIME type (shell command) handler will only be invoked to
8661 display or convert the MIME part if the message is addressed directly
8662 and alone by itself.
8663 Use this trigger to disable this and always invoke the handler
8664 .Pf ( Cd x-mailx-always ) .
8666 .It Ql #
8667 If set the handler will not be invoked when a message is to be quoted,
8668 but only when it will be displayed
8669 .Pf ( Cd x-mailx-noquote ) .
8671 .It Ql &
8672 The command will be run asynchronously, i.e., without blocking \*(UA,
8673 which may be a handy way to display a, e.g., PDF file while also
8674 continuing to read the mail message
8675 .Pf ( Cd x-mailx-async ) .
8676 Asynchronous execution implies
8677 .Ql # .
8679 .It Ql \&!
8680 The command must be run on an interactive terminal, \*(UA will
8681 temporarily release the terminal to it
8682 .Pf ( Cd needsterminal ) .
8683 This flag is mutual exclusive with
8684 .Ql & ,
8685 will only be used in interactive mode and implies
8686 .Ql # .
8688 .It Ql +
8689 Request creation of a zero-sized temporary file, the absolute pathname
8690 of which will be made accessible via the environment variable
8691 .Ev MAILX_FILENAME_TEMPORARY
8692 .Pf ( Cd x-mailx-tmpfile ) .
8693 If this trigger is given twice then the file will be unlinked
8694 automatically by \*(UA when the command loop is entered again at latest
8695 .Pf ( Cd x-mailx-tmpfile-unlink ) .
8696 (Do not use this for asynchronous handlers.)
8698 .It Ql =
8699 Normally the MIME part content is passed to the handler via standard
8700 input; if this flag is set then the data will instead be written into
8701 .Ev MAILX_FILENAME_TEMPORARY
8702 .Pf ( Cd x-mailx-tmpfile-fill ) ,
8703 the creation of which is implied; note however that in order to cause
8704 deletion of the temporary file you still have to use two plus signs
8705 .Ql ++
8706 explicitly!
8708 .It Ql @
8709 To avoid ambiguities with normal shell command content you can use
8710 another commercial at to forcefully terminate interpretation of
8711 remaining characters.
8712 (Any character not in this list will have the same effect.)
8716 Some information about the MIME part to be displayed is embedded into
8717 the environment of the shell command:
8720 .Bl -tag -compact -width ".It Ev _AIL__ILENAME__ENERATED"
8722 .It Ev MAILX_CONTENT
8723 The MIME content-type of the part, if known, the empty string otherwise.
8726 .It Ev MAILX_CONTENT_EVIDENCE
8728 .Va mime-counter-evidence
8729 includes the carry-around-bit (2), then this will be set to the detected
8730 MIME content-type; not only then identical to
8731 .Ev \&\&MAILX_CONTENT
8732 otherwise.
8735 .It Ev MAILX_FILENAME
8736 The filename, if any is set, the empty string otherwise.
8739 .It Ev MAILX_FILENAME_GENERATED
8740 A random string.
8743 .It Ev MAILX_FILENAME_TEMPORARY
8744 If temporary file creation has been requested through the command prefix
8745 this variable will be set and contain the absolute pathname of the
8746 temporary file.
8751 .It Va pipe-EXTENSION
8752 This is identical to
8753 .Va pipe-TYPE/SUBTYPE
8754 except that
8755 .Ql EXTENSION
8756 (normalized to lowercase using character mappings of the ASCII charset)
8757 names a file extension, e.g.,
8758 .Ql xhtml .
8759 Handlers registered using this method take precedence.
8761 .Mx Va pop3-auth
8762 .It Va pop3-auth-USER@HOST , pop3-auth-HOST , pop3-auth
8763 \*(OP\*(IN Variable chain that sets the POP3 authentication method.
8764 The only possible value as of now is
8765 .Ql plain ,
8766 which is thus the default.
8769 .Mx Va pop3-bulk-load
8770 .It Va pop3-bulk-load-USER@HOST , pop3-bulk-load-HOST , pop3-bulk-load
8771 \*(BO\*(OP When accessing a POP3 server \*(UA loads the headers of
8772 the messages, and only requests the message bodies on user request.
8773 For the POP3 protocol this means that the message headers will be
8774 downloaded twice.
8775 If this variable is set then \*(UA will download only complete messages
8776 from the given POP3 server(s) instead.
8778 .Mx Va pop3-keepalive
8779 .It Va pop3-keepalive-USER@HOST , pop3-keepalive-HOST , pop3-keepalive
8780 \*(OP POP3 servers close the connection after a period of inactivity;
8781 the standard requires this to be at least 10 minutes,
8782 but practical experience may vary.
8783 Setting this variable to a numeric value greater than
8784 .Ql 0
8785 causes a
8786 .Ql NOOP
8787 command to be sent each value seconds if no other operation is performed.
8789 .Mx Va pop3-no-apop
8790 .It Va pop3-no-apop-USER@HOST , pop3-no-apop-HOST , pop3-no-apop
8791 \*(BO\*(OP Unless this variable is set the
8792 .Ql APOP
8793 authentication method will be used when connecting to a POP3 server that
8794 advertises support.
8795 The advantage of
8796 .Ql APOP
8797 is that the password is not sent in clear text over the wire and that
8798 only a single packet is sent for the user/password tuple.
8799 Note that
8800 .Va pop3-no-apop-HOST
8801 requires \*(IN.
8803 .Mx Va pop3-use-starttls
8804 .It Va pop3-use-starttls-USER@HOST , pop3-use-starttls-HOST , pop3-use-starttls
8805 \*(BO\*(OP Causes \*(UA to issue a
8806 .Ql STLS
8807 command to make an unencrypted POP3 session SSL/TLS encrypted.
8808 This functionality is not supported by all servers,
8809 and is not used if the session is already encrypted by the POP3S method.
8810 Note that
8811 .Va pop3-use-starttls-HOST
8812 requires \*(IN.
8815 .It Va posix
8816 \*(BO This flag enables POSIX mode, which changes behaviour of \*(UA
8817 where that deviates from standardized behaviour.
8818 It will be set implicitly before the
8819 .Sx "Resource files"
8820 are loaded if the environment variable
8821 .Ev POSIXLY_CORRECT
8822 is set, and adjusting any of those two will be reflected by the other
8823 one implicitly.
8826 .It Va print-alternatives
8827 \*(BO When a MIME message part of type
8828 .Ql multipart/alternative
8829 is displayed and it contains a subpart of type
8830 .Ql text/plain ,
8831 other parts are normally discarded.
8832 Setting this variable causes all subparts to be displayed,
8833 just as if the surrounding part was of type
8834 .Ql multipart/mixed .
8837 .It Va prompt
8838 The string used as a prompt in interactive mode.
8839 Whenever the variable is evaluated the value is expanded as via
8840 dollar-single-quote expansion (see
8841 .Sx "Shell-style argument quoting" ) .
8842 This (post-assignment, i.e., second) expansion can be used to embed
8843 status information, for example
8844 .Va \&? ,
8845 .Va \&! ,
8846 .Va -account
8848 .Va -mailbox-display .
8850 In order to embed characters which should not be counted when
8851 calculating the visual width of the resulting string, enclose the
8852 characters of interest in a pair of reverse solidus escaped brackets:
8853 .Ql \e[\eE[0m\e] ;
8854 a slot for coloured prompts is also available with the \*(OPal command
8855 .Ic colour .
8856 Prompting may be prevented by setting this to the null string
8857 (a.k.a.\|
8858 .Ql set noprompt ) .
8861 .It Va prompt2
8862 This string is used for secondary prompts, but is otherwise identical to
8863 .Va prompt .
8864 The default is
8865 .Ql ..\0 .
8868 .It Va quiet
8869 \*(BO Suppresses the printing of the version when first invoked.
8872 .It Va quote
8873 If set, \*(UA starts a replying message with the original message
8874 prefixed by the value of the variable
8875 .Va indentprefix .
8876 Normally, a heading consisting of
8877 .Dq Fromheaderfield wrote:
8878 is put before the quotation.
8879 If the string
8880 .Ql noheading
8881 is assigned to the
8882 .Va \&\&quote
8883 variable, this heading is omitted.
8884 If the string
8885 .Ql headers
8886 is assigned, only the headers selected by the
8887 .Ql type
8888 .Ic headerpick
8889 selection are put above the message body,
8890 thus
8891 .Va \&\&quote
8892 acts like an automatic
8893 .Pf ` Ic ~m Ns '
8894 .Sx "COMMAND ESCAPES"
8895 command, then.
8896 If the string
8897 .Ql allheaders
8898 is assigned, all headers are put above the message body and all MIME
8899 parts are included, making
8900 .Va \&\&quote
8901 act like an automatic
8902 .Pf ` Ic ~M Ns '
8903 command; also see
8904 .Va quote-as-attachment .
8907 .It Va quote-as-attachment
8908 \*(BO Add the original message in its entirety as a
8909 .Ql message/rfc822
8910 MIME attachment when replying to a message.
8911 Note this works regardless of the setting of
8912 .Va quote .
8915 .It Va quote-fold
8916 \*(OP Can be set in addition to
8917 .Va indentprefix .
8918 Setting this turns on a more fancy quotation algorithm in that leading
8919 quotation characters are compressed and overlong lines are folded.
8920 .Va \&\&quote-fold
8921 can be set to either one or two (space separated) numeric values,
8922 which are interpreted as the maximum (goal) and the minimum line length,
8923 respectively, in a spirit rather equal to the
8924 .Xr fmt 1
8925 program, but line-, not paragraph-based.
8926 If not set explicitly the minimum will reflect the goal algorithmically.
8927 The goal cannot be smaller than the length of
8928 .Va indentprefix
8929 plus some additional pad.
8930 Necessary adjustments take place silently.
8933 .It Va r-option-implicit
8934 \*(BO Setting this option evaluates the contents of
8935 .Va from
8936 (or, if that contains multiple addresses,
8937 .Va sender )
8938 and passes the results onto the used (file-based) MTA as described for the
8939 .Fl r
8940 option (empty argument case).
8943 .It Va recipients-in-cc
8944 \*(BO On group replies, specify only the sender of the original mail in
8945 .Ql To:
8946 and mention the other recipients in the secondary
8947 .Ql Cc: .
8948 By default all recipients of the original mail will be addressed via
8949 .Ql To: .
8952 .It Va record
8953 If defined, gives the pathname of the folder used to record all outgoing
8954 mail.
8955 If not defined, then outgoing mail is not saved.
8956 When saving to this folder fails the message is not sent,
8957 but instead saved to
8958 .Ev DEAD .
8961 .It Va record-resent
8962 \*(BO If both this variable and the
8963 .Va record
8964 variable are set,
8966 .Ic resend
8968 .Ic Resend
8969 commands save messages to the
8970 .Va record
8971 folder as it is normally only done for newly composed messages.
8974 .It Va reply-in-same-charset
8975 \*(BO If this variable is set \*(UA first tries to use the same
8976 character set of the original message for replies.
8977 If this fails, the mechanism described in
8978 .Sx "Character sets"
8979 is evaluated as usual.
8982 .It Va reply-strings
8983 Can be set to a comma-separated list of (case-insensitive according to
8984 ASCII rules) strings which shall be recognized in addition to the
8985 builtin strings as
8986 .Ql Subject:
8987 reply message indicators \(en builtin are
8988 .Ql Re: ,
8989 which is mandated by RFC 5322, as well as the german
8990 .Ql Aw: ,
8991 .Ql Antw: ,
8992 and the
8993 .Ql Wg:
8994 which often has been seen in the wild;
8995 I.e., the separating colon has to be specified explicitly.
8998 .It Va replyto
8999 A list of addresses to put into the
9000 .Ql Reply-To:
9001 field of the message header.
9002 Members of this list are handled as if they were in the
9003 .Ic alternates
9004 list.
9007 .It Va reply-to-honour
9008 Controls whether a
9009 .Ql Reply-To:
9010 header is honoured when replying to a message via
9011 .Ic reply
9013 .Ic Lreply .
9014 This is a quadoption; if set without a value it defaults to
9015 .Dq yes .
9018 .It Va rfc822-body-from_
9019 \*(BO This variable can be used to force displaying a so-called
9020 .Ql From_
9021 line for messages that are embedded into an envelope mail via the
9022 .Ql message/rfc822
9023 MIME mechanism, for more visual convenience.
9026 .It Va save
9027 \*(BO Enable saving of (partial) messages in
9028 .Ev DEAD
9029 upon interrupt or delivery error.
9032 .It Va screen
9033 The number of lines that represents a
9034 .Dq screenful
9035 of lines, used in
9036 .Ic headers
9037 summary display,
9038 .Ic from
9039 .Ic search Ns
9040 ing, message
9041 .Ic top Ns
9042 line display and scrolling via
9043 .Ic z .
9044 If this variable is not set \*(UA falls back to a calculation based upon
9045 the detected terminal window size and the baud rate: the faster the
9046 terminal, the more will be shown.
9047 Overall screen dimensions and pager usage is influenced by the
9048 environment variables
9049 .Ev COLUMNS
9051 .Ev LINES
9052 and the variable
9053 .Va crt .
9056 .It Va searchheaders
9057 \*(BO Expand message-list specifiers in the form
9058 .Ql /x:y
9059 to all messages containing the substring
9060 .Dq y
9061 in the header field
9062 .Ql x .
9063 The string search is case insensitive.
9066 .It Va sendcharsets
9067 \*(OP A comma-separated list of character set names that can be used in
9068 outgoing internet mail.
9069 The value of the variable
9070 .Va charset-8bit
9071 is automatically appended to this list of character sets.
9072 If no character set conversion capabilities are compiled into \*(UA then
9073 the only supported charset is
9074 .Va ttycharset .
9075 Also see
9076 .Va sendcharsets-else-ttycharset
9077 and refer to the section
9078 .Sx "Character sets"
9079 for the complete picture of character set conversion in \*(UA.
9082 .It Va sendcharsets-else-ttycharset
9083 \*(BO\*(OP If this variable is set, but
9084 .Va sendcharsets
9085 is not, then \*(UA acts as if
9086 .Va sendcharsets
9087 had been set to the value of the variable
9088 .Va ttycharset .
9089 In effect this combination passes through the message data in the
9090 character set of the current locale (given that
9091 .Va ttycharset
9092 has not been set manually), i.e., without converting it to the
9093 .Va charset-8bit
9094 fallback character set.
9095 Thus, mail message text will be in ISO-8859-1 encoding when send from
9096 within a ISO-8859-1 locale, and in UTF-8 encoding when send from within
9097 an UTF-8 locale.
9098 If no character set conversion capabilities are available in \*(UA then
9099 the only supported character set is
9100 .Va ttycharset .
9103 .It Va sender
9104 An address that is put into the
9105 .Ql Sender:
9106 field of outgoing messages, quoting RFC 5322: the mailbox of the agent
9107 responsible for the actual transmission of the message.
9108 This field should normally not be used unless the
9109 .Va from
9110 field contains more than one address, on which case it is required.
9112 .Va \&\&sender
9113 address is handled as if it were in the
9114 .Ic alternates
9115 list; also see
9116 .Fl r ,
9117 .Va r-option-implicit .
9120 .It Va sendmail
9121 \*(OB Predecessor of
9122 .Va mta .
9125 .It Va sendmail-arguments
9126 \*(OB Predecessor of
9127 .Va mta-arguments .
9130 .It Va sendmail-no-default-arguments
9131 \*(OB\*(BO Predecessor of
9132 .Va mta-no-default-arguments .
9135 .It Va sendmail-progname
9136 \*(OB Predecessor of
9137 .Va mta-argv0 .
9140 .It Va sendwait
9141 \*(BO When sending a message wait until the
9142 .Va mta
9143 (including the builtin SMTP one) exits before accepting further commands.
9144 .Sy Only
9145 with this variable set errors reported by the MTA will be recognizable!
9146 If the MTA returns a non-zero exit status,
9147 the exit status of \*(UA will also be non-zero.
9150 .It Va showlast
9151 \*(BO This setting causes \*(UA to start at the last message
9152 instead of the first one when opening a mail folder.
9155 .It Va showname
9156 \*(BO Causes \*(UA to use the sender's real name instead of the plain
9157 address in the header field summary and in message specifications.
9160 .It Va showto
9161 \*(BO Causes the recipient of the message to be shown in the header
9162 summary if the message was sent by the user.
9165 .It Va Sign
9166 The string to expand
9167 .Ic ~A
9168 to (see
9169 .Sx "COMMAND ESCAPES" ) .
9172 .It Va sign
9173 The string to expand
9174 .Ic ~a
9175 to (see
9176 .Sx "COMMAND ESCAPES" ) .
9179 .It Va signature
9180 Must correspond to the name of a readable file if set.
9181 The file's content is then appended to each singlepart message
9182 and to the first part of each multipart message.
9183 Be warned that there is no possibility to edit the signature for an
9184 individual message.
9187 .It Va skipemptybody
9188 \*(BO If an outgoing message does not contain any text in its first or
9189 only message part, do not send it but discard it silently (see also the
9190 command line option
9191 .Fl E ) .
9195 .It Va smime-ca-dir , smime-ca-file
9196 \*(OP Specify the location of trusted CA certificates in PEM (Privacy
9197 Enhanced Mail) format as a directory and a file, respectively, for the
9198 purpose of verification of S/MIME signed messages.
9199 It is possible to set both, the file will be loaded immediately, the
9200 directory will be searched whenever no match has yet been found.
9201 The set of CA certificates which are built into the SSL/TLS library can
9202 be explicitly turned off by setting
9203 .Va smime-ca-no-defaults ,
9204 and further fine-tuning is possible via
9205 .Va smime-ca-flags .
9208 .It Va smime-ca-flags
9209 \*(OP Can be used to fine-tune behaviour of the X509 CA certificate
9210 storage, and the certificate verification that is used.
9211 The actual values and their meanings are documented for
9212 .Va ssl-ca-flags .
9215 .It Va smime-ca-no-defaults
9216 \*(BO\*(OP Do not load the default CA locations that are built into the
9217 used to SSL/TLS library to verify S/MIME signed messages.
9219 .Mx Va smime-cipher
9220 .It Va smime-cipher-USER@HOST , smime-cipher
9221 \*(OP Specifies the cipher to use when generating S/MIME encrypted
9222 messages (for the specified account).
9223 RFC 5751 mandates a default of
9224 .Ql aes128
9225 (AES-128 CBC).
9226 Possible values are (case-insensitive and) in decreasing cipher strength:
9227 .Ql aes256
9228 (AES-256 CBC),
9229 .Ql aes192
9230 (AES-192 CBC),
9231 .Ql aes128
9232 (AES-128 CBC),
9233 .Ql des3
9234 (DES EDE3 CBC, 168 bits; default if
9235 .Ql aes128
9236 is not available) and
9237 .Ql des
9238 (DES CBC, 56 bits).
9240 The actually available cipher algorithms depend on the cryptographic
9241 library that \*(UA uses.
9242 \*(OP Support for more cipher algorithms may be available through
9243 dynamic loading via, e.g.,
9244 .Xr EVP_get_cipherbyname 3
9245 (OpenSSL) if \*(UA has been compiled to support this.
9248 .It Va smime-crl-dir
9249 \*(OP Specifies a directory that contains files with CRLs in PEM format
9250 to use when verifying S/MIME messages.
9253 .It Va smime-crl-file
9254 \*(OP Specifies a file that contains a CRL in PEM format to use when
9255 verifying S/MIME messages.
9258 .It Va smime-encrypt-USER@HOST
9259 \*(OP If this variable is set, messages send to the given receiver are
9260 encrypted before sending.
9261 The value of the variable must be set to the name of a file that
9262 contains a certificate in PEM format.
9264 If a message is sent to multiple recipients,
9265 each of them for whom a corresponding variable is set will receive an
9266 individually encrypted message;
9267 other recipients will continue to receive the message in plain text
9268 unless the
9269 .Va smime-force-encryption
9270 variable is set.
9271 It is recommended to sign encrypted messages, i.e., to also set the
9272 .Va smime-sign
9273 variable.
9276 .It Va smime-force-encryption
9277 \*(BO\*(OP Causes \*(UA to refuse sending unencrypted messages.
9280 .It Va smime-sign
9281 \*(BO\*(OP S/MIME sign outgoing messages with the user's private key
9282 and include the user's certificate as a MIME attachment.
9283 Signing a message enables a recipient to verify that the sender used
9284 a valid certificate,
9285 that the email addresses in the certificate match those in the message
9286 header and that the message content has not been altered.
9287 It does not change the message text,
9288 and people will be able to read the message as usual.
9289 Also see
9290 .Va smime-sign-cert , smime-sign-include-certs
9292 .Va smime-sign-message-digest .
9294 .Mx Va smime-sign-cert
9295 .It Va smime-sign-cert-USER@HOST , smime-sign-cert
9296 \*(OP Points to a file in PEM format.
9297 For the purpose of signing and decryption this file needs to contain the
9298 user's private key, followed by his certificate.
9300 For message signing
9301 .Ql USER@HOST
9302 is always derived from the value of
9303 .Va from
9304 (or, if that contains multiple addresses,
9305 .Va sender ) .
9306 For the purpose of encryption the recipient's public encryption key
9307 (certificate) is expected; the command
9308 .Ic certsave
9309 can be used to save certificates of signed messages (the section
9310 .Sx "Signed and encrypted messages with S/MIME"
9311 gives some details).
9312 This mode of operation is usually driven by the specialized form.
9314 When decrypting messages the account is derived from the recipient
9315 fields
9316 .Pf ( Ql To:
9318 .Ql Cc: )
9319 of the message, which are searched for addresses for which such
9320 a variable is set.
9321 \*(UA always uses the first address that matches,
9322 so if the same message is sent to more than one of the user's addresses
9323 using different encryption keys, decryption might fail.
9325 For signing and decryption purposes it is possible to use encrypted
9326 keys, and the pseudo-host(s)
9327 .Ql USER@HOST.smime-cert-key
9328 for the private key
9329 (and
9330 .Ql USER@HOST.smime-cert-cert
9331 for the certificate stored in the same file)
9332 will be used for performing any necessary password lookup,
9333 therefore the lookup can be automatized via the mechanisms described in
9334 .Sx "On URL syntax and credential lookup" .
9335 For example, the hypothetical address
9336 .Ql bob@exam.ple
9337 could be driven with a private key / certificate pair path defined in
9338 .Va \&\&smime-sign-cert-bob@exam.ple ,
9339 and needed passwords would then be looked up via the pseudo hosts
9340 .Ql bob@exam.ple.smime-cert-key
9341 (and
9342 .Ql bob@exam.ple.smime-cert-cert ) .
9343 To include intermediate certificates, use
9344 .Va smime-sign-include-certs .
9346 .Mx Va smime-sign-include-certs
9347 .It Va smime-sign-include-certs-USER@HOST , smime-sign-include-certs
9348 \*(OP If used, this is supposed to a consist of a comma-separated list
9349 of files, each of which containing a single certificate in PEM format to
9350 be included in the S/MIME message in addition to the
9351 .Va smime-sign-cert
9352 certificate.
9353 This can be used to include intermediate certificates of the certificate
9354 authority, in order to allow the receiver's S/MIME implementation to
9355 perform a verification of the entire certificate chain, starting from
9356 a local root certificate, over the intermediate certificates, down to the
9357 .Va smime-sign-cert .
9358 Even though top level certificates may also be included in the chain,
9359 they won't be used for the verification on the receiver's side.
9361 For the purpose of the mechanisms involved here,
9362 .Ql USER@HOST
9363 refers to the content of the internal variable
9364 .Va from
9365 (or, if that contains multiple addresses,
9366 .Va sender ) .
9367 The pseudo-host
9368 .Ql USER@HOST.smime-include-certs
9369 will be used for performing password lookups for these certificates,
9370 shall they have been given one, therefore the lookup can be automatized
9371 via the mechanisms described in
9372 .Sx "On URL syntax and credential lookup" .
9374 .Mx Va smime-sign-message-digest
9375 .It Va smime-sign-message-digest-USER@HOST , smime-sign-message-digest
9376 \*(OP Specifies the message digest to use when signing S/MIME messages.
9377 RFC 5751 mandates a default of
9378 .Ql sha1 .
9379 Possible values are (case-insensitive and) in decreasing cipher strength:
9380 .Ql sha512 ,
9381 .Ql sha384 ,
9382 .Ql sha256 ,
9383 .Ql sha224
9385 .Ql md5 .
9387 The actually available message digest algorithms depend on the
9388 cryptographic library that \*(UA uses.
9389 \*(OP Support for more message digest algorithms may be available
9390 through dynamic loading via, e.g.,
9391 .Xr EVP_get_digestbyname 3
9392 (OpenSSL) if \*(UA has been compiled to support this.
9393 Remember that for this
9394 .Ql USER@HOST
9395 refers to the variable
9396 .Va from
9397 (or, if that contains multiple addresses,
9398 .Va sender ) .
9401 .It Va smtp
9402 \*(OB\*(OP To use the builtin SMTP transport, specify a SMTP URL in
9403 .Va mta .
9404 \*(ID For compatibility reasons a set
9405 .Va smtp
9406 is used in preference of
9407 .Va mta .
9409 .Mx Va smtp-auth
9410 .It Va smtp-auth-USER@HOST , smtp-auth-HOST , smtp-auth
9411 \*(OP Variable chain that controls the SMTP
9412 .Va mta
9413 authentication method, possible values are
9414 .Ql none
9415 (\*(OU default),
9416 .Ql plain
9417 (\*(IN default),
9418 .Ql login
9419 as well as the \*(OPal methods
9420 .Ql cram-md5
9422 .Ql gssapi .
9424 .Ql none
9425 method does not need any user credentials,
9426 .Ql gssapi
9427 requires a user name and all other methods require a user name and
9428 a password.
9429 See \*(IN
9430 .Va mta ,
9431 .Va user
9433 .Va password
9434 (\*(OU
9435 .Va smtp-auth-password
9437 .Va smtp-auth-user ) .
9438 Note that
9439 .Va smtp-auth-HOST
9440 is \*(IN.
9441 \*(OU: Note for
9442 .Va smtp-auth-USER@HOST :
9443 may override dependent on sender address in the variable
9444 .Va from .
9446 .It Va smtp-auth-password
9447 \*(OP\*(OU Sets the global fallback password for SMTP authentication.
9448 If the authentication method requires a password, but neither
9449 .Va smtp-auth-password
9450 nor a matching
9451 .Va smtp-auth-password-USER@HOST
9452 can be found,
9453 \*(UA will ask for a password on the user's terminal.
9455 .It Va smtp-auth-password-USER@HOST
9456 \*(OU Overrides
9457 .Va smtp-auth-password
9458 for specific values of sender addresses, dependent upon the variable
9459 .Va from .
9461 .It Va smtp-auth-user
9462 \*(OP\*(OU Sets the global fallback user name for SMTP authentication.
9463 If the authentication method requires a user name, but neither
9464 .Va smtp-auth-user
9465 nor a matching
9466 .Va smtp-auth-user-USER@HOST
9467 can be found,
9468 \*(UA will ask for a user name on the user's terminal.
9470 .It Va smtp-auth-user-USER@HOST
9471 \*(OU Overrides
9472 .Va smtp-auth-user
9473 for specific values of sender addresses, dependent upon the variable
9474 .Va from .
9477 .It Va smtp-hostname
9478 \*(OP\*(IN Normally \*(UA uses the variable
9479 .Va from
9480 to derive the necessary
9481 .Ql USER@HOST
9482 information in order to issue a
9483 .Ql MAIL FROM:<>
9484 SMTP
9485 .Va mta
9486 command.
9487 Setting
9488 .Va smtp-hostname
9489 can be used to use the
9490 .Ql USER
9491 from the SMTP account
9492 .Pf ( Va mta
9493 or the
9494 .Va user
9495 variable chain)
9496 and the
9497 .Ql HOST
9498 from the content of this variable (or, if that is the empty string,
9499 .Va hostname
9500 or the local hostname as a last resort).
9501 This often allows using an address that is itself valid but hosted by
9502 a provider other than which (in
9503 .Va from )
9504 is about to send the message.
9505 Setting this variable also influences generated
9506 .Ql Message-ID:
9508 .Ql Content-ID:
9509 header fields.
9511 .Mx Va smtp-use-starttls
9512 .It Va smtp-use-starttls-USER@HOST , smtp-use-starttls-HOST , smtp-use-starttls
9513 \*(BO\*(OP Causes \*(UA to issue a
9514 .Ql STARTTLS
9515 command to make an SMTP
9516 .Va mta
9517 session SSL/TLS encrypted, i.e., to enable transport layer security.
9521 .It Va spam-interface
9522 \*(OP In order to use any of the spam-related commands (like, e.g.,
9523 .Ic spamrate )
9524 the desired spam interface must be defined by setting this variable.
9525 Please refer to the manual section
9526 .Sx "Handling spam"
9527 for the complete picture of spam handling in \*(UA.
9528 All or none of the following interfaces may be available:
9530 .Bl -tag -width ".It Ql _ilte_"
9531 .It Ql spamc
9532 Interaction with
9533 .Xr spamc 1
9534 from the
9535 .Xr spamassassin 1
9536 .Pf ( Lk http://spamassassin.apache.org SpamAssassin )
9537 suite.
9538 Different to the generic filter interface \*(UA will automatically add
9539 the correct arguments for a given command and has the necessary
9540 knowledge to parse the program's output.
9541 A default value for
9542 .Va spamc-command
9543 will have been compiled into the \*(UA binary if
9544 .Xr spamc 1
9545 has been found in
9546 .Ev PATH
9547 during compilation.
9548 Shall it be necessary to define a specific connection type (rather than
9549 using a configuration file for that), the variable
9550 .Va spamc-arguments
9551 can be used as in, e.g.,
9552 .Ql -d server.example.com -p 783 .
9553 It is also possible to specify a per-user configuration via
9554 .Va spamc-user .
9555 Note that this interface does not inspect the
9556 .Ql is-spam
9557 flag of a message for the command
9558 .Ic spamforget .
9560 .It Ql filter
9561 generic spam filter support via freely configurable hooks.
9562 This interface is meant for programs like
9563 .Xr bogofilter 1
9564 and requires according behaviour in respect to the hooks' exit
9565 status for at least the command
9566 .Ic spamrate
9567 .Pf ( Ql 0
9568 meaning a message is spam,
9569 .Ql 1
9570 for non-spam,
9571 .Ql 2
9572 for unsure and any other return value indicating a hard error);
9573 since the hooks can include shell code snippets diverting behaviour
9574 can be intercepted as necessary.
9575 The hooks are
9576 .Va spamfilter-ham , spamfilter-noham , spamfilter-nospam , \
9577   spamfilter-rate
9579 .Va spamfilter-spam ;
9580 the manual section
9581 .Sx "Handling spam"
9582 contains examples for some programs.
9583 The process environment of the hooks will have the variable
9584 .Ev MAILX_FILENAME_GENERATED
9585 set.
9586 Note that spam score support for
9587 .Ic spamrate
9588 is not supported unless the \*(OPtional regular expression support is
9589 available and the
9590 .Va spamfilter-rate-scanscore
9591 variable is set.
9596 .It Va spam-maxsize
9597 \*(OP Messages that exceed this size will not be passed through to the
9598 configured
9599 .Va spam-interface .
9600 If unset or 0, the default of 420000 bytes is used.
9603 .It Va spamc-command
9604 \*(OP The path to the
9605 .Xr spamc 1
9606 program for the
9607 .Ql spamc
9608 .Va spam-interface .
9609 Note that the path is not expanded, but used
9610 .Dq as is .
9611 A fallback path will have been compiled into the \*(UA binary if the
9612 executable had been found during compilation.
9615 .It Va spamc-arguments
9616 \*(OP Even though \*(UA deals with most arguments for the
9617 .Ql spamc
9618 .Va spam-interface
9619 automatically, it may at least sometimes be desirable to specify
9620 connection-related ones via this variable, e.g.,
9621 .Ql -d server.example.com -p 783 .
9624 .It Va spamc-user
9625 \*(OP Specify a username for per-user configuration files for the
9626 .Ql spamc
9627 .Va spam-interface .
9628 If this is set to the empty string then \*(UA will use the name of the
9629 current
9630 .Va user .
9637 .It Va spamfilter-ham , spamfilter-noham , \
9638   spamfilter-nospam , spamfilter-rate , spamfilter-spam
9639 \*(OP Command and argument hooks for the
9640 .Ql filter
9641 .Va spam-interface .
9642 The manual section
9643 .Sx "Handling spam"
9644 contains examples for some programs.
9647 .It Va spamfilter-rate-scanscore
9648 \*(OP Because of the generic nature of the
9649 .Ql filter
9650 .Va spam-interface
9651 spam scores are not supported for it by default, but if the \*(OPnal
9652 regular expression support is available then setting this variable can
9653 be used to overcome this restriction.
9654 It is interpreted as follows: first a number (digits) is parsed that
9655 must be followed by a semicolon
9656 .Ql \&;
9657 and an extended regular expression.
9658 Then the latter is used to parse the first output line of the
9659 .Va spamfilter-rate
9660 hook, and, in case the evaluation is successful, the group that has been
9661 specified via the number is interpreted as a floating point scan score.
9665 .It Va ssl-ca-dir , ssl-ca-file
9666 \*(OP Specify the location of trusted CA certificates in PEM (Privacy
9667 Enhanced Mail) format as a directory and a file, respectively, for the
9668 purpose of verification of SSL/TLS server certificates.
9669 It is possible to set both, the file will be loaded immediately, the
9670 directory will be searched whenever no match has yet been found.
9671 The set of CA certificates which are built into the SSL/TLS library can
9672 be explicitly turned off by setting
9673 .Va ssl-ca-no-defaults ,
9674 and further fine-tuning is possible via
9675 .Va ssl-ca-flags ;
9676 also see
9677 .Xr SSL_CTX_load_verify_locations 3
9678 for more information.
9682 .It Va ssl-ca-flags
9683 \*(OP Can be used to fine-tune behaviour of the X509 CA certificate
9684 storage, and the certificate verification that is used (also see
9685 .Va ssl-verify ) .
9686 The value is expected to consist of a comma-separated list of
9687 configuration directives, with any intervening whitespace being ignored.
9688 The directives directly map to flags that can be passed to
9689 .Xr X509_STORE_set_flags 3 ,
9690 which are usually defined in a file
9691 .Pa openssl/x509_vfy.h ,
9692 and the availability of which depends on the used SSL/TLS library
9693 version: a directive without mapping is ignored (error log subject to
9694 .Va debug ) .
9695 Directives currently understood (case-insensitively) include:
9698 .Bl -tag -compact -width ".It Cd BaNg"
9699 .It Cd no-alt-chains
9700 If the initial chain is not trusted, do not attempt to build an
9701 alternative chain.
9702 Setting this flag will make OpenSSL certificate verification match that
9703 of older OpenSSL versions, before automatic building and checking of
9704 alternative chains has been implemented; also see
9705 .Cd trusted-first .
9706 .It Cd no-check-time
9707 Do not check certificate/CRL validity against current time.
9708 .It Cd partial-chain
9709 By default partial, incomplete chains which cannot be verified up to the
9710 chain top, a self-signed root certificate, will not verify.
9711 With this flag set, a chain succeeds to verify if at least one signing
9712 certificate of the chain is in any of the configured trusted stores of
9713 CA certificates.
9714 The OpenSSL manual page
9715 .Xr SSL_CTX_load_verify_locations 3
9716 gives some advise how to manage your own trusted store of CA certificates.
9717 .It Cd strict
9718 Disable workarounds for broken certificates.
9719 .It Cd trusted-first
9720 Try building a chain using issuers in the trusted store first to avoid
9721 problems with server-sent legacy intermediate certificates.
9722 Newer versions of OpenSSL support alternative chain checking and enable
9723 it by default, resulting in the same behaviour; also see
9724 .Cd no-alt-chains .
9729 .It Va ssl-ca-no-defaults
9730 \*(BO\*(OP Do not load the default CA locations that are built into the
9731 used to SSL/TLS library to verify SSL/TLS server certificates.
9733 .Mx Va ssl-cert
9734 .It Va ssl-cert-USER@HOST , ssl-cert-HOST , ssl-cert
9735 \*(OP Variable chain that sets the file name for a SSL/TLS client
9736 certificate required by some servers.
9737 This is a direct interface to the
9738 .Ql Certificate
9739 slot of the
9740 .Xr SSL_CONF_cmd 3
9741 function of the OpenSSL library, if available.
9743 .Mx Va ssl-cipher-list
9744 .It Va ssl-cipher-list-USER@HOST , ssl-cipher-list-HOST , ssl-cipher-list
9745 \*(OP Specifies a list of ciphers for SSL/TLS connections.
9746 This is a direct interface to the
9747 .Ql CipherString
9748 slot of the
9749 .Xr SSL_CONF_cmd 3
9750 function of the OpenSSL library, if available; see
9751 .Xr ciphers 1
9752 for more information.
9753 By default \*(UA does not set a list of ciphers, in effect using a
9754 .Va ssl-protocol
9755 specific cipher (protocol standards ship with a list of acceptable
9756 ciphers), possibly cramped to what the actually used SSL/TLS library
9757 supports \(en the manual section
9758 .Sx "An example configuration"
9759 also contains a SSL/TLS use case.
9762 .It Va ssl-config-file
9763 \*(OP If this variable is set \*(UA will call
9764 .Xr CONF_modules_load_file 3
9765 to allow OpenSSL to be configured according to the host system wide
9766 security settings.
9767 If a non-empty value is given then this will be used to specify the
9768 configuration file to be used instead of the global OpenSSL default;
9769 note that in this case it is an error if the file cannot be loaded.
9770 The application name will always be passed as
9771 .Dq \*(uA .
9775 .It Va ssl-crl-dir , ssl-crl-file
9776 \*(OP Specify a directory / a file, respectively that contains a CRL in
9777 PEM format to use when verifying SSL/TLS server certificates.
9779 .Mx Va ssl-key
9780 .It Va ssl-key-USER@HOST , ssl-key-HOST , ssl-key
9781 \*(OP Variable chain that sets the file name for the private key of
9782 a SSL/TLS client certificate.
9783 If unset, the name of the certificate file is used.
9784 The file is expected to be in PEM format.
9785 This is a direct interface to the
9786 .Ql PrivateKey
9787 slot of the
9788 .Xr SSL_CONF_cmd 3
9789 function of the OpenSSL library, if available.
9791 .Mx Va ssl-method
9792 .It Va ssl-method-USER@HOST , ssl-method-HOST , ssl-method
9793 \*(OB\*(OP Please use the newer and more flexible
9794 .Va ssl-protocol
9795 instead: if both values are set,
9796 .Va ssl-protocol
9797 will take precedence!
9798 Can be set to the following values, the actually used
9799 .Va ssl-protocol
9800 specification to which it is mapped is shown in parenthesis:
9801 .Ql tls1.2
9802 .Pf ( Ql -ALL, TLSv1.2 ) ,
9803 .Ql tls1.1
9804 .Pf ( Ql -ALL, TLSv1.1 ) ,
9805 .Ql tls1
9806 .Pf ( Ql -ALL, TLSv1 )
9808 .Ql ssl3
9809 .Pf ( Ql -ALL, SSLv3 ) ;
9810 the special value
9811 .Ql auto
9812 is mapped to
9813 .Ql ALL, -SSLv2
9814 and thus includes the SSLv3 protocol.
9815 Note that SSLv2 is no longer supported at all.
9817 .Mx Va ssl-protocol
9818 .It Va ssl-protocol-USER@HOST , ssl-protocol-HOST , ssl-protocol
9819 \*(OP Specify the used SSL/TLS protocol.
9820 This is a direct interface to the
9821 .Ql Protocol
9822 slot of the
9823 .Xr SSL_CONF_cmd 3
9824 function of the OpenSSL library, if available;
9825 otherwise an \*(UA internal parser is used which understands the
9826 following subset of (case-insensitive) command strings:
9827 .Ql SSLv3 ,
9828 .Ql TLSv1 ,
9829 .Ql TLSv1.1
9831 .Ql TLSv1.2 ,
9832 as well as the special value
9833 .Ql ALL .
9834 Multiple specifications may be given via a comma-separated list which
9835 ignores any whitespace.
9836 An optional
9837 .Ql +
9838 plus sign prefix will enable a protocol, a
9839 .Ql -
9840 hyphen-minus prefix will disable it, so that
9841 .Ql -ALL, TLSv1.2
9842 will enable only the TLSv1.2 protocol.
9844 It depends upon the used TLS/SSL library which protocols are actually
9845 supported and which protocols are used if
9846 .Va ssl-protocol
9847 is not set, but note that SSLv2 is no longer supported at all and
9848 actively disabled.
9849 Especially for older protocols explicitly securing
9850 .Va ssl-cipher-list
9851 may be worthwile, see
9852 .Sx "An example configuration" .
9855 .It Va ssl-rand-egd
9856 \*(OP Gives the pathname to an entropy daemon socket, see
9857 .Xr RAND_egd 3 .
9858 Not all SSL/TLS libraries support this.
9861 .It Va ssl-rand-file
9862 \*(OP Gives the filename to a file with random entropy data, see
9863 .Xr RAND_load_file 3 .
9864 If this variable is not set, or set to the empty string, or if the
9865 .Sx "Filename transformations"
9866 fail, then
9867 .Xr RAND_file_name 3
9868 will be used to create the filename if, and only if,
9869 .Xr RAND_status 3
9870 documents that the SSL PRNG is not yet sufficiently seeded.
9871 If \*(UA successfully seeded the SSL PRNG then it will update the file
9872 .Pf ( Xr RAND_write_file 3 ) .
9873 This variable is only used if
9874 .Va ssl-rand-egd
9875 is not set (or not supported by the SSL/TLS library).
9877 .Mx Va ssl-verify
9878 .It Va ssl-verify-USER@HOST , ssl-verify-HOST , ssl-verify
9879 \*(OP Variable chain that sets the action to be performed if an error
9880 occurs during SSL/TLS server certificate validation against the
9881 specified or default trust stores
9882 .Va ssl-ca-dir ,
9883 .Va ssl-ca-file ,
9884 or the SSL/TLS library builtin defaults (unless usage disallowed via
9885 .Va ssl-ca-no-defaults ) ,
9886 and as fine-tuned via
9887 .Va ssl-ca-flags .
9888 Valid (case-insensitive) values are
9889 .Ql strict
9890 (fail and close connection immediately),
9891 .Ql ask
9892 (ask whether to continue on standard input),
9893 .Ql warn
9894 (show a warning and continue),
9895 .Ql ignore
9896 (do not perform validation).
9897 The default is
9898 .Ql ask .
9901 .It Va stealthmua
9902 If only set without an assigned value, then this setting inhibits the
9903 generation of the
9904 .Ql Message-ID: ,
9905 .Ql Content-ID:
9907 .Ql User-Agent:
9908 header fields that include obvious references to \*(UA.
9909 There are two pitfalls associated with this:
9910 First, the message id of outgoing messages is not known anymore.
9911 Second, an expert may still use the remaining information in the header
9912 to track down the originating mail user agent.
9913 If set to the value
9914 .Ql noagent ,
9915 then the mentioned
9916 .Ql Message-ID:
9918 .Ql Content-ID:
9919 suppression does not occur.
9923 .It Va termcap
9924 (\*(OP) This specifies a comma-separated list of
9925 .Lb libterminfo
9926 and/or
9927 .Lb libtermcap
9928 capabilities (see
9929 .Sx "On terminal control and line editor" ,
9930 escape commas with reverse solidus) to be used to overwrite or define
9931 entries.
9932 Note that this variable will only be queried once at program startup and
9933 can thus only be specified in resource files or on the command line.
9936 String capabilities form
9937 .Ql cap=value
9938 pairs and are expected unless noted otherwise.
9939 Numerics have to be notated as
9940 .Ql cap#number
9941 where the number is expected in normal decimal notation.
9942 Finally, booleans do not have any value but indicate a true or false
9943 state simply by being defined or not; this indeed means that \*(UA
9944 does not support undefining an existing boolean.
9945 String capability values will undergo some expansions before use:
9946 for one notations like
9947 .Ql ^LETTER
9948 stand for
9949 .Ql control-LETTER ,
9950 and for clarification purposes
9951 .Ql \eE
9952 can be used to specify
9953 .Ql escape
9954 (the control notation
9955 .Ql ^[
9956 could lead to misreadings when a left bracket follows, which it does for
9957 the standard CSI sequence);
9958 finally three letter octal sequences, as in
9959 .Ql \e061 ,
9960 are supported.
9961 To specify that a terminal supports 256-colours, and to define sequences
9962 that home the cursor and produce an audible bell, one might write:
9964 .Bd -literal -offset indent
9965 set termcap='Co#256,home=\eE[H,bel=^G'
9969 The following terminal capabilities are or may be meaningful for the
9970 operation of the builtin line editor or \*(UA in general:
9973 .Bl -tag -compact -width yay
9974 .\" HAVE_COLOUR
9975 .It Cd colors Ns \0or Cd Co
9976 .Cd max_colors :
9977 numeric capability specifying the maximum number of colours.
9978 Note that \*(UA does not actually care about the terminal beside that,
9979 but always emits ANSI / ISO 6429 escape sequences.
9981 .\" HAVE_TERMCAP
9982 .It Cd rmcup Ns \0or Cd te Ns \0/ Cd smcup Ns \0or Cd ti
9983 .Cd exit_ca_mode
9985 .Cd enter_ca_mode ,
9986 respectively: exit and enter the alternative screen
9987 .Dq ca-mode ,
9988 effectively turning \*(UA into a fullscreen application.
9989 To disable that, set (at least) one to the empty string.
9991 .It Cd smkx Ns \0or Cd ks Ns \0/ Cd rmkx Ns \0or Cd ke
9992 .Cd keypad_xmit
9994 .Cd keypad_local ,
9995 respectively: enable and disable the keypad.
9996 This is always enabled if available, because it seems even keyboards
9997 without keypads generate other key codes for, e.g., cursor keys in that
9998 case, and only if enabled we see the codes that we are interested in.
10000 .It Cd ed Ns \0or Cd cd
10001 .Cd clr_eos :
10002 clear the screen.
10004 .It Cd clear Ns \0or Cd cl
10005 .Cd clear_screen :
10006 clear the screen and home cursor.
10007 (Will be simulated via
10008 .Cd ho
10009 plus
10010 .Cd cd . )
10012 .It Cd home Ns \0or Cd ho
10013 .Cd cursor_home :
10014 home cursor.
10016 .\" HAVE_MLE
10017 .It Cd el Ns \0or Cd ce
10018 .Cd clr_eol :
10019 clear to the end of line.
10020 (Will be simulated via
10021 .Cd ch
10022 plus repetitions of space characters.)
10024 .It Cd hpa Ns \0or Cd ch
10025 .Cd column_address :
10026 move the cursor (to the given column parameter) in the current row.
10027 (Will be simulated via
10028 .Cd cr
10029 plus
10030 .Cd nd . )
10032 .It Cd cr
10033 .Cd carriage_return :
10034 move to the first column in the current row.
10035 The default builtin fallback is
10036 .Ql \er .
10038 .It Cd cub1 Ns \0or Cd le
10039 .Cd cursor_left :
10040 move the cursor left one space (non-destructively).
10041 The default builtin fallback is
10042 .Ql \eb .
10044 .It Cd cuf1 Ns \0or Cd nd
10045 .Cd cursor_right :
10046 move the cursor right one space (non-destructively).
10047 The default builtin fallback is
10048 .Ql \eE[C ,
10049 which is used by most terminals.
10050 Less often occur
10051 .Ql \eEC
10053 .Ql \eEOC .
10057 Many more capabilities which describe key-sequences are documented for
10058 .Ic bind .
10061 .It Va termcap-disable
10062 \*(OP Disable any interaction with a terminal control library.
10063 If set only some generic fallback builtins and possibly the content of
10064 .Va termcap
10065 describe the terminal to \*(UA.
10066 .Sy Note
10067 that this variable will only be queried once at program startup and can
10068 thus only be specified in resource files or on the command line.
10071 .It Va toplines
10072 If defined, gives the number of lines of a message to be displayed
10073 with the command
10074 .Ic top ;
10075 if unset, the first five lines are printed, if set to 0 the variable
10076 .Va screen
10077 is inspected.
10078 If the value is negative then its absolute value will be used for
10079 unsigned right shifting (see
10080 .Ic vexpr )
10082 .Va screen
10083 height.
10086 .It Va topsqueeze
10087 \*(BO If set then the
10088 .Ic top
10089 command series will strip adjacent empty lines and quotations.
10092 .It Va ttycharset
10093 The character set of the terminal \*(UA operates on,
10094 and the one and only supported character set that \*(UA can use if no
10095 character set conversion capabilities have been compiled into it,
10096 in which case it defaults to ISO-8859-1 unless it can deduce a value
10097 from the
10098 .Ev LC_CTYPE
10099 locale environment.
10100 It defaults to UTF-8 if conversion is available.
10101 Refer to the section
10102 .Sx "Character sets"
10103 for the complete picture about character sets.
10106 .It Va typescript-mode
10107 \*(BO A special multiplex variable that disables all variables and
10108 settings which result in behaviour that interferes with running \*(UA in
10109 .Xr script 1 ,
10110 e.g., it sets
10111 .Va colour-disable ,
10112 .Va line-editor-disable
10113 and (before startup completed only)
10114 .Va termcap-disable .
10115 Unsetting it does not restore the former state of the covered settings.
10118 .It Va umask
10119 For a safety-by-default policy \*(UA sets its process
10120 .Xr umask 2
10122 .Ql 0077 ,
10123 but this variable can be used to override that:
10124 set it to an empty value to do not change the (current) setting,
10125 otherwise the process file mode creation mask is updated to the new value.
10126 Child processes inherit the process file mode creation mask.
10128 .Mx Va user
10129 .It Va user-HOST , user
10130 \*(IN Variable chain that sets a global fallback user name, which is
10131 used in case none has been given in the protocol and account-specific
10132 URL.
10133 This variable defaults to the name of the user who runs \*(UA.
10136 .It Va v15-compat
10137 \*(BO Setting this enables upward compatibility with \*(UA
10138 version 15.0 in respect to which configuration options are available and
10139 how they are handled.
10140 This manual uses \*(IN and \*(OU to refer to the new and the old way of
10141 doing things, respectively.
10144 .It Va verbose
10145 \*(BO This setting, also controllable via the command line option
10146 .Fl v ,
10147 causes \*(UA to be more verbose, e.g., it will display obsoletion
10148 warnings and SSL/TLS certificate chains.
10149 Even though marked \*(BO this option may be set twice in order to
10150 increase the level of verbosity even more, in which case even details of
10151 the actual message delivery and protocol conversations are shown.
10152 A single
10153 .Pf no Va verbose
10154 is sufficient to disable verbosity as such.
10160 .It Va version , version-major , version-minor , version-update
10161 \*(RO \*(UA version information: the first variable contains a string
10162 containing the complete version identification, the latter three contain
10163 only digits: the major, minor and update version numbers.
10164 The output of the command
10165 .Ic version
10166 will include this information.
10169 .It Va writebackedited
10170 If this variable is set messages modified using the
10171 .Ic edit
10173 .Ic visual
10174 commands are written back to the current folder when it is quit;
10175 it is only honoured for writable folders in MBOX format, though.
10176 Note that the editor will be pointed to the raw message content in that
10177 case, i.e., neither MIME decoding nor decryption will have been
10178 performed, and proper RFC 4155
10179 .Ql From_
10180 quoting of newly added or edited content is also left as an excercise to
10181 the user.
10183 .\" }}} (Variables)
10184 .\" }}} (INTERNAL VARIABLES)
10187 .\" .Sh ENVIRONMENT {{{
10188 .Sh ENVIRONMENT
10190 The term
10191 .Dq environment variable
10192 should be considered an indication that these variables are either
10193 standardized as vivid parts of process environments, or that they are
10194 commonly found in there.
10195 The process environment is inherited from the
10196 .Xr sh 1
10197 once \*(UA is started, and unless otherwise explicitly noted handling of
10198 the following variables transparently integrates into that of the
10199 .Sx "INTERNAL VARIABLES"
10200 from \*(UA's point of view.
10201 This means that, e.g., they can be managed via
10202 .Ic set
10204 .Ic unset ,
10205 causing automatic program environment updates (to be inherited by
10206 newly created child processes).
10209 In order to transparently integrate other environment variables equally
10210 they need to be imported (linked) with the command
10211 .Ic environ .
10212 This command can also be used to set and unset non-integrated
10213 environment variables from scratch, sufficient system support provided.
10214 The following example, applicable to a POSIX shell, sets the
10215 .Ev COLUMNS
10216 environment variable for \*(UA only, and beforehand exports the
10217 .Ev EDITOR
10218 in order to affect any further processing in the running shell:
10220 .Bd -literal -offset indent
10221 $ EDITOR="vim -u ${HOME}/.vimrc"
10222 $ export EDITOR
10223 $ COLUMNS=80 \*(uA -R
10226 .Bl -tag -width ".It Ev BaNg"
10228 .It Ev COLUMNS
10229 The user's preferred width in column positions for the terminal screen
10230 or window.
10231 Queried and used once on program startup, actively managed for child
10232 processes and the MLE (see
10233 .Sx "On terminal control and line editor" )
10234 in interactive mode thereafter.
10237 .It Ev DEAD
10238 The name of the (mailbox)
10239 .Ic file
10240 to use for saving aborted messages if
10241 .Va save
10242 is set; this defaults to
10243 .Pa dead.letter
10244 in the user's
10245 .Ev HOME
10246 directory.
10247 If the variable
10248 .Va debug
10249 is set no output will be generated, otherwise the contents of the file
10250 will be replaced.
10253 .It Ev EDITOR
10254 Pathname of the text editor to use in the
10255 .Ic edit
10256 command and
10257 .Ic ~e
10258 .Sx "COMMAND ESCAPES" .
10259 A default editor is used if this value is not defined.
10262 .It Ev HOME
10263 The user's home directory.
10264 This variable is only used when it resides in the process environment.
10271 .It Ev LANG , LC_ALL , LC_COLLATE , LC_CTYPE , LC_MESSAGES
10273 .Xr locale 7
10275 .Sx "Character sets" .
10278 .It Ev LINES
10279 The user's preferred number of lines on a page or the vertical screen
10280 or window size in lines.
10281 Queried and used once on program startup, actively managed for child
10282 processes in interactive mode thereafter.
10285 .It Ev LISTER
10286 Pathname of the directory lister to use in the
10287 .Ic folders
10288 command when operating on local mailboxes.
10289 Default is
10290 .Xr ls 1
10291 (path search through
10292 .Ev SHELL ) .
10295 .It Ev LOGNAME
10296 Upon startup \*(UA will actively ensure that this variable refers to the
10297 name of the user who runs \*(UA, in order to be able to pass a verified
10298 name to any newly created child process.
10301 .It Ev MAIL
10302 Is used as the users
10303 .Mx -sx
10304 .Sx "primary system mailbox"
10305 unless
10306 .Va inbox
10307 is set.
10308 This is assumed to be an absolute pathname.
10311 .It Ev MAILCAPS
10312 \*(OP Overrides the default path search for
10313 .Sx "The Mailcap files" ,
10314 which is defined in the standard RFC 1524 as
10315 .Ql ~/.mailcap:\:/etc/mailcap:\:/usr/etc/mailcap:\:/usr/local/etc/mailcap .
10316 .\" TODO we should have a mailcaps-default virtual RDONLY option!
10317 (\*(UA makes it a configuration option, however.)
10318 Note this is not a search path, but a path search.
10321 .It Ev MAILRC
10322 Is used as a startup file instead of
10323 .Pa \*(ur
10324 if set.
10325 When \*(UA scripts are invoked on behalf of other users,
10326 either this variable should be set to
10327 .Pa /dev/null
10328 or the
10329 .Fl \&:
10330 command line option should be used in order to avoid side-effects from
10331 reading their configuration files.
10332 This variable is only used when it resides in the process environment.
10335 .It Ev MAILX_NO_SYSTEM_RC
10336 If this variable is set then reading of
10337 .Pa \*(UR
10338 at startup is inhibited, i.e., the same effect is achieved as if \*(UA
10339 had been started up with the option
10340 .Fl \&:
10341 (and according argument) or
10342 .Fl n .
10343 This variable is only used when it resides in the process environment.
10346 .It Ev MBOX
10347 The name of the users mbox file.
10348 A logical subset of the special
10349 .Sx "Filename transformations"
10350 (also see
10351 .Ic file )
10352 are supported.
10353 The fallback default is
10354 .Pa mbox
10355 in the user's
10356 .Ev HOME
10357 directory.
10358 Traditionally this
10359 .Mx -sx
10360 .Sx "secondary mailbox"
10361 is used as the file to save messages from the
10362 .Mx -sx
10363 .Sx "primary system mailbox"
10364 that have been read.
10365 Also see
10366 .Sx "Message states" .
10369 .It Ev NETRC
10370 \*(IN\*(OP This variable overrides the default location of the user's
10371 .Pa .netrc
10372 file.
10375 .It Ev PAGER
10376 Pathname of the program to use for backing the command
10377 .Ic more ,
10378 and when the
10379 .Va crt
10380 variable enforces usage of a pager for output.
10381 The default paginator is
10382 .Xr more 1
10383 (path search through
10384 .Ev SHELL ) .
10386 \*(UA inspects the contents of this variable: if its contains the string
10387 .Dq less
10388 then a non-existing environment variable
10389 .Va LESS
10390 will be set to
10391 .Ql FRXi ,
10392 .Ql FRi
10394 .Ql Ri ,
10395 dependent on whether terminal control support is available and whether
10396 that supports full (alternative) screen mode or not (also see
10397 .Sx "On terminal control and line editor" ) .
10398 Likewise for
10399 .Dq lv
10400 .Va LV
10401 will optionally be set to
10402 .Dq -c .
10403 Alse see
10404 .Va colour-pager .
10407 .It Ev PATH
10408 A colon-separated list of directories that is searched by the shell when
10409 looking for commands, e.g.,
10410 .Ql /bin:/usr/bin:/usr/local/bin .
10413 .It Ev POSIXLY_CORRECT
10414 This variable is automatically looked for upon startup, see
10415 .Va posix
10416 for more.
10419 .It Ev SHELL
10420 The shell to use for the commands
10421 .Ic \&! ,
10422 .Ic shell ,
10424 .Ic ~!
10425 .Sx "COMMAND ESCAPES"
10426 and when starting subprocesses.
10427 A default shell is used if this environment variable is not defined.
10430 .It Ev SOURCE_DATE_EPOCH
10431 If set, this specifies a time in seconds since the Unix epoch
10432 (1970-01-01) to be used in place of the current time.
10433 This is for the sake of reproduceability of tests, to be used during
10434 development or by software packagers.
10437 .It Ev TERM
10438 \*(OP The terminal type for which output is to be prepared.
10439 For extended colour and font control please refer to
10440 .Sx "Coloured display" ,
10441 and for terminal management in general to
10442 .Sx "On terminal control and line editor" .
10445 .It Ev TMPDIR
10446 Used as directory for temporary files instead of
10447 .Pa /tmp ,
10448 if set.
10449 This variable is only used when it resides in the process environment,
10450 but \*(UA will ensure at startup that this environment variable is
10451 updated to contain a usable temporary directory.
10454 .It Ev USER
10455 Identical to
10456 .Ev LOGNAME
10457 (see there), but this variable is not standardized, should therefore not
10458 be used, and is only corrected if already set.
10461 .It Ev VISUAL
10462 Pathname of the text editor to use in the
10463 .Ic visual
10464 command and
10465 .Ic ~v
10466 .Sx "COMMAND ESCAPES" .
10468 .\" }}}
10471 .\" .Sh FILES {{{
10472 .Sh FILES
10474 .Bl -tag -width ".It Pa BaNg"
10475 .It Pa \*(ur
10476 File giving initial commands.
10478 .It Pa \*(UR
10479 System wide initialization file.
10482 .It Pa ~/.mailcap
10483 \*(OP Personal MIME type handler definition file, see
10484 .Sx "The Mailcap files" .
10485 (RFC 1524 location, the actual path is a configuration option.)
10488 .It Pa /etc/mailcap
10489 \*(OP System wide MIME type handler definition file, see
10490 .Sx "The Mailcap files" .
10491 (RFC 1524 location, the actual path is a configuration option.)
10494 .It Pa ~/.mime.types
10495 Personal MIME types, see
10496 .Sx "The mime.types files" .
10499 .It Pa /etc/mime.types
10500 System wide MIME types, see
10501 .Sx "The mime.types files" .
10504 .It Pa ~/.netrc
10505 \*(IN\*(OP The default location of the users
10506 .Pa .netrc
10507 file \(en the section
10508 .Sx "The .netrc file"
10509 documents the file format.
10512 .\" .Ss "The mime.types files" {{{
10513 .Ss "The mime.types files"
10515 When sending messages \*(UA tries to determine the content type of all
10516 attachments.
10517 When displaying message content or attachments \*(UA uses the content
10518 type to decide whether it can directly display data or whether it needs
10519 to deal with content handlers.
10520 It learns about M(ultipurpose) I(nternet) M(ail) E(xtensions) types and
10521 how to treat them by reading
10522 .Pa mime.types
10523 files, the loading of which can be controlled by setting the variable
10524 .Va mimetypes-load-control .
10525 (The command
10526 .Ic mimetype
10527 can also be used to deal with MIME types.)
10528 .Pa mime.types
10529 files have the following syntax:
10532 .Dl type/subtype extension [extension ...]
10535 where
10536 .Ql type/subtype
10537 are strings describing the file contents, and one or multiple
10538 .Ql extension Ns
10539 s, separated by whitespace, name the part of a filename starting after
10540 the last dot (of interest).
10541 Comments may be introduced anywhere on a line with a number sign
10542 .Ql # ,
10543 causing the remaining line to be discarded.
10545 \*(UA also supports an extended, non-portable syntax in specially
10546 crafted files, which can be loaded via the alternative value syntax of
10547 .Va mimetypes-load-control
10548 and prepends an optional
10549 .Ql type-marker :
10552 .Dl [type-marker ]type/subtype extension [extension ...]
10555 The following type markers are supported:
10558 .Bl -tag -compact -width ".It Ar _n_u"
10559 .It Ar @
10560 Treat message parts with this content as plain text.
10561 .It Ar @t@
10562 The same as plain
10563 .Ar @ .
10564 .It Ar @h@
10565 Treat message parts with this content as HTML tagsoup.
10566 If the \*(OPal HTML-tagsoup-to-text converter is not available treat
10567 the content as plain text instead.
10568 .It Ar @H@
10569 Likewise
10570 .Ar @h@
10571 but instead of falling back to plain text require an explicit content
10572 handler to be defined.
10576 Further reading:
10577 for sending messages:
10578 .Ic mimetype ,
10579 .Va mime-allow-text-controls ,
10580 .Va mimetypes-load-control .
10581 For reading etc. messages:
10582 .Sx "HTML mail and MIME attachments" ,
10583 .Sx "The Mailcap files" ,
10584 .Ic mimetype ,
10585 .Va mime-counter-evidence ,
10586 .Va mimetypes-load-control ,
10587 .Va pipe-TYPE/SUBTYPE ,
10588 .Va pipe-EXTENSION .
10589 .\" }}}
10591 .\" .Ss "The Mailcap files" {{{
10592 .Ss "The Mailcap files"
10594 .\" TODO MAILCAP DISABLED
10595 .Sy This feature is not available in v14.9.0, sorry!
10596 RFC 1524 defines a
10597 .Dq User Agent Configuration Mechanism
10598 which \*(UA \*(OPally supports.
10599 It defines a file format to be used to inform mail user agent programs
10600 about the locally-installed facilities for handling various data
10601 formats, i.e., about commands and how they can be used to display, edit
10602 etc. MIME part contents, as well as a default path search that includes
10603 multiple possible locations of
10604 .Dq mailcap
10605 files and the
10606 .Ev MAILCAPS
10607 environment variable that can be used to overwrite that (repeating here
10608 that it is not a search path, but instead a path search specification).
10609 Any existing files will be loaded in sequence, appending any content to
10610 the list of MIME type handler directives.
10613 .Dq Mailcap
10614 files consist of a set of newline separated entries.
10615 Comment lines start with a number sign
10616 .Ql #
10617 (in the first column!) and are ignored.
10618 Empty lines are also ignored.
10619 All other lines form individual entries that must adhere to the syntax
10620 described below.
10621 To extend a single entry (not comment) its line can be continued on
10622 follow lines if newline characters are
10623 .Dq escaped
10624 by preceding them with the reverse solidus character
10625 .Ql \e .
10626 The standard does not specify how leading whitespace of follow lines
10627 is to be treated, therefore \*(UA retains it.
10630 .Dq Mailcap
10631 entries consist of a number of semicolon
10632 .Ql \&;
10633 separated fields, and the reverse solidus
10634 .Ql \e
10635 character can be used to escape any following character including
10636 semicolon and itself.
10637 The first two fields are mandatory and must occur in the specified
10638 order, the remaining fields are optional and may appear in any order.
10639 Leading and trailing whitespace of content is ignored (removed).
10642 The first field defines the MIME
10643 .Ql TYPE/SUBTYPE
10644 the entry is about to handle (case-insensitively, and no reverse solidus
10645 escaping is possible in this field).
10646 If the subtype is specified as an asterisk
10647 .Ql *
10648 the entry is meant to match all subtypes of the named type, e.g.,
10649 .Ql audio/*
10650 would match any audio type.
10651 The second field defines the shell command which shall be used to
10652 .Dq display
10653 MIME parts of the given type; it is implicitly called the
10654 .Cd view
10655 command.
10658 For data
10659 .Dq consuming
10660 shell commands message (MIME part) data is passed via standard input
10661 unless the given shell command includes one or more instances of the
10662 (unquoted) string
10663 .Ql %s ,
10664 in which case these instances will be replaced with a temporary filename
10665 and the data will have been stored in the file that is being pointed to.
10666 Likewise, for data
10667 .Dq producing
10668 shell commands data is assumed to be generated on standard output unless
10669 the given command includes (one ore multiple)
10670 .Ql %s .
10671 In any case any given
10672 .Ql %s
10673 format is replaced with a(n already) properly quoted filename.
10674 Note that when a command makes use of a temporary file via
10675 .Ql %s
10676 then \*(UA will remove it again, as if the
10677 .Cd x-mailx-tmpfile ,
10678 .Cd x-mailx-tmpfile-fill
10680 .Cd x-mailx-tmpfile-unlink
10681 flags had been set; see below for more.
10684 The optional fields either define a shell command or an attribute (flag)
10685 value, the latter being a single word and the former being a keyword
10686 naming the field followed by an equals sign
10687 .Ql =
10688 succeeded by a shell command, and as usual for any
10689 .Dq Mailcap
10690 content any whitespace surrounding the equals sign will be removed, too.
10691 Optional fields include the following:
10694 .Bl -tag -width ".It Cd BaNg"
10695 .It Cd compose
10696 A program that can be used to compose a new body or body part in the
10697 given format.
10698 (Currently unused.)
10700 .It Cd composetyped
10701 Similar to the
10702 .Cd compose
10703 field, but is to be used when the composing program needs to specify the
10704 .Ql Content-type:
10705 header field to be applied to the composed data.
10706 (Currently unused.)
10708 .It Cd edit
10709 A program that can be used to edit a body or body part in the given
10710 format.
10711 (Currently unused.)
10713 .It Cd print
10714 A program that can be used to print a message or body part in the given
10715 format.
10716 (Currently unused.)
10718 .It Cd test
10719 Specifies a program to be run to test some condition, e.g., the machine
10720 architecture, or the window system in use, to determine whether or not
10721 this mailcap entry applies.
10722 If the test fails, a subsequent mailcap entry should be sought; also see
10723 .Cd x-mailx-test-once .
10725 .It Cd needsterminal
10726 This flag field indicates that the given shell command must be run on
10727 an interactive terminal.
10728 \*(UA will temporarily release the terminal to the given command in
10729 interactive mode, in non-interactive mode this entry will be entirely
10730 ignored; this flag implies
10731 .Cd x-mailx-noquote .
10733 .It Cd copiousoutput
10734 A flag field which indicates that the output of the
10735 .Cd view
10736 command will be an extended stream of textual output that can be
10737 (re)integrated into \*(UA's normal visual display.
10738 It is mutually exclusive with
10739 .Cd needsterminal
10740 and implies
10741 .Cd x-mailx-always .
10743 .It Cd textualnewlines
10744 A flag field which indicates that this type of data is line-oriented and
10745 that, if encoded in
10746 .Ql base64 ,
10747 all newlines should be converted to canonical form (CRLF) before
10748 encoding, and will be in that form after decoding.
10749 (Currently unused.)
10751 .It Cd nametemplate
10752 This field gives a file name format, in which
10753 .Ql %s
10754 will be replaced by a random string, the joined combination of which
10755 will be used as the filename denoted by
10756 .Ev MAILX_FILENAME_TEMPORARY .
10757 One could specify that a GIF file being passed to an image viewer should
10758 have a name ending in
10759 .Ql .gif
10760 by using
10761 .Ql nametemplate=%s.gif .
10762 Note that \*(UA ignores the name template unless that solely specifies
10763 a filename suffix that consists of (ASCII) alphabetic and numeric
10764 characters, the underscore and dot only.
10766 .It Cd x11-bitmap
10767 Names a file, in X11 bitmap (xbm) format, which points to an appropriate
10768 icon to be used to visually denote the presence of this kind of data.
10769 This field is not used by \*(UA.
10771 .It Cd description
10772 A textual description that describes this type of data.
10774 .It Cd x-mailx-always
10775 Extension flag field that denotes that the given
10776 .Cd view
10777 command shall be executed even if multiple messages will be displayed
10778 at once.
10779 Normally messages which require external viewers that produce output
10780 which does not integrate into \*(UA's visual display (i.e., do not have
10781 .Cd copiousoutput
10782 set) have to be addressed directly and individually.
10783 (To avoid cases where, e.g., a thousand PDF viewer instances are spawned
10784 in sequence.)
10786 .It Cd x-mailx-even-if-not-interactive
10787 An extension flag test field \(em by default handlers without
10788 .Cd copiousoutput
10789 are entirely ignored in non-interactive mode, but if this flag is set
10790 then their use will be considered.
10791 It is an error if this flag is set for commands that use the flag
10792 .Cd needsterminal .
10794 .It Cd x-mailx-noquote
10795 An extension flag field that indicates that even a
10796 .Cd copiousoutput
10797 .Cd view
10798 command shall not be used to generate message quotes
10799 (as it would be by default).
10801 .It Cd x-mailx-async
10802 Extension flag field that denotes that the given
10803 .Cd view
10804 command shall be executed asynchronously, without blocking \*(UA.
10805 Cannot be used in conjunction with
10806 .Cd needsterminal .
10808 .It Cd x-mailx-test-once
10809 Extension flag which denotes whether the given
10810 .Cd test
10811 command shall be evaluated once only and the (boolean) result be cached.
10812 This is handy if some global unchanging condition is to be queried, like
10813 .Dq running under the X Window System .
10815 .It Cd x-mailx-tmpfile
10816 Extension flag field that requests creation of a zero-sized temporary
10817 file, the name of which is to be placed in the environment variable
10818 .Ev MAILX_FILENAME_TEMPORARY .
10819 It is an error to use this flag with commands that include a
10820 .Ql %s
10821 format.
10823 .It Cd x-mailx-tmpfile-fill
10824 Normally the MIME part content is passed to the handler via standard
10825 input; if this flag is set then the data will instead be written into
10826 the implied
10827 .Cd x-mailx-tmpfile .
10828 In order to cause deletion of the temporary file you will have to set
10829 .Cd x-mailx-tmpfile-unlink
10830 explicitly!
10831 It is an error to use this flag with commands that include a
10832 .Ql %s
10833 format.
10835 .It Cd x-mailx-tmpfile-unlink
10836 Extension flag field that requests that the temporary file shall be
10837 deleted automatically when the command loop is entered again at latest.
10838 (Do not use this for asynchronous handlers.)
10839 It is an error to use this flag with commands that include a
10840 .Ql %s
10841 format, or without also setting
10842 .Cd x-mailx-tmpfile
10844 .Cd x-mailx-tmpfile-fill .
10846 .It Cd x-mailx-tmpfile-keep
10847 Using the string
10848 .Ql %s
10849 implies the three tmpfile related flags above, but if you want, e.g.,
10850 .Cd x-mailx-async
10851 and deal with the temporary file yourself, you can add in this flag to
10852 forcefully ignore
10853 .Cd x-mailx-tmpfile-unlink .
10858 The standard includes the possibility to define any number of additional
10859 entry fields, prefixed by
10860 .Ql x- .
10861 Flag fields apply to the entire
10862 .Dq Mailcap
10863 entry \(em in some unusual cases, this may not be desirable, but
10864 differentiation can be accomplished via separate entries, taking
10865 advantage of the fact that subsequent entries are searched if an earlier
10866 one does not provide enough information.
10867 E.g., if a
10868 .Cd view
10869 command needs to specify the
10870 .Cd needsterminal
10871 flag, but the
10872 .Cd compose
10873 command shall not, the following will help out the latter (with enabled
10874 .Va debug
10875 or an increased
10876 .Va verbose
10877 level \*(UA will show information about handler evaluation):
10879 .Bd -literal -offset indent
10880 application/postscript; ps-to-terminal %s; needsterminal
10881 application/postscript; ps-to-terminal %s; compose=idraw %s
10885 In fields any occurrence of the format string
10886 .Ql %t
10887 will be replaced by the
10888 .Ql TYPE/SUBTYPE
10889 specification.
10890 Named parameters from the
10891 .Ql Content-type:
10892 field may be placed in the command execution line using
10893 .Ql %{
10894 followed by the parameter name and a closing
10895 .Ql }
10896 character.
10897 The entire parameter should appear as a single command line argument,
10898 regardless of embedded spaces; thus:
10900 .Bd -literal -offset indent
10901 # Message
10902 Content-type:  multipart/mixed; boundary=42
10904 # Mailcap file
10905 multipart/*; /usr/local/bin/showmulti \e
10906   %t %{boundary}  ;  composetyped  = /usr/local/bin/makemulti
10908 # Executed shell command
10909 /usr/local/bin/showmulti multipart/mixed 42
10913 .\" TODO v15: Mailcap: %n,%F
10914 Note that \*(UA does not support handlers for multipart MIME parts as
10915 shown in this example (as of today).
10916 \*(UA does not support the additional formats
10917 .Ql %n
10919 .Ql %F .
10920 An example file, also showing how to properly deal with the expansion of
10921 .Ql %s ,
10922 which includes any quotes that are necessary to make it a valid shell
10923 argument by itself and thus will cause undesired behaviour when placed
10924 in additional user-provided quotes:
10926 .Bd -literal -offset indent
10927 # Comment line
10928 text/richtext; richtext %s; copiousoutput
10930 text/x-perl; perl -cWT %s
10932 application/pdf; \e
10933   infile=%s\e; \e
10934     trap "rm -f ${infile}" EXIT\e; \e
10935     trap "exit 75" INT QUIT TERM\e; \e
10936     mupdf %s; \e
10937   x-mailx-async; x-mailx-tmpfile-keep
10939 application/*; echo "This is \e"%t\e" but \e
10940     is 50 \e% Greek to me" \e; < %s head -c 1024 | cat -vET; \e
10941   copiousoutput; x-mailx-noquote
10945 Further reading:
10946 .Sx "HTML mail and MIME attachments" ,
10947 .Sx "The mime.types files" ,
10948 .Ic mimetype ,
10949 .Ev MAILCAPS ,
10950 .Va mime-counter-evidence ,
10951 .Va pipe-TYPE/SUBTYPE ,
10952 .Va pipe-EXTENSION .
10953 .\" }}}
10955 .\" .Ss "The .netrc file" {{{
10956 .Ss "The .netrc file"
10959 .Pa .netrc
10960 file contains user credentials for machine accounts.
10961 The default location in the user's
10962 .Ev HOME
10963 directory may be overridden by the
10964 .Ev NETRC
10965 environment variable.
10966 The file consists of space, tabulator or newline separated tokens.
10967 \*(UA implements a parser that supports a superset of the original BSD
10968 syntax, but users should nonetheless be aware of portability glitches
10969 of that file format, shall their
10970 .Pa .netrc
10971 be usable across multiple programs and platforms:
10974 .Bl -bullet -compact
10976 BSD does not support single, but only double quotation marks, e.g.,
10977 .Ql password="pass with spaces" .
10979 BSD (only?) supports escaping of single characters via a reverse solidus
10980 (e.g., a space can be escaped via
10981 .Ql \e\0 ) ,
10982 in- as well as outside of a quoted string.
10984 BSD does not require a final quotation mark of the last user input token.
10986 The original BSD (Berknet) parser also supported a format which allowed
10987 tokens to be separated with commas \(en whereas at least Hewlett-Packard
10988 still seems to support this syntax, \*(UA does not!
10990 As a non-portable extension some widely-used programs support
10991 shell-style comments: if an input line starts, after any amount of
10992 whitespace, with a number sign
10993 .Ql # ,
10994 then the rest of the line is ignored.
10996 Whereas other programs may require that the
10997 .Pa .netrc
10998 file is accessible by only the user if it contains a
10999 .Cd password
11000 token for any other
11001 .Cd login
11002 than
11003 .Dq anonymous ,
11004 \*(UA will always require these strict permissions.
11008 Of the following list of supported tokens \*(UA only uses (and caches)
11009 .Cd machine ,
11010 .Cd login
11012 .Cd password .
11013 At runtime the command
11014 .Ic netrc
11015 can be used to control \*(UA's
11016 .Pa .netrc
11017 cache.
11019 .Bl -tag -width ".It Cd BaNg"
11020 .It Cd machine Ar name
11021 The hostname of the entries' machine, lowercase-normalized by \*(UA
11022 before use.
11023 Any further file content, until either end-of-file or the occurrence
11024 of another
11025 .Cd machine
11026 or a
11027 .Cd default
11028 first-class token is bound (only related) to the machine
11029 .Ar name .
11031 As an extension that should not be the cause of any worries
11032 \*(UA supports a single wildcard prefix for
11033 .Ar name :
11034 .Bd -literal -offset indent
11035 machine *.example.com login USER password PASS
11036 machine pop3.example.com login USER password PASS
11037 machine smtp.example.com login USER password PASS
11040 which would match
11041 .Ql xy.example.com
11042 as well as
11043 .Ql pop3.example.com ,
11044 but neither
11045 .Ql example.com
11047 .Ql local.smtp.example.com .
11048 Note that in the example neither
11049 .Ql pop3.example.com
11051 .Ql smtp.example.com
11052 will be matched by the wildcard, since the exact matches take
11053 precedence (it is however faster to specify it the other way around).
11055 .It Cd default
11056 This is the same as
11057 .Cd machine
11058 except that it is a fallback entry that is used shall none of the
11059 specified machines match; only one default token may be specified,
11060 and it must be the last first-class token.
11062 .It Cd login Ar name
11063 The user name on the remote machine.
11065 .It Cd password Ar string
11066 The user's password on the remote machine.
11068 .It Cd account Ar string
11069 Supply an additional account password.
11070 This is merely for FTP purposes.
11072 .It Cd macdef Ar name
11073 Define a macro.
11074 A macro is defined with the specified
11075 .Ar name ;
11076 it is formed from all lines beginning with the next line and continuing
11077 until a blank line is (consecutive newline characters are) encountered.
11078 (Note that
11079 .Cd macdef
11080 entries cannot be utilized by multiple machines, too, but must be
11081 defined following the
11082 .Ic machine
11083 they are intended to be used with.)
11084 If a macro named
11085 .Ar init
11086 exists, it is automatically run as the last step of the login process.
11087 This is merely for FTP purposes.
11089 .\" }}}
11091 .\" }}}
11094 .\" .Sh EXAMPLES {{{
11095 .Sh EXAMPLES
11097 .\" .Ss "An example configuration" {{{
11098 .Ss "An example configuration"
11100 .Bd -literal -offset indent
11101 # This example assumes v15.0 compatibility mode
11102 set v15-compat
11104 # Request strict transport security checks!
11105 set ssl-verify=strict
11107 # Where are the up-to-date SSL certificates?
11108 # (Since we manage up-to-date ones explicitly, do not use any,
11109 # possibly outdated, default certificates shipped with OpenSSL)
11110 #set ssl-ca-dir=/etc/ssl/certs
11111 set ssl-ca-file=/etc/ssl/certs/ca-certificates.crt
11112 set ssl-ca-no-defaults
11113 #set ssl-ca-flags=partial-chain
11114 wysh set smime-ca-file="${ssl-ca-file}" \e
11115   smime-ca-no-defaults #smime-ca-flags="${ssl-ca-flags}"
11117 # Do not use protocols older than TLS v1.2.
11118 # Change this only when the remote server does not support it:
11119 # maybe use ssl-protocol-HOST (or -USER@HOST) syntax to define
11120 # such explicit exceptions, then, e.g.
11121 #   set ssl-protocol-exam.ple='-ALL,+TLSv1.1'
11122 set ssl-protocol='-ALL,+TLSv1.2'
11124 # Explicitly define the list of ciphers, which may improve security,
11125 # especially with protocols older than TLS v1.2.  See ciphers(1).
11126 # Including "@STRENGTH" will sort the final list by algorithm strength.
11127 # In reality it is possibly best to only use ssl-cipher-list-HOST
11128 # (or -USER@HOST), as necessary, again..
11129 set ssl-cipher-list=TLSv1.2:!aNULL:!eNULL:@STRENGTH
11130 # TLSv1.2:!aNULL:!eNULL:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:\e
11131     DHE-RSA-AES256-SHA:@STRENGTH
11132 # ALL:!aNULL:!eNULL:!MEDIUM:!LOW:!MD5:!RC4:!EXPORT:@STRENGTH
11134 # Essential setting: select allowed character sets
11135 set sendcharsets=utf-8,iso-8859-1
11137 # A very kind option: when replying to a message, first try to
11138 # use the same encoding that the original poster used herself!
11139 set reply-in-same-charset
11141 # When replying to or forwarding a message the comment and name
11142 # parts of email addresses are removed unless this variable is set
11143 set fullnames
11145 # When sending messages, wait until the Mail-Transfer-Agent finishs.
11146 # Only like this you will be able to see errors reported through the
11147 # exit status of the MTA (including the builtin SMTP one)!
11148 set sendwait
11150 # Only use builtin MIME types, no mime.types(5) files
11151 set mimetypes-load-control
11153 # Default directory where we act in (relative to $HOME)
11154 set folder=mail
11155 # A leading "+" (often) means: under *folder*
11156 # *record* is used to save copies of sent messages
11157 set MBOX=+mbox.mbox record=+sent.mbox DEAD=+dead.txt
11159 # Make "file mymbox" and "file myrec" go to..
11160 shortcut mymbox %:+mbox.mbox myrec +sent.mbox
11162 # Not really optional, e.g., for S/MIME
11163 set from='Your Name <address@exam.ple>'
11165 # It may be necessary to set hostname and/or smtp-hostname
11166 # if the "SERVER" of mta and "domain" of from do not match.
11167 # The `urlencode' command can be used to encode USER and PASS
11168 set mta=(smtps?|submission)://[USER[:PASS]@]SERVER[:PORT] \e
11169   smtp-auth=login/plain... \e
11170   smtp-use-starttls
11172 # Never refuse to start into interactive mode, and more
11173 set emptystart \e
11174   colour-pager crt= \e
11175   followup-to followup-to-honour=ask-yes \e
11176   history-file=+.\*(uAhist history-size=-1 history-gabby \e
11177   mime-counter-evidence=0xE \e
11178   prompt='?\e?!\e![\e${-account}#\e${-mailbox-display}]? ' \e
11179   reply-to-honour=ask-yes \e
11180   umask=
11182 # Only include the selected header fields when typing messages
11183 headerpick type retain add from_ date from to cc subject \e
11184   message-id mail-followup-to reply-to
11185 # ...when forwarding messages
11186 headerpick forward retain add subject date from to cc
11187 # ...when saving message, etc.
11188 #headerpick save ignore add ^Original-.*$ ^X-.*$
11190 # Some mailing lists
11191 mlist '@xyz-editor\e.xyz$' '@xyzf\e.xyz$'
11192 mlsubscribe '^xfans@xfans\e.xyz$'
11194 # A real life example of a very huge free mail provider
11195 account XooglX {
11196   set folder=~/spool/XooglX inbox=+syste.mbox sent=+sent
11197   set from='Your Name <address@examp.ple>'
11198   set mta=smtp://USER:PASS@smtp.gmXil.com smtp-use-starttls
11201 # Here is a pretty large one which does not allow sending mails
11202 # if there is a domain name mismatch on the SMTP protocol level,
11203 # which would bite us if the value of from does not match, e.g.,
11204 # for people who have a sXXXXeforge project and want to speak
11205 # with the mailing list under their project account (in from),
11206 # still sending the message through their normal mail provider
11207 account XandeX {
11208   set folder=~/spool/XandeX inbox=+syste.mbox sent=+sent
11209   set from='Your Name <address@exam.ple>'
11210   set mta=smtps://USER:PASS@smtp.yaXXex.ru:465 \e
11211     hostname=yaXXex.com smtp-hostname=
11214 # Create some new commands so that, e.g., `ls /tmp' will..
11215 wysh ghost lls '!ls ${LS_COLOR_FLAG} -aFlrS'
11216 wysh ghost llS '!ls ${LS_COLOR_FLAG} -aFlS'
11217 wysh ghost ls '!ls ${LS_COLOR_FLAG} -aFrS'
11218 wysh ghost lS '!ls ${LS_COLOR_FLAG} -aFS'
11219 wysh ghost lla '!ls ${LS_COLOR_FLAG} -aFlr'
11220 wysh ghost llA '!ls ${LS_COLOR_FLAG} -aFl'
11221 wysh ghost la '!ls ${LS_COLOR_FLAG} -aFr'
11222 wysh ghost lA '!ls ${LS_COLOR_FLAG} -aF'
11223 wysh ghost ll '!ls ${LS_COLOR_FLAG} -aFltr'
11224 wysh ghost lL '!ls ${LS_COLOR_FLAG} -aFlt'
11225 wysh ghost l '!ls ${LS_COLOR_FLAG} -aFtr'
11226 wysh ghost L '!ls ${LS_COLOR_FLAG} -aFt'
11228 # We do not support gpg(1) directly yet.  But simple --clearsign'd
11229 # message parts can be dealt with as follows:
11230 define V {
11231   localopts yes
11232   wysh set pipe-text/plain=$'@*#++=@\e
11233     < "${MAILX_FILENAME_TEMPORARY}" awk \e
11234         -v TMPFILE="${MAILX_FILENAME_TEMPORARY}" \e'\e
11235       BEGIN{done=0}\e
11236       /^-----BEGIN PGP SIGNED MESSAGE-----/,/^$/ {\e
11237         if(done++ != 0)\e
11238           next;\e
11239         print "--- GPG --verify ---";\e
11240         system("gpg --verify " TMPFILE " 2>&1");\e
11241         print "--- GPG --verify ---";\e
11242         print "";\e
11243         next;\e
11244       }\e
11245       /^-----BEGIN PGP SIGNATURE-----/,\e
11246           /^-----END PGP SIGNATURE-----/{\e
11247         next;\e
11248       }\e
11249       {print}\e
11250     \e''
11251     print
11253 ghost V '\e'call V
11255 define RK {
11256   !printf 'Key IDs to gpg --recv-keys: ';\e
11257     read keyids;\e
11258     gpg --recv-keys ${keyids};
11260 ghost RK call RK
11264 When storing passwords in
11265 .Pa \*(ur
11266 appropriate permissions should be set on this file with
11267 .Ql $ chmod 0600 \*(ur .
11268 If the \*(OPal
11269 .Va netrc-lookup
11270 is available user credentials can be stored in the central
11271 .Pa .netrc
11272 file instead; e.g., here is a different version of the example account
11273 that sets up SMTP and POP3:
11275 .Bd -literal -offset indent
11276 account XandeX {
11277   call XandeX
11279 define XandeX {
11280   set folder=~/spool/XandeX inbox=+syste.mbox sent=+sent
11281   set from='Your Name <address@exam.ple>'
11282   set netrc-lookup
11283   # Load an encrypted ~/.netrc by uncommenting the next line
11284   #set netrc-pipe='gpg -qd ~/.netrc.pgp'
11286   set mta=smtps://smtp.yXXXXx.ru:465 \e
11287       smtp-hostname= hostname=yXXXXx.com
11288   set pop3-keepalive=240 pop3-no-apop-pop.yXXXXx.ru
11289   ghost xp fi pop3s://pop.yXXXXx.ru
11294 and, in the
11295 .Pa .netrc
11296 file:
11298 .Bd -literal -offset indent
11299 machine *.yXXXXx.ru login USER password PASS
11303 This configuration should now work just fine:
11306 .Dl $ echo text | \*(uA -vv -AXandeX -s Subject user@exam.ple
11307 .\" }}}
11309 .\" .Ss "Signed and encrypted messages with S/MIME" {{{
11310 .Ss "Signed and encrypted messages with S/MIME"
11312 \*(OP S/MIME provides two central mechanisms:
11313 message signing and message encryption.
11314 A signed message contains some data in addition to the regular text.
11315 The data can be used to verify that the message was sent using a valid
11316 certificate, that the sender's address in the message header matches
11317 that in the certificate, and that the message text has not been altered.
11318 Signing a message does not change its regular text;
11319 it can be read regardless of whether the recipient's software is able to
11320 handle S/MIME.
11323 It is thus usually possible to sign all outgoing messages if so desired.
11324 Encryption, in contrast, makes the message text invisible for all people
11325 except those who have access to the secret decryption key.
11326 To encrypt a message, the specific recipient's public encryption key
11327 must be known.
11328 It is therefore not possible to send encrypted mail to people unless their
11329 key has been retrieved from either previous communication or public key
11330 directories.
11331 A message should always be signed before it is encrypted.
11332 Otherwise, it is still possible that the encrypted message text is
11333 altered.
11336 A central concept to S/MIME is that of the certification authority (CA).
11337 A CA is a trusted institution that issues certificates.
11338 For each of these certificates it can be verified that it really
11339 originates from the CA, provided that the CA's own certificate is
11340 previously known.
11341 A set of CA certificates is usually delivered with OpenSSL and installed
11342 on your system.
11343 If you trust the source of your OpenSSL software installation,
11344 this offers reasonable security for S/MIME on the Internet.
11345 Otherwise set
11346 .Va smime-ca-no-defaults
11347 to avoid using the default certificate and point
11348 .Va smime-ca-file
11349 and/or
11350 .Va smime-ca-dir
11351 to a trusted pool of certificates.
11352 In general, a certificate cannot be more secure than the method its CA
11353 certificate has been retrieved with.
11356 The first thing you need for participating in S/MIME message exchange is
11357 your personal certificate, including a private key.
11358 The certificate contains public information, in particular your name and
11359 your email address(es), and the public key that is used by others to
11360 encrypt messages for you,
11361 and to verify signed messages they supposedly received from you.
11362 The certificate is included in each signed message you send.
11363 The private key must be kept secret.
11364 It is used to decrypt messages that were previously encrypted with your
11365 public key, and to sign messages.
11368 For personal use it is recommended that you get a S/MIME certificate
11369 from one of the major CAs on the Internet using your WWW browser.
11370 Many CAs offer such certificates for free.
11371 There is also
11372 .Lk https://www.CAcert.org
11373 which issues client and server certificates to members of their
11374 community for free; their root certificate
11375 .Pf ( Lk https://\:www.cacert.org/\:certs/\:root.crt )
11376 is often not in the default set of trusted CA root certificates, though,
11377 which means you will have to download their root certificate separately
11378 and ensure it is part of our S/MIME certificate validation chain by
11379 including it in
11380 .Va smime-ca-dir
11381 or as a vivid member of the
11382 .Va smime-ca-file .
11383 But let us take a step-by-step tour on how to setup S/MIME with
11384 a certificate from CAcert.org despite this situation!
11387 First of all you will have to become a member of the CAcert.org
11388 community, simply by registrating yourself via the web interface.
11389 Once you are, create and verify all email addresses you want to be able
11390 to create signed and encrypted messages for/with using the corresponding
11391 entries of the web interface.
11392 Now ready to create S/MIME certificates, so let us create a new
11393 .Dq client certificate ,
11394 ensure to include all email addresses that should be covered by the
11395 certificate in the following web form, and also to use your name as the
11396 .Dq common name .
11399 Create a private key and a certificate request on your local computer
11400 (please see the manual pages of the used commands for more in-depth
11401 knowledge on what the used arguments etc. do):
11404 .Dl openssl req -nodes -newkey rsa:4096 -keyout key.pem -out creq.pem
11407 Afterwards copy-and-paste the content of
11408 .Dq creq.pem
11409 into the certificate-request (CSR) field of the web form on the
11410 CAcert.org website (you may need to unfold some
11411 .Dq advanced options
11412 to see the corresponding text field).
11413 This last step will ensure that your private key (which never left your
11414 box) and the certificate belong together (through the public key that
11415 will find its way into the certificate via the certificate-request).
11416 You are now ready and can create your CAcert certified certificate.
11417 Download and store or copy-and-paste it as
11418 .Dq pub.crt .
11421 Yay.
11422 In order to use your new S/MIME setup a combined private key/public key
11423 (certificate) file has to be created:
11426 .Dl cat key.pem pub.crt > ME@HERE.com.paired
11429 This is the file \*(UA will work with.
11430 If you have created your private key with a passphrase then \*(UA will
11431 ask you for it whenever a message is signed or decrypted.
11432 Set the following variables to henceforth use S/MIME (setting
11433 .Va smime-ca-file
11434 is of interest for verification only):
11436 .Bd -literal -offset indent
11437 set smime-ca-file=ALL-TRUSTED-ROOT-CERTS-HERE \e
11438   smime-sign-cert=ME@HERE.com.paired \e
11439   smime-sign-message-digest=SHA256 \e
11440   smime-sign
11444 From each signed message you send, the recipient can fetch your
11445 certificate and use it to send encrypted mail back to you.
11446 Accordingly if somebody sends you a signed message, you can do the same,
11447 and use the
11448 .Ic verify
11449 command to check the validity of the certificate.
11452 Variables of interest for S/MIME signing:
11453 .Va smime-ca-dir ,
11454 .Va smime-ca-file ,
11455 .Va smime-ca-flags ,
11456 .Va smime-ca-no-defaults ,
11457 .Va smime-crl-dir ,
11458 .Va smime-crl-file ,
11459 .Va smime-sign ,
11460 .Va smime-sign-cert ,
11461 .Va smime-sign-include-certs
11463 .Va smime-sign-message-digest .
11466 After it has been verified save the certificate via
11467 .Ic certsave
11468 and tell \*(UA that it should use it for encryption for further
11469 communication with that somebody:
11471 .Bd -literal -offset indent
11472 certsave FILENAME
11473 set smime-encrypt-USER@HOST=FILENAME \e
11474     smime-cipher-USER@HOST=AES256
11478 Additional variables of interest for S/MIME en- and decryption:
11479 .Va smime-cipher
11481 .Va smime-encrypt-USER@HOST .
11484 You should carefully consider if you prefer to store encrypted messages
11485 in decrypted form.
11486 If you do, anybody who has access to your mail folders can read them,
11487 but if you do not, you might be unable to read them yourself later if
11488 you happen to lose your private key.
11490 .Ic decrypt
11491 command saves messages in decrypted form, while the
11492 .Ic save , copy ,
11494 .Ic move
11495 commands leave them encrypted.
11498 Note that neither S/MIME signing nor encryption applies to message
11499 subjects or other header fields yet.
11500 Thus they may not contain sensitive information for encrypted messages,
11501 and cannot be trusted even if the message content has been verified.
11502 When sending signed messages,
11503 it is recommended to repeat any important header information in the
11504 message text.
11505 .\" }}}
11507 .\" .Ss "Using CRLs with S/MIME or SSL/TLS" {{{
11508 .Ss "Using CRLs with S/MIME or SSL/TLS"
11510 \*(OP Certification authorities (CAs) issue certificate revocation
11511 lists (CRLs) on a regular basis.
11512 These lists contain the serial numbers of certificates that have been
11513 declared invalid after they have been issued.
11514 Such usually happens because the private key for the certificate has
11515 been compromised,
11516 because the owner of the certificate has left the organization that is
11517 mentioned in the certificate, etc.
11518 To seriously use S/MIME or SSL/TLS verification,
11519 an up-to-date CRL is required for each trusted CA.
11520 There is otherwise no method to distinguish between valid and
11521 invalidated certificates.
11522 \*(UA currently offers no mechanism to fetch CRLs, nor to access them on
11523 the Internet, so they have to be retrieved by some external mechanism.
11526 \*(UA accepts CRLs in PEM format only;
11527 CRLs in DER format must be converted, like, e.\|g.:
11530 .Dl $ openssl crl \-inform DER \-in crl.der \-out crl.pem
11533 To tell \*(UA about the CRLs, a directory that contains all CRL files
11534 (and no other files) must be created.
11536 .Va smime-crl-dir
11538 .Va ssl-crl-dir
11539 variables, respectively, must then be set to point to that directory.
11540 After that, \*(UA requires a CRL to be present for each CA that is used
11541 to verify a certificate.
11542 .\" }}}
11544 .\" .Ss "Handling spam" {{{
11545 .Ss "Handling spam"
11547 \*(OP \*(UA can make use of several spam interfaces for the purpose of
11548 identification of, and, in general, dealing with spam messages.
11549 A precondition of most commands in order to function is that the
11550 .Va spam-interface
11551 variable is set to one of the supported interfaces.
11552 Once messages have been identified as spam their (volatile)
11553 .Ql is-spam
11554 state can be prompted: the
11555 .Ql Ar :s
11557 .Ql Ar :S
11558 message specifications will address respective messages and their
11559 .Va attrlist
11560 entries will be used when displaying the
11561 .Va headline
11562 in the header display.
11564 .Bl -bullet
11566 .Ic spamrate
11567 rates the given messages and sets their
11568 .Ql is-spam
11569 flag accordingly.
11570 If the spam interface offers spam scores those can also be displayed in
11571 the header display by including the
11572 .Ql %$
11573 format in the
11574 .Va headline
11575 variable.
11577 .Ic spamham ,
11578 .Ic spamspam
11580 .Ic spamforget
11581 will interact with the Bayesian filter of the chosen interface and learn
11582 the given messages as
11583 .Dq ham
11585 .Dq spam ,
11586 respectively; the last command can be used to cause
11587 .Dq unlearning
11588 of messages; it adheres to their current
11589 .Ql is-spam
11590 state and thus reverts previous teachings.
11592 .Ic spamclear
11594 .Ic spamset
11595 will simply set and clear, respectively, the mentioned volatile
11596 .Ql is-spam
11597 message flag, without any interface interaction.
11602 .Xr spamassassin 1
11603 based
11604 .Va spam-interface
11605 .Ql spamc
11606 requires a running instance of the
11607 .Xr spamd 1
11608 server in order to function, started with the option
11609 .Fl -allow-tell
11610 shall Bayesian filter learning be possible.
11612 .Bd -literal -offset indent
11613 $ spamd -i localhost:2142 -i /tmp/.spamsock -d [-L] [-l]
11614 $ spamd --listen=localhost:2142 --listen=/tmp/.spamsock \e
11615     --daemonize [--local] [--allow-tell]
11619 Thereafter \*(UA can make use of these interfaces:
11621 .Bd -literal -offset indent
11622 $ \*(uA -Sspam-interface=spamc -Sspam-maxsize=500000 \e
11623     -Sspamc-command=/usr/local/bin/spamc \e
11624     -Sspamc-arguments="-U /tmp/.spamsock" -Sspamc-user=
11626 $ \*(uA -Sspam-interface=spamc -Sspam-maxsize=500000 \e
11627     -Sspamc-command=/usr/local/bin/spamc \e
11628     -Sspamc-arguments="-d localhost -p 2142" -Sspamc-user=
11632 Using the generic filter approach allows usage of programs like
11633 .Xr bogofilter 1 .
11634 Here is an example, requiring it to be accessible via
11635 .Ev PATH :
11637 .Bd -literal -offset indent
11638 $ \*(uA -Sspam-interface=filter -Sspam-maxsize=500000 \e
11639     -Sspamfilter-ham="bogofilter -n" \e
11640     -Sspamfilter-noham="bogofilter -N" \e
11641     -Sspamfilter-nospam="bogofilter -S" \e
11642     -Sspamfilter-rate="bogofilter -TTu 2>/dev/null" \e
11643     -Sspamfilter-spam="bogofilter -s" \e
11644     -Sspamfilter-rate-scanscore="1;^(.+)$"
11648 Because messages must exist on local storage in order to be scored (or
11649 used for Bayesian filter training), it is possibly a good idea to
11650 perform the local spam check last:
11652 .Bd -literal -offset indent
11653 define spamdelhook {
11654   # Server side DCC
11655   spamset (header x-dcc-brand-metrics "bulk")
11656   # Server-side spamassassin(1)
11657   spamset (header x-spam-flag "YES")
11658   del :s # TODO we HAVE to be able to do `spamrate :u ! :sS'
11659   move :S +maybe-spam
11660   spamrate :u
11661   del :s
11662   move :S +maybe-spam
11664 set folder-hook-FOLDER=spamdelhook
11668 See also the documentation for the variables
11669 .Va spam-interface , spam-maxsize ,
11670 .Va spamc-command , spamc-arguments , spamc-user ,
11671 .Va spamfilter-ham , spamfilter-noham , spamfilter-nospam , \
11672   spamfilter-rate
11674 .Va spamfilter-rate-scanscore .
11675 .\" }}}
11676 .\" }}} (Examples)
11679 .\" .Sh "FAQ" {{{
11680 .Sh "FAQ"
11682 In general it is a good idea to turn on
11683 .Va debug
11684 .Pf ( Fl d )
11685 and / or
11686 .Va verbose
11687 .Pf ( Fl v ,
11688 twice) if something does not work well.
11689 Very often a diagnostic message can be produced that leads to the
11690 problems' solution.
11692 .\" .Ss "\*(UA shortly hangs on startup" {{{
11693 .Ss "\*(UA shortly hangs on startup"
11695 This can have two reasons, one is the necessity to wait for a file lock
11696 and cannot be helped, the other being that \*(UA calls the function
11697 .Xr uname 2
11698 in order to query the nodename of the box (sometimes the real one is
11699 needed instead of the one represented by the internal variable
11700 .Va hostname ) .
11701 One may have varying success by ensuring that the real hostname and
11702 .Ql localhost
11703 have entries in
11704 .Pa /etc/hosts ,
11705 or, more generally, that the name service is properly setup \(en
11706 and does
11707 .Xr hostname 1
11708 return the expected value?
11709 Does this local hostname has a domain suffix?
11710 RFC 6762 standardized the link-local top-level domain
11711 .Ql .local ,
11712 try again after adding an (additional) entry with this extension.
11713 .\" }}}
11715 .\" .Ss "\*(UA exits quick, and output is cleared away" {{{
11716 .Ss "\*(UA exits quick, and output is cleared away"
11718 When this happens even with
11719 .Va emptystart
11720 set, then this most likely indicates a problem with the creation of
11721 so-called dotlock files: setting
11722 .Va dotlock-ignore-error
11723 should overcome this situation.
11724 This only avoids symptoms, it does not address the problem, though.
11725 Since the output is cleared away \*(UA has support for
11726 .Sx "On terminal control and line editor" ,
11727 and switches to the
11728 .Dq ca-mode ,
11729 which causes the output clearance: by doing
11730 .Ql set termcap='smcup='
11731 this mode can be suppressed, and by setting
11732 .Va verbose
11733 (twice) the actual problem should be reported.
11734 .\" }}}
11736 .\" .Ss "I cannot login to Google mail aka GMail" {{{
11737 .Ss "I cannot login to Google mail aka GMail"
11739 Since 2014 some free service providers classify programs as
11740 .Dq less secure
11741 unless they use a special authentification method (OAuth 2.0) which
11742 was not standardized for non-HTTP protocol authentication token query
11743 until August 2015 (RFC 7628).
11746 Different to Kerberos / GSSAPI, which is developed since the mid of the
11747 1980s, where a user can easily create a local authentication ticket for
11748 her- and himself with the locally installed
11749 .Xr kinit 1
11750 program, that protocol has no such local part but instead requires
11751 a world-wide-web query to create or fetch a token; since there is no
11752 local cache this query would have to be performed whenever \*(UA is
11753 invoked (in interactive sessions situation may differ).
11756 \*(UA does not support OAuth.
11757 Because of this it is necessary to declare \*(UA a
11758 .Dq less secure app
11759 (on the providers account web page) in order to read and send mail.
11760 However, it also seems possible to take the following steps instead:
11763 .Bl -enum -compact
11765 give the provider the number of a mobile phone,
11767 enable
11768 .Dq 2-Step Verification ,
11770 create an application specific password (16 characters), and
11772 use that special password instead of the real Google account password in
11773 \*(UA (for more on that see the section
11774 .Sx "On URL syntax and credential lookup" ) .
11776 .\" }}}
11778 .\" .Ss "Not \(dqdefunctional\(dq, but the editor key does not work" {{{
11779 .Ss "Not \(dqdefunctional\(dq, but the editor key does not work"
11781 It can happen that the terminal library (see
11782 .Sx "On terminal control and line editor",
11783 .Ic bind ,
11784 .Va termcap )
11785 reports different codes than the terminal really sends, in which case
11786 \*(UA will tell that a key binding is functional, but will not be able to
11787 recognize it because the received data does not match anything expected.
11789 .Va verbose
11790 listing of
11791 .Ic bind Ns
11792 ings will show the byte sequences that are expected.
11795 To overcome the situation, use, e.g., the program
11796 .Xr cat 1 ,
11797 in conjunction with the command line option
11798 .Fl \&\&v ,
11799 if available, to see the byte sequences which are actually produced
11800 by keypresses, and use the variable
11801 .Va termcap
11802 to make \*(UA aware of them.
11803 E.g., the terminal this is typed on produces some false sequences, here
11804 an example showing the shifted home key:
11806 .Bd -literal -offset indent
11807 ? set verbose
11808 ? bind*
11809 # 1B 5B=[ 31=1 3B=; 32=2 48=H
11810   bind base :kHOM z0
11811 ? x
11812 $ cat -v
11813 ^[[H
11814 ? \*(uA -v -Stermcap='kHOM=\eE[H'
11815 ? bind*
11816 # 1B 5B=[ 48=H
11817   bind base :kHOM z0
11819 .\" }}}
11820 .\" }}}
11823 .\" .Sh "SEE ALSO" {{{
11824 .Sh "SEE ALSO"
11826 .Xr bogofilter 1 ,
11827 .Xr gpg 1 ,
11828 .Xr more 1 ,
11829 .Xr newaliases 1 ,
11830 .Xr openssl 1 ,
11831 .Xr sendmail 1 ,
11832 .Xr sh 1 ,
11833 .Xr spamassassin 1 ,
11834 .Xr iconv 3 ,
11835 .Xr setlocale 3 ,
11836 .Xr aliases 5 ,
11837 .Xr termcap 5 ,
11838 .Xr terminfo 5 ,
11839 .Xr locale 7 ,
11840 .Xr mailaddr 7 ,
11841 .Xr re_format 7 ,
11842 .Xr mailwrapper 8 ,
11843 .Xr sendmail 8
11844 .\" }}}
11847 .\" .Sh HISTORY {{{
11848 .Sh HISTORY
11850 M. Douglas McIlroy writes in his article
11851 .Dq A Research UNIX Reader: Annotated Excerpts \
11852 from the Programmer's Manual, 1971-1986
11854 .Xr mail 1
11855 command already appeared in First Edition
11857 in 1971:
11859 .Bd -ragged -offset indent
11860 Electronic mail was there from the start.
11861 Never satisfied with its exact behavior, everybody touched it at one
11862 time or another: to assure the safety of simultaneous access, to improve
11863 privacy, to survive crashes, to exploit uucp, to screen out foreign
11864 freeloaders, or whatever.
11865 Not until v7 did the interface change (Thompson).
11866 Later, as mail became global in its reach, Dave Presotto took charge and
11867 brought order to communications with a grab-bag of external networks
11868 (v8).
11873 Mail was written in 1978 by Kurt Shoens and developed as part of the
11876 distribution until 1995.
11877 Mail has then seen further development in open source
11879 variants, noticeably by Christos Zoulas in
11880 .Pf Net Bx .
11881 Based upon this Nail, later Heirloom Mailx, was developed by Gunnar
11882 Ritter in the years 2000 until 2008.
11883 Since 2012 S-nail is maintained by Steffen (Daode) Nurpmeso.
11884 This man page is derived from
11885 .Dq The Mail Reference Manual
11886 that was originally written by Kurt Shoens.
11887 .\" }}}
11890 .Sh AUTHORS
11892 .An "Kurt Shoens" ,
11893 .An "Edward Wang" ,
11894 .An "Keith Bostic" ,
11895 .An "Christos Zoulas" ,
11896 .An "Gunnar Ritter" ,
11897 .An "Steffen Nurpmeso" Aq Mt s-nail-users@lists.sourceforge.net
11898 (later
11899 .Mt s-mailx@sdaoden.eu ) .
11902 .\" .Sh CAVEATS {{{
11903 .Sh CAVEATS
11905 \*(ID Interrupting an operation via
11906 .Dv \&\&SIGINT
11908 .Ql control-C
11909 is often problematic: many library functions cannot deal with the
11910 .Fn siglongjmp 3
11911 that this software (still) performs.
11914 The SMTP and POP3 protocol support of \*(UA is very basic.
11915 Also, if it fails to contact its upstream SMTP server, it will not make
11916 further attempts to transfer the message at a later time (setting
11917 .Va save
11919 .Va sendwait
11920 may be useful).
11921 If this is a concern, it might be better to set up a local SMTP server
11922 that is capable of message queuing.
11923 .\" }}}
11926 .Sh BUGS
11928 After deleting some message of a POP3 mailbox the header summary falsely
11929 claims that there are no messages to display, one needs to perform
11930 a scroll or dot movement to restore proper state.
11932 In threaded display a power user may encounter crashes very
11933 occasionally (this is may and very).
11935 The file
11936 .Pa TODO
11937 in the source repository lists future directions.
11938 .\" s-ts-mode