8212 manpages contain obsolete references
[unleashed.git] / usr / src / man / man1m / sendmail.1m
blobdff3a81c3606996b7cad49623c30a470c58fad8f
1 '\" te
2 .\" Copyright (c) 1998-2003 Sendmail, Inc. and its suppliers. All rights reserved.
3 .\" Copyright (c) 1983, 1997 Eric P. Allman. All rights reserved.
4 .\" Copyright (c) 1988, 1991, 1993 The Regents of the University of California. All rights reserved.
5 .\" Portions Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
6 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
7 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
8 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
9 .TH SENDMAIL 1M "May 13, 2017"
10 .SH NAME
11 sendmail \- send mail over the internet
12 .SH SYNOPSIS
13 .LP
14 .nf
15 \fB/usr/lib/sendmail\fR [\fB-Ac\fR] [\fB-Am\fR] [\fB-ba\fR] [\fB-bD\fR] [\fB-bd\fR] [\fB-bi\fR] [\fB-bl\fR]
16      [\fB-bm\fR] [\fB-bp\fR] [\fB-bP\fR] [\fB-bs\fR] [\fB-bt\fR] [\fB-bv\fR] [\fB-B\fR \fItype\fR] [\fB-C\fR \fIfile\fR]
17      [\fB-D\fR \fIlogfile\fR] [\fB-d\fR \fIX\fR] [\fB-F\fR \fIfullname\fR] [\fB-f\fR \fIname\fR] [\fB-G\fR]
18      [\fB-h\fR \fIN\fR] [\fB-L \fItag\fR\fR] [\fB-M\fR x\fIvalue\fR] [\fB-N\fR \fInotifications\fR] [\fB-n\fR]
19      [\fB-O\fR\fIoption\fR =\fIvalue\fR] [\fB-o\fR x\fIvalue\fR] [\fB-p\fR \fIprotocol\fR]
20      [\fB-Q\fR [\fIreason\fR]] [\fB-q\fR [\fItime\fR]] [\fB-q\fR \fIXstring\fR] [\fB-R\fR \fIret\fR]
21      [\fB-r\fR \fIname\fR] [\fB-t\fR] [\fB-V\fR \fIenvid\fR] [\fB-v\fR] [\fB-X\fR \fIlogfile\fR]
22      [\fIaddress\fR]...
23 .fi
25 .SH DESCRIPTION
26 .LP
27 The \fBsendmail\fR utility sends a message to one or more people, routing the
28 message over whatever networks are necessary. \fBsendmail\fR does internetwork
29 forwarding as necessary to deliver the message to the correct place.
30 .sp
31 .LP
32 \fBsendmail\fR is not intended as a user interface routine. Other programs
33 provide user-friendly front ends. \fBsendmail\fR is used only to deliver
34 pre-formatted messages.
35 .sp
36 .LP
37 With no flags, \fBsendmail\fR reads its standard input up to an EOF, or a line
38 with a single dot, and sends a copy of the letter found there to all of the
39 addresses listed. It determines the network to use based on the syntax and
40 contents of the addresses.
41 .sp
42 .LP
43 Local addresses are looked up in the local \fBaliases\fR(4) file, or in a name
44 service as defined by the \fBnsswitch.conf\fR(4) file, and aliased
45 appropriately. In addition, if there is a \fB\&.forward\fR file in a
46 recipient's home directory, \fBsendmail\fR forwards a copy of each message to
47 the list of recipients that file contains. Refer to the \fBNOTES\fR section for
48 more information about \fB\&.forward\fR files. Aliasing can be prevented by
49 preceding the address with a backslash.
50 .sp
51 .LP
52 There are several conditions under which the expected behavior is for the alias
53 database to be either built or rebuilt. This cannot occur under any
54 circumstances unless root owns \fBand\fR has exclusive write permission to the
55 \fB/etc/mail/aliases*\fR files.
56 .sp
57 .LP
58 If a message is found to be undeliverable, it is returned to the sender with
59 diagnostics that indicate the location and nature of the failure; or, the
60 message is placed in a \fBdead.letter\fR file in the sender's home directory.
61 .SS "Service Management"
62 .LP
63 The \fBsendmail\fR service is managed by the service management facility,
64 \fBsmf\fR(5), under the service identifiers:
65 .sp
66 .in +2
67 .nf
68 svc:/network/smtp:sendmail
69 svc:/network/sendmail-client:default
71 .fi
72 .in -2
73 .sp
75 .sp
76 .LP
77 Administrative actions on these services, such as enabling, disabling, or
78 requesting restart, can be performed using \fBsvcadm\fR(1M). The services'
79 status can be queried using the \fBsvcs\fR(1) command.
80 .sp
81 .LP
82 These are separate services rather than instances of the same service so that
83 other services can properly express any dependencies. In particular, here are
84 some guidelines about which service/instance should be depended on for which
85 purposes:
86 .RS +4
87 .TP
88 .ie t \(bu
89 .el o
90 For a service that uses \fBsendmail\fR to send mail, an optional dependency on
91 the service \fBsvc:/network/sendmail-client\fR might be in order.
92 .RE
93 .RS +4
94 .TP
95 .ie t \(bu
96 .el o
97 For a service that needs to receive mail in general, but does not depend on
98 \fBsendmail\fR being the particular SMTP receiver, a dependency on the service
99 \fBsvc:/network/smtp\fR might be in order.
101 .RS +4
103 .ie t \(bu
104 .el o
105 For a service that needs to interact with sendmail in particular, such as a
106 \fBMilter\fR, a dependency on the instance \fBsvc:/network/smtp:sendmail\fR
107 might be in order.
111 For the last two, note the difference, as the latter has the \fB":sendmail"\fR
112 instance specification, whereas the former does not, thus representing the more
113 general service.
114 .SS "Enabling Access to Remote Clients"
116 On an unmodified system, access to \fBsendmail\fR by remote clients is enabled
117 and disabled through the service management facility (see \fBsmf\fR(5)). In
118 particular, remote access is determined by the value of the \fBlocal_only\fR
119 SMF property:
121 .in +2
123 svc:/network/smtp:sendmail/config/local_only = true
125 .in -2
129 A setting of \fBtrue\fR, as above, disallows remote access; \fBfalse\fR allows
130 remote access. The default value is \fBtrue\fR.
133 The following example shows the sequence of SMF commands used to enable
134 \fBsendmail\fR to allow access to remote systems:
136 .in +2
138 # \fBsvccfg -s svc:/network/smtp:sendmail setprop config/local_only = false\fR
139 # \fBsvcadm refresh svc:/network/smtp:sendmail\fR
140 # \fBsvcadm restart svc:/network/smtp:sendmail\fR
142 .in -2
147 See \fBsvcadm\fR(1M) and \fBsvccfg\fR(1M).
150 Note, however, on a system where any of the \fBsendmail\fR(4) files have been
151 customized, setting this property might not have the intended effect. See
152 \fBsendmail\fR(4) for details.
153 .SS "Automated Rebuilding of Configuration Files"
155 See \fBsendmail\fR(4) for details on which service properties can be set to
156 automate (re)building of configuration files when the service is started.
157 .SS "Restricting Host Access"
159 \fBsendmail\fR uses TCP Wrappers to restrict access to hosts. It uses the
160 service name of \fBsendmail\fR for \fBhosts_access()\fR. For more information
161 on TCP Wrappers, see \fBtcpd\fR(1M) and \fBhosts_access\fR(4).
162 .SS "Startup Options"
164 The \fB/etc/default/sendmail\fR file stores startup options for \fBsendmail\fR
165 so that the options are not removed when a host is upgraded. See also
166 \fBsendmail\fR(4) for details on which service properties can be set to
167 automate (re)building of configuration files when the service is started.
170 You can use the following variables in the \fB/etc/default/sendmail\fR startup
171 file:
173 .ne 2
175 \fBCLIENTOPTIONS=\fIstring\fR\fR
177 .sp .6
178 .RS 4n
179 Selects additional options to be used with the client daemon, which looks in
180 the client-only queue (\fB/var/spool/clientmqueue\fR) and acts as a client
181 queue runner. No syntax checking is done, so be careful when making changes to
182 this variable.
186 .ne 2
188 \fBCLIENTQUEUEINTERVAL=\fI#\fR\fR
190 .sp .6
191 .RS 4n
192 Similar to the \fBQUEUEINTERVAL\fR option, \fBCLIENTQUEUEINTERVAL\fR sets the
193 time interval for mail queue runs. However, the \fBCLIENTQUEUEINTERVAL\fR
194 option controls the functions of the client daemon, instead of the functions of
195 the master daemon. Typically, the master daemon is able to deliver all messages
196 to the SMTP port. However, if the message load is too high or the master daemon
197 is not running, then messages go into the client-only queue,
198 \fB/var/spool/clientmqueue\fR. The client daemon, which checks in the
199 client-only queue, then acts as a client queue processor.
203 .ne 2
205 \fBETRN_HOSTS=\fIstring\fR\fR
207 .sp .6
208 .RS 4n
209 Enables an SMTP client and server to interact immediately without waiting for
210 the queue run intervals, which are periodic. The server can immediately deliver
211 the portion of its queue that goes to the specified hosts. For more
212 information, refer to the \fBetrn\fR(1M) man page.
216 .ne 2
218 \fBMODE=-bd\fR
220 .sp .6
221 .RS 4n
222 Selects the mode to start \fBsendmail\fR with. Use the \fB-bd\fR option or
223 leave it undefined.
227 .ne 2
229 \fBOPTIONS=\fIstring\fR\fR
231 .sp .6
232 .RS 4n
233 Selects additional options to be used with the master daemon. No syntax
234 checking is done, so be careful when making changes to this variable.
238 .ne 2
240 \fBQUEUEINTERVAL=\fI#\fR\fR
242 .sp .6
243 .RS 4n
244 Sets the interval for mail queue runs on the master daemon. \fI#\fR can be a
245 positive integer that is followed by either \fBs\fR for seconds, \fBm\fR for
246 minutes, \fBh\fR for hours, \fBd\fR for days, or \fBw\fR for weeks. The syntax
247 is checked before \fBsendmail\fR is started. If the interval is negative or if
248 the entry does not end with an appropriate letter, the interval is ignored and
249 \fBsendmail\fR starts with a queue interval of 15 minutes.
253 .ne 2
255 \fBQUEUEOPTIONS=p\fR
257 .sp .6
258 .RS 4n
259 Enables one persistent queue runner that sleeps between queue run intervals,
260 instead of a new queue runner for each queue run interval. You can set this
261 option to \fBp\fR, which is the only setting available. Otherwise, this option
262 is not set.
265 .SS "Mail Filter API"
267 \fBsendmail\fR supports a mail filter API called "milter". For more
268 information, see \fB/usr/include/libmilter/README\fR and http://www.milter.org
269 .SH OPTIONS
271 The following options are supported:
273 .ne 2
275 \fB\fB-Ac\fR\fR
277 .sp .6
278 .RS 4n
279 Uses \fBsubmit.cf\fR even if the operation mode does not indicate an initial
280 mail submission.
284 .ne 2
286 \fB\fB-Am\fR\fR
288 .sp .6
289 .RS 4n
290 Uses \fBsendmail.cf\fR even if the operation mode indicates an initial mail
291 submission.
295 .ne 2
297 \fB\fB-ba\fR\fR
299 .sp .6
300 .RS 4n
301 Goes into \fBARPANET\fR mode. All input lines must end with a RETURN-LINEFEED,
302 and all messages are generated with a RETURN-LINEFEED at the end. Also, the
303 \fBFrom:\fR and \fBSender:\fR fields are examined for the name of the sender.
307 .ne 2
309 \fB\fB-bd\fR\fR
311 .sp .6
312 .RS 4n
313 Runs as a daemon in the background, waiting for incoming SMTP connections.
317 .ne 2
319 \fB\fB-bD\fR\fR
321 .sp .6
322 .RS 4n
323 Runs as a daemon in the foreground, waiting for incoming SMTP connections.
327 .ne 2
329 \fB\fB-bi\fR\fR
331 .sp .6
332 .RS 4n
333 Initializes the \fBaliases\fR(4) database. Root must own \fIand\fR have
334 exclusive write permission to the \fB/etc/mail/aliases*\fR files for successful
335 use of this option.
339 .ne 2
341 \fB\fB-bl\fR\fR
343 .sp .6
344 .RS 4n
345 Runs as a daemon (like \fB-bd\fR) but accepts only loopback SMTP connections.
349 .ne 2
351 \fB\fB-bm\fR\fR
353 .sp .6
354 .RS 4n
355 Delivers mail in the usual way (default).
359 .ne 2
361 \fB\fB-bp\fR\fR
363 .sp .6
364 .RS 4n
365 Prints a summary of the mail queues.
369 .ne 2
371 \fB\fB-bP\fR\fR
373 .sp .6
374 .RS 4n
375 Prints the number of entries in the queues. This option is only available with
376 shared memory support.
380 .ne 2
382 \fB\fB-bs\fR\fR
384 .sp .6
385 .RS 4n
386 Uses the SMTP protocol as described in RFC 2821. This flag implies all the
387 operations of the \fB-ba\fR flag that are compatible with \fBSMTP\fR.
391 .ne 2
393 \fB\fB-bt\fR\fR
395 .sp .6
396 .RS 4n
397 Runs in address test mode. This mode reads addresses and shows the steps in
398 parsing; it is used for debugging configuration tables.
402 .ne 2
404 \fB\fB-bv\fR\fR
406 .sp .6
407 .RS 4n
408 Verifies names only. Does not try to collect or deliver a message. Verify mode
409 is normally used for validating users or mailing lists.
413 .ne 2
415 \fB\fB-B\fR \fItype\fR\fR
417 .sp .6
418 .RS 4n
419 Indicates body \fItype\fR (\fB7BIT\fR or \fB8BITMIME\fR).
423 .ne 2
425 \fB\fB-C\fR \fIfile\fR\fR
427 .sp .6
428 .RS 4n
429 Uses alternate configuration file.
433 .ne 2
435 \fB\fB-D\fR \fIlogfile\fR\fR
437 .sp .6
438 .RS 4n
439 Send debugging output to the indicated log file instead of \fBstdout\fR.
443 .ne 2
445 \fB\fB-d\fR \fIX\fR\fR
447 .sp .6
448 .RS 4n
449 Sets debugging value to \fIX\fR.
453 .ne 2
455 \fB\fB-f\fR \fIname\fR\fR
457 .sp .6
458 .RS 4n
459 Sets the name of the "from" person (that is, the sender of the mail).
463 .ne 2
465 \fB\fB-F\fR \fIfullname\fR\fR
467 .sp .6
468 .RS 4n
469 Sets the full name of the sender.
473 .ne 2
475 \fB\fB-G\fR\fR
477 .sp .6
478 .RS 4n
479 When accepting messages by way of the command line, indicates that they are for
480 relay (gateway) submission. When this flag is set, \fBsendmail\fR might
481 complain about syntactically invalid messages, for example, unqualified host
482 names, rather than fixing them. \fBsendmail\fR does not do any canonicalization
483 in this mode.
487 .ne 2
489 \fB\fB-h\fR \fIN\fR\fR
491 .sp .6
492 .RS 4n
493 Sets the hop count to \fIN\fR. The hop count is incremented every time the mail
494 is processed. When it reaches a limit, the mail is returned with an error
495 message, the victim of an aliasing loop.
499 .ne 2
501 \fB\fB-L\fR \fItag\fR\fR
503 .sp .6
504 .RS 4n
505 Sets the identifier used in \fBsyslog\fR messages to the supplied \fItag\fR.
509 .ne 2
511 \fB\fB-M\fR\fIxvalue\fR\fR
513 .sp .6
514 .RS 4n
515 Sets macro \fIx\fR to the specified \fIvalue\fR.
519 .ne 2
521 \fB\fB-n\fR\fR
523 .sp .6
524 .RS 4n
525 Does not do aliasing.
529 .ne 2
531 \fB\fB-N\fR \fInotifications\fR\fR
533 .sp .6
534 .RS 4n
535 Tags all addresses being sent as wanting the indicated \fInotifications\fR,
536 which consists of the word "NEVER" or a comma-separated list of "SUCCESS",
537 "FAILURE", and "DELAY" for successful delivery, failure and a message that is
538 stuck in a queue somewhere. The default is "FAILURE,DELAY".
542 .ne 2
544 \fB\fB-o\fR\fIxvalue\fR\fR
546 .sp .6
547 .RS 4n
548 Sets option \fIx\fR to the specified \fIvalue\fR. \fBProcessing\fR
549 \fBOptions\fR are described below.
553 .ne 2
555 \fB\fB-O\fR\fIoption=value\fR\fR
557 .sp .6
558 .RS 4n
559 Sets \fIoption\fR to the specified \fIvalue\fR (for long from names).
560 \fBProcessing\fR \fBOptions\fR are described below.
564 .ne 2
566 \fB\fB-p\fR \fIprotocol\fR\fR
568 .sp .6
569 .RS 4n
570 Sets the sending protocol. The \fIprotocol\fR field can be in form
571 \fIprotocol\fR\fB:\fR\fIhost\fR to set both the sending protocol and the
572 sending host. For example: \fB-pUUCP:uunet\fR sets the sending \fIprotocol\fR
573 to \fBUUCP\fR and the sending host to \fBuunet\fR. Some existing programs use
574 \fB-oM\fR to set the \fIr\fR and \fIs\fR macros; this is equivalent to using
575 \fB-p\fR.
579 .ne 2
581 \fB\fB-q\fR[\fItime\fR]\fR
583 .sp .6
584 .RS 4n
585 Processes saved messages in the queue at given intervals. If \fItime\fR is
586 omitted, processes the queue once. \fItime\fR is given as a tagged number,
587 where \fIs\fR is seconds, \fIm\fR is minutes, \fIh\fR is hours, \fId\fR is
588 days, and \fIw\fR is weeks. For example, \fB-q1h30m\fR or \fB-q90m\fR would
589 both set the timeout to one hour thirty minutes.
591 By default, sendmail runs in the background. This option can be used safely
592 with \fB-bd\fR.
596 .ne 2
598 \fB\fB-qp[\fR\fItime\fR\fB-]\fR\fR
600 .sp .6
601 .RS 4n
602 Similar to \fB-q\fR[\fItime\fR], except that instead of periodically forking a
603 child to process the queue, \fBsendmail\fR forks a single persistent child for
604 each queue that alternates between processing the queue and sleeping. The sleep
605 time (\fItime\fR) is specified as the argument; it defaults to \fB1\fR second.
606 The process always sleeps at least \fB5\fR seconds if the queue was empty in
607 the previous queue run.
611 .ne 2
613 \fB\fB-qf\fR\fR
615 .sp .6
616 .RS 4n
617 Processes saved messages in the queue once and does not \fBfork\fR(2), but runs
618 in the foreground.
622 .ne 2
624 \fB\fB-qG\fR \fIname\fR\fR
626 .sp .6
627 .RS 4n
628 Processes jobs in queue group called \fIname\fR only.
632 .ne 2
634 \fB\fB-q[!]I\fR \fIsubstr\fR\fR
636 .sp .6
637 .RS 4n
638 Limits processed jobs to those containing \fIsubstr\fR as a substring of the
639 queue \fBID\fR or not when \fB!\fR is specified.
643 .ne 2
645 \fB\fB-q[!]Q\fR \fIsubstr\fR\fR
647 .sp .6
648 .RS 4n
649 Limits processed jobs to those quarantined jobs containing \fIsubstr\fR as a
650 substring of the quarantine \fIreason\fR or not when \fB!\fR is specified.
654 .ne 2
656 \fB\fB-q[!]R\fR \fIsubstr\fR\fR
658 .sp .6
659 .RS 4n
660 Limits processed jobs to those containing \fIsubstr\fR as a substring of one of
661 the recipients or not when \fB!\fR is specified.
665 .ne 2
667 \fB\fB-q[!]S\fR \fIsubstr\fR\fR
669 .sp .6
670 .RS 4n
671 Limits processed jobs to those containing \fIsubstr\fR as a substring of the
672 sender or not when \fB!\fR is specified.
676 .ne 2
678 \fB\fB-Q\fR[\fIreason\fR]\fR
680 .sp .6
681 .RS 4n
682 Quarantines a normal queue item with the given reason or unquarantines a
683 quarantined queue item if no reason is given. This should only be used with
684 some sort of item matching as described above.
688 .ne 2
690 \fB\fB-r\fR \fIname\fR\fR
692 .sp .6
693 .RS 4n
694 An alternate and obsolete form of the \fB-f\fR flag.
698 .ne 2
700 \fB\fB-R\fR \fIret\fR\fR
702 .sp .6
703 .RS 4n
704 Identifies the information you want returned if the message bounces. \fIret\fR
705 can be \fBHDRS\fR for headers only or \fBFULL\fR for headers plus body.
709 .ne 2
711 \fB\fB-t\fR\fR
713 .sp .6
714 .RS 4n
715 Reads message for recipients. \fBTo:\fR,\fBCc:\fR, and \fBBcc:\fR lines are
716 scanned for people to send to. The \fBBcc:\fR line is deleted before
717 transmission. Any addresses in the argument list is suppressed. The
718 \fBNoRecipientAction\fR Processing Option can be used to change the behavior
719 when no legal recipients are included in the message.
723 .ne 2
725 \fB\fB-v\fR\fR
727 .sp .6
728 .RS 4n
729 Goes into verbose mode. Alias expansions are announced, and so forth.
733 .ne 2
735 \fB\fB-V\fR \fIenvid\fR\fR
737 .sp .6
738 .RS 4n
739 The indicated \fIenvid\fR is passed with the envelope of the message and
740 returned if the message bounces.
744 .ne 2
746 \fB\fB-X\fR \fIlogfile\fR\fR
748 .sp .6
749 .RS 4n
750 Logs all traffic in and out of \fBsendmail\fR in the indicated \fIlogfile\fR
751 for debugging mailer problems. This produces a lot of data very quickly and
752 should be used sparingly.
755 .SS "Processing Options"
757 There are a number of "random" options that can be set from a configuration
758 file. Options are represented by a single character or by multiple character
759 names. The syntax for the single character names of is:
761 .in +2
763 \fBO\fR\fIxvalue\fR
765 .in -2
770 This sets option \fIx\fR to be \fIvalue\fR. Depending on the option,
771 \fIvalue\fR may be a string, an integer, a boolean (with legal values \fBt\fR,
772 \fBT\fR, \fBf\fR, or \fBF\fR; the default is \fBTRUE\fR), or a time interval.
775 The multiple character or long names use this syntax:
777 .in +2
779 \fBO\fR \fILongname=argument\fR
781 .in -2
786 This sets the option \fILongname\fR to be \fIargument\fR. The long names are
787 beneficial because they are easier to interpret than the single character
788 names.
791 Not all processing options have single character names associated with them. In
792 the list below, the multiple character name is presented first followed by the
793 single character syntax enclosed in parentheses.
795 .ne 2
797 \fB\fBAliasFile (A\fR\fIfile\fR\fB)\fR\fR
799 .sp .6
800 .RS 4n
801 Specifies possible alias files.
805 .ne 2
807 \fB\fBAliasWait (a\fR \fIN\fR\fB)\fR\fR
809 .sp .6
810 .RS 4n
811 If set, waits up to \fIN\fR minutes for an "@:@" entry to exist in the
812 \fBaliases\fR(4) database before starting up. If it does not appear in \fIN\fR
813 minutes, issues a warning. Defaults to 10 minutes.
817 .ne 2
819 \fB\fBAllowBogusHELO\fR\fR
821 .sp .6
822 .RS 4n
823 Allows a \fBHELO SMTP\fR command that does not include a host name. By default
824 this option is disabled.
828 .ne 2
830 \fB\fBBadRcptThrottle=\fR\fIN\fR\fR
832 .sp .6
833 .RS 4n
834 If set and more than the specified number of recipients in a single \fBSMTP\fR
835 envelope are rejected, sleeps for one second after each rejected RCPT command.
839 .ne 2
841 \fB\fBBlankSub (B\fR\fIc\fR\fB)\fR\fR
843 .sp .6
844 .RS 4n
845 Sets the blank substitution character to \fIc\fR. Unquoted spaces in addresses
846 are replaced by this character. Defaults to SPACE (that is, no change is made).
850 .ne 2
852 \fB\fBCACertFile\fR\fR
854 .sp .6
855 .RS 4n
856 File containing one CA cert.
860 .ne 2
862 \fB\fBCACertPath\fR\fR
864 .sp .6
865 .RS 4n
866 Path to directory with certs of CAs.
870 .ne 2
872 \fB\fBCheckAliases (n)\fR\fR
874 .sp .6
875 .RS 4n
876 Validates the RHS of aliases when rebuilding the \fBaliases\fR(4) database.
880 .ne 2
882 \fB\fBCheckpointInterval (C\fR\fIN\fR\fB)\fR\fR
884 .sp .6
885 .RS 4n
886 Checkpoints the queue every \fIN\fR (default \fB10\fR) addresses sent. If your
887 system crashes during delivery to a large list, this prevents retransmission to
888 any but the last \fIN\fR recipients.
892 .ne 2
894 \fB\fBClassFactor (z\fR\fIfact\fR\fB)\fR\fR
896 .sp .6
897 .RS 4n
898 The indicated factor \fIfact\fR is multiplied by the message class (determined
899 by the \fBPrecedence:\fR field in the user header and the \fBP\fR lines in the
900 configuration file) and subtracted from the priority. Thus, messages with a
901 higher \fBPriority:\fR are favored. Defaults to \fB1800\fR.
905 .ne 2
907 \fB\fBClientCertFile\fR\fR
909 .sp .6
910 .RS 4n
911 File containing the cert of the client, that is, this cert is used when
912 \fBsendmail\fR acts as client.
916 .ne 2
918 \fB\fBClientKeyFile\fR\fR
920 .sp .6
921 .RS 4n
922 File containing the private key belonging to the client cert.
926 .ne 2
928 \fB\fBClientPortOptions\fR\fR
930 .sp .6
931 .RS 4n
932 Sets client \fBSMTP\fR options. The options are key=value pairs. Known keys
933 are:
935 .ne 2
937 \fB\fBAddr\fR \fIAddress Mask\fR\fR
939 .sp .6
940 .RS 4n
941 \fIAddress Mask\fR defaults to \fBINADDR_ANY\fR. The address mask can be a
942 numeric address in dot notation or a network name.
946 .ne 2
948 \fB\fBFamily\fR\fR
950 .sp .6
951 .RS 4n
952 Address family (defaults to INET).
956 .ne 2
958 \fB\fBListen\fR\fR
960 .sp .6
961 .RS 4n
962 Size of listen queue (defaults to 10).
966 .ne 2
968 \fB\fBPort\fR\fR
970 .sp .6
971 .RS 4n
972 Name/number of listening port (defaults to \fBsmtp\fR).
976 .ne 2
978 \fB\fBRcvBufSize\fR\fR
980 .sp .6
981 .RS 4n
982 The size of the TCP/IP receive buffer.
986 .ne 2
988 \fB\fBSndBufSize\fR\fR
990 .sp .6
991 .RS 4n
992 The size of the TCP/IP send buffer.
996 .ne 2
998 \fB\fBModifier\fR\fR
1000 .sp .6
1001 .RS 4n
1002 Options (flags) for the daemon. Can be:
1004 .ne 2
1006 \fB\fBh\fR\fR
1008 .sp .6
1009 .RS 4n
1010 Uses name of interface for \fBHELO\fR command.
1013 If \fBh\fR is set, the name corresponding to the outgoing interface address
1014 (whether chosen by means of the \fBConnection\fR parameter or the default) is
1015 used for the \fBHELO\fR/\fBEHLO\fR command.
1021 .ne 2
1023 \fB\fBColonOkInAddr\fR\fR
1025 .sp .6
1026 .RS 4n
1027 If set, colons are treated as a regular character in addresses. If not set,
1028 they are treated as the introducer to the RFC 822 "group" syntax. This option
1029 is on for version 5 and lower configuration files.
1033 .ne 2
1035 \fB\fBConnectionCacheSize (k\fR\fIN\fR\fB)\fR\fR
1037 .sp .6
1038 .RS 4n
1039 The maximum number of open connections that are to be cached at a time. The
1040 default is \fB1\fR. This delays closing the current connection until either
1041 this invocation of \fBsendmail\fR needs to connect to another host or it
1042 terminates. Setting it to \fB0\fR defaults to the old behavior, that is,
1043 connections are closed immediately.
1047 .ne 2
1049 \fB\fBConnectionCacheTimeout (K\fR\fItimeout\fR\fB)\fR\fR
1051 .sp .6
1052 .RS 4n
1053 The maximum amount of time a cached connection is permitted to idle without
1054 activity. If this time is exceeded, the connection is immediately closed. This
1055 value should be small (on the order of ten minutes). Before \fBsendmail\fR uses
1056 a cached connection, it always sends a \fBNOOP\fR (no operation) command to
1057 check the connection. If the \fBNOOP\fR command fails, it reopens the
1058 connection. This keeps your end from failing if the other end times out. The
1059 point of this option is to be a good network neighbor and avoid using up
1060 excessive resources on the other end. The default is five minutes.
1064 .ne 2
1066 \fB\fBConnectionRateThrottle\fR\fR
1068 .sp .6
1069 .RS 4n
1070 The maximum number of connections permitted per second. After this many
1071 connections are accepted, further connections are delayed. If not set or <= 0,
1072 there is no limit.
1076 .ne 2
1078 \fB\fBConnectionRateWindowSize\fR\fR
1080 .sp .6
1081 .RS 4n
1082 Define the length of the interval for which the number of incoming connections
1083 is maintained. The default is 60 seconds.
1087 .ne 2
1089 \fB\fBControlSocketName\fR\fR
1091 .sp .6
1092 .RS 4n
1093 Name of the control socket for daemon management. A running \fBsendmail\fR
1094 daemon can be controlled through this Unix domain socket. Available commands
1095 are: \fBhelp\fR, \fBrestart\fR, \fBshutdown\fR, and \fBstatus\fR. The
1096 \fBstatus\fR command returns the current number of daemon children, the free
1097 disk space (in blocks) of the queue directory, and the load average of the
1098 machine expressed as an integer. If not set, no control socket is available.
1099 For the sake of security, this Unix domain socket must be in a directory which
1100 is accessible only by root; \fB/var/spool/mqueue/.smcontrol\fR is recommended
1101 for the socket name.
1105 .ne 2
1107 \fB\fBCRLFile\fR\fR
1109 .sp .6
1110 .RS 4n
1111 File containing certificate revocation status, useful for X.509v3
1112 authentication.
1116 .ne 2
1118 \fB\fBDaemonPortOptions (O\fR\fIoptions\fR\fB)\fR\fR
1120 .sp .6
1121 .RS 4n
1122 Sets server SMTP options. The options are \fIkey=value\fR pairs. Known keys
1123 are:
1125 .ne 2
1127 \fB\fBName\fR\fR
1129 .sp .6
1130 .RS 4n
1131 User-definable name for the daemon (defaults to "\fBDaemon#\fR"). Used for
1132 error messages and logging.
1136 .ne 2
1138 \fB\fBAddr\fR\fR
1140 .sp .6
1141 .RS 4n
1142 Address mask (defaults \fBINADDR_ANY)\fR.
1144 The address mask may be a numeric address in dot notation or a network name.
1148 .ne 2
1150 \fB\fBFamily\fR\fR
1152 .sp .6
1153 .RS 4n
1154 Address family (defaults to \fBINET).\fR
1158 .ne 2
1160 \fB\fBInputMailFilters\fR\fR
1162 .sp .6
1163 .RS 4n
1164 List of input mail filters for the daemon.
1168 .ne 2
1170 \fB\fBListen\fR\fR
1172 .sp .6
1173 .RS 4n
1174 Size of listen queue (defaults to \fB10\fR).
1178 .ne 2
1180 \fB\fBModifier\fR\fR
1182 .sp .6
1183 .RS 4n
1184 Options (flags) for the daemon; can be a sequence (without any delimiters) of:
1186 .ne 2
1188 \fB\fBa\fR\fR
1190 .sp .6
1191 .RS 4n
1192 Requires authentication.
1196 .ne 2
1198 \fB\fBb\fR\fR
1200 .sp .6
1201 .RS 4n
1202 Binds to interface through which mail has been received.
1206 .ne 2
1208 \fB\fBc\fR\fR
1210 .sp .6
1211 .RS 4n
1212 Performs hostname canonification (\fB\&.cf\fR).
1216 .ne 2
1218 \fB\fBf\fR\fR
1220 .sp .6
1221 .RS 4n
1222 Requires fully qualified hostname (\fB\&.cf\fR).
1226 .ne 2
1228 \fB\fBh\fR\fR
1230 .sp .6
1231 .RS 4n
1232 Uses name of interface for \fBHELO\fR command.
1236 .ne 2
1238 \fB\fBu\fR\fR
1240 .sp .6
1241 .RS 4n
1242 Allows unqualified addresses (\fB\&.cf\fR).
1246 .ne 2
1248 \fB\fBC\fR\fR
1250 .sp .6
1251 .RS 4n
1252 Does not perform hostname canonification.
1256 .ne 2
1258 \fB\fBE\fR\fR
1260 .sp .6
1261 .RS 4n
1262 Disallows \fBETRN\fR (see \fBRFC\fR 2476).
1268 .ne 2
1270 \fB\fBName\fR\fR
1272 .sp .6
1273 .RS 4n
1274 User-definable name for the daemon (defaults to \fBDaemon#\fR). Used for error
1275 messages and logging.
1279 .ne 2
1281 \fB\fBPort\fR\fR
1283 .sp .6
1284 .RS 4n
1285 Name/number of listening port (defaults to \fBsmtp\fR).
1289 .ne 2
1291 \fB\fBReceiveSize\fR\fR
1293 .sp .6
1294 .RS 4n
1295 The size of the TCP/IP receive buffer.
1299 .ne 2
1301 \fB\fBSendSize\fR\fR
1303 .sp .6
1304 .RS 4n
1305 The size of the TCP/IP send buffer.
1309 .ne 2
1311 \fB\fBchildren\fR\fR
1313 .sp .6
1314 .RS 4n
1315 Maximum number of children per daemon. See \fBMaxDaemonChildren\fR.
1319 .ne 2
1321 \fB\fBDeliveryMode\fR\fR
1323 .sp .6
1324 .RS 4n
1325 Delivery mode per daemon. See \fBDeliveryMode\fR.
1329 .ne 2
1331 \fB\fBrefuseLA\fR\fR
1333 .sp .6
1334 .RS 4n
1335 \fBRefuseLA\fR per daemon.
1339 .ne 2
1341 \fB\fBdelayLA\fR\fR
1343 .sp .6
1344 .RS 4n
1345 \fBDelayLA\fR per daemon.
1349 .ne 2
1351 \fB\fBqueueLA\fR\fR
1353 .sp .6
1354 .RS 4n
1355 \fBQueueLA\fR per daemon.
1358 \fBsendmail\fR listens on a new socket for each occurrence of the
1359 \fBDaemonPortOptions\fR option in a configuration file.
1363 .ne 2
1365 \fB\fBDataFileBufferSize\fR\fR
1367 .sp .6
1368 .RS 4n
1369 Sets the threshold, in bytes, before a memory-bases queue data file becomes
1370 disk-based. The default is 4096 bytes.
1374 .ne 2
1376 \fB\fBDeadLetterDrop\fR\fR
1378 .sp .6
1379 .RS 4n
1380 Defines the location of the system-wide dead.letter file, formerly hard-coded
1381 to \fB/var/tmp/dead.letter\fR. If this option is not set (the default),
1382 \fBsendmail\fR does not attempt to save to a system-wide \fBdead.letter\fR file
1383 in the event it cannot bounce the mail to the user or postmaster. Instead, it
1384 renames the \fBqf\fR file as it has in the past when the \fBdead.letter\fR file
1385 could not be opened.
1389 .ne 2
1391 \fB\fBDefaultCharSet\fR\fR
1393 .sp .6
1394 .RS 4n
1395 Sets the default character set to use when converting unlabeled 8 bit input to
1396 MIME.
1400 .ne 2
1402 \fB\fBDefaultUser (g\fR\fIgid\fR\fB) or (u\fR\fIuid\fR\fB)\fR\fR
1404 .sp .6
1405 .RS 4n
1406 Sets the default group ID for mailers to run in to \fIgid\fR or set the default
1407 userid for mailers to \fIuid\fR. Defaults to \fB1\fR. The value can also be
1408 given as a symbolic group or user name.
1412 .ne 2
1414 \fB\fBDelayLA=\fR\fILA\fR\fR
1416 .sp .6
1417 .RS 4n
1418 When the system load average exceeds \fILA\fR, \fBsendmail\fR sleeps for one
1419 second on most SMTP commands and before accepting connections.
1423 .ne 2
1425 \fB\fBDeliverByMin=\fR\fItime\fR\fR
1427 .sp .6
1428 .RS 4n
1429 Sets minimum time for \fBDeliver By SMTP Service Extension\fR (RFC 2852). If
1430 \fB0\fR, no time is listed, if less than \fB0\fR, the extension is not offered,
1431 if greater than \fB0\fR, it is listed as minimum time for the \fBEHLO\fR
1432 keyword \fBDELIVERBY\fR.
1436 .ne 2
1438 \fB\fBDeliveryMode (d\fR\fIx\fR\fB)\fR\fR
1440 .sp .6
1441 .RS 4n
1442 Delivers in mode \fIx\fR. Legal modes are:
1444 .ne 2
1446 \fB\fBi\fR\fR
1448 .sp .6
1449 .RS 4n
1450 Delivers interactively (synchronously).
1454 .ne 2
1456 \fB\fBb\fR\fR
1458 .sp .6
1459 .RS 4n
1460 Delivers in background (asynchronously).
1464 .ne 2
1466 \fB\fBd\fR\fR
1468 .sp .6
1469 .RS 4n
1470 Deferred mode. Database lookups are deferred until the actual queue run.
1474 .ne 2
1476 \fB\fBq\fR\fR
1478 .sp .6
1479 .RS 4n
1480 Just queues the message (delivers during queue run).
1483 Defaults to \fBb\fR if no option is specified, \fBi\fR if it is specified but
1484 given no argument (that is, \fBOd\fR is equivalent to \fBOdi\fR).
1488 .ne 2
1490 \fB\fBDHParameters\fR\fR
1492 .sp .6
1493 .RS 4n
1494 File containing the DH parameters.
1498 .ne 2
1500 \fB\fBDialDelay\fR\fR
1502 .sp .6
1503 .RS 4n
1504 If a connection fails, waits this many seconds and tries again. Zero means "do
1505 not retry".
1509 .ne 2
1511 \fB\fBDontBlameSendmail\fR\fR
1513 .sp .6
1514 .RS 4n
1515 If set, overrides the file safety checks. This compromises system security and
1516 should not be used. See http://www.sendmail.org/tips/DontBlameSendmail.html for
1517 more information.
1521 .ne 2
1523 \fB\fBDontExpandCnames\fR\fR
1525 .sp .6
1526 .RS 4n
1527 If set, $[ ... $] lookups that do DNS-based lookups do not expand CNAME
1528 records.
1532 .ne 2
1534 \fB\fBDontInitGroups\fR\fR
1536 .sp .6
1537 .RS 4n
1538 If set, the \fBinitgroups\fR(3C) routine is never invoked. If you set this,
1539 agents run on behalf of users only have their primary (\fB/etc/passwd\fR) group
1540 permissions.
1544 .ne 2
1546 \fB\fBDontProbeInterfaces\fR\fR
1548 .sp .6
1549 .RS 4n
1550 If set, \fBsendmail\fR does not insert the names and addresses of any local
1551 interfaces into the \fB$=w class\fR. If set, you must also include support for
1552 these addresses, otherwise mail to addresses in this list bounces with a
1553 configuration error.
1557 .ne 2
1559 \fB\fBDontPruneRoutes (R)\fR\fR
1561 .sp .6
1562 .RS 4n
1563 If set, does not prune route-addr syntax addresses to the minimum possible.
1567 .ne 2
1569 \fB\fBDoubleBounceAddress\fR\fR
1571 .sp .6
1572 .RS 4n
1573 If an error occurs when sending an error message, sends that "double bounce"
1574 error message to this address.
1578 .ne 2
1580 \fB\fBEightBitMode (8)\fR\fR
1582 .sp .6
1583 .RS 4n
1584 Uses 8-bit data handling. This option requires one of the following keys. The
1585 key can selected by using just the first character, but using the full word is
1586 better for clarity.
1588 .ne 2
1590 \fB\fBmimify\fR\fR
1592 .sp .6
1593 .RS 4n
1594 Does any necessary conversion of \fB8BITMIME\fR to 7-bit.
1598 .ne 2
1600 \fB\fBpass\fR\fR
1602 .sp .6
1603 .RS 4n
1604 Passes unlabeled 8-bit input through as is.
1608 .ne 2
1610 \fB\fBstrict\fR\fR
1612 .sp .6
1613 .RS 4n
1614 Rejects unlabeled 8-bit input.
1620 .ne 2
1622 \fB\fBErrorHeader (E\fR\fIfile/message\fR\fB)\fR\fR
1624 .sp .6
1625 .RS 4n
1626 Appends error messages with the indicated message. If it begins with a slash,
1627 it is assumed to be the pathname of a file containing a message (this is the
1628 recommended setting). Otherwise, it is a literal message. The error file might
1629 contain the name, email address, and/or phone number of a local postmaster who
1630 could provide assistance to end users. If the option is missing or \fINULL\fR,
1631 or if it names a file which does not exist or which is not readable, no message
1632 is printed.
1636 .ne 2
1638 \fB\fBErrorMode (e\fR\fIx\fR\fB)\fR\fR
1640 .sp .6
1641 .RS 4n
1642 Disposes of errors using mode \fIx\fR. The values for \fIx\fR are:
1644 .ne 2
1646 \fB\fBe\fR\fR
1648 .sp .6
1649 .RS 4n
1650 Mails back errors and gives \fB0\fR exit status always.
1654 .ne 2
1656 \fB\fBm\fR\fR
1658 .sp .6
1659 .RS 4n
1660 Mails back errors.
1664 .ne 2
1666 \fB\fBp\fR\fR
1668 .sp .6
1669 .RS 4n
1670 Prints error messages (default).
1674 .ne 2
1676 \fB\fBq\fR\fR
1678 .sp .6
1679 .RS 4n
1680 No messages, just gives exit status.
1684 .ne 2
1686 \fB\fBw\fR\fR
1688 .sp .6
1689 .RS 4n
1690 Writes back errors (mail if user not logged in).
1696 .ne 2
1698 \fB\fBFallbackMXhost (V\fR\fIfallbackhost\fR\fB)\fR\fR
1700 .sp .6
1701 .RS 4n
1702 If specified, the \fIfallbackhost\fR acts like a very low priority MX on every
1703 host. This is intended to be used by sites with poor network connectivity.
1707 .ne 2
1709 \fB\fBFallBackSmartHost\fR\fR
1711 .sp .6
1712 .RS 4n
1713 If specified, the \fIfallBackSmartHost\fR is used in a last-ditch effort for
1714 each host. This is intended to be used by sites with "fake internal DNS". That
1715 is, a company whose DNS accurately reflects the world inside that company's
1716 domain but not outside.
1720 .ne 2
1722 \fB\fBFastSplit\fR\fR
1724 .sp .6
1725 .RS 4n
1726 If set to a value greater than zero (the default is one), it suppresses the MX
1727 lookups on addresses when they are initially sorted, that is, for the first
1728 delivery attempt. This usually results in faster envelope splitting unless the
1729 MX records are readily available in a local DNS cache. To enforce initial
1730 sorting based on MX records set \fBFastSplit\fR to zero. If the mail is
1731 submitted directly from the command line, then the value also limits the number
1732 of processes to deliver the envelopes; if more envelopes are created they are
1733 only queued up and must be taken care of by a queue run. Since the default
1734 submission method is by way of SMTP (either from a MUA or by way of the Message
1735 Submission Program [MSP]), the value of \fBFastSplit\fR is seldom used to limit
1736 the number of processes to deliver the envelopes.
1740 .ne 2
1742 \fB\fBForkEachJob (Y)\fR\fR
1744 .sp .6
1745 .RS 4n
1746 If set, delivers each job that is run from the queue in a separate process. Use
1747 this option if you are short of memory, since the default tends to consume
1748 considerable amounts of memory while the queue is being processed.
1752 .ne 2
1754 \fB\fBForwardPath (J\fR\fIpath\fR\fB)\fR\fR
1756 .sp .6
1757 .RS 4n
1758 Sets the path for searching for users' \fB\&.forward\fR files. The default is
1759 \fB$z/.forward\fR. Some sites that use the automounter may prefer to change
1760 this to \fB/var/forward/$u\fR to search a file with the same name as the user
1761 in a system directory. It can also be set to a sequence of paths separated by
1762 colons; \fBsendmail\fR stops at the first file it can successfully and safely
1763 open. For example, \fB/var/forward/$u:$z/.forward\fR searches first in
1764 \fB/var/forward/\fR \fIusername\fR and then in
1765 \fB~\fR\fIusername\fR\fB/.forward\fR (but only if the first file does not
1766 exist). Refer to the NOTES section for more information.
1770 .ne 2
1772 \fB\fBHeloName=\fIname\fR\fR\fR
1774 .sp .6
1775 .RS 4n
1776 Sets the name to be used for \fBHELO\fR/\fBEHLO\fR (instead of \fB$j\fR).
1780 .ne 2
1782 \fB\fBHelpFile (H\fR\fIfile\fR\fB)\fR\fR
1784 .sp .6
1785 .RS 4n
1786 Specifies the help file for SMTP.
1790 .ne 2
1792 \fB\fBHoldExpensive (c)\fR\fR
1794 .sp .6
1795 .RS 4n
1796 If an outgoing mailer is marked as being expensive, does not connect
1797 immediately.
1801 .ne 2
1803 \fB\fBHostsFile\fR\fR
1805 .sp .6
1806 .RS 4n
1807 Sets the file to use when doing "file" type access of host names.
1811 .ne 2
1813 \fB\fBHostStatusDirectory\fR\fR
1815 .sp .6
1816 .RS 4n
1817 If set, host status is kept on disk between \fBsendmail\fR runs in the named
1818 directory tree. If a full path is not used, then the path is interpreted
1819 relative to the queue directory.
1823 .ne 2
1825 \fB\fBIgnoreDots (i)\fR\fR
1827 .sp .6
1828 .RS 4n
1829 Ignores dots in incoming messages. This is always disabled (that is, dots are
1830 always accepted) when reading \fBSMTP\fR mail.
1834 .ne 2
1836 \fB\fBLogLevel (L\fR\fIn\fR\fB)\fR\fR
1838 .sp .6
1839 .RS 4n
1840 Sets the default log level to \fIn\fR. Defaults to \fB9\fR.
1844 .ne 2
1846 \fB\fB(M\fR\fIx\|value\fR\fB)\fR\fR
1848 .sp .6
1849 .RS 4n
1850 Sets the macro \fIx\fR to \fIvalue\fR. This is intended only for use from the
1851 command line.
1855 .ne 2
1857 \fB\fBMailboxDatabase\fR\fR
1859 .sp .6
1860 .RS 4n
1861 Type of lookup to find information about local mail boxes, defaults to \fBpw\fR
1862 which uses \fBgetpwnam\fR(3C). Other types can be introduced by adding them to
1863 the source code, see \fBlibsm/mbdb.c\fR for details.
1867 .ne 2
1869 \fB\fBMatchGECOS (G)\fR\fR
1871 .sp .6
1872 .RS 4n
1873 Tries to match recipient names using the GECOS field. This allows for mail to
1874 be delivered using names defined in the GECOS field in \fB/etc/passwd\fR as
1875 well as the login name.
1879 .ne 2
1881 \fB\fBMaxDaemonChildren\fR\fR
1883 .sp .6
1884 .RS 4n
1885 The maximum number of children the daemon permits. After this number,
1886 connections are rejected. If not set or <=0, there is no limit.
1890 .ne 2
1892 \fB\fBMaxHopCount (h\fR\fIN\fR\fB)\fR\fR
1894 .sp .6
1895 .RS 4n
1896 The maximum hop count. Messages that have been processed more than \fIN\fR
1897 times are assumed to be in a loop and are rejected. Defaults to \fB25\fR.
1901 .ne 2
1903 \fB\fBMaxMessageSize\fR\fR
1905 .sp .6
1906 .RS 4n
1907 The maximum size of messages that are accepted (in bytes).
1911 .ne 2
1913 \fB\fBMaxMimeHeaderLength=\fR\fIM\fR\fB[/\fR\fIN\fR\fB]\fR\fR
1915 .sp .6
1916 .RS 4n
1917 Sets the maximum length of certain MIME header field values to \fIM\fR
1918 characters. For some of these headers which take parameters, the maximum length
1919 of each parameter is set to \fIN\fR if specified. If \fB/\fR\fIN\fR is not
1920 specified, one half of \fIM\fR is used. By default, these values are \fB0\fR,
1921 meaning no checks are done.
1925 .ne 2
1927 \fB\fBMaxNOOPCommands=\fR\fIN\fR\fR
1929 .sp .6
1930 .RS 4n
1931 Overrides the default of 20 for the number of useless commands.
1935 .ne 2
1937 \fB\fBMaxQueueChildren=\fR\fIN\fR\fR
1939 .sp .6
1940 .RS 4n
1941 When set, this limits the number of concurrent queue runner processes to
1942 \fIN\fR. This helps to control the amount of system resources used when
1943 processing the queue. When there are multiple queue groups defined and the
1944 total number of queue runners for these queue groups would exceed
1945 \fBMaxQueueChildren\fR then the queue groups are not all run concurrently. That
1946 is, some portion of the queue groups run concurrently such that
1947 \fBMaxQueueChildren\fR is not be exceeded, while the remaining queue groups are
1948 run later (in round robin order). See \fBMaxRunnersPerQueue\fR.
1952 .ne 2
1954 \fB\fBMaxQueueRunSize\fR\fR
1956 .sp .6
1957 .RS 4n
1958 If set, limits the maximum size of any given queue run to this number of
1959 entries. This stops reading the queue directory after this number of entries is
1960 reached; job priority is not used. If not set, there is no limit.
1964 .ne 2
1966 \fB\fBMaxRunnersPerQueue=\fR\fIN\fR\fR
1968 .sp .6
1969 .RS 4n
1970 This sets the default maximum number of queue runners for queue groups. Up to
1971 \fIN\fR queue runners work in parallel on a queue group's messages. This is
1972 useful where the processing of a message in the queue might delay the
1973 processing of subsequent messages. Such a delay can be the result of
1974 non-erroneous situations such as a low bandwidth connection. The can be
1975 overridden on a per queue group basis by setting the \fBRunners\fR option. The
1976 default is \fB1\fR when not set.
1980 .ne 2
1982 \fB\fBMeToo (M)\fR\fR
1984 .sp .6
1985 .RS 4n
1986 Sends to me too, even if I am in an alias expansion.
1990 .ne 2
1992 \fB\fBMaxRecipientsPerMessage\fR\fR
1994 .sp .6
1995 .RS 4n
1996 If set, allows no more than the specified number of recipients in an SMTP
1997 envelope. Further recipients receive a 452 error code and are deferred for the
1998 next delivery attempt.
2002 .ne 2
2004 \fB\fBMinFreeBlocks (b\fR\fIN/M\fR\fB)\fR\fR
2006 .sp .6
2007 .RS 4n
2008 Insists on at least \fIN\fR blocks free on the file system that holds the queue
2009 files before accepting email by way of SMTP. If there is insufficient space,
2010 \fBsendmail\fR gives a \fB452\fR response to the \fBMAIL\fR command. This
2011 invites the sender to try again later. The optional \fIM\fR is a maximum
2012 message size advertised in the \fBESMTP\fR \fBEHLO\fR response. It is currently
2013 otherwise unused.
2017 .ne 2
2019 \fB\fBMinQueueAge\fR\fR
2021 .sp .6
2022 .RS 4n
2023 Specifies the amount of time a job must sit in the queue between queue runs.
2024 This allows you to set the queue run interval low for better responsiveness
2025 without trying all jobs in each run. The default value is 0.
2029 .ne 2
2031 \fB\fBMustQuoteChars\fR\fR
2033 .sp .6
2034 .RS 4n
2035 Specifies the characters to be quoted in a full name phrase. \fB&,;:\e()[]\fR
2036 are quoted automatically.
2040 .ne 2
2042 \fB\fBNiceQueueRun\fR\fR
2044 .sp .6
2045 .RS 4n
2046 Specifies the priority of queue runners. See \fBnice\fR(1).
2050 .ne 2
2052 \fB\fBNoRecipientAction\fR\fR
2054 .sp .6
2055 .RS 4n
2056 Sets action if there are no legal recipient files in the message. The legal
2057 values are:
2059 .ne 2
2061 \fB\fBadd-apparently-to\fR\fR
2063 .sp .6
2064 .RS 4n
2065 Adds an \fBApparently-to:\fR header with all the known recipients (which may
2066 expose blind recipients).
2070 .ne 2
2072 \fB\fBadd-bcc\fR\fR
2074 .sp .6
2075 .RS 4n
2076 Adds an empty \fBBcc:\fR header.
2080 .ne 2
2082 \fB\fBadd-to\fR\fR
2084 .sp .6
2085 .RS 4n
2086 Adds a \fBTo:\fR header with all the known recipients (which may expose blind
2087 recipients).
2091 .ne 2
2093 \fB\fBadd-to-undisclosed\fR\fR
2095 .sp .6
2096 .RS 4n
2097 Adds a \fBTo: undisclosed-recipients:\fR header.
2101 .ne 2
2103 \fB\fBnone\fR\fR
2105 .sp .6
2106 .RS 4n
2107 Does nothing, that is, leaves the message as it is.
2113 .ne 2
2115 \fB\fBOldStyleHeaders (o)\fR\fR
2117 .sp .6
2118 .RS 4n
2119 Assumes that the headers may be in old format, that is, spaces delimit names.
2120 This actually turns on an adaptive algorithm: if any recipient address contains
2121 a comma, parenthesis, or angle bracket, it is assumed that commas already
2122 exist. If this flag is not on, only commas delimit names. Headers are always
2123 output with commas between the names.
2127 .ne 2
2129 \fB\fBOperatorChars or $o\fR\fR
2131 .sp .6
2132 .RS 4n
2133 Defines the list of characters that can be used to separate the components of
2134 an address into tokens.
2138 .ne 2
2140 \fB\fBPidFile\fR\fR
2142 .sp .6
2143 .RS 4n
2144 Specifies the filename of the \fBpid\fR file. The default is
2145 \fB/var/run/sendmail.pid\fR. The filename is macro-expanded before it is
2146 opened, and unlinked when \fBsendmail\fR exits.
2150 .ne 2
2152 \fB\fBPostmasterCopy (P\fR\fIpostmaster\fR\fB)\fR\fR
2154 .sp .6
2155 .RS 4n
2156 If set, copies of error messages are sent to the named \fIpostmaster\fR. Only
2157 the header of the failed message is sent. Since most errors are user problems,
2158 this is probably not a good idea on large sites, and arguably contains all
2159 sorts of privacy violations, but it seems to be popular with certain operating
2160 systems vendors.
2164 .ne 2
2166 \fB\fBPrivacyOptions (p\fR\fIopt,opt,...\fR\fB)\fR\fR
2168 .sp .6
2169 .RS 4n
2170 Sets privacy options. Privacy is really a misnomer; many of these options are
2171 just a way of insisting on stricter adherence to the SMTP protocol.
2173 The \fBgoaway\fR pseudo-flag sets all flags except \fBnoreceipts\fR,
2174 \fBrestrictmailq\fR, \fBrestrictqrun\fR, \fBrestrictexpand\fR, \fBnoetrn\fR,
2175 and \fBnobodyreturn\fR. If \fBmailq\fR is restricted, only people in the same
2176 group as the queue directory can print the queue. If queue runs are restricted,
2177 only root and the owner of the queue directory can run the queue. The
2178 \fBrestrict-expand\fR pseudo-flag instructs sendmail to drop privileges when
2179 the -bv option is given by users who are neither root nor the \fBTrustedUser\fR
2180 so users cannot read private aliases, forwards, or \fB:include:\fR files. It
2181 adds the \fBNonRootSafeAddr\fR to the "DontBlame-Sendmail" option to prevent
2182 misleading unsafe address warnings. It also overrides the \fB-v\fR (verbose)
2183 command line option to prevent information leakage. Authentication Warnings add
2184 warnings about various conditions that may indicate attempts to fool the mail
2185 system, such as using an non-standard queue directory.
2187 The options can be selected from:
2189 .ne 2
2191 \fB\fBauthwarnings\fR\fR
2193 .sp .6
2194 .RS 4n
2195 Puts \fBX-Authentication-Warning:\fR headers in messages.
2199 .ne 2
2201 \fB\fBgoaway\fR\fR
2203 .sp .6
2204 .RS 4n
2205 Disallows essentially all SMTP status queries.
2209 .ne 2
2211 \fB\fBneedexpnhelo\fR\fR
2213 .sp .6
2214 .RS 4n
2215 Insists on \fBHELO\fR or \fBEHLO\fR command before \fBEXPN\fR.
2219 .ne 2
2221 \fB\fBneedmailhelo\fR\fR
2223 .sp .6
2224 .RS 4n
2225 Insists on \fBHELO\fR or \fBEHLO\fR command before \fBMAIL\fR.
2229 .ne 2
2231 \fB\fBneedvrfyhelo\fR\fR
2233 .sp .6
2234 .RS 4n
2235 Insists on \fBHELO\fR or \fBEHLO\fR command before \fBVRFY\fR.
2239 .ne 2
2241 \fB\fBnoactualrecipient\fR\fR
2243 .sp .6
2244 .RS 4n
2245 Do not put an X-Actual-Recipient line in a DNS that reveals the actual account
2246 to which an address is mapped.
2250 .ne 2
2252 \fB\fBnoetrn\fR\fR
2254 .sp .6
2255 .RS 4n
2256 Disallows \fBETRN\fR entirely.
2260 .ne 2
2262 \fB\fBnoexpn\fR\fR
2264 .sp .6
2265 .RS 4n
2266 Disallows \fBEXPN\fR entirely.
2270 .ne 2
2272 \fB\fBnoreceipts\fR\fR
2274 .sp .6
2275 .RS 4n
2276 Prevents return receipts.
2280 .ne 2
2282 \fB\fBnobodyreturn\fR\fR
2284 .sp .6
2285 .RS 4n
2286 Does not return the body of a message with DSNs.
2290 .ne 2
2292 \fB\fBnovrfy\fR\fR
2294 .sp .6
2295 .RS 4n
2296 Disallows \fBVRFY\fR entirely.
2300 .ne 2
2302 \fB\fBpublic\fR\fR
2304 .sp .6
2305 .RS 4n
2306 Allows open access.
2310 .ne 2
2312 \fB\fBre\fR\fB\fR\fBstrictexpand\fR\fR
2314 .sp .6
2315 .RS 4n
2316 Restricts \fB-bv\fR and \fB-v\fR command line flags.
2320 .ne 2
2322 \fB\fBrestrictmailq\fR\fR
2324 .sp .6
2325 .RS 4n
2326 Restricts \fBmailq\fR command.
2330 .ne 2
2332 \fB\fBrestrictqrun\fR\fR
2334 .sp .6
2335 .RS 4n
2336 Restricts \fB-q\fR command line flag.
2342 .ne 2
2344 \fB\fBProcessTitlePrefix \fIstring\fR\fR\fR
2346 .sp .6
2347 .RS 4n
2348 Prefixes the process title shown on "\fB/usr/ucb/ps auxww\fR" listings with
2349 \fIstring\fR. The string is macro processed.
2353 .ne 2
2355 \fB\fBQueueDirectory (Q\fR\fIdir\fR\fB)\fR\fR
2357 .sp .6
2358 .RS 4n
2359 Uses the named \fIdir\fR as the queue directory.
2363 .ne 2
2365 \fB\fBQueueFactor (q\fR\fIfactor\fR\fB)\fR\fR
2367 .sp .6
2368 .RS 4n
2369 Uses \fIfactor\fR as the multiplier in the map function to decide when to just
2370 queue up jobs rather than run them. This value is divided by the difference
2371 between the current load average and the load average limit (\fBx\fR flag) to
2372 determine the maximum message priority to be sent. Defaults to \fB600000\fR.
2376 .ne 2
2378 \fB\fBQueueFileMode=\fR\fImode\fR\fR
2380 .sp .6
2381 .RS 4n
2382 Defaults permissions for queue files (octal). If not set, \fBsendmail\fR uses
2383 \fB0600\fR unless its real and effective \fBuid\fR are different in which case
2384 it uses \fB0644\fR.
2388 .ne 2
2390 \fB\fBQueueLA (x\fR\fILA\fR\fB)\fR\fR
2392 .sp .6
2393 .RS 4n
2394 When the system load average exceeds \fILA\fR, just queues messages (that is,
2395 does not try to send them). Defaults to eight times the number of processors
2396 online when \fBsendmail\fR starts.
2400 .ne 2
2402 \fB\fBQueueSortOrder=\fR\fIalgorithm\fR\fR
2404 .sp .6
2405 .RS 4n
2406 Sets the algorithm used for sorting the queue. Only the first character of the
2407 value is used. Legal values are \fBhost\fR (to order by the name of the first
2408 host name of the first recipient), \fBfilename\fR (to order by the name of the
2409 queue file name), \fBtime\fR (to order by the submission/creation time),
2410 \fBrandom\fR (to order randomly), \fBmodification\fR (to order by the
2411 modification time of the \fBqf\fR file (older entries first)), \fBnone\fR (to
2412 not order), and \fBpriority\fR (to order by message priority). Host ordering
2413 makes better use of the connection cache, but may tend to process low priority
2414 messages that go to a single host over high priority messages that go to
2415 several hosts; it probably shouldn't be used on slow network links. Filename
2416 and modification time ordering saves the overhead of reading all of the queued
2417 items before starting the queue run. Creation (submission) time ordering is
2418 almost always a bad idea, since it allows large, bulk mail to go out before
2419 smaller, personal mail, but may have applicability on some hosts with very fast
2420 connections. Random is useful if several queue runners are started by hand
2421 which try to drain the same queue since odds are they are working on different
2422 parts of the queue at the same time. Priority ordering is the default.
2426 .ne 2
2428 \fB\fBQueueTimeout (T\fR\fIrtime\fR\fB/\fR\fIwtime\fR\fB)\fR\fR
2430 .sp .6
2431 .RS 4n
2432 Sets the queue timeout to \fIrtime\fR. After this interval, messages that have
2433 not been successfully sent are returned to the sender. Defaults to five days
2434 (\fB5d\fR). The optional \fIwtime\fR is the time after which a warning message
2435 is sent. If it is missing or \fB0\fR, then no warning messages are sent.
2439 .ne 2
2441 \fB\fBRandFile\fR\fR
2443 .sp .6
2444 .RS 4n
2445 File containing random data (use prefix \fBfile:\fR) or the name of the UNIX
2446 socket if EGD is used (use prefix \fBegd:\fR). Note that Solaris supports
2447 \fBrandom\fR(7D), so this does not need to be specified.
2451 .ne 2
2453 \fB\fBRecipientFactor (y\fR\fIfact\fR\fB)\fR\fR
2455 .sp .6
2456 .RS 4n
2457 The indicated factor \fIfact\fR is added to the priority (thus \fIlowering\fR
2458 the priority of the job) for each recipient, that is, this value penalizes jobs
2459 with large numbers of recipients. Defaults to \fB30000\fR.
2463 .ne 2
2465 \fB\fBRefuseLA (X\fR\fILA\fR\fB)\fR\fR
2467 .sp .6
2468 .RS 4n
2469 When the system load average exceeds \fILA\fR, refuses incoming \fBSMTP\fR
2470 connections. Defaults to 12 times the number of processors online when
2471 \fBsendmail\fR starts.
2475 .ne 2
2477 \fB\fBRejectLogInterval\fR\fR
2479 .sp .6
2480 .RS 4n
2481 Log interval when refusing connections for this long (default: 3h).
2485 .ne 2
2487 \fB\fBResolverOptions (I)\fR\fR
2489 .sp .6
2490 .RS 4n
2491 Tunes DNS lookups.
2495 .ne 2
2497 \fB\fBRetryFactor (Z\fR\fIfact\fR\fB)\fR\fR
2499 .sp .6
2500 .RS 4n
2501 The indicated factor \fIfact\fR is added to the priority every time a job is
2502 processed. Thus, each time a job is processed, its priority is decreased by the
2503 indicated value. In most environments this should be positive, since hosts that
2504 are down are all too often down for a long time. Defaults to \fB90000\fR.
2508 .ne 2
2510 \fB\fBRrtImpliesDsn\fR\fR
2512 .sp .6
2513 .RS 4n
2514 If this option is set, a \fBReturn-Receipt-To\fR: header causes the request of
2515 a \fBDSN\fR, which is sent to the envelope sender as required by RFC 1891, not
2516 to the address given in the header.
2520 .ne 2
2522 \fB\fBRunAsUser\fR\fR
2524 .sp .6
2525 .RS 4n
2526 If set, becomes this user when reading and delivering mail. Intended for use of
2527 firewalls where users do not have accounts.
2531 .ne 2
2533 \fB\fBSafeFileEnvironment\fR\fR
2535 .sp .6
2536 .RS 4n
2537 If set, \fBsendmail\fR does a \fBchroot\fR into this directory before writing
2538 files.
2542 .ne 2
2544 \fB\fBSaveFromLine (f)\fR\fR
2546 .sp .6
2547 .RS 4n
2548 Saves Unix-style \fBFrom\fR lines at the front of headers. Normally they are
2549 assumed redundant and discarded.
2553 .ne 2
2555 \fB\fBSendMimeErrors (j)\fR\fR
2557 .sp .6
2558 .RS 4n
2559 If set, sends error messages in MIME format (see RFC 2045 and RFC 1344 for
2560 details). If disabled, \fBsendmail\fR does not return the DSN keyword in
2561 response to an \fBEHLO\fR and does not do Delivery Status Notification
2562 processing as described in RFC 1891.
2566 .ne 2
2568 \fB\fBServerCertFile\fR\fR
2570 .sp .6
2571 .RS 4n
2572 File containing the cert of the server, that is, this cert is used when
2573 \fBsendmail\fR acts as server.
2577 .ne 2
2579 \fB\fBServerKeyFile\fR\fR
2581 .sp .6
2582 .RS 4n
2583 File containing the private key belonging to the server cert.
2587 .ne 2
2589 \fB\fBServiceSwitchFile\fR\fR
2591 .sp .6
2592 .RS 4n
2593 Defines the path to the service-switch file. Since the service-switch file is
2594 defined in the Solaris operating environment this option is ignored.
2598 .ne 2
2600 \fB\fBSevenBitInput (7)\fR\fR
2602 .sp .6
2603 .RS 4n
2604 Strips input to seven bits for compatibility with old systems. This should not
2605 be necessary.
2609 .ne 2
2611 \fB\fBSharedMemoryKey\fR\fR
2613 .sp .6
2614 .RS 4n
2615 Specifies key to use for shared memory segment. If not set (or \fB0\fR), shared
2616 memory is not be used. If this option is set, \fBsendmail\fR can share some
2617 data between different instances. For example, the number of entries in a queue
2618 directory or the available space in a file system. This allows for more
2619 efficient program execution, since only one process needs to update the data
2620 instead of each individual process gathering the data each time it is required.
2624 .ne 2
2626 \fB\fBSharedMemoryKeyFile=\fR\fIfile\fR\fR
2628 .sp .6
2629 .RS 4n
2630 If \fBSharedMemoryKeyFile\fR is set to \fB-1\fR, the automatically selected
2631 shared memory key will be stored in the specified file.
2635 .ne 2
2637 \fB\fBSingleLineFromHeader\fR\fR
2639 .sp .6
2640 .RS 4n
2641 If set, \fBFrom:\fR lines that have embedded newlines are unwrapped onto one
2642 line.
2646 .ne 2
2648 \fB\fBSingleThreadDelivery\fR\fR
2650 .sp .6
2651 .RS 4n
2652 If this option and the \fBHostStatusDirectory\fR option are both set, uses
2653 single thread deliveries to other hosts.
2657 .ne 2
2659 \fB\fBSmtpGreetingMessage or $e\fR\fR
2661 .sp .6
2662 .RS 4n
2663 Specifies the initial SMTP greeting message.
2667 .ne 2
2669 \fB\fBSoftBounce\fR\fR
2671 .sp .6
2672 .RS 4n
2673 If set, issue temporary errors (\fB4xy\fR) instead of permanent errors
2674 (\fB5xy\fR). This can be useful during testing of a new configuration to avoid
2675 erroneous bouncing of mail.
2679 .ne 2
2681 \fB\fBStatusFile (S\fR\fIfile\fR\fB)\fR\fR
2683 .sp .6
2684 .RS 4n
2685 Logs statistics in the named \fIfile\fR. By default, this is
2686 \fB/etc/mail/sendmail.st\fR. As root, you must \fBtouch\fR(1) this file to
2687 enable \fBmailstats\fR(1).
2691 .ne 2
2693 \fB\fBSuperSafe (s)\fR\fR
2695 .sp .6
2696 .RS 4n
2697 This option can be set to \fBTrue\fR, \fBFalse\fR, \fBInteractive\fR, or
2698 \fBPostMilter\fR. If set to \fBTrue\fR, \fBsendmail\fR is set to super-safe
2699 when running things, that is, always instantiate the queue file, even if you
2700 are going to attempt immediate delivery. \fBsendmail\fR always instantiates the
2701 queue file before returning control to the client under any circumstances. This
2702 should really always be set to \fBTrue\fR. The \fBInteractive\fR value has been
2703 introduced in \fB8.12\fR and can be used together with \fBDeliveryMode=i\fR. It
2704 skips some synchronization calls which are effectively doubled in the code
2705 execution path for this mode. If set to \fBPostMilter\fR, \fBsendmail\fR defers
2706 synchronizing the queue file until any milters have signaled acceptance of the
2707 message. \fBPostMilter\fR is useful only when \fBsendmail\fR is running as an
2708 SMTP server; in all other situations it acts the same as True.
2712 .ne 2
2714 \fB\fBTempFileMode (F\fR\fImode\fR\fB)\fR\fR
2716 .sp .6
2717 .RS 4n
2718 Specifies the file mode for queue files.
2722 .ne 2
2724 \fB\fBTimeout (r\fR\fItimeouts\fR\fB)\fR\fR
2726 .sp .6
2727 .RS 4n
2728 Timeout reads after time interval. The \fItimeouts\fR argument is a list of
2729 \fIkeyword=value\fR pairs. All but \fIcommand\fR apply to client \fBSMTP\fR.
2730 For backward compatibility, a timeout with no \fIkeyword\fR= part is set all of
2731 the longer values. The recognized timeouts and their default values, and their
2732 minimum values specified in RFC 1123 section 5.3.2 are:
2734 .ne 2
2736 \fB\fBaconnect\fR\fR
2738 .sp .6
2739 .RS 4n
2740 all connections for a single delivery attempt [0, unspecified]
2744 .ne 2
2746 \fB\fBcommand\fR\fR
2748 .sp .6
2749 .RS 4n
2750 command read [1h, 5m]
2754 .ne 2
2756 \fB\fBconnect\fR\fR
2758 .sp .6
2759 .RS 4n
2760 initial connect [0, unspecified]
2764 .ne 2
2766 \fB\fBcontrol\fR\fR
2768 .sp .6
2769 .RS 4n
2770 complete control socket transaction [2m, none]
2774 .ne 2
2776 \fB\fBdatablock\fR\fR
2778 .sp .6
2779 .RS 4n
2780 data block read [1h, 3m]
2784 .ne 2
2786 \fB\fBdatafinal\fR\fR
2788 .sp .6
2789 .RS 4n
2790 reply to final \fB\&.\fR in data [1h, 10m]
2794 .ne 2
2796 \fB\fBdatainit\fR\fR
2798 .sp .6
2799 .RS 4n
2800 reply to \fBDATA\fR command [5m, 2m]
2804 .ne 2
2806 \fB\fBfileopen\fR\fR
2808 .sp .6
2809 .RS 4n
2810 file open [60sec, none]
2814 .ne 2
2816 \fB\fBhelo\fR\fR
2818 .sp .6
2819 .RS 4n
2820 reply to \fBHELO\fR or \fBEHLO\fR command [5m, none]
2824 .ne 2
2826 \fB\fBhoststatus\fR\fR
2828 .sp .6
2829 .RS 4n
2830 host retry [30m, unspecified]
2834 .ne 2
2836 \fB\fBiconnect\fR\fR
2838 .sp .6
2839 .RS 4n
2840 first attempt to connect to a host [0, unspecified]
2844 .ne 2
2846 \fB\fBident\fR\fR
2848 .sp .6
2849 .RS 4n
2850 \fBIDENT\fR protocol timeout [5s, none]
2854 .ne 2
2856 \fB\fBinitial\fR\fR
2858 .sp .6
2859 .RS 4n
2860 wait for initial greeting message [5m, 5m]
2864 .ne 2
2866 \fB\fBlhlo\fR\fR
2868 .sp .6
2869 .RS 4n
2870 wait for reply to an LMTP LHLO command [2m, unspecified]
2874 .ne 2
2876 \fB\fBmail\fR\fR
2878 .sp .6
2879 .RS 4n
2880 reply to \fBMAIL\fR command [10m, 5m]
2884 .ne 2
2886 \fB\fBmisc\fR\fR
2888 .sp .6
2889 .RS 4n
2890 reply to \fBNOOP\fR and \fBVERB\fR commands [2m, none]
2894 .ne 2
2896 \fB\fBqueuereturn\fR\fR
2898 .sp .6
2899 .RS 4n
2900 undeliverable message returned [5d]
2904 .ne 2
2906 \fB\fBqueuewarn\fR\fR
2908 .sp .6
2909 .RS 4n
2910 deferred warning [4h]
2914 .ne 2
2916 \fB\fBquit\fR\fR
2918 .sp .6
2919 .RS 4n
2920 reply to \fBQUIT\fR command [2m, none]
2924 .ne 2
2926 \fB\fBrcpt\fR\fR
2928 .sp .6
2929 .RS 4n
2930 reply to \fBRCPT\fR command [1h, 5m]
2934 .ne 2
2936 \fB\fBresolver.retrans\fR\fR
2938 .sp .6
2939 .RS 4n
2940 Resolver's retransmission time interval (in seconds) [varies]. Sets both
2941 \fBTimeout.resolver.retrans.first\fR and \fBTimeout.resolver.retrans.normal\fR.
2945 .ne 2
2947 \fB\fBresolver.retrans.first\fR\fR
2949 .sp .6
2950 .RS 4n
2951 Resolver's retransmission time interval (in seconds) for the first attempt to
2952 deliver a message [varies].
2956 .ne 2
2958 \fB\fBresolver.retrans.normal\fR\fR
2960 .sp .6
2961 .RS 4n
2962 Resolver's retransmission time interval (in seconds) for all look-ups except
2963 the first delivery attempt [varies].
2967 .ne 2
2969 \fB\fBresolver.retry\fR\fR
2971 .sp .6
2972 .RS 4n
2973 Number of times to retransmit a resolver query [varies]. Sets both
2974 \fBTimeout.resolver.retry.first\fR and \fBTimeout.resolver.retry.normal\fR.
2978 .ne 2
2980 \fB\fBresolver.retry.first\fR\fR
2982 .sp .6
2983 .RS 4n
2984 Number of times to retransmit a resolver query for the first attempt to deliver
2985 a message [varies].
2989 .ne 2
2991 \fB\fBresolver.retry.normal\fR\fR
2993 .sp .6
2994 .RS 4n
2995 Number of times to retransmit a resolver query for all look-ups except the
2996 first delivery attempt [varies].
3000 .ne 2
3002 \fB\fBrset\fR\fR
3004 .sp .6
3005 .RS 4n
3006 reply to \fBRSET\fR command [5m, none]
3010 .ne 2
3012 \fB\fBstarttls\fR\fR
3014 .sp .6
3015 .RS 4n
3016 response to an \fBSMTP STARTTLS\fR command [1h]
3022 .ne 2
3024 \fB\fBTimeZoneSpec (t\fR\fItzinfo\fR\fB)\fR\fR
3026 .sp .6
3027 .RS 4n
3028 Sets the local time zone info to \fItzinfo\fR, for example, "PST8PDT".
3029 Actually, if this is not set, the \fBTZ\fR environment variable is cleared (so
3030 the system default is used); if set but null, the user's \fBTZ\fR variable is
3031 used, and if set and non-null, the \fBTZ\fR variable is set to this value.
3035 .ne 2
3037 \fB\fBTLSSrvOptions\fR\fR
3039 .sp .6
3040 .RS 4n
3041 If this option is '\fBV\fR', then no client verification is performed,that is,
3042 the server does not ask for a certificate.
3046 .ne 2
3048 \fB\fBTrustedUser\fR\fR
3050 .sp .6
3051 .RS 4n
3052 The user parameter can be a user name (looked up in the passwd map) or a
3053 numeric user id. Trusted user for file ownership and starting the daemon. If
3054 set, generated alias databases and the control socket (if configured) are
3055 automatically owned by this user.
3059 .ne 2
3061 \fB\fBTryNullMXList (w)\fR\fR
3063 .sp .6
3064 .RS 4n
3065 If you are the "best" (that is, lowest preference) \fBMX\fR for a given host,
3066 you should normally detect this situation and treat that condition specially,
3067 by forwarding the mail to a \fBUUCP\fR feed, treating it as local, or whatever.
3068 However, in some cases (such as Internet firewalls) you may want to try to
3069 connect directly to that host as though it had no \fBMX\fR records at all.
3070 Setting this option causes \fBsendmail\fR to try this. The downside is that
3071 errors in your configuration are likely to be diagnosed as "host unknown" or
3072 "message timed out" instead of something more meaningful. This option is
3073 deprecated.
3077 .ne 2
3079 \fB\fBUnixFromLine or $l\fR\fR
3081 .sp .6
3082 .RS 4n
3083 The "From " line used when sending to files or programs.
3087 .ne 2
3089 \fB\fBUnsafeGroupWrites\fR\fR
3091 .sp .6
3092 .RS 4n
3093 If set, group-writable :include: and .forward files are considered "unsafe",
3094 that is, programs and files cannot be directly referenced from such files.
3098 .ne 2
3100 \fB\fBUseErrorsTo (l)\fR\fR
3102 .sp .6
3103 .RS 4n
3104 If there is an \fBErrors-To\fR: header, sends error messages to the addresses
3105 listed there. They normally go to the envelope sender. Use of this option
3106 causes \fBsendmail\fR to violate \fBRFC\fR 1123. This option is not recommended
3107 and deprecated.
3111 .ne 2
3113 \fB\fBUseMSP\fR\fR
3115 .sp .6
3116 .RS 4n
3117 Uses as mail submission program, that is, allows group writable queue files if
3118 the group is the same as that of a set-group-id \fBsendmail\fR binary.
3122 .ne 2
3124 \fB\fBUserDatabaseSpec (U)\fR\fR
3126 .sp .6
3127 .RS 4n
3128 Defines the name and location of the file containing User Database information.
3132 .ne 2
3134 \fB\fBVerbose (v)\fR\fR
3136 .sp .6
3137 .RS 4n
3138 Runs in verbose mode. If this is set, \fBsendmail\fR adjusts the
3139 \fBHoldExpensive\fR and \fBDeliveryMode\fR options so that all mail is
3140 delivered completely in a single job so that you can see the entire delivery
3141 process. The \fBVerbose\fR option should \fBnever\fR be set in the
3142 configuration file; it is intended for command line use only.
3146 .ne 2
3148 \fB\fBXscriptFileBufferSize\fR\fR
3150 .sp .6
3151 .RS 4n
3152 Sets the threshold, in bytes, before a memory-bases queue transcript file
3153 becomes disk-based. The default is 4096 bytes.
3158 If the first character of the user name is a vertical bar, the rest of the user
3159 name is used as the name of a program to pipe the mail to. It may be necessary
3160 to quote the name of the user to keep \fBsendmail\fR from suppressing the
3161 blanks from between arguments.
3164 If invoked as \fBnewaliases\fR, \fBsendmail\fR rebuilds the alias database, so
3165 long as the \fB/etc/mail/aliases*\fR files are owned by root \fIand\fR root has
3166 exclusive write permission. If invoked as \fBmailq\fR, \fBsendmail\fR prints
3167 the contents of the mail queue.
3168 .SH OPERANDS
3169 .ne 2
3171 \fB\fIaddress\fR\fR
3173 .sp .6
3174 .RS 4n
3175 address of an intended recipient of the message being sent.
3178 .SH USAGE
3180 See \fBlargefile\fR(5) for the description of the behavior of \fBsendmail\fR
3181 when encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
3182 .SH EXIT STATUS
3184 \fBsendmail\fR returns an exit status describing what it did. The codes are
3185 defined in \fB/usr/include/sysexits.h\fR.
3187 .ne 2
3189 \fB\fBEX_OK\fR\fR
3191 .sp .6
3192 .RS 4n
3193 Successful completion on all addresses.
3197 .ne 2
3199 \fB\fBEX_NOUSER\fR\fR
3201 .sp .6
3202 .RS 4n
3203 User name not recognized.
3207 .ne 2
3209 \fB\fBEX_UNAVAILABLE\fR\fR
3211 .sp .6
3212 .RS 4n
3213 Catchall. Necessary resources were not available.
3217 .ne 2
3219 \fB\fBEX_SYNTAX\fR\fR
3221 .sp .6
3222 .RS 4n
3223 Syntax error in address.
3227 .ne 2
3229 \fB\fBEX_SOFTWARE\fR\fR
3231 .sp .6
3232 .RS 4n
3233 Internal software error, including bad arguments.
3237 .ne 2
3239 \fB\fBEX_OSERR\fR\fR
3241 .sp .6
3242 .RS 4n
3243 Temporary operating system error, such as "cannot fork".
3247 .ne 2
3249 \fB\fBEX_NOHOST\fR\fR
3251 .sp .6
3252 .RS 4n
3253 Host name not recognized.
3257 .ne 2
3259 \fB\fBEX_TEMPFAIL\fR\fR
3261 .sp .6
3262 .RS 4n
3263 Message could not be sent immediately, but was queued.
3266 .SH ENVIRONMENT VARIABLES
3268 No environment variables are used. However, sendmail's start-up script, invoked
3269 by \fBsvcadm\fR(1M), reads \fB/etc/default/sendmail\fR. In this file, if the
3270 variable \fBETRN_HOSTS\fR is set, the start-up script parses this variable and
3271 invokes \fBetrn\fR(1M) appropriately. \fBETRN_HOSTS\fR should be of the form:
3273 .in +2
3275 "s1:c1.1,c1.2        s2:c2.1 s3:c3.1,c3.2,c3.3"
3277 .in -2
3282 That is, white-space separated groups of \fIserver:client\fR where \fIclient\fR
3283 can be one or more comma-separated names. The \fI:client\fR part is optional.
3284 \fIserver\fR is the name of the server to prod; a mail queue run is requested
3285 for each \fIclient\fR name. This is comparable to running:
3287 .in +2
3289 /usr/lib/sendmail -qR \fIclient\fR
3291 .in -2
3296 on the host \fIserver\fR.
3297 .SH FILES
3298 .ne 2
3300 \fB\fBdead.letter\fR\fR
3302 .sp .6
3303 .RS 4n
3304 Unmailable text
3308 .ne 2
3310 \fB\fB/etc/default/sendmail\fR\fR
3312 .sp .6
3313 .RS 4n
3314 Contains default settings. You can override some of the settings by command
3315 line options.
3319 .ne 2
3321 \fB\fB/etc/mail/aliases\fR\fR
3323 .sp .6
3324 .RS 4n
3325 Mail aliases file (ASCII)
3329 .ne 2
3331 \fB\fB/etc/mail/aliases.db\fR\fR
3333 .sp .6
3334 .RS 4n
3335 Database of mail aliases (binary)
3339 .ne 2
3341 \fB\fB/etc/mail/aliases.dir\fR\fR
3343 .sp .6
3344 .RS 4n
3345 Database of mail aliases (binary)
3349 .ne 2
3351 \fB\fB/etc/mail/aliases.pag\fR\fR
3353 .sp .6
3354 .RS 4n
3355 Database of mail aliases (binary)
3359 .ne 2
3361 \fB\fB/etc/mail/sendmail.cf\fR\fR
3363 .sp .6
3364 .RS 4n
3365 Defines environment for \fBsendmail\fR
3369 .ne 2
3371 \fB\fB/etc/mail/submit.cf\fR\fR
3373 .sp .6
3374 .RS 4n
3375 Defines environment for MSP
3379 .ne 2
3381 \fB\fB/etc/mail/trusted-users\fR\fR
3383 .sp .6
3384 .RS 4n
3385 Lists users that are "trusted", that is, able to set their envelope from
3386 address using \fB-f\fR without generating a warning message. Note that this
3387 file is consulted by the default \fBsendmail.cf\fR, but not by the default
3388 \fBsubmit.cf\fR, in which the line referring to \fB/etc/mail/trusted-users\fR
3389 is commented out. See \fBsendmail\fR(4) for instructions on making changes to
3390 \fBsubmit.cf\fR and \fBsendmail.cf\fR.
3394 .ne 2
3396 \fB\fB/var/spool/clientmqueue/*\fR\fR
3398 .sp .6
3399 .RS 4n
3400 Temporary files and queued mail
3404 .ne 2
3406 \fB\fB/var/spool/mqueue/*\fR\fR
3408 .sp .6
3409 .RS 4n
3410 Temporary files and queued mail
3414 .ne 2
3416 \fB\fB~/.forward\fR\fR
3418 .sp .6
3419 .RS 4n
3420 List of recipients for forwarding messages
3424 .ne 2
3426 \fB\fB/usr/include/libmilter/README\fR\fR
3428 .sp .6
3429 .RS 4n
3430 Describes the steps needed to compile and run a filter
3433 .SH SEE ALSO
3435 \fBsvcs\fR(1), \fBbiff\fR(1B), \fBmail\fR(1), \fBmailq\fR(1), \fBmailx\fR(1),
3436 \fBnice\fR(1), \fBcheck-hostname\fR(1M), \fBcheck-permissions\fR(1M),
3437 \fBetrn\fR(1M), \fBnewaliases\fR(1M), \fBsvcadm\fR(1M), \fBsvccfg\fR(1M),
3438 \fBfork\fR(2), \fBgetpwnam\fR(3C), \fBgetusershell\fR(3C),
3439 \fBresolver\fR(3RESOLV), \fBaliases\fR(4), \fBhosts\fR(4), \fBsendmail\fR(4),
3440 \fBshells\fR(4), \fBattributes\fR(5), \fBlargefile\fR(5), \fBsmf\fR(5),
3441 \fBrandom\fR(7D), \fBtcpd\fR(1M), \fBhosts_access\fR(4)
3444 \fBRFC\fR 2821 \fISimple Mail Transfer Protocol\fR, John Klensin, April 2001.
3447 \fBRFC\fR 2822 \fIInternet Message Format\fR, Pete Resnick, April 2001.
3450 \fIsendmail, Third Edition\fR, Bryan Costales with Eric Allman\fB\fR, O'Reilly
3451 & Associates, Inc., 2003.
3454 http://www.sendmail.org
3457 http://www.milter.org
3458 .SH NOTES
3460 The \fBsendmail\fR program requires a fully qualified host name when starting.
3461 A script has been included to help verify if the host name is defined properly
3462 (see \fBcheck-hostname\fR(1M)).
3465 The permissions and the ownership of several directories have been changed in
3466 order to increase security. In particular, access to \fB/etc/mail\fR and
3467 \fB/var/spool/mqueue\fR has been restricted.
3470 Security restrictions have been placed users using \fB\&.forward\fR files to
3471 pipe mail to a program or redirect mail to a file. The default shell (as listed
3472 in \fB/etc/passwd\fR) of these users must be listed in \fB/etc/shells\fR. This
3473 restriction does not affect mail that is being redirected to another alias.
3476 Additional restrictions have been put in place on \fB\&.forward\fR and
3477 \fB:include:\fR files. These files and the directory structure that they are
3478 placed in cannot be group- or world-writable. See \fBcheck-permissions\fR(1M).
3481 If you have interfaces that map to domains that have MX records that point to
3482 non-local destinations, you might need to enable the \fBDontProbeInterfaces\fR
3483 option to enable delivery to those destinations. In its default startup
3484 behavior, \fBsendmail\fR probes each interface and adds an interface's \fBIP\fR
3485 addresses, as well as any domains that those addresses map to, to its list of
3486 domains that are considered local. For domains thus added, being on the list of
3487 local domains is equivalent to having a 0-preference MX record, with
3488 \fBlocalhost\fR as the MX value. If this is not the result you want, enable
3489 \fBDontProbeInterfaces\fR.