1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
|
.\" Copyright (c) 1998-2001 Sendmail, Inc. and its suppliers.
.\" All rights reserved.
.\" Copyright (c) 1983, 1997 Eric P. Allman. All rights reserved.
.\" Copyright (c) 1988, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
.\" By using this file, you agree to the terms and conditions set
.\" forth in the LICENSE file which can be found at the top level of
.\" the sendmail distribution.
.\"
.\"
.\" $Id: sendmail.8,v 8.49 2001/03/23 22:10:00 ca Exp $
.\"
.\" $FreeBSD$
.\"
.TH SENDMAIL 8 "$Date: 2001/03/23 22:10:00 $"
.SH NAME
sendmail
\- an electronic mail transport agent
.SH SYNOPSIS
.B sendmail
.RI [ flags "] [" "address ..." ]
.br
.B newaliases
.br
.B mailq
.RB [ \-v ]
.br
.B hoststat
.br
.B purgestat
.br
.B smtpd
.SH DESCRIPTION
.B Sendmail
sends a message to one or more
.I recipients,
routing the message over whatever networks
are necessary.
.B Sendmail
does internetwork forwarding as necessary
to deliver the message to the correct place.
.PP
.B Sendmail
is not intended as a user interface routine;
other programs provide user-friendly
front ends;
.B sendmail
is used only to deliver pre-formatted messages.
.PP
With no flags,
.B sendmail
reads its standard input
up to an end-of-file
or a line consisting only of a single dot
and sends a copy of the message found there
to all of the addresses listed.
It determines the network(s) to use
based on the syntax and contents of the addresses.
.PP
Local addresses are looked up in a file
and aliased appropriately.
Aliasing can be prevented by preceding the address
with a backslash.
Beginning with 8.10, the sender is included in any alias
expansions, e.g.,
if `john' sends to `group',
and `group' includes `john' in the expansion,
then the letter will also be delivered to `john'.
.SS Parameters
.TP
.B \-Ac
Use submit.cf even if the operation mode does not indicate
an initial mail submission.
.TP
.B \-Am
Use sendmail.cf even if the operation mode indicates
an initial mail submission.
.TP
.BI \-B type
Set the body type to
.IR type .
Current legal values are
7BIT
or
8BITMIME.
.TP
.B \-ba
Go into
ARPANET
mode. All input lines must end with a CR-LF,
and all messages will be generated with a CR-LF at the end.
Also,
the ``From:'' and ``Sender:''
fields are examined for the name of the sender.
.TP
.B \-bd
Run as a daemon. This requires Berkeley
IPC.
.B Sendmail
will fork and run in background
listening on socket 25 for incoming
SMTP
connections.
This is normally run from
/etc/rc.
.TP
.B \-bD
Same as
.B \-bd
except runs in foreground.
.TP
.B \-bh
Print the persistent host status database.
.TP
.B \-bH
Purge expired entries from the persistent host status database.
.TP
.B \-bi
Initialize the alias database.
.TP
.B \-bm
Deliver mail in the usual way (default).
.TP
.B \-bp
Print a listing of the queue(s).
.TP
.B \-bP
Print number of entries in the queue(s);
only available with shared memory support.
.TP
.B \-bs
Use the
SMTP
protocol as described in
RFC821
on standard input and output.
This flag implies all the operations of the
.B \-ba
flag that are compatible with
SMTP.
.TP
.B \-bt
Run in address test mode.
This mode reads addresses and shows the steps in parsing;
it is used for debugging configuration tables.
.TP
.B \-bv
Verify names only \- do not try to collect or deliver a message.
Verify mode is normally used for validating
users or mailing lists.
.TP
.BI \-C file
Use alternate configuration file.
.B Sendmail
refuses to run as root if an alternate configuration file is specified.
.TP
.BI \-d X
Set debugging value to
.IR X .
.ne 1i
.TP
.BI \-F fullname
Set the full name of the sender.
.TP
.BI \-f name
Sets the name of the ``from'' person
(i.e., the envelope sender of the mail).
This address may also be used in the From: header
if that header is missing during initial submission.
The envelope sender address is used as the recipient
for delivery status notifications
and may also appear in a Return-Path: header.
.B \-f
should only be used
by ``trusted'' users
(normally
.IR root ", " daemon ,
and
.IR network )
or if the person you are trying to become
is the same as the person you are.
Otherwise,
an X-Authentication-Warning header
will be added to the message.
.TP
.BI \-G
Relay (gateway) submission of a message,
e.g., when
.BR rmail
calls
.B sendmail .
.TP
.BI \-h N
Set the hop count to
.IR N .
The hop count is incremented every time the mail is
processed.
When it reaches a limit,
the mail is returned with an error message,
the victim of an aliasing loop.
If not specified,
``Received:'' lines in the message are counted.
.TP
.B \-i
Ignore dots alone on lines by themselves in incoming messages.
This should be set if you are reading data from a file.
.TP
.BI "\-L " tag
Set the identifier used in syslog messages to the supplied
.IR tag .
.TP
.BI "\-N " dsn
Set delivery status notification conditions to
.IR dsn ,
which can be
`never'
for no notifications
or a comma separated list of the values
`failure'
to be notified if delivery failed,
`delay'
to be notified if delivery is delayed, and
`success'
to be notified when the message is successfully delivered.
.TP
.B \-n
Don't do aliasing.
.TP
\fB\-O\fP \fIoption\fR=\fIvalue\fR
Set option
.I option
to the specified
.IR value .
This form uses long names. See below for more details.
.TP
.BI \-o "x value"
Set option
.I x
to the specified
.IR value .
This form uses single character names only.
The short names are not described in this manual page;
see the
.I "Sendmail Installation and Operation Guide"
for details.
.TP
.BI \-p protocol
Set the name of the protocol used to receive the message.
This can be a simple protocol name such as ``UUCP''
or a protocol and hostname, such as ``UUCP:ucbvax''.
.TP
\fB\-q\fR[\fItime\fR]
Process saved messages in the queue at given intervals.
If
.I time
is omitted, process the queue once.
.I Time
is given as a tagged number,
with
`s'
being seconds,
`m'
being minutes (default),
`h'
being hours,
`d'
being days,
and
`w'
being weeks.
For example,
`\-q1h30m'
or
`\-q90m'
would both set the timeout to one hour thirty minutes.
By default,
.B sendmail
will run in the background.
This option can be used safely with
.BR \-bd .
.TP
\fB\-qp\fR[\fItime\fR]
Similar to \fB\-q\fItime\fR,
except that instead of periodically forking a child to process the queue,
sendmail forks a single persistent child for each queue
that alternates between processing the queue and sleeping.
The sleep time is given as the argument; it defaults to 1 second.
The process will always sleep at least 5 seconds if the queue was
empty in the previous queue run.
.TP
\fB\-q\fRf
Process saved messages in the queue once and do not fork(),
but run in the foreground.
.TP
\fB\-q\fRG name
Process jobs in queue group called
.I name
only.
.TP
\fB\-q\fR[\fI!\fR]I substr
Limit processed jobs to those containing
.I substr
as a substring of the queue id or not when
.I !
is specified.
.TP
\fB\-q\fR[\fI!\fR]R substr
Limit processed jobs to those containing
.I substr
as a substring of one of the recipients or not when
.I !
is specified.
.TP
\fB\-q\fR[\fI!\fR]S substr
Limit processed jobs to those containing
.I substr
as a substring of the sender or not when
.I !
is specified.
.TP
.BI "\-R " return
Set the amount of the message to be returned
if the message bounces.
The
.I return
parameter can be
`full'
to return the entire message or
`hdrs'
to return only the headers.
In the latter case also local bounces return only the headers.
.TP
.BI \-r name
An alternate and obsolete form of the
.B \-f
flag.
.TP
.B \-t
Read message for recipients.
To:, Cc:, and Bcc: lines will be scanned for recipient addresses.
The Bcc: line will be deleted before transmission.
.TP
.BI "\-V " envid
Set the original envelope id.
This is propagated across SMTP to servers that support DSNs
and is returned in DSN-compliant error messages.
.TP
.B \-v
Go into verbose mode.
Alias expansions will be announced, etc.
.TP
.BI "\-X " logfile
Log all traffic in and out of mailers in the indicated log file.
This should only be used as a last resort
for debugging mailer bugs.
It will log a lot of data very quickly.
.TP
.B \-\-
Stop processing command flags and use the rest of the arguments as
addresses.
.SS Options
There are also a number of processing options that may be set.
Normally these will only be used by a system administrator.
Options may be set either on the command line
using the
.B \-o
flag (for short names), the
.B \-O
flag (for long names),
or in the configuration file.
This is a partial list limited to those options that are likely to be useful
on the command line
and only shows the long names;
for a complete list (and details), consult the
.IR "Sendmail Installation and Operation Guide" .
The options are:
.TP
.RI AliasFile= file
Use alternate alias file.
.TP
HoldExpensive
On mailers that are considered ``expensive'' to connect to,
don't initiate immediate connection.
This requires queueing.
.TP
.RI CheckpointInterval= N
Checkpoint the queue file after every
.I N
successful deliveries (default 10).
This avoids excessive duplicate deliveries
when sending to long mailing lists
interrupted by system crashes.
.ne 1i
.TP
.RI DeliveryMode= x
Set the delivery mode to
.IR x .
Delivery modes are
`i'
for interactive (synchronous) delivery,
`b'
for background (asynchronous) delivery,
`q'
for queue only \- i.e.,
actual delivery is done the next time the queue is run, and
`d'
for deferred \- the same as
`q'
except that database lookups for maps which have set the \-D option
(default for the host map) are avoided.
.TP
.RI ErrorMode= x
Set error processing to mode
.IR x .
Valid modes are
`m'
to mail back the error message,
`w'
to ``write''
back the error message
(or mail it back if the sender is not logged in),
`p'
to print the errors on the terminal
(default),
`q'
to throw away error messages
(only exit status is returned),
and
`e'
to do special processing for the BerkNet.
If the text of the message is not mailed back
by
modes
`m'
or
`w'
and if the sender is local to this machine,
a copy of the message is appended to the file
.I dead.letter
in the sender's home directory.
.TP
SaveFromLine
Save
UNIX-style
From lines at the front of messages.
.TP
.RI MaxHopCount= N
The maximum number of times a message is allowed to ``hop''
before we decide it is in a loop.
.TP
IgnoreDots
Do not take dots on a line by themselves
as a message terminator.
.TP
SendMimeErrors
Send error messages in MIME format.
If not set, the DSN (Delivery Status Notification) SMTP extension
is disabled.
.TP
.RI ConnectionCacheTimeout= timeout
Set connection cache timeout.
.TP
.RI ConnectionCacheSize= N
Set connection cache size.
.TP
.RI LogLevel= n
The log level.
.TP
.RI MeToo= False
Don't send to ``me'' (the sender) if I am in an alias expansion.
.TP
CheckAliases
Validate the right hand side of aliases during a
newaliases(1)
command.
.TP
OldStyleHeaders
If set, this message may have
old style headers.
If not set,
this message is guaranteed to have new style headers
(i.e., commas instead of spaces between addresses).
If set, an adaptive algorithm is used that will correctly
determine the header format in most cases.
.TP
.RI QueueDirectory= queuedir
Select the directory in which to queue messages.
.TP
.RI StatusFile= file
Save statistics in the named file.
.TP
.RI Timeout.queuereturn= time
Set the timeout on undelivered messages in the queue to the specified time.
After delivery has failed
(e.g., because of a host being down)
for this amount of time,
failed messages will be returned to the sender.
The default is five days.
.TP
.RI UserDatabaseSpec= userdatabase
If set, a user database is consulted to get forwarding information.
You can consider this an adjunct to the aliasing mechanism,
except that the database is intended to be distributed;
aliases are local to a particular host.
This may not be available if your sendmail does not have the
USERDB
option compiled in.
.TP
ForkEachJob
Fork each job during queue runs.
May be convenient on memory-poor machines.
.TP
SevenBitInput
Strip incoming messages to seven bits.
.TP
.RI EightBitMode= mode
Set the handling of eight bit input to seven bit destinations to
.IR mode :
m
(mimefy) will convert to seven-bit MIME format,
p
(pass) will pass it as eight bits (but violates protocols),
and
s
(strict) will bounce the message.
.TP
.RI MinQueueAge= timeout
Sets how long a job must ferment in the queue between attempts to send it.
.TP
.RI DefaultCharSet= charset
Sets the default character set used to label 8-bit data
that is not otherwise labelled.
.TP
.RI DialDelay= sleeptime
If opening a connection fails,
sleep for
.I sleeptime
seconds and try again.
Useful on dial-on-demand sites.
.TP
.RI NoRecipientAction= action
Set the behaviour when there are no recipient headers (To:, Cc: or
Bcc:) in the message to
.IR action :
none
leaves the message unchanged,
add-to
adds a To: header with the envelope recipients,
add-apparently-to
adds an Apparently-To: header with the envelope recipients,
add-bcc
adds an empty Bcc: header, and
add-to-undisclosed
adds a header reading
`To: undisclosed-recipients:;'.
.TP
.RI MaxDaemonChildren= N
Sets the maximum number of children that an incoming SMTP daemon
will allow to spawn at any time to
.IR N .
.TP
.RI ConnectionRateThrottle= N
Sets the maximum number of connections per second to the SMTP port to
.IR N .
.PP
In aliases,
the first character of a name may be
a vertical bar to cause interpretation of
the rest of the name as a command
to pipe the mail to.
It may be necessary to quote the name
to keep
.B sendmail
from suppressing the blanks from between arguments.
For example, a common alias is:
.IP
msgs: "|/usr/bin/msgs -s"
.PP
Aliases may also have the syntax
.RI ``:include: filename ''
to ask
.B sendmail
to read the named file for a list of recipients.
For example, an alias such as:
.IP
poets: ":include:/usr/local/lib/poets.list"
.PP
would read
.I /usr/local/lib/poets.list
for the list of addresses making up the group.
.PP
.B Sendmail
returns an exit status
describing what it did.
The codes are defined in
.RI < sysexits.h >:
.TP
EX_OK
Successful completion on all addresses.
.TP
EX_NOUSER
User name not recognized.
.TP
EX_UNAVAILABLE
Catchall meaning necessary resources
were not available.
.TP
EX_SYNTAX
Syntax error in address.
.TP
EX_SOFTWARE
Internal software error,
including bad arguments.
.TP
EX_OSERR
Temporary operating system error,
such as
``cannot fork''.
.TP
EX_NOHOST
Host name not recognized.
.TP
EX_TEMPFAIL
Message could not be sent immediately,
but was queued.
.PP
If invoked as
.BR newaliases ,
.B sendmail
will rebuild the alias database. If invoked as
.BR mailq ,
.B sendmail
will print the contents of the mail queue.
If invoked as
.BR hoststat ,
.B sendmail
will print the persistent host status database.
If invoked as
.BR purgestat ,
.B sendmail
will purge expired entries from the persistent host status database.
If invoked as
.BR smtpd ,
.B sendmail
will act as a daemon, as if the
.B \-bd
option were specified.
.SH NOTES
.B sendmail
often gets blamed for many problems
that are actually the result of other problems,
such as overly permissive modes on directories.
For this reason,
.B sendmail
checks the modes on system directories and files
to determine if they can be trusted.
Although these checks can be turned off
and your system security reduced by setting the
.BR DontBlameSendmail
option,
the permission problems should be fixed.
For more information, see:
.I http://www.sendmail.org/tips/DontBlameSendmail.html
.SH FILES
Except for the file
.I /etc/mail/sendmail.cf
itself the following pathnames are all specified in
.IR /etc/mail/sendmail.cf .
Thus,
these values are only approximations.
.PP
.TP
/etc/mail/aliases
raw data for alias names
.TP
/etc/mail/aliases.db
data base of alias names
.TP
/etc/mail/sendmail.cf
configuration file
.TP
/etc/mail/helpfile
help file
.TP
/etc/mail/statistics
collected statistics
.TP
/var/spool/mqueue/*
temp files
.SH SEE ALSO
mail(1),
syslog(3),
aliases(5),
mailaddr(7),
mail.local(8),
rc(8),
rmail(8)
.PP
DARPA
Internet Request For Comments
.IR RFC819 ,
.IR RFC821 ,
.IR RFC822 .
.IR "Sendmail Installation and Operation Guide" ,
No. 8, SMM.
.PP
http://www.sendmail.org/
.SH HISTORY
The
.B sendmail
command appeared in
4.2BSD.
|