usr/src/man/man1m/mail.local.1m

   1 '\" te
   2 .\" Copyright (c) 1983 Eric P. Allman
   3 .\" Copyright (c) 1988, 1993 The Regents of the University of California.  All rights reserved.
   4 .\" Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright    notice, this list of conditions and the following disclaimer.
   5 .\" 2. Redistributions in binary form must reproduce the above copyright    notice, this list of conditions and the following disclaimer in the    documentation and/or other materials provided with the distribution. 3. All advertising materials mentioning features or use of this software    must display
   6 .\" the following acknowledgement: This product includes software developed by the University of California, Berkeley and its contributors. 4. Neither the name of the University nor the names of its contributors    may be used to endorse or promote products derived from this software    without specific
   7 .\" prior written permission.  THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR
   8 .\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
   9 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  10 .\" Copyright (c) 1998-2006, 2008 Sendmail, Inc. and its suppliers.  All rights reserved.
  11 .\" The following license terms and conditions apply, unless a different license is obtained from Sendmail, Inc., 6425 Christie Ave, Fourth Floor, Emeryville, CA 94608, USA, or by electronic mail at license@sendmail.com.  License Terms:  Use, Modification and Redistribution
  12 .\" (including distribution of any modified or derived work) in source and binary forms is permitted only if each of the following conditions is met:  1. Redistributions qualify as "freeware" or "Open Source Software" under    one of the following terms:     (a) Redistributions are made at no charge
  13 .\" beyond the reasonable cost of        materials and delivery.     (b) Redistributions are accompanied by a copy of the Source Code or by an        irrevocable offer to provide a copy of the Source Code for up to three       years at the cost of materials and delivery.  Such redistributions
  14 .\"    must allow further use, modification, and redistribution of the Source       Code under substantially the same terms as this license.  For the        purposes of redistribution "Source Code" means the complete compilable       and linkable source code of sendmail including all modifications.
  15 .\"  2. Redistributions of source code must retain the copyright notices as they    appear in each source code file, these license terms, and the    disclaimer/limitation of liability set forth as paragraph 6 below.  3. Redistributions in binary form must reproduce the Copyright Notice,    these license
  16 .\" terms, and the disclaimer/limitation of liability set    forth as paragraph 6 below, in the documentation and/or other materials    provided with the distribution.  For the purposes of binary distribution    the "Copyright Notice" refers to the following language:    "Copyright (c) 1998-2004 Sendmail,
  17 .\" Inc.  All rights reserved."  4. Neither the name of Sendmail, Inc. nor the University of California nor    the names of their contributors may be used to endorse or promote    products derived from this software without specific prior written    permission.  The name "sendmail" is a trademark
  18 .\" of Sendmail, Inc.  5. All redistributions must comply with the conditions imposed by the    University of California on certain embedded code, whose copyright    notice and conditions for redistribution are as follows:     (a) Copyright (c) 1988, 1993 The Regents of the University of        California.
  19 .\"  All rights reserved.     (b) Redistribution and use in source and binary forms, with or without        modification, are permitted provided that the following conditions        are met:        (i)   Redistributions of source code must retain the above copyright             notice, this list of
  20 .\" conditions and the following disclaimer.        (ii)  Redistributions in binary form must reproduce the above             copyright notice, this list of conditions and the following             disclaimer in the documentation and/or other materials provided             with the distribution.
  21 .\"       (iii) Neither the name of the University nor the names of its             contributors may be used to endorse or promote products derived             from this software without specific prior written permission. 6. Disclaimer/Limitation of Liability: THIS SOFTWARE IS PROVIDED BY    SENDMAIL,
  22 .\" INC. AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED    WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN    NO EVENT SHALL SENDMAIL, INC., THE REGENTS OF THE UNIVERSITY OF    CALIFORNIA OR CONTRIBUTORS
  23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT,    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF    USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON    ANY THEORY OF LIABILITY, WHETHER
  24 .\" IN CONTRACT, STRICT LIABILITY, OR TORT    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF    THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  25 .\" Portions Copyright (c) 2009, Sun Microsystems, Inc.  All Rights Reserved.
  26 .TH MAIL.LOCAL 1M "Apr 11, 1997"
  27 .SH NAME
  28 mail.local \- store mail in a mailbox
  29 .SH SYNOPSIS
  30 .LP
  31 .nf
  32 \fB/usr/lib/mail.local\fR [\fB-f\fR \fIsender\fR] [\fB-d\fR] \fIrecipient\fR
  33 .fi
  34
  35 .SH DESCRIPTION
  36 .sp
  37 .LP
  38 \fBmail.local\fR reads the standard input up to an end-of-file and appends it
  39 to each user's mail file (mailbox). This program is intended to be used by
  40 \fBsendmail\fR(1M) as a mail delivery agent for local mail. It is not a user
  41 interface agent.
  42 .sp
  43 .LP
  44 Messages are appended to the user's mail file in the \fB/var/mail\fR directory.
  45 The user must be a valid user name.
  46 .sp
  47 .LP
  48 Each delivered mail message in the mailbox is preceded by a "Unix From line"
  49 with the following format:
  50 .sp
  51 .LP
  52 \fBFrom\fR \fIsender_address\fR \fItime_stamp\fR
  53 .sp
  54 .LP
  55 The \fIsender_address\fR is extracted from the \fBSMTP\fR envelope address (the
  56 envelope address is specified with the \fB-f\fR option).
  57 .sp
  58 .LP
  59 A trailing blank line is also added to the end of each message.
  60 .sp
  61 .LP
  62 The mail files are locked with a \fB\&.lock\fR file while mail is appended.
  63 .sp
  64 .LP
  65 The mail files are created with mode \fB660\fR, owner is set to
  66 \fIrecipient\fR, and group is set to \fBmail\fR. If the ``biff'' service is
  67 returned by \fBgetservbyname\fR(3SOCKET), the biff server is notified of
  68 delivered mail. This program also computes the \fBContent-Length:\fR header
  69 which will be used by the mailbox reader to mark the message boundary.
  70 .SH OPTIONS
  71 .sp
  72 .LP
  73 The following options are supported:
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fB-f\fR \fIsender\fR\fR
  78 .ad
  79 .RS 13n
  80 Specifies the "envelope from address" of the message. This flag is technically
  81 optional,  but should be used.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fB-d\fR\fR
  88 .ad
  89 .RS 13n
  90 Specifies the recipient of the message. This flag is also optional and is
  91 supported here for backward compatibility. That is, \fBmail.local\fR\fI
  92 recipient\fR is the same as \fBmail.local\fR \fB-d\fR \fIrecipient\fR.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fB-l\fR\fR
  99 .ad
 100 .RS 13n
 101 Turn on \fBLMTP\fR mode.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fB-r\fR \fIfrom\fR\fR
 108 .ad
 109 .RS 13n
 110 Specify the sender's name (for backward compatibility).
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fB-7\fR\fR
 117 .ad
 118 .RS 13n
 119 Do not advertise 8BITMIME support in \fBLMTP\fR mode.
 120 .RE
 121
 122 .sp
 123 .ne 2
 124 .na
 125 \fB\fB-b\fR\fR
 126 .ad
 127 .RS 13n
 128 Return a permanent error instead of a temporary error if a mailbox exceeds
 129 quota.
 130 .RE
 131
 132 .SH OPERANDS
 133 .sp
 134 .LP
 135 The following operand is supported:
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fIrecipient\fR\fR
 140 .ad
 141 .RS 13n
 142 The recipient of the mail message.
 143 .RE
 144
 145 .SH ENVIRONMENT VARIABLES
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fBTZ\fR\fR
 150 .ad
 151 .RS 6n
 152 Used to set the appropriate time zone on the timestamp.
 153 .RE
 154
 155 .SH EXIT STATUS
 156 .sp
 157 .LP
 158 The following exit values are returned:
 159 .sp
 160 .ne 2
 161 .na
 162 \fB\fB0\fR\fR
 163 .ad
 164 .RS 6n
 165 Successful operation.
 166 .RE
 167
 168 .sp
 169 .ne 2
 170 .na
 171 \fB\fB>0\fR\fR
 172 .ad
 173 .RS 6n
 174 An error occurred.
 175 .RE
 176
 177 .SH FILES
 178 .sp
 179 .ne 2
 180 .na
 181 \fB\fB/tmp/local.\fR\fIXXXXXX\fR\fR
 182 .ad
 183 .RS 23n
 184 temporary files
 185 .RE
 186
 187 .sp
 188 .ne 2
 189 .na
 190 \fB\fB/tmp/lochd.\fR\fIXXXXXX\fR\fR
 191 .ad
 192 .RS 23n
 193 temporary files
 194 .RE
 195
 196 .sp
 197 .ne 2
 198 .na
 199 \fB\fB/var/mail/\fR\fIuser_name\fR\fR
 200 .ad
 201 .RS 23n
 202 user's mail file
 203 .RE
 204
 205 .SH SEE ALSO
 206 .sp
 207 .LP
 208 \fBmail\fR(1), \fBcomsat\fR(1M), \fBsendmail\fR(1M),
 209 \fBgetservbyname\fR(3SOCKET), \fBattributes\fR(5)