6324 Add an `ndp' tool for manipulating the neighbors table
[illumos-gate.git] / usr / src / man / man1m / sendmail.1m
blob8fbf6c870b9cb0b70f1bcddb705fdda2d576750a
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 "Feb 25, 2009"
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 .sp
27 .LP
28 The \fBsendmail\fR utility sends a message to one or more people, routing the
29 message over whatever networks are necessary. \fBsendmail\fR does internetwork
30 forwarding as necessary to deliver the message to the correct place.
31 .sp
32 .LP
33 \fBsendmail\fR is not intended as a user interface routine. Other programs
34 provide user-friendly front ends. \fBsendmail\fR is used only to deliver
35 pre-formatted messages.
36 .sp
37 .LP
38 With no flags, \fBsendmail\fR reads its standard input up to an EOF, or a line
39 with a single dot, and sends a copy of the letter found there to all of the
40 addresses listed. It determines the network to use based on the syntax and
41 contents of the addresses.
42 .sp
43 .LP
44 Local addresses are looked up in the local \fBaliases\fR(4) file, or in a name
45 service as defined by the \fBnsswitch.conf\fR(4) file, and aliased
46 appropriately. In addition, if there is a \fB\&.forward\fR file in a
47 recipient's home directory, \fBsendmail\fR forwards a copy of each message to
48 the list of recipients that file contains. Refer to the \fBNOTES\fR section for
49 more information about \fB\&.forward\fR files. Aliasing can be prevented by
50 preceding the address with a backslash.
51 .sp
52 .LP
53 There are several conditions under which the expected behavior is for the alias
54 database to be either built or rebuilt. This cannot occur under any
55 circumstances unless root owns \fBand\fR has exclusive write permission to the
56 \fB/etc/mail/aliases*\fR files.
57 .sp
58 .LP
59 If a message is found to be undeliverable, it is returned to the sender with
60 diagnostics that indicate the location and nature of the failure; or, the
61 message is placed in a \fBdead.letter\fR file in the sender's home directory.
62 .SS "Service Management"
63 .sp
64 .LP
65 The \fBsendmail\fR service is managed by the service management facility,
66 \fBsmf\fR(5), under the service identifiers:
67 .sp
68 .in +2
69 .nf
70 svc:/network/smtp:sendmail
71 svc:/network/sendmail-client:default
73 .fi
74 .in -2
75 .sp
77 .sp
78 .LP
79 Administrative actions on these services, such as enabling, disabling, or
80 requesting restart, can be performed using \fBsvcadm\fR(1M). The services'
81 status can be queried using the \fBsvcs\fR(1) command.
82 .sp
83 .LP
84 These are separate services rather than instances of the same service so that
85 other services can properly express any dependencies. In particular, here are
86 some guidelines about which service/instance should be depended on for which
87 purposes:
88 .RS +4
89 .TP
90 .ie t \(bu
91 .el o
92 For a service that uses \fBsendmail\fR to send mail, an optional dependency on
93 the service \fBsvc:/network/sendmail-client\fR might be in order.
94 .RE
95 .RS +4
96 .TP
97 .ie t \(bu
98 .el o
99 For a service that needs to receive mail in general, but does not depend on
100 \fBsendmail\fR being the particular SMTP receiver, a dependency on the service
101 \fBsvc:/network/smtp\fR might be in order.
103 .RS +4
105 .ie t \(bu
106 .el o
107 For a service that needs to interact with sendmail in particular, such as a
108 \fBMilter\fR, a dependency on the instance \fBsvc:/network/smtp:sendmail\fR
109 might be in order.
113 For the last two, note the difference, as the latter has the \fB":sendmail"\fR
114 instance specification, whereas the former does not, thus representing the more
115 general service.
116 .SS "Enabling Access to Remote Clients"
119 On an unmodified system, access to \fBsendmail\fR by remote clients is enabled
120 and disabled through the service management facility (see \fBsmf\fR(5)). In
121 particular, remote access is determined by the value of the \fBlocal_only\fR
122 SMF property:
124 .in +2
126 svc:/network/smtp:sendmail/config/local_only = true
128 .in -2
132 A setting of \fBtrue\fR, as above, disallows remote access; \fBfalse\fR allows
133 remote access. The default value is \fBtrue\fR.
136 The following example shows the sequence of SMF commands used to enable
137 \fBsendmail\fR to allow access to remote systems:
139 .in +2
141 # \fBsvccfg -s svc:/network/smtp:sendmail setprop config/local_only = false\fR
142 # \fBsvcadm refresh svc:/network/smtp:sendmail\fR
143 # \fBsvcadm restart svc:/network/smtp:sendmail\fR
145 .in -2
150 See \fBsvcadm\fR(1M) and \fBsvccfg\fR(1M).
153 Note, however, on a system where any of the \fBsendmail\fR(4) files have been
154 customized, setting this property might not have the intended effect. See
155 \fBsendmail\fR(4) for details.
156 .SS "Automated Rebuilding of Configuration Files"
159 See \fBsendmail\fR(4) for details on which service properties can be set to
160 automate (re)building of configuration files when the service is started.
161 .SS "Restricting Host Access"
164 \fBsendmail\fR uses TCP Wrappers to restrict access to hosts. It uses the
165 service name of \fBsendmail\fR for \fBhosts_access()\fR. For more information
166 on TCP Wrappers, see \fBtcpd\fR(1M) and \fBhosts_access\fR(4) in the
167 \fBSUNWtcpd\fR package. \fBtcpd\fR(1M) and \fBhosts_access\fR(4) are not part
168 of the Solaris man pages.
169 .SS "Startup Options"
172 The \fB/etc/default/sendmail\fR file stores startup options for \fBsendmail\fR
173 so that the options are not removed when a host is upgraded. See also
174 \fBsendmail\fR(4) for details on which service properties can be set to
175 automate (re)building of configuration files when the service is started.
178 You can use the following variables in the \fB/etc/default/sendmail\fR startup
179 file:
181 .ne 2
183 \fBCLIENTOPTIONS=\fIstring\fR\fR
185 .sp .6
186 .RS 4n
187 Selects additional options to be used with the client daemon, which looks in
188 the client-only queue (\fB/var/spool/clientmqueue\fR) and acts as a client
189 queue runner. No syntax checking is done, so be careful when making changes to
190 this variable.
194 .ne 2
196 \fBCLIENTQUEUEINTERVAL=\fI#\fR\fR
198 .sp .6
199 .RS 4n
200 Similar to the \fBQUEUEINTERVAL\fR option, \fBCLIENTQUEUEINTERVAL\fR sets the
201 time interval for mail queue runs. However, the \fBCLIENTQUEUEINTERVAL\fR
202 option controls the functions of the client daemon, instead of the functions of
203 the master daemon. Typically, the master daemon is able to deliver all messages
204 to the SMTP port. However, if the message load is too high or the master daemon
205 is not running, then messages go into the client-only queue,
206 \fB/var/spool/clientmqueue\fR. The client daemon, which checks in the
207 client-only queue, then acts as a client queue processor.
211 .ne 2
213 \fBETRN_HOSTS=\fIstring\fR\fR
215 .sp .6
216 .RS 4n
217 Enables an SMTP client and server to interact immediately without waiting for
218 the queue run intervals, which are periodic. The server can immediately deliver
219 the portion of its queue that goes to the specified hosts. For more
220 information, refer to the \fBetrn\fR(1M) man page.
224 .ne 2
226 \fBMODE=-bd\fR
228 .sp .6
229 .RS 4n
230 Selects the mode to start \fBsendmail\fR with. Use the \fB-bd\fR option or
231 leave it undefined.
235 .ne 2
237 \fBOPTIONS=\fIstring\fR\fR
239 .sp .6
240 .RS 4n
241 Selects additional options to be used with the master daemon. No syntax
242 checking is done, so be careful when making changes to this variable.
246 .ne 2
248 \fBQUEUEINTERVAL=\fI#\fR\fR
250 .sp .6
251 .RS 4n
252 Sets the interval for mail queue runs on the master daemon. \fI#\fR can be a
253 positive integer that is followed by either \fBs\fR for seconds, \fBm\fR for
254 minutes, \fBh\fR for hours, \fBd\fR for days, or \fBw\fR for weeks. The syntax
255 is checked before \fBsendmail\fR is started. If the interval is negative or if
256 the entry does not end with an appropriate letter, the interval is ignored and
257 \fBsendmail\fR starts with a queue interval of 15 minutes.
261 .ne 2
263 \fBQUEUEOPTIONS=p\fR
265 .sp .6
266 .RS 4n
267 Enables one persistent queue runner that sleeps between queue run intervals,
268 instead of a new queue runner for each queue run interval. You can set this
269 option to \fBp\fR, which is the only setting available. Otherwise, this option
270 is not set.
273 .SS "Mail Filter API"
276 \fBsendmail\fR supports a mail filter API called "milter". For more
277 information, see \fB/usr/include/libmilter/README\fR and http://www.milter.org
278 .SH OPTIONS
281 The following options are supported:
283 .ne 2
285 \fB\fB-Ac\fR\fR
287 .sp .6
288 .RS 4n
289 Uses \fBsubmit.cf\fR even if the operation mode does not indicate an initial
290 mail submission.
294 .ne 2
296 \fB\fB-Am\fR\fR
298 .sp .6
299 .RS 4n
300 Uses \fBsendmail.cf\fR even if the operation mode indicates an initial mail
301 submission.
305 .ne 2
307 \fB\fB-ba\fR\fR
309 .sp .6
310 .RS 4n
311 Goes into \fBARPANET\fR mode. All input lines must end with a RETURN-LINEFEED,
312 and all messages are generated with a RETURN-LINEFEED at the end. Also, the
313 \fBFrom:\fR and \fBSender:\fR fields are examined for the name of the sender.
317 .ne 2
319 \fB\fB-bd\fR\fR
321 .sp .6
322 .RS 4n
323 Runs as a daemon in the background, waiting for incoming SMTP connections.
327 .ne 2
329 \fB\fB-bD\fR\fR
331 .sp .6
332 .RS 4n
333 Runs as a daemon in the foreground, waiting for incoming SMTP connections.
337 .ne 2
339 \fB\fB-bi\fR\fR
341 .sp .6
342 .RS 4n
343 Initializes the \fBaliases\fR(4) database. Root must own \fIand\fR have
344 exclusive write permission to the \fB/etc/mail/aliases*\fR files for successful
345 use of this option.
349 .ne 2
351 \fB\fB-bl\fR\fR
353 .sp .6
354 .RS 4n
355 Runs as a daemon (like \fB-bd\fR) but accepts only loopback SMTP connections.
359 .ne 2
361 \fB\fB-bm\fR\fR
363 .sp .6
364 .RS 4n
365 Delivers mail in the usual way (default).
369 .ne 2
371 \fB\fB-bp\fR\fR
373 .sp .6
374 .RS 4n
375 Prints a summary of the mail queues.
379 .ne 2
381 \fB\fB-bP\fR\fR
383 .sp .6
384 .RS 4n
385 Prints the number of entries in the queues. This option is only available with
386 shared memory support.
390 .ne 2
392 \fB\fB-bs\fR\fR
394 .sp .6
395 .RS 4n
396 Uses the SMTP protocol as described in RFC 2821. This flag implies all the
397 operations of the \fB-ba\fR flag that are compatible with \fBSMTP\fR.
401 .ne 2
403 \fB\fB-bt\fR\fR
405 .sp .6
406 .RS 4n
407 Runs in address test mode. This mode reads addresses and shows the steps in
408 parsing; it is used for debugging configuration tables.
412 .ne 2
414 \fB\fB-bv\fR\fR
416 .sp .6
417 .RS 4n
418 Verifies names only. Does not try to collect or deliver a message. Verify mode
419 is normally used for validating users or mailing lists.
423 .ne 2
425 \fB\fB-B\fR \fItype\fR\fR
427 .sp .6
428 .RS 4n
429 Indicates body \fItype\fR (\fB7BIT\fR or \fB8BITMIME\fR).
433 .ne 2
435 \fB\fB-C\fR \fIfile\fR\fR
437 .sp .6
438 .RS 4n
439 Uses alternate configuration file.
443 .ne 2
445 \fB\fB-D\fR \fIlogfile\fR\fR
447 .sp .6
448 .RS 4n
449 Send debugging output to the indicated log file instead of \fBstdout\fR.
453 .ne 2
455 \fB\fB-d\fR \fIX\fR\fR
457 .sp .6
458 .RS 4n
459 Sets debugging value to \fIX\fR.
463 .ne 2
465 \fB\fB-f\fR \fIname\fR\fR
467 .sp .6
468 .RS 4n
469 Sets the name of the "from" person (that is, the sender of the mail).
473 .ne 2
475 \fB\fB-F\fR \fIfullname\fR\fR
477 .sp .6
478 .RS 4n
479 Sets the full name of the sender.
483 .ne 2
485 \fB\fB-G\fR\fR
487 .sp .6
488 .RS 4n
489 When accepting messages by way of the command line, indicates that they are for
490 relay (gateway) submission. When this flag is set, \fBsendmail\fR might
491 complain about syntactically invalid messages, for example, unqualified host
492 names, rather than fixing them. \fBsendmail\fR does not do any canonicalization
493 in this mode.
497 .ne 2
499 \fB\fB-h\fR \fIN\fR\fR
501 .sp .6
502 .RS 4n
503 Sets the hop count to \fIN\fR. The hop count is incremented every time the mail
504 is processed. When it reaches a limit, the mail is returned with an error
505 message, the victim of an aliasing loop.
509 .ne 2
511 \fB\fB-L\fR \fItag\fR\fR
513 .sp .6
514 .RS 4n
515 Sets the identifier used in \fBsyslog\fR messages to the supplied \fItag\fR.
519 .ne 2
521 \fB\fB-M\fR\fIxvalue\fR\fR
523 .sp .6
524 .RS 4n
525 Sets macro \fIx\fR to the specified \fIvalue\fR.
529 .ne 2
531 \fB\fB-n\fR\fR
533 .sp .6
534 .RS 4n
535 Does not do aliasing.
539 .ne 2
541 \fB\fB-N\fR \fInotifications\fR\fR
543 .sp .6
544 .RS 4n
545 Tags all addresses being sent as wanting the indicated \fInotifications\fR,
546 which consists of the word "NEVER" or a comma-separated list of "SUCCESS",
547 "FAILURE", and "DELAY" for successful delivery, failure and a message that is
548 stuck in a queue somwhere. The default is "FAILURE,DELAY".
552 .ne 2
554 \fB\fB-o\fR\fIxvalue\fR\fR
556 .sp .6
557 .RS 4n
558 Sets option \fIx\fR to the specified \fIvalue\fR. \fBProcessing\fR
559 \fBOptions\fR are described below.
563 .ne 2
565 \fB\fB-O\fR\fIoption=value\fR\fR
567 .sp .6
568 .RS 4n
569 Sets \fIoption\fR to the specified \fIvalue\fR (for long from names).
570 \fBProcessing\fR \fBOptions\fR are described below.
574 .ne 2
576 \fB\fB-p\fR \fIprotocol\fR\fR
578 .sp .6
579 .RS 4n
580 Sets the sending protocol. The \fIprotocol\fR field can be in form
581 \fIprotocol\fR\fB:\fR\fIhost\fR to set both the sending protocol and the
582 sending host. For example: \fB-pUUCP:uunet\fR sets the sending \fIprotocol\fR
583 to \fBUUCP\fR and the sending host to \fBuunet\fR. Some existing programs use
584 \fB-oM\fR to set the \fIr\fR and \fIs\fR macros; this is equivalent to using
585 \fB-p\fR.
589 .ne 2
591 \fB\fB-q\fR[\fItime\fR]\fR
593 .sp .6
594 .RS 4n
595 Processes saved messages in the queue at given intervals. If \fItime\fR is
596 omitted, processes the queue once. \fItime\fR is given as a tagged number,
597 where \fIs\fR is seconds, \fIm\fR is minutes, \fIh\fR is hours, \fId\fR is
598 days, and \fIw\fR is weeks. For example, \fB-q1h30m\fR or \fB-q90m\fR would
599 both set the timeout to one hour thirty minutes.
601 By default, sendmail runs in the background. This option can be used safely
602 with \fB-bd\fR.
606 .ne 2
608 \fB\fB-qp[\fR\fItime\fR\fB-]\fR\fR
610 .sp .6
611 .RS 4n
612 Similar to \fB-q\fR[\fItime\fR], except that instead of periodically forking a
613 child to process the queue, \fBsendmail\fR forks a single persistent child for
614 each queue that alternates between processing the queue and sleeping. The sleep
615 time (\fItime\fR) is specified as the argument; it defaults to \fB1\fR second.
616 The process always sleeps at least \fB5\fR seconds if the queue was empty in
617 the previous queue run.
621 .ne 2
623 \fB\fB-qf\fR\fR
625 .sp .6
626 .RS 4n
627 Processes saved messages in the queue once and does not \fBfork\fR(2), but runs
628 in the foreground.
632 .ne 2
634 \fB\fB-qG\fR \fIname\fR\fR
636 .sp .6
637 .RS 4n
638 Processes jobs in queue group called \fIname\fR only.
642 .ne 2
644 \fB\fB-q[!]I\fR \fIsubstr\fR\fR
646 .sp .6
647 .RS 4n
648 Limits processed jobs to those containing \fIsubstr\fR as a substring of the
649 queue \fBID\fR or not when \fB!\fR is specified.
653 .ne 2
655 \fB\fB-q[!]Q\fR \fIsubstr\fR\fR
657 .sp .6
658 .RS 4n
659 Limits processed jobs to those quarantined jobs containing \fIsubstr\fR as a
660 substring of the quarantine \fIreason\fR or not when \fB!\fR is specified.
664 .ne 2
666 \fB\fB-q[!]R\fR \fIsubstr\fR\fR
668 .sp .6
669 .RS 4n
670 Limits processed jobs to those containing \fIsubstr\fR as a substring of one of
671 the recipients or not when \fB!\fR is specified.
675 .ne 2
677 \fB\fB-q[!]S\fR \fIsubstr\fR\fR
679 .sp .6
680 .RS 4n
681 Limits processed jobs to those containing \fIsubstr\fR as a substring of the
682 sender or not when \fB!\fR is specified.
686 .ne 2
688 \fB\fB-Q\fR[\fIreason\fR]\fR
690 .sp .6
691 .RS 4n
692 Quarantines a normal queue item with the given reason or unquarantines a
693 quarantined queue item if no reason is given. This should only be used with
694 some sort of item matching as described above.
698 .ne 2
700 \fB\fB-r\fR \fIname\fR\fR
702 .sp .6
703 .RS 4n
704 An alternate and obsolete form of the \fB-f\fR flag.
708 .ne 2
710 \fB\fB-R\fR \fIret\fR\fR
712 .sp .6
713 .RS 4n
714 Identifies the information you want returned if the message bounces. \fIret\fR
715 can be \fBHDRS\fR for headers only or \fBFULL\fR for headers plus body.
719 .ne 2
721 \fB\fB-t\fR\fR
723 .sp .6
724 .RS 4n
725 Reads message for recipients. \fBTo:\fR,\fBCc:\fR, and \fBBcc:\fR lines are
726 scanned for people to send to. The \fBBcc:\fR line is deleted before
727 transmission. Any addresses in the argument list is suppressed. The
728 \fBNoRecipientAction\fR Processing Option can be used to change the behavior
729 when no legal recipients are included in the message.
733 .ne 2
735 \fB\fB-v\fR\fR
737 .sp .6
738 .RS 4n
739 Goes into verbose mode. Alias expansions are announced, and so forth.
743 .ne 2
745 \fB\fB-V\fR \fIenvid\fR\fR
747 .sp .6
748 .RS 4n
749 The indicated \fIenvid\fR is passed with the envelope of the message and
750 returned if the message bounces.
754 .ne 2
756 \fB\fB-X\fR \fIlogfile\fR\fR
758 .sp .6
759 .RS 4n
760 Logs all traffic in and out of \fBsendmail\fR in the indicated \fIlogfile\fR
761 for debugging mailer problems. This produces a lot of data very quickly and
762 should be used sparingly.
765 .SS "Processing Options"
768 There are a number of "random" options that can be set from a configuration
769 file. Options are represented by a single character or by multiple character
770 names. The syntax for the single character names of is:
772 .in +2
774 \fBO\fR\fIxvalue\fR
776 .in -2
781 This sets option \fIx\fR to be \fIvalue\fR. Depending on the option,
782 \fIvalue\fR may be a string, an integer, a boolean (with legal values \fBt\fR,
783 \fBT\fR, \fBf\fR, or \fBF\fR; the default is \fBTRUE\fR), or a time interval.
786 The multiple character or long names use this syntax:
788 .in +2
790 \fBO\fR \fILongname=argument\fR
792 .in -2
797 This sets the option \fILongname\fR to be \fIargument\fR. The long names are
798 beneficial because they are easier to interpret than the single character
799 names.
802 Not all processing options have single character names associated with them. In
803 the list below, the multiple character name is presented first followed by the
804 single character syntax enclosed in parentheses.
806 .ne 2
808 \fB\fBAliasFile (A\fR\fIfile\fR\fB)\fR\fR
810 .sp .6
811 .RS 4n
812 Specifies possible alias files.
816 .ne 2
818 \fB\fBAliasWait (a\fR \fIN\fR\fB)\fR\fR
820 .sp .6
821 .RS 4n
822 If set, waits up to \fIN\fR minutes for an "@:@" entry to exist in the
823 \fBaliases\fR(4) database before starting up. If it does not appear in \fIN\fR
824 minutes, issues a warning. Defaults to 10 minutes.
828 .ne 2
830 \fB\fBAllowBogusHELO\fR\fR
832 .sp .6
833 .RS 4n
834 Allows a \fBHELO SMTP\fR command that does not include a host name. By default
835 this option is disabled.
839 .ne 2
841 \fB\fBBadRcptThrottle=\fR\fIN\fR\fR
843 .sp .6
844 .RS 4n
845 If set and more than the specified number of recipients in a single \fBSMTP\fR
846 envelope are rejected, sleeps for one second after each rejected RCPT command.
850 .ne 2
852 \fB\fBBlankSub (B\fR\fIc\fR\fB)\fR\fR
854 .sp .6
855 .RS 4n
856 Sets the blank substitution character to \fIc\fR. Unquoted spaces in addresses
857 are replaced by this character. Defaults to SPACE (that is, no change is made).
861 .ne 2
863 \fB\fBCACertFile\fR\fR
865 .sp .6
866 .RS 4n
867 File containing one CA cert.
871 .ne 2
873 \fB\fBCACertPath\fR\fR
875 .sp .6
876 .RS 4n
877 Path to directory with certs of CAs.
881 .ne 2
883 \fB\fBCheckAliases (n)\fR\fR
885 .sp .6
886 .RS 4n
887 Validates the RHS of aliases when rebuilding the \fBaliases\fR(4) database.
891 .ne 2
893 \fB\fBCheckpointInterval (C\fR\fIN\fR\fB)\fR\fR
895 .sp .6
896 .RS 4n
897 Checkpoints the queue every \fIN\fR (default \fB10\fR) addresses sent. If your
898 system crashes during delivery to a large list, this prevents retransmission to
899 any but the last \fIN\fR recipients.
903 .ne 2
905 \fB\fBClassFactor (z\fR\fIfact\fR\fB)\fR\fR
907 .sp .6
908 .RS 4n
909 The indicated factor \fIfact\fR is multiplied by the message class (determined
910 by the \fBPrecedence:\fR field in the user header and the \fBP\fR lines in the
911 configuration file) and subtracted from the priority. Thus, messages with a
912 higher \fBPriority:\fR are favored. Defaults to \fB1800\fR.
916 .ne 2
918 \fB\fBClientCertFile\fR\fR
920 .sp .6
921 .RS 4n
922 File containing the cert of the client, that is, this cert is used when
923 \fBsendmail\fR acts as client.
927 .ne 2
929 \fB\fBClientKeyFile\fR\fR
931 .sp .6
932 .RS 4n
933 File containing the private key belonging to the client cert.
937 .ne 2
939 \fB\fBClientPortOptions\fR\fR
941 .sp .6
942 .RS 4n
943 Sets client \fBSMTP\fR options. The options are key=value pairs. Known keys
944 are:
946 .ne 2
948 \fB\fBAddr\fR \fIAddress Mask\fR\fR
950 .sp .6
951 .RS 4n
952 \fIAddress Mask\fR defaults to \fBINADDR_ANY\fR. The address mask can be a
953 numeric address in dot notation or a network name.
957 .ne 2
959 \fB\fBFamily\fR\fR
961 .sp .6
962 .RS 4n
963 Address family (defaults to INET).
967 .ne 2
969 \fB\fBListen\fR\fR
971 .sp .6
972 .RS 4n
973 Size of listen queue (defaults to 10).
977 .ne 2
979 \fB\fBPort\fR\fR
981 .sp .6
982 .RS 4n
983 Name/number of listening port (defaults to \fBsmtp\fR).
987 .ne 2
989 \fB\fBRcvBufSize\fR\fR
991 .sp .6
992 .RS 4n
993 The size of the TCP/IP receive buffer.
997 .ne 2
999 \fB\fBSndBufSize\fR\fR
1001 .sp .6
1002 .RS 4n
1003 The size of the TCP/IP send buffer.
1007 .ne 2
1009 \fB\fBModifier\fR\fR
1011 .sp .6
1012 .RS 4n
1013 Options (flags) for the daemon. Can be:
1015 .ne 2
1017 \fB\fBh\fR\fR
1019 .sp .6
1020 .RS 4n
1021 Uses name of interface for \fBHELO\fR command.
1024 If \fBh\fR is set, the name corresponding to the outgoing interface address
1025 (whether chosen by means of the \fBConnection\fR parameter or the default) is
1026 used for the \fBHELO\fR/\fBEHLO\fR command.
1032 .ne 2
1034 \fB\fBColonOkInAddr\fR\fR
1036 .sp .6
1037 .RS 4n
1038 If set, colons are treated as a regular character in addresses. If not set,
1039 they are treated as the introducer to the RFC 822 "group" syntax. This option
1040 is on for version 5 and lower configuration files.
1044 .ne 2
1046 \fB\fBConnectionCacheSize (k\fR\fIN\fR\fB)\fR\fR
1048 .sp .6
1049 .RS 4n
1050 The maximum number of open connections that are to be cached at a time. The
1051 default is \fB1\fR. This delays closing the current connection until either
1052 this invocation of \fBsendmail\fR needs to connect to another host or it
1053 terminates. Setting it to \fB0\fR defaults to the old behavior, that is,
1054 connections are closed immediately.
1058 .ne 2
1060 \fB\fBConnectionCacheTimeout (K\fR\fItimeout\fR\fB)\fR\fR
1062 .sp .6
1063 .RS 4n
1064 The maximum amount of time a cached connection is permitted to idle without
1065 activity. If this time is exceeded, the connection is immediately closed. This
1066 value should be small (on the order of ten minutes). Before \fBsendmail\fR uses
1067 a cached connection, it always sends a \fBNOOP\fR (no operation) command to
1068 check the connection. If the \fBNOOP\fR command fails, it reopens the
1069 connection. This keeps your end from failing if the other end times out. The
1070 point of this option is to be a good network neighbor and avoid using up
1071 excessive resources on the other end. The default is five minutes.
1075 .ne 2
1077 \fB\fBConnectionRateThrottle\fR\fR
1079 .sp .6
1080 .RS 4n
1081 The maximum number of connections permitted per second. After this many
1082 connections are accepted, further connections are delayed. If not set or <= 0,
1083 there is no limit.
1087 .ne 2
1089 \fB\fBConnectionRateWindowSize\fR\fR
1091 .sp .6
1092 .RS 4n
1093 Define the length of the interval for which the number of incoming connections
1094 is maintained. The default is 60 seconds.
1098 .ne 2
1100 \fB\fBControlSocketName\fR\fR
1102 .sp .6
1103 .RS 4n
1104 Name of the control socket for daemon management. A running \fBsendmail\fR
1105 daemon can be controlled through this Unix domain socket. Available commands
1106 are: \fBhelp\fR, \fBrestart\fR, \fBshutdown\fR, and \fBstatus\fR. The
1107 \fBstatus\fR command returns the current number of daemon children, the free
1108 disk space (in blocks) of the queue directory, and the load average of the
1109 machine expressed as an integer. If not set, no control socket is available.
1110 For the sake of security, this Unix domain socket must be in a directory which
1111 is accessible only by root; \fB/var/spool/mqueue/.smcontrol\fR is recommended
1112 for the socket name.
1116 .ne 2
1118 \fB\fBCRLFile\fR\fR
1120 .sp .6
1121 .RS 4n
1122 File containing certificate revocation status, useful for X.509v3
1123 authentication.
1127 .ne 2
1129 \fB\fBDaemonPortOptions (O\fR\fIoptions\fR\fB)\fR\fR
1131 .sp .6
1132 .RS 4n
1133 Sets server SMTP options. The options are \fIkey=value\fR pairs. Known keys
1134 are:
1136 .ne 2
1138 \fB\fBName\fR\fR
1140 .sp .6
1141 .RS 4n
1142 User-definable name for the daemon (defaults to "\fBDaemon#\fR"). Used for
1143 error messages and logging.
1147 .ne 2
1149 \fB\fBAddr\fR\fR
1151 .sp .6
1152 .RS 4n
1153 Address mask (defaults \fBINADDR_ANY)\fR.
1155 The address mask may be a numeric address in dot notation or a network name.
1159 .ne 2
1161 \fB\fBFamily\fR\fR
1163 .sp .6
1164 .RS 4n
1165 Address family (defaults to \fBINET).\fR
1169 .ne 2
1171 \fB\fBInputMailFilters\fR\fR
1173 .sp .6
1174 .RS 4n
1175 List of input mail filters for the daemon.
1179 .ne 2
1181 \fB\fBListen\fR\fR
1183 .sp .6
1184 .RS 4n
1185 Size of listen queue (defaults to \fB10\fR).
1189 .ne 2
1191 \fB\fBModifier\fR\fR
1193 .sp .6
1194 .RS 4n
1195 Options (flags) for the daemon; can be a sequence (without any delimiters) of:
1197 .ne 2
1199 \fB\fBa\fR\fR
1201 .sp .6
1202 .RS 4n
1203 Requires authentication.
1207 .ne 2
1209 \fB\fBb\fR\fR
1211 .sp .6
1212 .RS 4n
1213 Binds to interface through which mail has been received.
1217 .ne 2
1219 \fB\fBc\fR\fR
1221 .sp .6
1222 .RS 4n
1223 Performs hostname canonification (\fB\&.cf\fR).
1227 .ne 2
1229 \fB\fBf\fR\fR
1231 .sp .6
1232 .RS 4n
1233 Requires fully qualified hostname (\fB\&.cf\fR).
1237 .ne 2
1239 \fB\fBh\fR\fR
1241 .sp .6
1242 .RS 4n
1243 Uses name of interface for \fBHELO\fR command.
1247 .ne 2
1249 \fB\fBu\fR\fR
1251 .sp .6
1252 .RS 4n
1253 Allows unqualified addresses (\fB\&.cf\fR).
1257 .ne 2
1259 \fB\fBC\fR\fR
1261 .sp .6
1262 .RS 4n
1263 Does not perform hostname canonification.
1267 .ne 2
1269 \fB\fBE\fR\fR
1271 .sp .6
1272 .RS 4n
1273 Disallows \fBETRN\fR (see \fBRFC\fR 2476).
1279 .ne 2
1281 \fB\fBName\fR\fR
1283 .sp .6
1284 .RS 4n
1285 User-definable name for the daemon (defaults to \fBDaemon#\fR). Used for error
1286 messages and logging.
1290 .ne 2
1292 \fB\fBPort\fR\fR
1294 .sp .6
1295 .RS 4n
1296 Name/number of listening port (defaults to \fBsmtp\fR).
1300 .ne 2
1302 \fB\fBReceiveSize\fR\fR
1304 .sp .6
1305 .RS 4n
1306 The size of the TCP/IP receive buffer.
1310 .ne 2
1312 \fB\fBSendSize\fR\fR
1314 .sp .6
1315 .RS 4n
1316 The size of the TCP/IP send buffer.
1320 .ne 2
1322 \fB\fBchildren\fR\fR
1324 .sp .6
1325 .RS 4n
1326 Maximum number of children per daemon. See \fBMaxDaemonChildren\fR.
1330 .ne 2
1332 \fB\fBDeliveryMode\fR\fR
1334 .sp .6
1335 .RS 4n
1336 Delivery mode per daemon. See \fBDeliveryMode\fR.
1340 .ne 2
1342 \fB\fBrefuseLA\fR\fR
1344 .sp .6
1345 .RS 4n
1346 \fBRefuseLA\fR per daemon.
1350 .ne 2
1352 \fB\fBdelayLA\fR\fR
1354 .sp .6
1355 .RS 4n
1356 \fBDelayLA\fR per daemon.
1360 .ne 2
1362 \fB\fBqueueLA\fR\fR
1364 .sp .6
1365 .RS 4n
1366 \fBQueueLA\fR per daemon.
1369 \fBsendmail\fR listens on a new socket for each occurrence of the
1370 \fBDaemonPortOptions\fR option in a configuration file.
1374 .ne 2
1376 \fB\fBDataFileBufferSize\fR\fR
1378 .sp .6
1379 .RS 4n
1380 Sets the threshold, in bytes, before a memory-bases queue data file becomes
1381 disk-based. The default is 4096 bytes.
1385 .ne 2
1387 \fB\fBDeadLetterDrop\fR\fR
1389 .sp .6
1390 .RS 4n
1391 Defines the location of the system-wide dead.letter file, formerly hard-coded
1392 to \fB/var/tmp/dead.letter\fR. If this option is not set (the default),
1393 \fBsendmail\fR does not attempt to save to a system-wide \fBdead.letter\fR file
1394 in the event it cannot bounce the mail to the user or postmaster. Instead, it
1395 renames the \fBqf\fR file as it has in the past when the \fBdead.letter\fR file
1396 could not be opened.
1400 .ne 2
1402 \fB\fBDefaultCharSet\fR\fR
1404 .sp .6
1405 .RS 4n
1406 Sets the default character set to use when converting unlabeled 8 bit input to
1407 MIME.
1411 .ne 2
1413 \fB\fBDefaultUser (g\fR\fIgid\fR\fB) or (u\fR\fIuid\fR\fB)\fR\fR
1415 .sp .6
1416 .RS 4n
1417 Sets the default group ID for mailers to run in to \fIgid\fR or set the default
1418 userid for mailers to \fIuid\fR. Defaults to \fB1\fR. The value can also be
1419 given as a symbolic group or user name.
1423 .ne 2
1425 \fB\fBDelayLA=\fR\fILA\fR\fR
1427 .sp .6
1428 .RS 4n
1429 When the system load average exceeds \fILA\fR, \fBsendmail\fR sleeps for one
1430 second on most SMTP commands and before accepting connections.
1434 .ne 2
1436 \fB\fBDeliverByMin=\fR\fItime\fR\fR
1438 .sp .6
1439 .RS 4n
1440 Sets minimum time for \fBDeliver By SMTP Service Extension\fR (RFC 2852). If
1441 \fB0\fR, no time is listed, if less than \fB0\fR, the extension is not offered,
1442 if greater than \fB0\fR, it is listed as minimum time for the \fBEHLO\fR
1443 keyword \fBDELIVERBY\fR.
1447 .ne 2
1449 \fB\fBDeliveryMode (d\fR\fIx\fR\fB)\fR\fR
1451 .sp .6
1452 .RS 4n
1453 Delivers in mode \fIx\fR. Legal modes are:
1455 .ne 2
1457 \fB\fBi\fR\fR
1459 .sp .6
1460 .RS 4n
1461 Delivers interactively (synchronously).
1465 .ne 2
1467 \fB\fBb\fR\fR
1469 .sp .6
1470 .RS 4n
1471 Delivers in background (asynchronously).
1475 .ne 2
1477 \fB\fBd\fR\fR
1479 .sp .6
1480 .RS 4n
1481 Deferred mode. Database lookups are deferred until the actual queue run.
1485 .ne 2
1487 \fB\fBq\fR\fR
1489 .sp .6
1490 .RS 4n
1491 Just queues the message (delivers during queue run).
1494 Defaults to \fBb\fR if no option is specified, \fBi\fR if it is specified but
1495 given no argument (that is, \fBOd\fR is equivalent to \fBOdi\fR).
1499 .ne 2
1501 \fB\fBDHParameters\fR\fR
1503 .sp .6
1504 .RS 4n
1505 File containing the DH parameters.
1509 .ne 2
1511 \fB\fBDialDelay\fR\fR
1513 .sp .6
1514 .RS 4n
1515 If a connection fails, waits this many seconds and tries again. Zero means "do
1516 not retry".
1520 .ne 2
1522 \fB\fBDontBlameSendmail\fR\fR
1524 .sp .6
1525 .RS 4n
1526 If set, overrides the file safety checks. This compromises system security and
1527 should not be used. See http://www.sendmail.org/tips/DontBlameSendmail.html for
1528 more information.
1532 .ne 2
1534 \fB\fBDontExpandCnames\fR\fR
1536 .sp .6
1537 .RS 4n
1538 If set, $[ ... $] lookups that do DNS-based lookups do not expand CNAME
1539 records.
1543 .ne 2
1545 \fB\fBDontInitGroups\fR\fR
1547 .sp .6
1548 .RS 4n
1549 If set, the \fBinitgroups\fR(3C) routine is never invoked. If you set this,
1550 agents run on behalf of users only have their primary (\fB/etc/passwd\fR) group
1551 permissions.
1555 .ne 2
1557 \fB\fBDontProbeInterfaces\fR\fR
1559 .sp .6
1560 .RS 4n
1561 If set, \fBsendmail\fR does not insert the names and addresses of any local
1562 interfaces into the \fB$=w class\fR. If set, you must also include support for
1563 these addresses, otherwise mail to addresses in this list bounces with a
1564 configuration error.
1568 .ne 2
1570 \fB\fBDontPruneRoutes (R)\fR\fR
1572 .sp .6
1573 .RS 4n
1574 If set, does not prune route-addr syntax addresses to the minimum possible.
1578 .ne 2
1580 \fB\fBDoubleBounceAddress\fR\fR
1582 .sp .6
1583 .RS 4n
1584 If an error occurs when sending an error message, sends that "double bounce"
1585 error message to this address.
1589 .ne 2
1591 \fB\fBEightBitMode (8)\fR\fR
1593 .sp .6
1594 .RS 4n
1595 Uses 8-bit data handling. This option requires one of the following keys. The
1596 key can selected by using just the first character, but using the full word is
1597 better for clarity.
1599 .ne 2
1601 \fB\fBmimify\fR\fR
1603 .sp .6
1604 .RS 4n
1605 Does any necessary conversion of \fB8BITMIME\fR to 7-bit.
1609 .ne 2
1611 \fB\fBpass\fR\fR
1613 .sp .6
1614 .RS 4n
1615 Passes unlabeled 8-bit input through as is.
1619 .ne 2
1621 \fB\fBstrict\fR\fR
1623 .sp .6
1624 .RS 4n
1625 Rejects unlabeled 8-bit input.
1631 .ne 2
1633 \fB\fBErrorHeader (E\fR\fIfile/message\fR\fB)\fR\fR
1635 .sp .6
1636 .RS 4n
1637 Appends error messages with the indicated message. If it begins with a slash,
1638 it is assumed to be the pathname of a file containing a message (this is the
1639 recommended setting). Otherwise, it is a literal message. The error file might
1640 contain the name, email address, and/or phone number of a local postmaster who
1641 could provide assistance to end users. If the option is missing or \fINULL\fR,
1642 or if it names a file which does not exist or which is not readable, no message
1643 is printed.
1647 .ne 2
1649 \fB\fBErrorMode (e\fR\fIx\fR\fB)\fR\fR
1651 .sp .6
1652 .RS 4n
1653 Disposes of errors using mode \fIx\fR. The values for \fIx\fR are:
1655 .ne 2
1657 \fB\fBe\fR\fR
1659 .sp .6
1660 .RS 4n
1661 Mails back errors and gives \fB0\fR exit status always.
1665 .ne 2
1667 \fB\fBm\fR\fR
1669 .sp .6
1670 .RS 4n
1671 Mails back errors.
1675 .ne 2
1677 \fB\fBp\fR\fR
1679 .sp .6
1680 .RS 4n
1681 Prints error messages (default).
1685 .ne 2
1687 \fB\fBq\fR\fR
1689 .sp .6
1690 .RS 4n
1691 No messages, just gives exit status.
1695 .ne 2
1697 \fB\fBw\fR\fR
1699 .sp .6
1700 .RS 4n
1701 Writes back errors (mail if user not logged in).
1707 .ne 2
1709 \fB\fBFallbackMXhost (V\fR\fIfallbackhost\fR\fB)\fR\fR
1711 .sp .6
1712 .RS 4n
1713 If specified, the \fIfallbackhost\fR acts like a very low priority MX on every
1714 host. This is intended to be used by sites with poor network connectivity.
1718 .ne 2
1720 \fB\fBFallBackSmartHost\fR\fR
1722 .sp .6
1723 .RS 4n
1724 If specified, the \fIfallBackSmartHost\fR is used in a last-ditch effort for
1725 each host. This is intended to be used by sites with "fake internal DNS". That
1726 is, a company whose DNS accurately reflects the world inside that company's
1727 domain but not outside.
1731 .ne 2
1733 \fB\fBFastSplit\fR\fR
1735 .sp .6
1736 .RS 4n
1737 If set to a value greater than zero (the default is one), it suppresses the MX
1738 lookups on addresses when they are initially sorted, that is, for the first
1739 delivery attempt. This usually results in faster envelope splitting unless the
1740 MX records are readily available in a local DNS cache. To enforce initial
1741 sorting based on MX records set \fBFastSplit\fR to zero. If the mail is
1742 submitted directly from the command line, then the value also limits the number
1743 of processes to deliver the envelopes; if more envelopes are created they are
1744 only queued up and must be taken care of by a queue run. Since the default
1745 submission method is by way of SMTP (either from a MUA or by way of the Message
1746 Submission Program [MSP]), the value of \fBFastSplit\fR is seldom used to limit
1747 the number of processes to deliver the envelopes.
1751 .ne 2
1753 \fB\fBForkEachJob (Y)\fR\fR
1755 .sp .6
1756 .RS 4n
1757 If set, delivers each job that is run from the queue in a separate process. Use
1758 this option if you are short of memory, since the default tends to consume
1759 considerable amounts of memory while the queue is being processed.
1763 .ne 2
1765 \fB\fBForwardPath (J\fR\fIpath\fR\fB)\fR\fR
1767 .sp .6
1768 .RS 4n
1769 Sets the path for searching for users' \fB\&.forward\fR files. The default is
1770 \fB$z/.forward\fR. Some sites that use the automounter may prefer to change
1771 this to \fB/var/forward/$u\fR to search a file with the same name as the user
1772 in a system directory. It can also be set to a sequence of paths separated by
1773 colons; \fBsendmail\fR stops at the first file it can successfully and safely
1774 open. For example, \fB/var/forward/$u:$z/.forward\fR searches first in
1775 \fB/var/forward/\fR \fIusername\fR and then in
1776 \fB~\fR\fIusername\fR\fB/.forward\fR (but only if the first file does not
1777 exist). Refer to the NOTES section for more information.
1781 .ne 2
1783 \fB\fBHeloName=\fIname\fR\fR\fR
1785 .sp .6
1786 .RS 4n
1787 Sets the name to be used for \fBHELO\fR/\fBEHLO\fR (instead of \fB$j\fR).
1791 .ne 2
1793 \fB\fBHelpFile (H\fR\fIfile\fR\fB)\fR\fR
1795 .sp .6
1796 .RS 4n
1797 Specifies the help file for SMTP.
1801 .ne 2
1803 \fB\fBHoldExpensive (c)\fR\fR
1805 .sp .6
1806 .RS 4n
1807 If an outgoing mailer is marked as being expensive, does not connect
1808 immediately.
1812 .ne 2
1814 \fB\fBHostsFile\fR\fR
1816 .sp .6
1817 .RS 4n
1818 Sets the file to use when doing "file" type access of host names.
1822 .ne 2
1824 \fB\fBHostStatusDirectory\fR\fR
1826 .sp .6
1827 .RS 4n
1828 If set, host status is kept on disk between \fBsendmail\fR runs in the named
1829 directory tree. If a full path is not used, then the path is interpreted
1830 relative to the queue directory.
1834 .ne 2
1836 \fB\fBIgnoreDots (i)\fR\fR
1838 .sp .6
1839 .RS 4n
1840 Ignores dots in incoming messages. This is always disabled (that is, dots are
1841 always accepted) when reading \fBSMTP\fR mail.
1845 .ne 2
1847 \fB\fBLogLevel (L\fR\fIn\fR\fB)\fR\fR
1849 .sp .6
1850 .RS 4n
1851 Sets the default log level to \fIn\fR. Defaults to \fB9\fR.
1855 .ne 2
1857 \fB\fB(M\fR\fIx\|value\fR\fB)\fR\fR
1859 .sp .6
1860 .RS 4n
1861 Sets the macro \fIx\fR to \fIvalue\fR. This is intended only for use from the
1862 command line.
1866 .ne 2
1868 \fB\fBMailboxDatabase\fR\fR
1870 .sp .6
1871 .RS 4n
1872 Type of lookup to find information about local mail boxes, defaults to \fBpw\fR
1873 which uses \fBgetpwnam\fR(3C). Other types can be introduced by adding them to
1874 the source code, see \fBlibsm/mbdb.c\fR for details.
1878 .ne 2
1880 \fB\fBMatchGECOS (G)\fR\fR
1882 .sp .6
1883 .RS 4n
1884 Tries to match recipient names using the GECOS field. This allows for mail to
1885 be delivered using names defined in the GECOS field in \fB/etc/passwd\fR as
1886 well as the login name.
1890 .ne 2
1892 \fB\fBMaxDaemonChildren\fR\fR
1894 .sp .6
1895 .RS 4n
1896 The maximum number of children the daemon permits. After this number,
1897 connections are rejected. If not set or <=0, there is no limit.
1901 .ne 2
1903 \fB\fBMaxHopCount (h\fR\fIN\fR\fB)\fR\fR
1905 .sp .6
1906 .RS 4n
1907 The maximum hop count. Messages that have been processed more than \fIN\fR
1908 times are assumed to be in a loop and are rejected. Defaults to \fB25\fR.
1912 .ne 2
1914 \fB\fBMaxMessageSize\fR\fR
1916 .sp .6
1917 .RS 4n
1918 The maximum size of messages that are accepted (in bytes).
1922 .ne 2
1924 \fB\fBMaxMimeHeaderLength=\fR\fIM\fR\fB[/\fR\fIN\fR\fB]\fR\fR
1926 .sp .6
1927 .RS 4n
1928 Sets the maximum length of certain MIME header field values to \fIM\fR
1929 characters. For some of these headers which take parameters, the maximum length
1930 of each parameter is set to \fIN\fR if specified. If \fB/\fR\fIN\fR is not
1931 specified, one half of \fIM\fR is used. By default, these values are \fB0\fR,
1932 meaning no checks are done.
1936 .ne 2
1938 \fB\fBMaxNOOPCommands=\fR\fIN\fR\fR
1940 .sp .6
1941 .RS 4n
1942 Overrides the default of 20 for the number of useless commands.
1946 .ne 2
1948 \fB\fBMaxQueueChildren=\fR\fIN\fR\fR
1950 .sp .6
1951 .RS 4n
1952 When set, this limits the number of concurrent queue runner processes to
1953 \fIN\fR. This helps to control the amount of system resources used when
1954 processing the queue. When there are multiple queue groups defined and the
1955 total number of queue runners for these queue groups would exceed
1956 \fBMaxQueueChildren\fR then the queue groups are not all run concurrently. That
1957 is, some portion of the queue groups run concurrently such that
1958 \fBMaxQueueChildren\fR is not be exceeded, while the remaining queue groups are
1959 run later (in round robin order). See \fBMaxRunnersPerQueue\fR.
1963 .ne 2
1965 \fB\fBMaxQueueRunSize\fR\fR
1967 .sp .6
1968 .RS 4n
1969 If set, limits the maximum size of any given queue run to this number of
1970 entries. This stops reading the queue directory after this number of entries is
1971 reached; job priority is not used. If not set, there is no limit.
1975 .ne 2
1977 \fB\fBMaxRunnersPerQueue=\fR\fIN\fR\fR
1979 .sp .6
1980 .RS 4n
1981 This sets the default maximum number of queue runners for queue groups. Up to
1982 \fIN\fR queue runners work in parallel on a queue group's messages. This is
1983 useful where the processing of a message in the queue might delay the
1984 processing of subsequent messages. Such a delay can be the result of
1985 non-erroneous situations such as a low bandwidth connection. The can be
1986 overridden on a per queue group basis by setting the \fBRunners\fR option. The
1987 default is \fB1\fR when not set.
1991 .ne 2
1993 \fB\fBMeToo (M)\fR\fR
1995 .sp .6
1996 .RS 4n
1997 Sends to me too, even if I am in an alias expansion.
2001 .ne 2
2003 \fB\fBMaxRecipientsPerMessage\fR\fR
2005 .sp .6
2006 .RS 4n
2007 If set, allows no more than the specified number of recipients in an SMTP
2008 envelope. Further recipients receive a 452 error code and are deferred for the
2009 next delivery attempt.
2013 .ne 2
2015 \fB\fBMinFreeBlocks (b\fR\fIN/M\fR\fB)\fR\fR
2017 .sp .6
2018 .RS 4n
2019 Insists on at least \fIN\fR blocks free on the file system that holds the queue
2020 files before accepting email by way of SMTP. If there is insufficient space,
2021 \fBsendmail\fR gives a \fB452\fR response to the \fBMAIL\fR command. This
2022 invites the sender to try again later. The optional \fIM\fR is a maximum
2023 message size advertised in the \fBESMTP\fR \fBEHLO\fR response. It is currently
2024 otherwise unused.
2028 .ne 2
2030 \fB\fBMinQueueAge\fR\fR
2032 .sp .6
2033 .RS 4n
2034 Specifies the amount of time a job must sit in the queue between queue runs.
2035 This allows you to set the queue run interval low for better responsiveness
2036 without trying all jobs in each run. The default value is 0.
2040 .ne 2
2042 \fB\fBMustQuoteChars\fR\fR
2044 .sp .6
2045 .RS 4n
2046 Specifies the characters to be quoted in a full name phrase. \fB&,;:\e()[]\fR
2047 are quoted automatically.
2051 .ne 2
2053 \fB\fBNiceQueueRun\fR\fR
2055 .sp .6
2056 .RS 4n
2057 Specifies the priority of queue runners. See \fBnice\fR(1).
2061 .ne 2
2063 \fB\fBNoRecipientAction\fR\fR
2065 .sp .6
2066 .RS 4n
2067 Sets action if there are no legal recipient files in the message. The legal
2068 values are:
2070 .ne 2
2072 \fB\fBadd-apparently-to\fR\fR
2074 .sp .6
2075 .RS 4n
2076 Adds an \fBApparently-to:\fR header with all the known recipients (which may
2077 expose blind recipients).
2081 .ne 2
2083 \fB\fBadd-bcc\fR\fR
2085 .sp .6
2086 .RS 4n
2087 Adds an empty \fBBcc:\fR header.
2091 .ne 2
2093 \fB\fBadd-to\fR\fR
2095 .sp .6
2096 .RS 4n
2097 Adds a \fBTo:\fR header with all the known recipients (which may expose blind
2098 recipients).
2102 .ne 2
2104 \fB\fBadd-to-undisclosed\fR\fR
2106 .sp .6
2107 .RS 4n
2108 Adds a \fBTo: undisclosed-recipients:\fR header.
2112 .ne 2
2114 \fB\fBnone\fR\fR
2116 .sp .6
2117 .RS 4n
2118 Does nothing, that is, leaves the message as it is.
2124 .ne 2
2126 \fB\fBOldStyleHeaders (o)\fR\fR
2128 .sp .6
2129 .RS 4n
2130 Assumes that the headers may be in old format, that is, spaces delimit names.
2131 This actually turns on an adaptive algorithm: if any recipient address contains
2132 a comma, parenthesis, or angle bracket, it is assumed that commas already
2133 exist. If this flag is not on, only commas delimit names. Headers are always
2134 output with commas between the names.
2138 .ne 2
2140 \fB\fBOperatorChars or $o\fR\fR
2142 .sp .6
2143 .RS 4n
2144 Defines the list of characters that can be used to separate the components of
2145 an address into tokens.
2149 .ne 2
2151 \fB\fBPidFile\fR\fR
2153 .sp .6
2154 .RS 4n
2155 Specifies the filename of the \fBpid\fR file. The default is
2156 \fB/var/run/sendmail.pid\fR. The filename is macro-expanded before it is
2157 opened, and unlinked when \fBsendmail\fR exits.
2161 .ne 2
2163 \fB\fBPostmasterCopy (P\fR\fIpostmaster\fR\fB)\fR\fR
2165 .sp .6
2166 .RS 4n
2167 If set, copies of error messages are sent to the named \fIpostmaster\fR. Only
2168 the header of the failed message is sent. Since most errors are user problems,
2169 this is probably not a good idea on large sites, and arguably contains all
2170 sorts of privacy violations, but it seems to be popular with certain operating
2171 systems vendors.
2175 .ne 2
2177 \fB\fBPrivacyOptions (p\fR\fIopt,opt,...\fR\fB)\fR\fR
2179 .sp .6
2180 .RS 4n
2181 Sets privacy options. Privacy is really a misnomer; many of these options are
2182 just a way of insisting on stricter adherence to the SMTP protocol.
2184 The \fBgoaway\fR pseudo-flag sets all flags except \fBnoreceipts\fR,
2185 \fBrestrictmailq\fR, \fBrestrictqrun\fR, \fBrestrictexpand\fR, \fBnoetrn\fR,
2186 and \fBnobodyreturn\fR. If \fBmailq\fR is restricted, only people in the same
2187 group as the queue directory can print the queue. If queue runs are restricted,
2188 only root and the owner of the queue directory can run the queue. The
2189 \fBrestrict-expand\fR pseudo-flag instructs sendmail to drop privileges when
2190 the -bv option is given by users who are neither root nor the \fBTrustedUser\fR
2191 so users cannot read private aliases, forwards, or \fB:include:\fR files. It
2192 adds the \fBNonRootSafeAddr\fR to the "DontBlame-Sendmail" option to prevent
2193 misleading unsafe address warnings. It also overrides the \fB-v\fR (verbose)
2194 command line option to prevent information leakage. Authentication Warnings add
2195 warnings about various conditions that may indicate attempts to fool the mail
2196 system, such as using an non-standard queue directory.
2198 The options can be selected from:
2200 .ne 2
2202 \fB\fBauthwarnings\fR\fR
2204 .sp .6
2205 .RS 4n
2206 Puts \fBX-Authentication-Warning:\fR headers in messages.
2210 .ne 2
2212 \fB\fBgoaway\fR\fR
2214 .sp .6
2215 .RS 4n
2216 Disallows essentially all SMTP status queries.
2220 .ne 2
2222 \fB\fBneedexpnhelo\fR\fR
2224 .sp .6
2225 .RS 4n
2226 Insists on \fBHELO\fR or \fBEHLO\fR command before \fBEXPN\fR.
2230 .ne 2
2232 \fB\fBneedmailhelo\fR\fR
2234 .sp .6
2235 .RS 4n
2236 Insists on \fBHELO\fR or \fBEHLO\fR command before \fBMAIL\fR.
2240 .ne 2
2242 \fB\fBneedvrfyhelo\fR\fR
2244 .sp .6
2245 .RS 4n
2246 Insists on \fBHELO\fR or \fBEHLO\fR command before \fBVRFY\fR.
2250 .ne 2
2252 \fB\fBnoactualrecipient\fR\fR
2254 .sp .6
2255 .RS 4n
2256 Do not put an X-Actual-Recipient line in a DNS that reveals the actual account
2257 to which an address is mapped.
2261 .ne 2
2263 \fB\fBnoetrn\fR\fR
2265 .sp .6
2266 .RS 4n
2267 Disallows \fBETRN\fR entirely.
2271 .ne 2
2273 \fB\fBnoexpn\fR\fR
2275 .sp .6
2276 .RS 4n
2277 Disallows \fBEXPN\fR entirely.
2281 .ne 2
2283 \fB\fBnoreceipts\fR\fR
2285 .sp .6
2286 .RS 4n
2287 Prevents return receipts.
2291 .ne 2
2293 \fB\fBnobodyreturn\fR\fR
2295 .sp .6
2296 .RS 4n
2297 Does not return the body of a message with DSNs.
2301 .ne 2
2303 \fB\fBnovrfy\fR\fR
2305 .sp .6
2306 .RS 4n
2307 Disallows \fBVRFY\fR entirely.
2311 .ne 2
2313 \fB\fBpublic\fR\fR
2315 .sp .6
2316 .RS 4n
2317 Allows open access.
2321 .ne 2
2323 \fB\fBre\fR\fB\fR\fBstrictexpand\fR\fR
2325 .sp .6
2326 .RS 4n
2327 Restricts \fB-bv\fR and \fB-v\fR command line flags.
2331 .ne 2
2333 \fB\fBrestrictmailq\fR\fR
2335 .sp .6
2336 .RS 4n
2337 Restricts \fBmailq\fR command.
2341 .ne 2
2343 \fB\fBrestrictqrun\fR\fR
2345 .sp .6
2346 .RS 4n
2347 Restricts \fB-q\fR command line flag.
2353 .ne 2
2355 \fB\fBProcessTitlePrefix \fIstring\fR\fR\fR
2357 .sp .6
2358 .RS 4n
2359 Prefixes the process title shown on "\fB/usr/ucb/ps auxww\fR" listings with
2360 \fIstring\fR. The string is macro processed.
2364 .ne 2
2366 \fB\fBQueueDirectory (Q\fR\fIdir\fR\fB)\fR\fR
2368 .sp .6
2369 .RS 4n
2370 Uses the named \fIdir\fR as the queue directory.
2374 .ne 2
2376 \fB\fBQueueFactor (q\fR\fIfactor\fR\fB)\fR\fR
2378 .sp .6
2379 .RS 4n
2380 Uses \fIfactor\fR as the multiplier in the map function to decide when to just
2381 queue up jobs rather than run them. This value is divided by the difference
2382 between the current load average and the load average limit (\fBx\fR flag) to
2383 determine the maximum message priority to be sent. Defaults to \fB600000\fR.
2387 .ne 2
2389 \fB\fBQueueFileMode=\fR\fImode\fR\fR
2391 .sp .6
2392 .RS 4n
2393 Defaults permissions for queue files (octal). If not set, \fBsendmail\fR uses
2394 \fB0600\fR unless its real and effective \fBuid\fR are different in which case
2395 it uses \fB0644\fR.
2399 .ne 2
2401 \fB\fBQueueLA (x\fR\fILA\fR\fB)\fR\fR
2403 .sp .6
2404 .RS 4n
2405 When the system load average exceeds \fILA\fR, just queues messages (that is,
2406 does not try to send them). Defaults to eight times the number of processors
2407 online when \fBsendmail\fR starts.
2411 .ne 2
2413 \fB\fBQueueSortOrder=\fR\fIalgorithm\fR\fR
2415 .sp .6
2416 .RS 4n
2417 Sets the algorithm used for sorting the queue. Only the first character of the
2418 value is used. Legal values are \fBhost\fR (to order by the name of the first
2419 host name of the first recipient), \fBfilename\fR (to order by the name of the
2420 queue file name), \fBtime\fR (to order by the submission/creation time),
2421 \fBrandom\fR (to order randomly), \fBmodification\fR (to order by the
2422 modification time of the \fBqf\fR file (older entries first)), \fBnone\fR (to
2423 not order), and \fBpriority\fR (to order by message priority). Host ordering
2424 makes better use of the connection cache, but may tend to process low priority
2425 messages that go to a single host over high priority messages that go to
2426 several hosts; it probably shouldn't be used on slow network links. Filename
2427 and modification time ordering saves the overhead of reading all of the queued
2428 items before starting the queue run. Creation (submission) time ordering is
2429 almost always a bad idea, since it allows large, bulk mail to go out before
2430 smaller, personal mail, but may have applicability on some hosts with very fast
2431 connections. Random is useful if several queue runners are started by hand
2432 which try to drain the same queue since odds are they are working on different
2433 parts of the queue at the same time. Priority ordering is the default.
2437 .ne 2
2439 \fB\fBQueueTimeout (T\fR\fIrtime\fR\fB/\fR\fIwtime\fR\fB)\fR\fR
2441 .sp .6
2442 .RS 4n
2443 Sets the queue timeout to \fIrtime\fR. After this interval, messages that have
2444 not been successfully sent are returned to the sender. Defaults to five days
2445 (\fB5d\fR). The optional \fIwtime\fR is the time after which a warning message
2446 is sent. If it is missing or \fB0\fR, then no warning messages are sent.
2450 .ne 2
2452 \fB\fBRandFile\fR\fR
2454 .sp .6
2455 .RS 4n
2456 File containing random data (use prefix \fBfile:\fR) or the name of the UNIX
2457 socket if EGD is used (use prefix \fBegd:\fR). Note that Solaris supports
2458 \fBrandom\fR(7D), so this does not need to be specified.
2462 .ne 2
2464 \fB\fBRecipientFactor (y\fR\fIfact\fR\fB)\fR\fR
2466 .sp .6
2467 .RS 4n
2468 The indicated factor \fIfact\fR is added to the priority (thus \fIlowering\fR
2469 the priority of the job) for each recipient, that is, this value penalizes jobs
2470 with large numbers of recipients. Defaults to \fB30000\fR.
2474 .ne 2
2476 \fB\fBRefuseLA (X\fR\fILA\fR\fB)\fR\fR
2478 .sp .6
2479 .RS 4n
2480 When the system load average exceeds \fILA\fR, refuses incoming \fBSMTP\fR
2481 connections. Defaults to 12 times the number of processors online when
2482 \fBsendmail\fR starts.
2486 .ne 2
2488 \fB\fBRejectLogInterval\fR\fR
2490 .sp .6
2491 .RS 4n
2492 Log interval when refusing connections for this long (default: 3h).
2496 .ne 2
2498 \fB\fBResolverOptions (I)\fR\fR
2500 .sp .6
2501 .RS 4n
2502 Tunes DNS lookups.
2506 .ne 2
2508 \fB\fBRetryFactor (Z\fR\fIfact\fR\fB)\fR\fR
2510 .sp .6
2511 .RS 4n
2512 The indicated factor \fIfact\fR is added to the priority every time a job is
2513 processed. Thus, each time a job is processed, its priority is decreased by the
2514 indicated value. In most environments this should be positive, since hosts that
2515 are down are all too often down for a long time. Defaults to \fB90000\fR.
2519 .ne 2
2521 \fB\fBRrtImpliesDsn\fR\fR
2523 .sp .6
2524 .RS 4n
2525 If this option is set, a \fBReturn-Receipt-To\fR: header causes the request of
2526 a \fBDSN\fR, which is sent to the envelope sender as required by RFC 1891, not
2527 to the address given in the header.
2531 .ne 2
2533 \fB\fBRunAsUser\fR\fR
2535 .sp .6
2536 .RS 4n
2537 If set, becomes this user when reading and delivering mail. Intended for use of
2538 firewalls where users do not have accounts.
2542 .ne 2
2544 \fB\fBSafeFileEnvironment\fR\fR
2546 .sp .6
2547 .RS 4n
2548 If set, \fBsendmail\fR does a \fBchroot\fR into this directory before writing
2549 files.
2553 .ne 2
2555 \fB\fBSaveFromLine (f)\fR\fR
2557 .sp .6
2558 .RS 4n
2559 Saves Unix-style \fBFrom\fR lines at the front of headers. Normally they are
2560 assumed redundant and discarded.
2564 .ne 2
2566 \fB\fBSendMimeErrors (j)\fR\fR
2568 .sp .6
2569 .RS 4n
2570 If set, sends error messages in MIME format (see RFC 2045 and RFC 1344 for
2571 details). If disabled, \fBsendmail\fR does not return the DSN keyword in
2572 response to an \fBEHLO\fR and does not do Delivery Status Notification
2573 processing as described in RFC 1891.
2577 .ne 2
2579 \fB\fBServerCertFile\fR\fR
2581 .sp .6
2582 .RS 4n
2583 File containing the cert of the server, that is, this cert is used when
2584 \fBsendmail\fR acts as server.
2588 .ne 2
2590 \fB\fBServerKeyFile\fR\fR
2592 .sp .6
2593 .RS 4n
2594 File containing the private key belonging to the server cert.
2598 .ne 2
2600 \fB\fBServiceSwitchFile\fR\fR
2602 .sp .6
2603 .RS 4n
2604 Defines the path to the service-switch file. Since the service-switch file is
2605 defined in the Solaris operating environment this option is ignored.
2609 .ne 2
2611 \fB\fBSevenBitInput (7)\fR\fR
2613 .sp .6
2614 .RS 4n
2615 Strips input to seven bits for compatibility with old systems. This should not
2616 be necessary.
2620 .ne 2
2622 \fB\fBSharedMemoryKey\fR\fR
2624 .sp .6
2625 .RS 4n
2626 Specifies key to use for shared memory segment. If not set (or \fB0\fR), shared
2627 memory is not be used. If this option is set, \fBsendmail\fR can share some
2628 data between different instances. For example, the number of entries in a queue
2629 directory or the available space in a file system. This allows for more
2630 efficient program execution, since only one process needs to update the data
2631 instead of each individual process gathering the data each time it is required.
2635 .ne 2
2637 \fB\fBSharedMemoryKeyFile=\fR\fIfile\fR\fR
2639 .sp .6
2640 .RS 4n
2641 If \fBSharedMemoryKeyFile\fR is set to \fB-1\fR, the automatically selected
2642 shared memory key will be stored in the specified file.
2646 .ne 2
2648 \fB\fBSingleLineFromHeader\fR\fR
2650 .sp .6
2651 .RS 4n
2652 If set, \fBFrom:\fR lines that have embedded newlines are unwrapped onto one
2653 line.
2657 .ne 2
2659 \fB\fBSingleThreadDelivery\fR\fR
2661 .sp .6
2662 .RS 4n
2663 If this option and the \fBHostStatusDirectory\fR option are both set, uses
2664 single thread deliveries to other hosts.
2668 .ne 2
2670 \fB\fBSmtpGreetingMessage or $e\fR\fR
2672 .sp .6
2673 .RS 4n
2674 Specifies the initial SMTP greeting message.
2678 .ne 2
2680 \fB\fBSoftBounce\fR\fR
2682 .sp .6
2683 .RS 4n
2684 If set, issue temporary errors (\fB4xy\fR) instead of permanent errors
2685 (\fB5xy\fR). This can be useful during testing of a new configuration to avoid
2686 erroneous bouncing of mail.
2690 .ne 2
2692 \fB\fBStatusFile (S\fR\fIfile\fR\fB)\fR\fR
2694 .sp .6
2695 .RS 4n
2696 Logs statistics in the named \fIfile\fR. By default, this is
2697 \fB/etc/mail/sendmail.st\fR. As root, you must \fBtouch\fR(1) this file to
2698 enable \fBmailstats\fR(1).
2702 .ne 2
2704 \fB\fBSuperSafe (s)\fR\fR
2706 .sp .6
2707 .RS 4n
2708 This option can be set to \fBTrue\fR, \fBFalse\fR, \fBInteractive\fR, or
2709 \fBPostMilter\fR. If set to \fBTrue\fR, \fBsendmail\fR is set to super-safe
2710 when running things, that is, always instantiate the queue file, even if you
2711 are going to attempt immediate delivery. \fBsendmail\fR always instantiates the
2712 queue file before returning control to the client under any circumstances. This
2713 should really always be set to \fBTrue\fR. The \fBInteractive\fR value has been
2714 introduced in \fB8.12\fR and can be used together with \fBDeliveryMode=i\fR. It
2715 skips some synchronization calls which are effectively doubled in the code
2716 execution path for this mode. If set to \fBPostMilter\fR, \fBsendmail\fR defers
2717 synchronizing the queue file until any milters have signaled acceptance of the
2718 message. \fBPostMilter\fR is useful only when \fBsendmail\fR is running as an
2719 SMTP server; in all other situations it acts the same as True.
2723 .ne 2
2725 \fB\fBTempFileMode (F\fR\fImode\fR\fB)\fR\fR
2727 .sp .6
2728 .RS 4n
2729 Specifies the file mode for queue files.
2733 .ne 2
2735 \fB\fBTimeout (r\fR\fItimeouts\fR\fB)\fR\fR
2737 .sp .6
2738 .RS 4n
2739 Timeout reads after time interval. The \fItimeouts\fR argument is a list of
2740 \fIkeyword=value\fR pairs. All but \fIcommand\fR apply to client \fBSMTP\fR.
2741 For backward compatibility, a timeout with no \fIkeyword\fR= part is set all of
2742 the longer values. The recognized timeouts and their default values, and their
2743 minimum values specified in RFC 1123 section 5.3.2 are:
2745 .ne 2
2747 \fB\fBaconnect\fR\fR
2749 .sp .6
2750 .RS 4n
2751 all connections for a single delivery attempt [0, unspecified]
2755 .ne 2
2757 \fB\fBcommand\fR\fR
2759 .sp .6
2760 .RS 4n
2761 command read [1h, 5m]
2765 .ne 2
2767 \fB\fBconnect\fR\fR
2769 .sp .6
2770 .RS 4n
2771 initial connect [0, unspecified]
2775 .ne 2
2777 \fB\fBcontrol\fR\fR
2779 .sp .6
2780 .RS 4n
2781 complete control socket transaction [2m, none]
2785 .ne 2
2787 \fB\fBdatablock\fR\fR
2789 .sp .6
2790 .RS 4n
2791 data block read [1h, 3m]
2795 .ne 2
2797 \fB\fBdatafinal\fR\fR
2799 .sp .6
2800 .RS 4n
2801 reply to final \fB\&.\fR in data [1h, 10m]
2805 .ne 2
2807 \fB\fBdatainit\fR\fR
2809 .sp .6
2810 .RS 4n
2811 reply to \fBDATA\fR command [5m, 2m]
2815 .ne 2
2817 \fB\fBfileopen\fR\fR
2819 .sp .6
2820 .RS 4n
2821 file open [60sec, none]
2825 .ne 2
2827 \fB\fBhelo\fR\fR
2829 .sp .6
2830 .RS 4n
2831 reply to \fBHELO\fR or \fBEHLO\fR command [5m, none]
2835 .ne 2
2837 \fB\fBhoststatus\fR\fR
2839 .sp .6
2840 .RS 4n
2841 host retry [30m, unspecified]
2845 .ne 2
2847 \fB\fBiconnect\fR\fR
2849 .sp .6
2850 .RS 4n
2851 first attempt to connect to a host [0, unspecified]
2855 .ne 2
2857 \fB\fBident\fR\fR
2859 .sp .6
2860 .RS 4n
2861 \fBIDENT\fR protocol timeout [5s, none]
2865 .ne 2
2867 \fB\fBinitial\fR\fR
2869 .sp .6
2870 .RS 4n
2871 wait for initial greeting message [5m, 5m]
2875 .ne 2
2877 \fB\fBlhlo\fR\fR
2879 .sp .6
2880 .RS 4n
2881 wait for reply to an LMTP LHLO command [2m, unspecified]
2885 .ne 2
2887 \fB\fBmail\fR\fR
2889 .sp .6
2890 .RS 4n
2891 reply to \fBMAIL\fR command [10m, 5m]
2895 .ne 2
2897 \fB\fBmisc\fR\fR
2899 .sp .6
2900 .RS 4n
2901 reply to \fBNOOP\fR and \fBVERB\fR commands [2m, none]
2905 .ne 2
2907 \fB\fBqueuereturn\fR\fR
2909 .sp .6
2910 .RS 4n
2911 undeliverable message returned [5d]
2915 .ne 2
2917 \fB\fBqueuewarn\fR\fR
2919 .sp .6
2920 .RS 4n
2921 deferred warning [4h]
2925 .ne 2
2927 \fB\fBquit\fR\fR
2929 .sp .6
2930 .RS 4n
2931 reply to \fBQUIT\fR command [2m, none]
2935 .ne 2
2937 \fB\fBrcpt\fR\fR
2939 .sp .6
2940 .RS 4n
2941 reply to \fBRCPT\fR command [1h, 5m]
2945 .ne 2
2947 \fB\fBresolver.retrans\fR\fR
2949 .sp .6
2950 .RS 4n
2951 Resolver's retransmission time interval (in seconds) [varies]. Sets both
2952 \fBTimeout.resolver.retrans.first\fR and \fBTimeout.resolver.retrans.normal\fR.
2956 .ne 2
2958 \fB\fBresolver.retrans.first\fR\fR
2960 .sp .6
2961 .RS 4n
2962 Resolver's retransmission time interval (in seconds) for the first attempt to
2963 deliver a message [varies].
2967 .ne 2
2969 \fB\fBresolver.retrans.normal\fR\fR
2971 .sp .6
2972 .RS 4n
2973 Resolver's retransmission time interval (in seconds) for all look-ups except
2974 the first delivery attempt [varies].
2978 .ne 2
2980 \fB\fBresolver.retry\fR\fR
2982 .sp .6
2983 .RS 4n
2984 Number of times to retransmit a resolver query [varies]. Sets both
2985 \fBTimeout.resolver.retry.first\fR and \fBTimeout.resolver.retry.normal\fR.
2989 .ne 2
2991 \fB\fBresolver.retry.first\fR\fR
2993 .sp .6
2994 .RS 4n
2995 Number of times to retransmit a resolver query for the first attempt to deliver
2996 a message [varies].
3000 .ne 2
3002 \fB\fBresolver.retry.normal\fR\fR
3004 .sp .6
3005 .RS 4n
3006 Number of times to retransmit a resolver query for all look-ups except the
3007 first delivery attempt [varies].
3011 .ne 2
3013 \fB\fBrset\fR\fR
3015 .sp .6
3016 .RS 4n
3017 reply to \fBRSET\fR command [5m, none]
3021 .ne 2
3023 \fB\fBstarttls\fR\fR
3025 .sp .6
3026 .RS 4n
3027 response to an \fBSMTP STARTTLS\fR command [1h]
3033 .ne 2
3035 \fB\fBTimeZoneSpec (t\fR\fItzinfo\fR\fB)\fR\fR
3037 .sp .6
3038 .RS 4n
3039 Sets the local time zone info to \fItzinfo\fR, for example, "PST8PDT".
3040 Actually, if this is not set, the \fBTZ\fR environment variable is cleared (so
3041 the system default is used); if set but null, the user's \fBTZ\fR variable is
3042 used, and if set and non-null, the \fBTZ\fR variable is set to this value.
3046 .ne 2
3048 \fB\fBTLSSrvOptions\fR\fR
3050 .sp .6
3051 .RS 4n
3052 If this option is '\fBV\fR', then no client verification is performed,that is,
3053 the server does not ask for a certificate.
3057 .ne 2
3059 \fB\fBTrustedUser\fR\fR
3061 .sp .6
3062 .RS 4n
3063 The user parameter can be a user name (looked up in the passwd map) or a
3064 numeric user id. Trusted user for file ownership and starting the daemon. If
3065 set, generated alias databases and the control socket (if configured) are
3066 automatically owned by this user.
3070 .ne 2
3072 \fB\fBTryNullMXList (w)\fR\fR
3074 .sp .6
3075 .RS 4n
3076 If you are the "best" (that is, lowest preference) \fBMX\fR for a given host,
3077 you should normally detect this situation and treat that condition specially,
3078 by forwarding the mail to a \fBUUCP\fR feed, treating it as local, or whatever.
3079 However, in some cases (such as Internet firewalls) you may want to try to
3080 connect directly to that host as though it had no \fBMX\fR records at all.
3081 Setting this option causes \fBsendmail\fR to try this. The downside is that
3082 errors in your configuration are likely to be diagnosed as "host unknown" or
3083 "message timed out" instead of something more meaningful. This option is
3084 deprecated.
3088 .ne 2
3090 \fB\fBUnixFromLine or $l\fR\fR
3092 .sp .6
3093 .RS 4n
3094 The "From " line used when sending to files or programs.
3098 .ne 2
3100 \fB\fBUnsafeGroupWrites\fR\fR
3102 .sp .6
3103 .RS 4n
3104 If set, group-writable :include: and .forward files are considered "unsafe",
3105 that is, programs and files cannot be directly referenced from such files.
3109 .ne 2
3111 \fB\fBUseErrorsTo (l)\fR\fR
3113 .sp .6
3114 .RS 4n
3115 If there is an \fBErrors-To\fR: header, sends error messages to the addresses
3116 listed there. They normally go to the envelope sender. Use of this option
3117 causes \fBsendmail\fR to violate \fBRFC\fR 1123. This option is not recommended
3118 and deprecated.
3122 .ne 2
3124 \fB\fBUseMSP\fR\fR
3126 .sp .6
3127 .RS 4n
3128 Uses as mail submission program, that is, allows group writable queue files if
3129 the group is the same as that of a set-group-id \fBsendmail\fR binary.
3133 .ne 2
3135 \fB\fBUserDatabaseSpec (U)\fR\fR
3137 .sp .6
3138 .RS 4n
3139 Defines the name and location of the file containing User Database information.
3143 .ne 2
3145 \fB\fBVerbose (v)\fR\fR
3147 .sp .6
3148 .RS 4n
3149 Runs in verbose mode. If this is set, \fBsendmail\fR adjusts the
3150 \fBHoldExpensive\fR and \fBDeliveryMode\fR options so that all mail is
3151 delivered completely in a single job so that you can see the entire delivery
3152 process. The \fBVerbose\fR option should \fBnever\fR be set in the
3153 configuration file; it is intended for command line use only.
3157 .ne 2
3159 \fB\fBXscriptFileBufferSize\fR\fR
3161 .sp .6
3162 .RS 4n
3163 Sets the threshold, in bytes, before a memory-bases queue transcript file
3164 becomes disk-based. The default is 4096 bytes.
3169 If the first character of the user name is a vertical bar, the rest of the user
3170 name is used as the name of a program to pipe the mail to. It may be necessary
3171 to quote the name of the user to keep \fBsendmail\fR from suppressing the
3172 blanks from between arguments.
3175 If invoked as \fBnewaliases\fR, \fBsendmail\fR rebuilds the alias database, so
3176 long as the \fB/etc/mail/aliases*\fR files are owned by root \fIand\fR root has
3177 exclusive write permission. If invoked as \fBmailq\fR, \fBsendmail\fR prints
3178 the contents of the mail queue.
3179 .SH OPERANDS
3181 .ne 2
3183 \fB\fIaddress\fR\fR
3185 .sp .6
3186 .RS 4n
3187 address of an intended recipient of the message being sent.
3190 .SH USAGE
3193 See \fBlargefile\fR(5) for the description of the behavior of \fBsendmail\fR
3194 when encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
3195 .SH EXIT STATUS
3198 \fBsendmail\fR returns an exit status describing what it did. The codes are
3199 defined in \fB/usr/include/sysexits.h\fR.
3201 .ne 2
3203 \fB\fBEX_OK\fR\fR
3205 .sp .6
3206 .RS 4n
3207 Successful completion on all addresses.
3211 .ne 2
3213 \fB\fBEX_NOUSER\fR\fR
3215 .sp .6
3216 .RS 4n
3217 User name not recognized.
3221 .ne 2
3223 \fB\fBEX_UNAVAILABLE\fR\fR
3225 .sp .6
3226 .RS 4n
3227 Catchall. Necessary resources were not available.
3231 .ne 2
3233 \fB\fBEX_SYNTAX\fR\fR
3235 .sp .6
3236 .RS 4n
3237 Syntax error in address.
3241 .ne 2
3243 \fB\fBEX_SOFTWARE\fR\fR
3245 .sp .6
3246 .RS 4n
3247 Internal software error, including bad arguments.
3251 .ne 2
3253 \fB\fBEX_OSERR\fR\fR
3255 .sp .6
3256 .RS 4n
3257 Temporary operating system error, such as "cannot fork".
3261 .ne 2
3263 \fB\fBEX_NOHOST\fR\fR
3265 .sp .6
3266 .RS 4n
3267 Host name not recognized.
3271 .ne 2
3273 \fB\fBEX_TEMPFAIL\fR\fR
3275 .sp .6
3276 .RS 4n
3277 Message could not be sent immediately, but was queued.
3280 .SH ENVIRONMENT VARIABLES
3283 No environment variables are used. However, sendmail's start-up script, invoked
3284 by \fBsvcadm\fR(1M), reads \fB/etc/default/sendmail\fR. In this file, if the
3285 variable \fBETRN_HOSTS\fR is set, the start-up script parses this variable and
3286 invokes \fBetrn\fR(1M) appropriately. \fBETRN_HOSTS\fR should be of the form:
3288 .in +2
3290 "s1:c1.1,c1.2        s2:c2.1 s3:c3.1,c3.2,c3.3"
3292 .in -2
3297 That is, white-space separated groups of \fIserver:client\fR where \fIclient\fR
3298 can be one or more comma-separated names. The \fI:client\fR part is optional.
3299 \fIserver\fR is the name of the server to prod; a mail queue run is requested
3300 for each \fIclient\fR name. This is comparable to running:
3302 .in +2
3304 /usr/lib/sendmail -qR \fIclient\fR
3306 .in -2
3311 on the host \fIserver\fR.
3312 .SH FILES
3314 .ne 2
3316 \fB\fBdead.letter\fR\fR
3318 .sp .6
3319 .RS 4n
3320 Unmailable text
3324 .ne 2
3326 \fB\fB/etc/default/sendmail\fR\fR
3328 .sp .6
3329 .RS 4n
3330 Contains default settings. You can override some of the settings by command
3331 line options.
3335 .ne 2
3337 \fB\fB/etc/mail/aliases\fR\fR
3339 .sp .6
3340 .RS 4n
3341 Mail aliases file (ASCII)
3345 .ne 2
3347 \fB\fB/etc/mail/aliases.db\fR\fR
3349 .sp .6
3350 .RS 4n
3351 Database of mail aliases (binary)
3355 .ne 2
3357 \fB\fB/etc/mail/aliases.dir\fR\fR
3359 .sp .6
3360 .RS 4n
3361 Database of mail aliases (binary)
3365 .ne 2
3367 \fB\fB/etc/mail/aliases.pag\fR\fR
3369 .sp .6
3370 .RS 4n
3371 Database of mail aliases (binary)
3375 .ne 2
3377 \fB\fB/etc/mail/sendmail.cf\fR\fR
3379 .sp .6
3380 .RS 4n
3381 Defines environment for \fBsendmail\fR
3385 .ne 2
3387 \fB\fB/etc/mail/submit.cf\fR\fR
3389 .sp .6
3390 .RS 4n
3391 Defines environment for MSP
3395 .ne 2
3397 \fB\fB/etc/mail/trusted-users\fR\fR
3399 .sp .6
3400 .RS 4n
3401 Lists users that are "trusted", that is, able to set their envelope from
3402 address using \fB-f\fR without generating a warning message. Note that this
3403 file is consulted by the default \fBsendmail.cf\fR, but not by the default
3404 \fBsubmit.cf\fR, in which the line referring to \fB/etc/mail/trusted-users\fR
3405 is commented out. See \fBsendmail\fR(4) for instructions on making changes to
3406 \fBsubmit.cf\fR and \fBsendmail.cf\fR.
3410 .ne 2
3412 \fB\fB/var/spool/clientmqueue/*\fR\fR
3414 .sp .6
3415 .RS 4n
3416 Temporary files and queued mail
3420 .ne 2
3422 \fB\fB/var/spool/mqueue/*\fR\fR
3424 .sp .6
3425 .RS 4n
3426 Temporary files and queued mail
3430 .ne 2
3432 \fB\fB~/.forward\fR\fR
3434 .sp .6
3435 .RS 4n
3436 List of recipients for forwarding messages
3440 .ne 2
3442 \fB\fB/usr/include/libmilter/README\fR\fR
3444 .sp .6
3445 .RS 4n
3446 Describes the steps needed to compile and run a filter
3449 .SH SEE ALSO
3452 \fBsvcs\fR(1), \fBbiff\fR(1B), \fBmail\fR(1), \fBmailq\fR(1), \fBmailx\fR(1),
3453 \fBnice\fR(1), \fBcheck-hostname\fR(1M), \fBcheck-permissions\fR(1M),
3454 \fBetrn\fR(1M), \fBnewaliases\fR(1M), \fBsvcadm\fR(1M), \fBsvccfg\fR(1M),
3455 \fBfork\fR(2), \fBgetpwnam\fR(3C), \fBgetusershell\fR(3C),
3456 \fBresolver\fR(3RESOLV), \fBaliases\fR(4), \fBhosts\fR(4), \fBsendmail\fR(4),
3457 \fBshells\fR(4), \fBattributes\fR(5), \fBlargefile\fR(5), \fBsmf\fR(5),
3458 \fBrandom\fR(7D)
3461 \fBtcpd\fR(1M), \fBhosts_access\fR(4) in the \fBSUNWtcpd\fR package.
3464 \fBRFC\fR 2821 \fISimple Mail Transfer Protocol\fR, John Klensin, April 2001.
3467 \fBRFC\fR 2822 \fIInternet Message Format\fR, Pete Resnick, April 2001.
3470 \fIsendmail, Third Edition\fR, Bryan Costales with Eric Allman\fB\fR, O'Reilly
3471 & Associates, Inc., 2003.
3474 http://www.sendmail.org
3477 http://www.milter.org
3478 .SH NOTES
3481 The \fBsendmail\fR program requires a fully qualified host name when starting.
3482 A script has been included to help verify if the host name is defined properly
3483 (see \fBcheck-hostname\fR(1M)).
3486 The permissions and the ownership of several directories have been changed in
3487 order to increase security. In particular, access to \fB/etc/mail\fR and
3488 \fB/var/spool/mqueue\fR has been restricted.
3491 Security restrictions have been placed users using \fB\&.forward\fR files to
3492 pipe mail to a program or redirect mail to a file. The default shell (as listed
3493 in \fB/etc/passwd\fR) of these users must be listed in \fB/etc/shells\fR. This
3494 restriction does not affect mail that is being redirected to another alias.
3497 Additional restrictions have been put in place on \fB\&.forward\fR and
3498 \fB:include:\fR files. These files and the directory structure that they are
3499 placed in cannot be group- or world-writable. See \fBcheck-permissions\fR(1M).
3502 If you have interfaces that map to domains that have MX records that point to
3503 non-local destinations, you might need to enable the \fBDontProbeInterfaces\fR
3504 option to enable delivery to those destinations. In its default startup
3505 behavior, \fBsendmail\fR probes each interface and adds an interface's \fBIP\fR
3506 addresses, as well as any domains that those addresses map to, to its list of
3507 domains that are considered local. For domains thus added, being on the list of
3508 local domains is equivalent to having a 0-preference MX record, with
3509 \fBlocalhost\fR as the MX value. If this is not the result you want, enable
3510 \fBDontProbeInterfaces\fR.