1 |
.\" Copyright (c) 1998-2001, 2003 Proofpoint, Inc. and its suppliers. |
2 |
.\" All rights reserved. |
3 |
.\" Copyright (c) 1990, 1993 |
4 |
.\" The Regents of the University of California. All rights reserved. |
5 |
.\" |
6 |
.\" By using this file, you agree to the terms and conditions set |
7 |
.\" forth in the LICENSE file which can be found at the top level of |
8 |
.\" the sendmail distribution. |
9 |
.\" |
10 |
.\" |
11 |
.\" $Id: mail.local.8,v 8.26 2013-11-22 20:51:51 ca Exp $ |
12 |
.\" |
13 |
.TH MAIL.LOCAL 8 "$Date: 2013-11-22 20:51:51 $" |
14 |
.SH NAME |
15 |
mail.local |
16 |
\- store mail in a mailbox |
17 |
.SH SYNOPSIS |
18 |
.B mail.local |
19 |
.RB [ \-7 "] [" \-B "] [" \-b "] [" \-d "] [" \-D |
20 |
.IR mbdb ] |
21 |
.RB [ \-l "] [" \-s "] [" \-f |
22 |
\fIfrom\fR|\fB\-r\fR |
23 |
.IR from ] |
24 |
.RB [ \-h |
25 |
\fIfilename\fR ] |
26 |
.I "user ..." |
27 |
.SH DESCRIPTION |
28 |
.B Mail.local |
29 |
reads the standard input up to an end-of-file and appends it to each |
30 |
.I user's |
31 |
.B mail |
32 |
file. The |
33 |
.I user |
34 |
must be a valid user name. |
35 |
.PP |
36 |
The options are as follows: |
37 |
.TP 1i |
38 |
.B \-7 |
39 |
Do not advertise 8BITMIME support in LMTP mode. |
40 |
.TP |
41 |
.B \-B |
42 |
Turn off the attempts to notify the ``biff'' service. |
43 |
.TP |
44 |
.B \-b |
45 |
Return a permanent error instead of a temporary error |
46 |
if a mailbox exceeds quota. |
47 |
.TP |
48 |
.B \-d |
49 |
Specify this is a delivery (for backward compatibility). |
50 |
This option has no effect. |
51 |
.TP |
52 |
.BI \-D " mbdb" |
53 |
Specify the name of the mailbox database |
54 |
which is used to look up local recipient names. |
55 |
This option defaults to "pw", which means use getpwnam(). |
56 |
.TP |
57 |
.BI \-f " from" |
58 |
Specify the sender's name. |
59 |
.TP |
60 |
.B \-l |
61 |
Turn on LMTP mode. |
62 |
.TP |
63 |
.B \-s |
64 |
Turn off the fsync(2) call that forces the mailbox to be committed |
65 |
to disk before returning a "success" status. |
66 |
.TP |
67 |
.BI \-r " from" |
68 |
Specify the sender's name (for backward compatibility). |
69 |
Same as \-f. |
70 |
.TP |
71 |
.BI \-h " filename" |
72 |
Store incoming mail in \fIfilename\fR in the user's home directory instead |
73 |
of a system mail spool directory. |
74 |
.PP |
75 |
The next options are only available if |
76 |
.B mail.local |
77 |
has been compiled with -DHASHSPOOL. |
78 |
.TP |
79 |
.BI \-H " hashtypehashdepth" |
80 |
Select hashed mail directories. |
81 |
Valid hash types are |
82 |
.B u |
83 |
for user name and |
84 |
.B m |
85 |
for MD5 (requires compilation with -DHASHSPOOLMD5). |
86 |
Example: |
87 |
.BI \-H " u2" |
88 |
selects user name hashing with a hash depth of 2. |
89 |
Note: there must be no space between the hash type and the depth. |
90 |
.TP |
91 |
.BI \-p " path" |
92 |
Specify an alternate mail spool path. |
93 |
.TP |
94 |
.BI \-n |
95 |
Specify that the domain part of recipient addresses in LMTP mode |
96 |
should not be stripped. |
97 |
.PP |
98 |
Individual mail messages in the mailbox are delimited by an empty |
99 |
line followed by a line beginning with the string ``From ''. |
100 |
A line containing the string ``From '', the sender's name and a time stamp |
101 |
is prepended to each delivered mail message. |
102 |
A blank line is appended to each message. |
103 |
A greater-than character (``>'') is prepended to any line in the message |
104 |
which could be mistaken for a ``From '' delimiter line |
105 |
(that is, |
106 |
a line beginning with the five characters |
107 |
``From '' following a blank line). |
108 |
.PP |
109 |
The mail files are exclusively locked with |
110 |
flock(2) |
111 |
while mail is appended, |
112 |
and a |
113 |
.B user.lock |
114 |
file also is created while the mailbox is locked |
115 |
for compatibility with older MUAs. |
116 |
.PP |
117 |
If the ``biff'' service is returned by |
118 |
getservbyname(3), |
119 |
the biff server is notified of delivered mail. |
120 |
.PP |
121 |
The |
122 |
.B mail.local |
123 |
utility exits 0 on success, and >0 if an error occurs. |
124 |
.SH ENVIRONMENT |
125 |
.IP TZ |
126 |
Used to set the appropriate time zone on the timestamp. |
127 |
.SH FILES |
128 |
.PD 0.2v |
129 |
.TP 2.2i |
130 |
/tmp/local.XXXXXX |
131 |
temporary files |
132 |
.TP |
133 |
/var/mail/user |
134 |
user's default mailbox directory |
135 |
.TP |
136 |
/var/mail/user.lock |
137 |
lock file for a user's default mailbox |
138 |
.PD |
139 |
.SH SEE ALSO |
140 |
mail(1), |
141 |
flock(2), |
142 |
getservbyname(3), |
143 |
comsat(8), |
144 |
sendmail(8) |
145 |
.SH WARNING |
146 |
.B mail.local |
147 |
escapes only "^From " lines that follow an empty line. |
148 |
If all lines starting with "From " should be escaped, |
149 |
use the 'E' flag for the local mailer in the |
150 |
sendmail.cf file. |
151 |
.SH HISTORY |
152 |
A superset of |
153 |
.B mail.local |
154 |
(handling mailbox reading as well as mail delivery) |
155 |
appeared in |
156 |
Version 7 AT&T UNIX |
157 |
as the program |
158 |
.BR mail . |
159 |
.\" $FreeBSD: stable/10/contrib/sendmail/mail.local/mail.local.8 266692 2014-05-26 15:28:28Z gshapiro $ |